POST
/Distribution/Allotment
Usage Notes
When
- Execute DRP unit allocations for reinvestment participants
- Complete step 4 of 4-stage workflow
- Process final distribution allocation
Requirements
- Distribution must be in post-distribute state
- DRP price and settings configured
Notes
- Step 4 of 4-stage workflow (optional - only if DRP participants exist)
- Creates BizTransaction/Allotment records for each DRP participant
- Completes distribution lifecycle
Description
Processes DRP unit allocations for reinvestment participants. Step 4 of the 4-stage workflow. Creates BizTransaction records for each DRP allocation.
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
bash
# Execute DRP allotment by corporate action ID
curl -X POST 'https://api.7g.com.au/Distribution/Allotment' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0' \
-H 'Content-Type: application/json' \
-d '{
"productID": 100,
"corporateActionID": 12346,
"comment": "Standard Q2 2024 DRP allotment"
}'
# Execute with external ID and override date
curl -X POST 'https://api.7g.com.au/Distribution/Allotment' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0' \
-H 'Content-Type: application/json' \
-d '{
"productID": 100,
"externalCorporateActionId": "DIST-2024-Q2",
"overrideDate": "2024-07-25",
"comment": "Allotment with custom date"
}'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"
}
}