POST
/BizTransaction/SetQuantity
When to Use
- System Migrations: Establish opening balances during platform transitions or data conversions
- Position Establishment: Set absolute unit quantities for new investment allocations or restructures
- Reconciliation Corrections: Align system quantities with external registry or custodian records
- Corporate Actions: Set new quantities following mergers, demergers, or capital restructures
- Bulk Updates: Process large-scale quantity corrections as part of operational maintenance
- Account Closures: Set positions to zero as part of final account closure procedures
Prerequisites
- Target account must be active and accessible
- Investment must be active and allow quantity operations
- User must have administrative rights for quantity setting
Considerations
- Absolute Operation: Sets exact quantity rather than relative adjustment - current holdings are replaced completely
- Enhanced Permissions: Requires higher authorization levels due to potential significant balance impact
- Business Validation: System validates against minimum holding requirements and investment rules
- Audit Compliance: Creates permanent audit trail with timestamp and user identification for regulatory compliance
- Tax Implications: Quantity changes may affect cost base calculations for capital gains tax purposes
- Reversal Process: Incorrect quantities require new transactions - original records remain immutable for audit integrity
Description
Sets the absolute quantity of investment units in an account, replacing any existing holdings with the specified amount. This endpoint creates a permanent audit record and is typically used for system migrations, bulk corrections, or establishing opening positions.
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 |
|---|---|---|---|
quantity |
number (double) | Absolute target quantity value replacing current holdings completely (ignores current balance, use 0 for account closures). | |
comment |
string | Optional |
Audit trail documentation explaining absolute quantity setting reason, authorization source, and business context (appears on account statements). |
accountID |
integer (int32) | Native account identifier specifying which account's holdings will be replaced with absolute quantity value. | |
externalAccountId |
string | External account identifier for cross-platform integration (resolves to internal accountID for holdings replacement). | |
externalBizTransactionId |
string | Optional |
External transaction identifier preventing duplicate absolute quantity setting during migration failures and linking to originating system records. |
investmentID |
integer (int32) | Native investment identifier specifying which investment class holdings will be set to absolute quantity value within target account. | |
externalInvestmentId |
string | External investment identifier for cross-platform integration using security codes, ISIN, or APIR codes. | |
productID |
integer (int32) | Native product identifier validating investment and account belong to correct fund structure. | |
externalProductId |
string | External product identifier for cross-system product correlation (resolves to internal productID for validation). | |
transactionDate |
string (date) | Transaction effective date determining financial period allocation and cost base date for absolute quantity setting (format: YYYY-MM-DD, must not be DateOnly.MinValue). |
quantity
Absolute target quantity value replacing current holdings completely (ignores current balance, use 0 for account closures).
comment
Audit trail documentation explaining absolute quantity setting reason, authorization source, and business context (appears on account statements).
accountID
Native account identifier specifying which account's holdings will be replaced with absolute quantity value.
externalAccountId
External account identifier for cross-platform integration (resolves to internal accountID for holdings replacement).
externalBizTransactionId
External transaction identifier preventing duplicate absolute quantity setting during migration failures and linking to originating system records.
investmentID
Native investment identifier specifying which investment class holdings will be set to absolute quantity value within target account.
externalInvestmentId
External investment identifier for cross-platform integration using security codes, ISIN, or APIR codes.
productID
Native product identifier validating investment and account belong to correct fund structure.
externalProductId
External product identifier for cross-system product correlation (resolves to internal productID for validation).
transactionDate
Transaction effective date determining financial period allocation and cost base date for absolute quantity setting (format: YYYY-MM-DD, must not be DateOnly.MinValue).
Example Requests
json
{
"quantity": 50000.00,
"comment": "Opening balance - system migration",
"accountID": 12345,
"externalAccountId": "",
"externalBizTransactionId": "SET-2024-001",
"investmentID": 25,
"externalInvestmentId": "",
"productID": 10,
"externalProductId": "",
"transactionDate": "2025-08-14"
}Response Examples
json
{
"result": true,
"message": "Quantity set successfully",
"recordCount": 1,
"data": {
"bizTransactionID": 5001,
"externalBizTransactionId": "SET-2024-001",
"bizTransactionTypeID": 7,
"typeName": "Set Quantity",
"movementReasonCode": "ABSOLUTE_SET",
"parentBizTransactionID": null,
"transactionDate": "2025-08-14T00:00:00Z",
"productID": 10,
"externalProductId": "FUND-001",
"accountID": 12345,
"externalAccountId": "ACC-12345",
"accountNumber": "ACC001234",
"bizEntityName": "Smith Family Trust",
"investmentID": 25,
"externalInvestmentId": "INV-GROWTH",
"securityCode": "GRW001",
"investmentName": "Growth Investment Class A",
"investmentPrice": 1.2500,
"comment": "Opening balance - system migration",
"corporateActionID": null,
"externalCorporateActionId": null,
"corporateActionName": null,
"amount": null,
"quantity": 50000.00,
"transactionClosingAmount": null,
"transactionClosingQuantity": null,
"accountClosingAmount": null,
"accountClosingQuantity": null,
"createdDate": "2025-08-14T10:30:15Z",
"updatedDate": null,
"bizTransactionStatusID": 1,
"statusName": "Complete"
}
}