POST
/Document/Statement
When to Use
- Distribution Statements (Type 1): Generate AMIT-compliant distribution statements for specific corporate actions including unit trust distributions, dividend payments, and capital returns with complete tax component breakdowns
- Transaction Statements (Type 2): Create member account activity statements for specified date ranges showing applications, redemptions, switches, fee deductions, and balance movements for member inquiries or periodic reporting
- Tax Statements (Type 3): Produce annual tax statements for financial year-end ATO reporting including distribution components, franking credits, foreign income, and capital gains for member tax returns
- On-Demand Generation: Generate statements dynamically in response to member portal requests, customer service inquiries, or automated scheduled statement runs
- Regulatory Compliance: Meet ASIC disclosure requirements and Corporations Act obligations for member communication and record-keeping with proper retention periods
Prerequisites
- Valid Bearer token with statement generation permissions
- Statement templates configured for requested statementTypeID
- Complete entity and transaction data for specified period
Considerations
- Performance: Statement generation is resource-intensive for large transaction histories
- Date Range Limits: Large date ranges may cause performance issues
- Binary Response: Returns PDF stream, not JSON - handle file downloads appropriately
- Retention: Consider automatic storage to Document records for compliance
Description
Generates customized investor statements using configured templates and returns the statement as a binary PDF file stream. Statements include transaction history, balances, distributions, and tax information for specified periods and entities.
Required Headers - See Authentication
Header | Value | Description |
---|---|---|
Content-Type | application/json | Request content type |
Authorization | {accessToken} | Bearer token for API access |
Version | 2.0 | API version identifier |
Request Body
Parameter | Type | Required | Description |
---|---|---|---|
statementTypeID |
integer | The statement type classification ID (1=Distribution, 2=Transaction, 3=Tax). Determines template selection, data inclusion, required fields, and validation logic for statement generation. | |
ProductID |
integer | The product identifier for statement generation. Required for all statement types. If ProductID > 0, it takes precedence over ExternalProductId. | |
externalProductId |
string | Your external product identifier. Required for all statement types when ProductID is not provided or equals 0. | |
InvestmentID |
integer | Optional |
The investment identifier to include in statement. Filter to specific investments within a product. |
externalInvestmentId |
string | Optional |
Your external investment identifier. Alternative to investmentID for investment-specific statements. |
CorporateActionID |
integer | The corporate action identifier for distribution statement generation. Mandatory for statementTypeID = 1. Returns 400 Bad Request if missing: 'UniqueID is required for distribution statement.' | |
externalCorporateActionId |
string | Your external corporate action identifier. Required for distribution statements when CorporateActionID is not provided or equals 0. | |
BizEntityID |
integer | The business entity identifier for statement generation. Mandatory for all statement types (Distribution, Transaction, Tax). System validates entity exists and user has access permissions. | |
externalBizEntityId |
string | Your external business entity identifier. Required for all statement types when BizEntityID is not provided or equals 0. | |
OrganisationID |
integer | Optional |
The organisation identifier to generate statement for. Filter to specific organisations. |
externalOrganisationId |
string | Optional |
Your external organisation identifier. Alternative to organisationID for organisation-specific statements. |
fromDate |
string (date) | Start date for transaction statement period in YYYY-MM-DD format. Mandatory for statementTypeID = 2. Returns 400 Bad Request if missing: 'From Date required for Transaction Statement.' | |
toDate |
string (date) | End date for statement period in YYYY-MM-DD format. Mandatory for statementTypeID = 2 and 3. For Tax statements (type 3), must correspond to valid financial year end date. Returns 400 Bad Request if missing or invalid financial year. | |
code |
string | Optional |
Statement reference code for identification and tracking purposes. |
statementTypeID
The statement type classification ID (1=Distribution, 2=Transaction, 3=Tax). Determines template selection, data inclusion, required fields, and validation logic for statement generation.
ProductID
The product identifier for statement generation. Required for all statement types. If ProductID > 0, it takes precedence over ExternalProductId.
externalProductId
Your external product identifier. Required for all statement types when ProductID is not provided or equals 0.
InvestmentID
The investment identifier to include in statement. Filter to specific investments within a product.
externalInvestmentId
Your external investment identifier. Alternative to investmentID for investment-specific statements.
CorporateActionID
The corporate action identifier for distribution statement generation. Mandatory for statementTypeID = 1. Returns 400 Bad Request if missing: 'UniqueID is required for distribution statement.'
externalCorporateActionId
Your external corporate action identifier. Required for distribution statements when CorporateActionID is not provided or equals 0.
BizEntityID
The business entity identifier for statement generation. Mandatory for all statement types (Distribution, Transaction, Tax). System validates entity exists and user has access permissions.
externalBizEntityId
Your external business entity identifier. Required for all statement types when BizEntityID is not provided or equals 0.
OrganisationID
The organisation identifier to generate statement for. Filter to specific organisations.
externalOrganisationId
Your external organisation identifier. Alternative to organisationID for organisation-specific statements.
fromDate
Start date for transaction statement period in YYYY-MM-DD format. Mandatory for statementTypeID = 2. Returns 400 Bad Request if missing: 'From Date required for Transaction Statement.'
toDate
End date for statement period in YYYY-MM-DD format. Mandatory for statementTypeID = 2 and 3. For Tax statements (type 3), must correspond to valid financial year end date. Returns 400 Bad Request if missing or invalid financial year.
code
Statement reference code for identification and tracking purposes.
Statement Types & Required Fields
Type ID | Statement Type | Required Fields | Purpose |
---|---|---|---|
1 | Distribution Statement | corporateActionID or externalCorporateActionId bizEntityID or externalBizEntityId |
AMIT-compliant distribution statements with tax component details, franking credits, and ATO reporting information for specific corporate actions |
2 | Transaction Statement | fromDate and toDate (both required)bizEntityID or externalBizEntityId |
Member account activity for specified date range including unit applications/redemptions, fee deductions, balance changes, and transaction history |
3 | Tax Statement | toDate (validates financial year)bizEntityID or externalBizEntityId |
Annual tax information for ATO reporting including distribution components, franking credits, capital gains, and financial year summaries. System validates toDate corresponds to valid financial year end |
Regulatory Requirements: All statements must include required disclaimers, PDS references, and contact information per ASIC RG97 and Corporations Act 2001. Retention period: 7 years minimum.
Example Requests
json
{
"statementTypeID": 1,
"productID": 100,
"bizEntityID": 12345,
"fromDate": "2024-01-01",
"toDate": "2024-12-31",
"code": "ANNUAL-2024"
}
Response Examples
json
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="Investment_Statement_2024.pdf"
[Binary file content streamed to client]