POST

/Document/Statement

Usage Notes

When

  • Generate investor statements with date ranges
  • Create reports scoped to specific entities or products

Requirements

  • StatementTypeID required
  • Entity or product scope (BizEntityID, ProductID, etc.)

Notes

  • Date range parameters (FromDate, ToDate) for period filtering
  • Generated document stored and accessible via Document endpoints

Description

Generates an investor statement or report with specified parameters. Returns document record for the generated file.

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

The statementTypeID determines which template, validation rules, and data sources are used for statement generation. Query Common/Lookup for the latest available statement types.

ID: 8 Tax Statement
toDate bizEntityID
Required Fields
toDate (validates financial year end) bizEntityID or externalBizEntityId

Annual tax information for ATO reporting including distribution components, franking credits, capital gains, and financial year summaries.

ID: 9 Distribution Statement
corporateActionID bizEntityID
Required Fields
corporateActionID or externalCorporateActionId bizEntityID or externalBizEntityId

AMIT-compliant distribution statements with tax component details, franking credits, and ATO reporting information for specific corporate actions.

ID: 32 Transaction Statement
fromDate toDate bizEntityID
Required Fields
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.

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

bash
# Generate a distribution statement (statementTypeID: 9)
curl -X POST 'https://api.7g.com.au/Document/Statement' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "statementTypeID": 9,
    "productID": 100,
    "bizEntityID": 12345,
    "corporateActionID": 789,
    "code": "DIST-2024-Q4"
  }' \
  --output distribution_statement.pdf

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