PUT

/Distribution

Usage Notes

When

Modify distribution parameters before declaration
Update tax components or DRP settings
Correct distribution configuration

Requirements

CorporateActionID or ExternalCorporateActionId to identify the record
Distribution must not be declared yet

Notes

PUT replaces entire distribution record - include all data to retain
Only works before declaration stage
Tax components must total exactly 100%

Description

Updates a distribution by complete replacement. Only available before declaration. Retrieve current data via GET, modify required fields, and submit the complete structure.

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	> Conditional...	Native 7G identifier for the product.
`externalProductId` >	string	> Conditional...	External system identifier for the product (alternative to productID).
`InvestmentID` >	integer	> Required...	Native 7G investment identifier (immutable after creation).
`DistributionStatusID`	integer	Optional	Distribution workflow stage identifier. Read-only field - cannot be modified in updates. Updated automatically by workflow endpoints (Declare/Distribute/Allotment). Resolvable via common/lookup.
`externalInvestmentId`	string	Optional	Client-supplied investment reference (alternative to investmentID).
`securityCode`	string	Optional	Business-facing security code for the distributing investment. Third way to identify it; resolved within the supplied productID / externalProductId scope. Returns 'No record was found for the provided InvestmentID, ExternalInvestmentId or SecurityCode in ProductID ({id}).' if unmatched.
`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).
`drpSecurityCode`	string	Optional	Business-facing security code for the DRP target investment. Third way to identify it; resolved within the supplied productID / externalProductId scope. Returns 'Can't find any record with the provided DrpInvestmentID, DrpExternalInvestmentId or DrpSecurityCode.' if unmatched.
`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

> Conditional...

Native 7G identifier for the product.

externalProductId

string

> Conditional...

External system identifier for the product (alternative to productID).

InvestmentID

integer

> Required...

Native 7G investment identifier (immutable after creation).

DistributionStatusID

integer

Optional

Distribution workflow stage identifier. Read-only field - cannot be modified in updates. Updated automatically by workflow endpoints (Declare/Distribute/Allotment). Resolvable via common/lookup.

externalInvestmentId

string

Optional

Client-supplied investment reference (alternative to investmentID).

securityCode

string

Optional

Business-facing security code for the distributing investment. Third way to identify it; resolved within the supplied productID / externalProductId scope. Returns 'No record was found for the provided InvestmentID, ExternalInvestmentId or SecurityCode in ProductID ({id}).' if unmatched.

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

drpSecurityCode

string

Optional

Business-facing security code for the DRP target investment. Third way to identify it; resolved within the supplied productID / externalProductId scope. Returns 'Can't find any record with the provided DrpInvestmentID, DrpExternalInvestmentId or DrpSecurityCode.' if unmatched.

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.

💡

Two Independent Investment Identifications

Distributions identify two investments: the distributing investment (investmentID / externalInvestmentId / securityCode) and, optionally, the DRP target investment for reinvestment (drpInvestmentID / drpExternalInvestmentId / drpSecurityCode). Each follows the three-key identifier model independently, but both resolve within the same productID / externalProductId scope.

Error messages differ between the two lookups - see IDs & External References for the exact strings.

Example Requests

bash

# Complete distribution update (all fields)
curl -X PUT 'https://api.7g.com.au/Distribution' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "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,
    "distributionStatusID": 3,
    "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
      }
    ]
  }
}

Usage Notes

When

Requirements

Notes

Description

Required Headers - See Authentication

Request Body

Two Independent Investment Identifications

Example Requests

Response Examples

Related Endpoints

Connection Lost