POST
/Distribution/Allotment
When to Use
- Complete Step 4 (final optional stage) of distribution workflow after payment execution
- Execute Distribution Reinvestment Plan (DRP) unit allotments
- Process precise unit calculations including fractional units
- Handle tax-deferred unit creation for return of capital components
- Execute AMIT attribution unit allotments with tax flow-through
- Complete distribution workflow by updating unit registry holdings
Prerequisites
- Distribution must be declared and distributed with payments completed
- DRP settings configured with pricing and fractional unit rules
- Current DRP elections recorded for eligible investors
Important Considerations
⚠️ Critical Implementation Notes
- Allotment Irreversibility: Unit allotments are permanent and cannot be reversed - validate all calculations and pricing before execution
- CGT Event Creation: Unit allotments may create CGT events affecting investor tax positions and require accurate cost base establishment
- Fractional Unit Handling: Fractional units below minimum thresholds may be paid as cash requiring additional payment processing workflows
- AMIT Attribution Integrity: Attribution percentages must be correctly maintained across new unit holdings to preserve tax flow-through benefits
- Registry Timing Dependencies: Unit registry updates must be completed before market open to ensure accurate NAV calculations and trading operations
- Regulatory Capital Limits: New unit creation must comply with investment limits, concentration requirements, and regulatory capital constraints
Description
Executes the DRP unit allotment process for a declared and distributed distribution. This endpoint calculates and allocates new investment units to eligible investors based on their distribution amounts and DRP election preferences. The allotment completes the distribution workflow by converting cash distributions into additional investment units.
Distribution Workflow - Step 4 of 4
- Create: Define distribution parameters, tax components, and DRP settings
- Declare: Lock eligible investors, calculate amounts, select accounts (preCalculatedAccounts/includeAccounts/excludeAccounts)
- Distribute: Process payments to investors
- Allotment: Execute DRP unit allocation (this endpoint - optional, only if applicable)
⚠️ Critical: Allotment Prerequisites
Distribution must be both declared AND distributed before allotment can be executed. The system validates distribution status and DRP configurations before processing.
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 |
---|---|---|---|
ProductID |
integer | Native 7G product identifier for DRP allotment validation. | |
externalProductId |
string | Optional |
Client-supplied product reference (alternative to productID). |
CorporateActionID |
integer | Native 7G distribution identifier for DRP unit allocation. | |
externalCorporateActionId |
string | Optional |
Client-supplied distribution reference (alternative to corporateActionID). |
overrideDate |
date | Optional |
Allotment execution date override (defaults to distribution's drpAllotmentDate). |
comment |
string | Optional |
Allotment processing comment for audit trail and business records. |
ProductID
Native 7G product identifier for DRP allotment validation.
externalProductId
Client-supplied product reference (alternative to productID).
CorporateActionID
Native 7G distribution identifier for DRP unit allocation.
externalCorporateActionId
Client-supplied distribution reference (alternative to corporateActionID).
overrideDate
Allotment execution date override (defaults to distribution's drpAllotmentDate).
comment
Allotment processing comment for audit trail and business records.
Example Requests
json
{
"productID": 100,
"externalProductId": "PROD-100",
"corporateActionID": 12346,
"externalCorporateActionId": "DIST-2024-Q2",
"overrideDate": "2024-07-25",
"comment": "Q2 2024 DRP unit allotment executed with override date for business closure"
}
Response Examples
json
{
"result": true,
"message": "DRP allotment executed successfully",
"recordCount": 1,
"data": {
"allotmentId": "ALL-2024-Q2-001",
"corporateActionID": 12346,
"externalCorporateActionId": "DIST-2024-Q2",
"productID": 100,
"totalUnitsAllocated": 5102.35,
"totalInvestorsProcessed": 247,
"allotmentDate": "2024-07-25",
"drpPrice": 2.55,
"status": "Completed",
"processedAt": "2024-07-25T10:15:30Z"
}
}