PUT

/Distribution

When to Use

Update distribution parameters during Created stage (Step 1) before declaration and distribution
Modify payment dates, amounts, or tax component allocations
Adjust DRP settings including pricing and allotment dates
Correct distribution descriptions or external reference IDs

Prerequisites

Valid Bearer token with distribution modification permissions
Existing distribution record (corporateActionID or externalCorporateActionId)
Distribution must be in Created stage (Step 1) - not yet declared, distributed, or allotted
Board approval or authorization for any material changes

Considerations

Updates are only allowed before distribution declaration - workflow stage validation applies
Record date changes affect investor eligibility and must be carefully considered
Tax component modifications require recalculation and must total 100%
DRP pricing changes impact reinvestment calculations and unit allocations
All fields in the request body replace existing values - partial updates not supported
Distribution amount changes may require board re-approval for compliance

Description

Updates an existing distribution record with new values. This endpoint performs a complete replacement of the distribution data structure. All required fields must be provided even if only some values are changing. Use this endpoint to correct errors or make approved changes before the distribution workflow begins.

Update Requirements

PUT requests require the complete distribution object with all values. This is a full replacement operation, not a partial update. Include all fields even when only modifying specific properties.

Distribution Workflow Context

Updates only allowed during the Created stage (Step 1 of 4). Once declared, distributed, or allotted, use the admin portal for modifications.

� Important Limitations

Unlike POST requests, PUT operations require the corporateActionID to identify which distribution to update. This ID cannot be changed during the update operation.

Required Headers - See Authentication

Header	Value	Description
Content-Type	application/json	Request content type
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Request Body

Parameter	Type	Required	Description
`CorporateActionID` >	integer	> Required...	Native 7G distribution identifier (immutable after creation).
`externalCorporateActionId`	string	Optional	Client-supplied unique distribution reference (modifiable if unique).
`ProductID` >	integer	> Required...	Native 7G product identifier (immutable after creation).
`externalProductId`	string	Optional	Client-supplied product reference (alternative to productID).
`InvestmentID` >	integer	> Required...	Native 7G investment identifier (immutable after creation).
`externalInvestmentId`	string	Optional	Client-supplied investment reference (alternative to investmentID).
`name`	string	Optional	Human-readable distribution title for reports and investor communications.
`description`	string	Optional	Business rationale and context for the distribution decision.
`accrualDate`	string (date)	Optional	Income accrual period end date for accounting and tax purposes.
`recordDate`	string (date)	Optional	Eligibility cutoff date - changes affect investor entitlements and must be carefully considered.
`paymentDate`	string (date)	Optional	Scheduled payment execution date (must follow record date chronologically).
`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.
`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).
`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).
`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

> Required...

Native 7G distribution identifier (immutable after creation).

externalCorporateActionId

string

Optional

Client-supplied unique distribution reference (modifiable if unique).

ProductID

integer

> Required...

Native 7G product identifier (immutable after creation).

externalProductId

string

Optional

Client-supplied product reference (alternative to productID).

InvestmentID

integer

> Required...

Native 7G investment identifier (immutable after creation).

externalInvestmentId

string

Optional

Client-supplied investment reference (alternative to investmentID).

name

string

Optional

Human-readable distribution title for reports and investor communications.

description

string

Optional

Business rationale and context for the distribution decision.

accrualDate

string (date)

Optional

Income accrual period end date for accounting and tax purposes.

recordDate

string (date)

Optional

Eligibility cutoff date - changes affect investor entitlements and must be carefully considered.

paymentDate

string (date)

Optional

Scheduled payment execution date (must follow record date chronologically).

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.

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).

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).

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

json

{
  "corporateActionID": 12346,
  "externalCorporateActionId": "DIST-2024-Q2-UPDATED",
  "productID": 100,
  "externalProductId": "PROD-100",
  "investmentID": 456,
  "externalInvestmentId": "INV-456",
  "name": "Q2 2024 Distribution (Revised)",
  "description": "Revised quarterly income distribution for June 2024",
  "accrualDate": "2024-06-30",
  "recordDate": "2024-07-01",
  "paymentDate": "2024-07-20",
  "distributionAmountPerUnit": 0.145,
  "distributionAmountTotal": 145000.00,
  "centsPerUnitPerDay": 0.00159341,
  "distributionTermID": 1,
  "distributionPeriodID": 3,
  "drpIndicatorID": 1,
  "drpPrice": 2.60,
  "drpInvestmentID": 456,
  "drpExternalInvestmentId": "INV-456",
  "drpAllotmentDate": "2024-07-25",
  "fileName": "dist_q2_2024_revised.pdf",
  "proRataPercentPerAnnum": 5.8,
  "proRataStartDate": "2024-04-01",
  "proRataEndDate": "2024-06-30",
  "unitValuationMethod": "ClosingPrice",
  "taxComponents": [
    {
      "taxComponentName": "AustralianIncomeDividendsFranked",
      "percentage": 75.0
    },
    {
      "taxComponentName": "AustralianIncomeDividendsUnfrankedPercentage",
      "percentage": 15.0
    },
    {
      "taxComponentName": "CapitalGainsCapital",
      "percentage": 10.0
    }
  ]
}

Response Examples

json

{
  "result": true,
  "message": "Distribution updated successfully",
  "recordCount": 1,
  "data": {
    "corporateActionID": 12346,
    "externalCorporateActionId": "DIST-2024-Q2-UPDATED",
    "productID": 100,
    "externalProductId": "PROD-100",
    "investmentID": 456,
    "externalInvestmentId": "INV-456",
    "name": "Q2 2024 Distribution (Revised)",
    "description": "Revised quarterly income distribution for June 2024",
    "accrualDate": "2024-06-30",
    "recordDate": "2024-07-01",
    "paymentDate": "2024-07-20",
    "distributionAmountPerUnit": 0.145,
    "distributionAmountTotal": 145000.00,
    "centsPerUnitPerDay": 0.00159341,
    "distributionTermID": 1,
    "distributionPeriodID": 3,
    "drpIndicatorID": 1,
    "drpPrice": 2.60,
    "drpInvestmentID": 456,
    "drpExternalInvestmentId": "INV-456",
    "drpAllotmentDate": "2024-07-25",
    "fileName": "dist_q2_2024_revised.pdf",
    "proRataPercentPerAnnum": 5.8,
    "proRataStartDate": "2024-04-01",
    "proRataEndDate": "2024-06-30",
    "unitValuationMethod": "ClosingPrice",
    "taxComponents": [
      {
        "taxComponentName": "AustralianIncomeDividendsFranked",
        "percentage": 75.0
      },
      {
        "taxComponentName": "AustralianIncomeDividendsUnfrankedPercentage",
        "percentage": 15.0
      },
      {
        "taxComponentName": "CapitalGainsCapital",
        "percentage": 10.0
      }
    ]
  }
}

When to Use

Prerequisites

Considerations

Description

Update Requirements

Distribution Workflow Context

� Important Limitations

Required Headers - See Authentication

Request Body

Example Requests

Response Examples

Related Endpoints

Connection Lost

� Important Limitations