POST

/Distribution

Usage Notes

When

  • Create new distribution with parameters and tax components
  • Define DRP settings and record/payment dates
  • Establish distribution for subsequent workflow stages

Requirements

  • ProductID or ExternalProductId required
  • Tax components must total exactly 100%
  • DistributionAmountPerUnit or rate parameters required

Notes

  • Step 1 of 4-stage workflow
  • Cannot proceed to declare until configuration complete
  • All parameters modifiable until declaration

Description

Creates a distribution record defining parameters, tax components, and DRP settings. Step 1 of the 4-stage workflow. Configuration remains modifiable until declaration.

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
CorporateActionID
 integer
Optional
System-generated distribution identifier - do not include in POST requests (auto-assigned).
externalCorporateActionId
 string
Optional
Client-supplied unique distribution reference for tracking in your system.
ProductID >
integer
Native 7G product identifier for distribution validation and portfolio association.
externalProductId
 string
Optional
Client-supplied product reference (alternative to productID).
accrualDate
 string (date)
Optional
Income accrual period end date for accounting and tax purposes.
recordDate
 string (date)
Optional
Eligibility cutoff date - investors holding units at market close qualify for distribution.
paymentDate
 string (date)
Optional
Scheduled payment execution date for cash distributions and DRP processing.
distributionAmountPerUnit
 number (double)
Optional
Payment rate per unit held - multiplied by investor holdings for total entitlement.
distributionAmountTotal
 number (double)
Optional
Aggregate distribution pool requiring board approval and cash availability.
centsPerUnitPerDay
 number (double)
Optional
Daily accrual rate for pro-rating distributions based on holding periods.
description
 string
Optional
Business rationale and context for the distribution decision.
distributionTermID
 integer
Optional
Distribution frequency classification (quarterly/annual) via common/lookup.
distributionPeriodID
 integer
Optional
Distribution period grouping identifier via common/lookup.
drpIndicatorID
 integer
Optional
DRP availability flag controlling reinvestment option for eligible investors.
drpPrice
 number (double)
Optional
Fixed DRP reinvestment price (often discounted from market rate).
InvestmentID >
integer
Native 7G investment identifier targeting specific unit class for distribution.
DistributionStatusID
 integer
Optional
Distribution workflow stage identifier - system-assigned based on processing lifecycle. Do not include in POST requests (auto-assigned). Resolvable via common/lookup.
externalInvestmentId
 string
Optional
Client-supplied investment reference (alternative to investmentID).
fileName
 string
Optional
Distribution statement filename for document generation.
drpInvestmentID
 integer
Optional
Target investment for DRP unit allocations (typically same as distribution source).
drpExternalInvestmentId
 string
Optional
Client reference for DRP target investment (alternative to drpInvestmentID).
drpAllotmentDate
 string (date)
Optional
DRP unit allocation date (typically after payment date for settlement).
name
 string
Optional
Human-readable distribution title for reports and investor communications.
proRataPercentPerAnnum
 number (double)
Optional
Annualized rate for pro-rata adjustments (100% for full period distributions).
proRataStartDate
 string (date)
Optional
Pro-rata calculation start date for mid-period investor entries.
proRataEndDate
 string (date)
Optional
Pro-rata calculation end date for mid-period investor exits.
unitValuationMethod
 string
