GET

/Distribution

Usage Notes

When

Query distributions within a product using flexible filter criteria
Filter distributions by corporate action, investment, or record date
Paginate through distribution records for reporting and reconciliation

Requirements

ProductID or ExternalProductId is required to scope the query
Use additional filters (CorporateActionID, RecordDate, etc.) to narrow results

Notes

Returns paginated array of distributions matching filter criteria
Supports dot operators for advanced filtering on multiple fields
Account-level details available via GET /Distribution/Account
Default PageSize is 1000; use pagination for large result sets

Description

Queries distributions within a product using comprehensive filtering with dot operators. Returns paginated array of distributions with configuration, tax components, and workflow status. Use GET /Distribution/Account for per-account details after declaration.

Distribution Query Workflow

GET /Distribution retrieves distributions matching your filter criteria. Common workflows include:

Query distributions by record date range for period-end reporting
Filter by investment to find distributions for specific securities
Retrieve specific distribution by CorporateActionID for status verification

Workflow Pattern: Use GET /Distribution to identify distributions, then GET /Distribution/Account with CorporateActionID filter to retrieve per-account details.

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Query Parameters

Parameter	Type	Required	Description
`ProductID` >	integer	> Conditional...	Product identifier to scope the distribution query. Required for all queries.
`ExternalProductId` >	string	> Conditional...	External product identifier for cross-system product mapping.
`CorporateActionID`	FilterOfInt32	Optional	Filter distributions by native corporate action identifier.
`ExternalCorporateActionId`	StringFilter	Optional	Filter distributions by external corporate action identifier with pattern matching.
`InvestmentID`	FilterOfInt32	Optional	Filter distributions by native investment identifier.
`ExternalInvestmentId`	StringFilter	Optional	Filter distributions by external investment identifier with pattern matching.
`RecordDate`	FilterOfDateOnly	Optional	Filter distributions by record date for period-based reporting.
`PageNumber`	integer	Optional	Page number to retrieve starting from 1. Use with PageSize for efficient pagination.
`PageSize`	integer	Optional	Number of records per page (default 100). Controls response size for large result sets.

ProductID

integer

> Conditional...

Product identifier to scope the distribution query. Required for all queries.

ExternalProductId

string

> Conditional...

External product identifier for cross-system product mapping.

CorporateActionID

FilterOfInt32

Optional

Filter distributions by native corporate action identifier.

ExternalCorporateActionId

StringFilter

Optional

Filter distributions by external corporate action identifier with pattern matching.

InvestmentID

FilterOfInt32

Optional

Filter distributions by native investment identifier.

ExternalInvestmentId

StringFilter

Optional

Filter distributions by external investment identifier with pattern matching.

RecordDate

FilterOfDateOnly

Optional

Filter distributions by record date for period-based reporting.

PageNumber

integer

Optional

Page number to retrieve starting from 1. Use with PageSize for efficient pagination.

PageSize

integer

Optional

Number of records per page (default 100). Controls response size for large result sets.

Query & Filtering

🔍 7G Query & Filtering with Dot Operators

Distribution supports advanced typed filtering for efficient distribution management and reporting workflows.

FilterOfInt32 Numeric filtering

.equal .in .greaterThan .lessThan

CorporateActionID.equal=12345 InvestmentID.in=100,200,300

StringFilter Text pattern matching

.equal .contains .beginsWith .endsWith

ExternalCorporateActionId.beginsWith=DIST-2024 ExternalInvestmentId.contains=EQUITY

FilterOfDateOnly Date ranges

.equal .greaterThan .lessThan .greaterThanOrEqual

RecordDate.greaterThanOrEqual=2024-01-01 RecordDate.lessThan=2024-12-31

🎯 Key Distribution Scenarios: Period Reporting → RecordDate.greaterThanOrEqual=2024-01-01&RecordDate.lessThan=2024-04-01 Investment Filter → InvestmentID.equal=456 Specific Lookup → CorporateActionID.equal=12345

📖 Complete Query & Filtering Guide

Example Requests

bash

