GET

/Distribution

Usage Notes

When

Retrieve distribution by corporateActionID or externalCorporateActionId
Verify distribution details before workflow progression
Access distribution data for reporting and reconciliation

Requirements

CorporateActionID or ExternalCorporateActionId to identify the record

Notes

Returns complete distribution structure with tax components
CorporateActionID links consistently across all workflow stages
Account-level details available via GET /Distribution/Account

Description

Retrieves a distribution record with all configuration, tax components, and workflow status. Use GET /Distribution/Account for per-account details after declaration.

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,
    "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
      }
    ],
    "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
      }
    ]
  }
}