Optional
Unit pricing method for distribution calculations (ClosingPrice/VWAP/Fixed).
taxComponents
> List<TaxComponentDTO>...
Optional
Tax component allocation array - must sum to 100% for ATO compliance.
CorporateActionID
integer
Optional
System-generated distribution identifier - do not include in POST requests (auto-assigned).
externalCorporateActionId
string
Optional
Client-supplied unique distribution reference for tracking in your system.
ProductID
integer
Native 7G product identifier for distribution validation and portfolio association.
externalProductId
string
Optional
Client-supplied product reference (alternative to productID).
accrualDate
string (date)
Optional
Income accrual period end date for accounting and tax purposes.
recordDate
string (date)
Optional
Eligibility cutoff date - investors holding units at market close qualify for distribution.
paymentDate
string (date)
Optional
Scheduled payment execution date for cash distributions and DRP processing.
distributionAmountPerUnit
number (double)
Optional
Payment rate per unit held - multiplied by investor holdings for total entitlement.
distributionAmountTotal
number (double)
Optional
Aggregate distribution pool requiring board approval and cash availability.
centsPerUnitPerDay
number (double)
Optional
Daily accrual rate for pro-rating distributions based on holding periods.
description
string
Optional
Business rationale and context for the distribution decision.
distributionTermID
integer
Optional
Distribution frequency classification (quarterly/annual) via common/lookup.
distributionPeriodID
integer
Optional
Distribution period grouping identifier via common/lookup.
drpIndicatorID
integer
Optional
DRP availability flag controlling reinvestment option for eligible investors.
drpPrice
number (double)
Optional
Fixed DRP reinvestment price (often discounted from market rate).
InvestmentID
integer
Native 7G investment identifier targeting specific unit class for distribution.
DistributionStatusID
integer
Optional
Distribution workflow stage identifier - system-assigned based on processing lifecycle. Do not include in POST requests (auto-assigned). Resolvable via common/lookup.
externalInvestmentId
string
Optional
Client-supplied investment reference (alternative to investmentID).
fileName
string
Optional
Distribution statement filename for document generation.
drpInvestmentID
integer
Optional
Target investment for DRP unit allocations (typically same as distribution source).
drpExternalInvestmentId
string
Optional
Client reference for DRP target investment (alternative to drpInvestmentID).
drpAllotmentDate
string (date)
Optional
DRP unit allocation date (typically after payment date for settlement).
name
string
Optional
Human-readable distribution title for reports and investor communications.
proRataPercentPerAnnum
number (double)
Optional
Annualized rate for pro-rata adjustments (100% for full period distributions).
proRataStartDate
string (date)
Optional
Pro-rata calculation start date for mid-period investor entries.
proRataEndDate
string (date)
Optional
Pro-rata calculation end date for mid-period investor exits.
unitValuationMethod
string
Optional
Unit pricing method for distribution calculations (ClosingPrice/VWAP/Fixed).
taxComponents
> List<TaxComponentDTO>...
Optional
Tax component allocation array - must sum to 100% for ATO compliance.

Example Requests

bash
# Create distribution with DRP and tax components
curl -X POST 'https://api.7g.com.au/Distribution' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "productID": 145,
    "externalProductId": "FUND-INCOME-001",
    "investmentID": 789,
    "externalInvestmentId": "UNIT-CLASS-A",
    "externalCorporateActionId": "DIST-2024-Q3",
    "name": "September 2024 Quarterly Distribution",
    "description": "Q3 quarterly income distribution",
    "distributionAmountPerUnit": 0.1850,
    "distributionAmountTotal": 925000.00,
    "accrualDate": "2024-09-30",
    "recordDate": "2024-10-01",
    "paymentDate": "2024-10-15",
    "drpIndicatorID": 1,
    "drpPrice": 2.75,
    "drpInvestmentID": 789,
    "drpAllotmentDate": "2024-10-22",
    "taxComponents": [
      {
        "taxComponentName": "AustralianIncomeDividendsFranked",
        "percentage": 65.0
      },
      {
        "taxComponentName": "AustralianIncomeDividendsUnfrankedPercentage",
        "percentage": 15.0
      },
      {
        "taxComponentName": "CapitalGainsCapital",
        "percentage": 20.0
      }
    ]
  }'

Response Examples

json
{
  "result": true,
  "message": "Distribution created successfully. Use /Distribution/Declare to lock in eligible investors.",
  "recordCount": 1,
  "data": {
    "corporateActionID": 15789,
    "externalCorporateActionId": "DIST-2024-Q3",
    "productID": 145,
    "externalProductId": "FUND-INCOME-001",
    "investmentID": 789,
    "distributionStatusID": 3,
    "externalInvestmentId": "UNIT-CLASS-A",
    "name": "September 2024 Quarterly Distribution",
    "description": "Q3 2024 quarterly income distribution - franked dividends and capital gains",
    "accrualDate": "2024-09-30",
    "recordDate": "2024-10-01",
    "paymentDate": "2024-10-15",
    "distributionAmountPerUnit": 0.1850,
    "distributionAmountTotal": 925000.00,
    "centsPerUnitPerDay": 0.00202740,
    "distributionTermID": 1,
    "distributionPeriodID": 3,
    "drpIndicatorID": 1,
    "drpPrice": 2.75,
    "drpInvestmentID": 789,
    "drpExternalInvestmentId": "UNIT-CLASS-A",
    "drpAllotmentDate": "2024-10-22",
    "fileName": "quarterly_distribution_sep_2024.pdf",
    "proRataPercentPerAnnum": 7.4,
    "proRataStartDate": "2024-07-01",
    "proRataEndDate": "2024-09-30",
    "unitValuationMethod": "ClosingPrice",
    "taxComponents": [
      {
        "taxComponentName": "AustralianIncomeDividendsFranked",
        "percentage": 65.0
      },
      {
        "taxComponentName": "AustralianIncomeDividendsUnfrankedPercentage",
        "percentage": 15.0
      },
      {
        "taxComponentName": "CapitalGainsCapital",
        "percentage": 20.0
      }
    ]
  }
}
POST Declare GET Get Distributions PUT Update Distribution