GET

/Distribution

When to Use

Retrieve distribution at any workflow stage (Created/Declared/Distributed/Allotted) to check status and details
Retrieve a specific distribution record by ID or external reference
View complete distribution details including payment dates, amounts, and tax components
Access DRP settings and allotment information for processing workflows
Review distribution parameters before declaration or execution

Common Scenarios

Distribution Lookup: Use CorporateActionID=12345 or ExternalCorporateActionId="DIST-2024-001" for direct retrieval
Product Distribution Analysis: Combine ProductID filtering with distribution status checks
DRP Configuration Review: Examine DRP settings and allotment patterns for processing optimization
Payment Date Tracking: Use date-based filtering for distribution schedules and timing analysis
Tax Component Analysis: Review tax components and withholding patterns for compliance

Prerequisites

Valid Bearer token with distribution read permissions
Knowledge of corporateActionID or externalCorporateActionId for the distribution
Product and investment context for distribution interpretation

Considerations

Returns single distribution record - use /Distribution/Account for filtering multiple records
Either CorporateActionID or ExternalCorporateActionId must be provided
Distribution records contain comprehensive tax component breakdowns that must total 100%
DRP pricing and allotment dates are critical for reinvestment processing
Includes nested accounts array showing distribution account allocations after declaration
Data completeness varies based on distribution processing stage (created/declared/distributed/allotted)

Description

Retrieves a single distribution record with complete details including distribution amounts per unit, total amounts, tax components, DRP settings, and associated distribution account information. This endpoint returns the full DistributionDTO structure exactly as stored in the system, including all 26 properties plus nested tax components and account arrays.

Distribution Workflow Status

The completeness of the returned data depends on the distribution's workflow stage:

Created (Step 1): All distribution parameters set, accounts array empty
Declared (Step 2): Eligible investors locked in, accounts array populated with allocations
Distributed (Step 3): Payments processed to investors
Allotted (Step 4): DRP units allocated, reinvestment complete (optional)

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
`CorporateActionID` >	integer	> Conditional...	Native 7G distribution identifier for direct database lookup.
`ExternalCorporateActionId` >	string	> Conditional...	Client-supplied distribution reference from your system.

CorporateActionID

integer

> Conditional...

Native 7G distribution identifier for direct database lookup.

ExternalCorporateActionId

string

> Conditional...

Client-supplied distribution reference from your system.

Example Requests

bash

# Get distribution by corporate action ID
curl -X GET "https://api.7g.com.au/Distribution?CorporateActionID=12345" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get distribution by external ID
curl -X GET "https://api.7g.com.au/Distribution?ExternalCorporateActionId=DIST-2024-Q1" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": "Distribution retrieved successfully",
  "recordCount": 1,
  "data": {
    "corporateActionID": 12345,
    "externalCorporateActionId": "DIST-2024-Q1",
    "productID": 100,
    "externalProductId": "PROD-100",
    "investmentID": 456,
    "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
      }
    ],
    "accounts": [
      {
        "corporateActionID": 12345,
        "externalCorporateActionId": "DIST-2024-Q1",
        "productID": 100,
        "externalProductId": "PROD-100",
        "accountID": 789,
        "externalAccountId": "ACC-789",
        "accountNumber": "7G-789",
        "bizEntityName": "Smith Super Fund",
        "cumBalance": 2500.00,
        "daysInPossession": 90,
        "drpTypeID": 1,
        "drpValue": 100.0,
        "fee": 5.00,
        "grossDistribution": 312.50,
        "reinvestedAmount": 312.50,
        "reinvestedPrice": 2.45,
        "reinvestedQuantity": 127.55,
        "taxationCountryCode": "AUS",
        "transferredFunds": 0.00,
        "withholdingTax": 0.00,
        "withholdingTaxRefunded": 0.00
      }
    ]
  }
}