POST

/Document

When to Use

  • Create document metadata records before uploading file content
  • Register investor statements, tax documents, or distribution notices
  • Record compliance documents and regulatory filings
  • Set up documents with portal visibility controls

Prerequisites

  • Valid Bearer token with document creation permissions
  • Valid documentTypeID configured in system

Considerations

  • Metadata Only: Creates document record without file content - use /Document/File for file upload
  • Portal Visibility: showInDocumentsInPortal controls investor portal visibility
  • Public Access: isPublic determines if authentication is required for access
  • Entity Association: Documents can be linked to BizEntity, Organisation, or Product, but not required
  • Password Protection: Optional password field for additional document security
  • Product Validation Logic: ProductID takes precedence if > 0, otherwise ExternalProductId is used. At least one must be provided for product security validation
  • ExternalDocumentId Uniqueness: Uniqueness is scoped per ProductID. You can reuse the same ExternalDocumentId across different products without conflicts
  • BizEntity Permissions: Associating documents with a BizEntity triggers automatic permission validation. Operation fails with 400 Bad Request if user lacks access rights
  • Entity Association Flexibility: Documents can be associated at Product level (accessible to all), BizEntity level (investor-specific), or Organisation level (corporate-specific) based on access control requirements

Description

Creates a new document metadata record in the 7G system. This establishes the document's properties, type classification, entity associations, and visibility settings without uploading file content. Returns the created document with system-generated documentID.

Required Headers - See Authentication

HeaderValueDescription
Content-Typeapplication/jsonRequest content type
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier

Request Body

Parameter Type Required Description
documentID
 integer
Optional
The document identifier. Must be null for new documents - will be auto-generated by the system.
externalDocumentId
 string
Optional
Your external system identifier for the document. Used for integration and synchronization. Uniqueness is scoped to ProductID - the same ExternalDocumentId can exist across different products without conflicts.
documentTypeID >
integer
The document type classification ID. Determines document handling and retention policies.
name
 string
Optional
Human-readable document name displayed in portals and document lists.
code
 string
Optional
Short code for internal reference and document identification.
description
 string
Optional
Detailed description of the document's content and purpose.
password
 string
Optional
Optional password for document protection. Required to access password-protected documents.
ordinal
 integer
Optional
Sort order for document display in lists. Lower numbers appear first.
ProductID >
integer
The product identifier for document association and security validation. If ProductID > 0, it takes precedence over ExternalProductId.
externalProductId >
string
Your external product identifier. Used for product association when ProductID is not provided or equals 0.
BizEntityID >
integer
Associates the document with a specific business entity. Use for investor-specific documents. If provided, triggers permission validation to ensure user has access rights to this BizEntity.
externalBizEntityId >
string
Your external business entity identifier. Used for entity association when BizEntityID is not provided or equals 0. Triggers same permission validation as BizEntityID.
OrganisationID >
integer
Associates the document with a specific organisation. Alternative to BizEntity association for corporate-level documents (e.g., trust deeds, constitutional documents, corporate actions).
externalOrganisationId >
string
Your external organisation identifier. Used for organisation association when OrganisationID is not provided or equals 0. Alternative to BizEntity for corporate-level document management.
showInDocumentsInPortal >
boolean
Controls whether the document appears in client-facing investor portals.
isPublic >
boolean
Determines if the document can be accessed without authentication.
documentID
integer
Optional
The document identifier. Must be null for new documents - will be auto-generated by the system.
externalDocumentId
string
Optional
Your external system identifier for the document. Used for integration and synchronization. Uniqueness is scoped to ProductID - the same ExternalDocumentId can exist across different products without conflicts.
documentTypeID
integer
The document type classification ID. Determines document handling and retention policies.
name
string
Optional
Human-readable document name displayed in portals and document lists.
code
string
Optional
Short code for internal reference and document identification.
description
string
Optional
Detailed description of the document's content and purpose.
password
string
Optional
Optional password for document protection. Required to access password-protected documents.
ordinal
integer
Optional
Sort order for document display in lists. Lower numbers appear first.
ProductID
integer
The product identifier for document association and security validation. If ProductID > 0, it takes precedence over ExternalProductId.
externalProductId
string
Your external product identifier. Used for product association when ProductID is not provided or equals 0.
BizEntityID
integer
Associates the document with a specific business entity. Use for investor-specific documents. If provided, triggers permission validation to ensure user has access rights to this BizEntity.
externalBizEntityId
string
Your external business entity identifier. Used for entity association when BizEntityID is not provided or equals 0. Triggers same permission validation as BizEntityID.
OrganisationID
integer
Associates the document with a specific organisation. Alternative to BizEntity association for corporate-level documents (e.g., trust deeds, constitutional documents, corporate actions).
externalOrganisationId
string
Your external organisation identifier. Used for organisation association when OrganisationID is not provided or equals 0. Alternative to BizEntity for corporate-level document management.
showInDocumentsInPortal
boolean
Controls whether the document appears in client-facing investor portals.
isPublic
boolean
Determines if the document can be accessed without authentication.

Example Requests

json
{
  "documentID": null,
  "externalDocumentId": "STMT_2024_Q1_001",
  "documentTypeID": 1,
  "name": "Quarterly Investment Statement - Q1 2024",
  "code": "Q1_STMT_2024",
  "description": "Comprehensive quarterly investment statement showing portfolio performance, transactions, and distribution details for Q1 2024",
  "password": null,
  "ordinal": 1,
  "productID": 100,
  "externalProductId": "GROWTH_FUND_AU",
  "bizEntityID": 67890,
  "externalBizEntityId": "CLIENT_ENT_001",
  "organisationID": null,
  "externalOrganisationId": null,
  "showInDocumentsInPortal": true,
  "isPublic": false
}

Response Examples

json
{
  "result": true,
  "message": "Document created successfully",
  "data": {
    "documentID": 12347,
    "externalDocumentId": "STMT_2024_Q1_001",
    "documentTypeID": 1,
    "name": "Quarterly Investment Statement - Q1 2024",
    "code": "Q1_STMT_2024",
    "description": "Comprehensive quarterly investment statement showing portfolio performance, transactions, and distribution details for Q1 2024",
    "password": null,
    "ordinal": 1,
    "productID": 100,
    "externalProductId": "GROWTH_FUND_AU",
    "bizEntityID": 67890,
    "externalBizEntityId": "CLIENT_ENT_001",
    "organisationID": null,
    "externalOrganisationId": null,
    "showInDocumentsInPortal": true,
    "isPublic": false
  }
}
GET Retrieve document metadata PUT Update document metadata DELETE Delete document record POST /Document/File - Upload file content POST /Document/Statement - Generate statement