# Query distributions for a product (required scope)
curl -X GET 'https://api.7g.com.au/Distribution?ProductID=100&PageSize=50' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Filter by specific corporate action ID
curl -X GET 'https://api.7g.com.au/Distribution?ProductID=100&CorporateActionID.equal=12345' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Filter by record date range (Q1 2024)
curl -X GET 'https://api.7g.com.au/Distribution?ProductID=100&RecordDate.greaterThanOrEqual=2024-01-01&RecordDate.lessThan=2024-04-01' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Filter by investment with external ID pattern
curl -X GET 'https://api.7g.com.au/Distribution?ProductID=100&ExternalInvestmentId.beginsWith=EQUITY-' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

Response Examples

json

{
  "result": true,
  "message": "Distributions retrieved successfully",
  "recordCount": 2,
  "data": [
    {
      "corporateActionID": 12345,
      "externalCorporateActionId": "DIST-2024-Q1",
      "productID": 100,
      "externalProductId": "PROD-100",
      "investmentID": 456,
      "distributionStatusID": 2,
      "externalInvestmentId": "INV-456",
      "name": "Q1 2024 Distribution",
      "description": "Quarterly income distribution for March 2024",
      "accrualDate": "2024-03-31",
      "recordDate": "2024-04-01",
      "paymentDate": "2024-04-15",
      "distributionAmountPerUnit": 0.125,
      "distributionAmountTotal": 125000.00,
      "centsPerUnitPerDay": 0.00138889,
      "distributionTermID": 1,
      "distributionPeriodID": 3,
      "drpIndicatorID": 1,
      "drpPrice": 2.45,
      "drpInvestmentID": 456,
      "drpExternalInvestmentId": "INV-456",
      "drpAllotmentDate": "2024-04-20",
      "fileName": "Q1-2024-Distribution.pdf",
      "proRataPercentPerAnnum": 5.0,
      "proRataStartDate": "2024-01-01",
      "proRataEndDate": "2024-03-31",
      "unitValuationMethod": "ClosingPrice",
      "taxComponents": [
        {
          "taxComponentName": "AustralianFrankedDividends",
          "percentage": 65.0
        },
        {
          "taxComponentName": "AustralianUnfrankedDividends",
          "percentage": 25.0
        },
        {
          "taxComponentName": "CapitalGains",
          "percentage": 10.0
        }
      ]
    },
    {
      "corporateActionID": 12346,
      "externalCorporateActionId": "DIST-2024-Q2",
      "productID": 100,
      "externalProductId": "PROD-100",
      "investmentID": 456,
      "distributionStatusID": 1,
      "externalInvestmentId": "INV-456",
      "name": "Q2 2024 Distribution",
      "description": "Quarterly income distribution for June 2024",
      "accrualDate": "2024-06-30",
      "recordDate": "2024-07-01",
      "paymentDate": "2024-07-15",
      "distributionAmountPerUnit": 0.130,
      "distributionAmountTotal": 130000.00,
      "centsPerUnitPerDay": 0.00144444,
      "distributionTermID": 1,
      "distributionPeriodID": 3,
      "drpIndicatorID": 1,
      "drpPrice": null,
      "drpInvestmentID": 456,
      "drpExternalInvestmentId": "INV-456",
      "drpAllotmentDate": null,
      "fileName": null,
      "proRataPercentPerAnnum": 5.2,
      "proRataStartDate": "2024-04-01",
      "proRataEndDate": "2024-06-30",
      "unitValuationMethod": "ClosingPrice",
      "taxComponents": [
        {
          "taxComponentName": "AustralianFrankedDividends",
          "percentage": 70.0
        },
        {
          "taxComponentName": "AustralianUnfrankedDividends",
          "percentage": 30.0
        }
      ]
    }
  ]
}

Usage Notes

When

Requirements

Notes

Description

Distribution Query Workflow

Required Headers - See Authentication

Query Parameters

Query & Filtering

🔍 7G Query & Filtering with Dot Operators

Example Requests

Response Examples

Related Endpoints

Connection Lost