POST

/Document/Statement

When to Use

  • Generate distribution statements for specific corporate actions with tax component breakdowns
  • Create member account activity statements for specified date ranges
  • Produce annual tax statements for financial year-end reporting
  • Generate statements dynamically in response to member portal requests

Prerequisites

  • Statement templates configured for requested statementTypeID

Considerations

  • Statement generation is resource-intensive for large transaction histories
  • Large date ranges may cause performance issues
  • Returns PDF stream, not JSON (handle file downloads appropriately)
  • 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

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

Request Body

Parameter Type Required Description
statementTypeID >
integer
Statement type classification reference via common/lookup. 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 distribution statements.
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.
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 transaction statements.
toDate >
string (date)
End date for statement period in YYYY-MM-DD format. Mandatory for transaction and tax statements. Tax statements require valid financial year end date.
code
 string
Optional
Statement reference code for identification and tracking purposes.
statementTypeID
integer
Statement type classification reference via common/lookup. 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 distribution statements.
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.
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 transaction statements.
toDate
string (date)
End date for statement period in YYYY-MM-DD format. Mandatory for transaction and tax statements. Tax statements require valid financial year end date.
code
string
Optional
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]
GET Get BizEntities GET Get Distributions POST Create Document POST Upload Document File