📄 Document Resource

Document and statement management with secure file handling

Document management system for files, statements, and compliance documents. Handle file uploads, downloads, metadata management, and automated statement generation.

8
Endpoints
File+Meta
Management
Statements
Generation
Secure
Storage
📄

File Management

File upload, download, and management with secure storage and file type validation.

📋

Document Types & Metadata

Support for statements, documents, and custom files with metadata tracking and entity associations.

📊

Statement Generation

Financial statement generation with configurable date ranges, entity filtering, and multi-format output.

Available Endpoints

Document Operations

POST Create Document Register document with metadata and type classification
GET Get Documents Retrieve documents with entity associations and metadata
PUT Update Document Update document metadata and properties
DELETE Delete Document Remove document from system

File Operations

POST Upload File Upload files with automatic validation and secure storage
GET Download File Download file content from document storage
PUT Update File Replace file content for existing document

Statement Generation

POST Generate Statement Generate statements with date ranges and entity filtering

Core Data Transfer Objects

DocumentDTO POST, PUT, GET Document endpoints Document metadata structure (16 properties) including type classification, file metadata, entity associations (BizEntity, Organisation), security settings, portal visibility flags, and public access controls
StatementDTO Statement generation endpoint Statement generation parameters (14 properties) with statement type, entity filters (Product, Investment, CorporateAction, BizEntity, Organisation), date ranges, and code identification

Business Rules & Constraints

File Management & Validation

  • File type validation: Supported formats include PDF, DOCX, XLSX, CSV, PNG, JPG with MIME type verification
  • Document metadata: Each document includes type classification, name, description, and optional password protection
  • Entity associations: Documents can be linked to BizEntity, Organisation, or Product records via ID references

Statement Generation

  • Date range parameters: Statement generation accepts optional FromDate and ToDate parameters for period filtering
  • Entity filtering: Supports BizEntity, Organisation, Investment, Product, and CorporateAction scoping via ID parameters
  • Statement types: StatementTypeID determines the generated report format and content structure
  • Code identification: Optional Code parameter for statement reference tracking and retrieval

Document Properties & Controls

  • Portal visibility: ShowInDocumentsInPortal flag controls whether document appears in investor portal views
  • Public access: IsPublic flag determines document accessibility without authentication requirements
  • Password protection: Optional Password field enables document-level access restrictions
  • Ordinal sequencing: Ordinal property supports custom document ordering within entity document lists

Integration & Cross-Resource Dependencies

  • BizEntity linkage: Documents can be associated with BizEntity records via BizEntityID or ExternalBizEntityId
  • Organisation linkage: Documents can be associated with Organisation records via OrganisationID or ExternalOrganisationId
  • Product linkage: Documents can be associated with Product records via ProductID or ExternalProductId
  • External system integration: ExternalDocumentId supports external document management system synchronization and idempotency

Document Management Workflows

Document resource integrates with the broader 7G ecosystem, providing secure file storage, statement generation, and document management across investor and organisational operations.

📊

Report Integration

Generated reports from Report resource can be stored as Document records with metadata linkage for retrieval and distribution.

→ Generate Reports • → Track Report Status
🏢

BizEntity Document Association

Documents link to BizEntity records for investor-specific file management, supporting document storage with entity associations and portal visibility controls.

→ BizEntity Overview • → Entity Queries
💰

Transaction & Distribution Documentation

Documents can be categorized and managed alongside transaction and distribution operations for organized record-keeping and investor communications.

→ Transaction Resource • → Distribution Resource