POST

/BizTransaction/AdjustQuantity

When to Use

  • Correct account holdings discrepancies identified through reconciliation
  • Adjust balances by positive or negative amounts (increase or decrease)
  • Record manual corrections for administrative errors
  • Process unit adjustments following registry corrections

Prerequisites

  • Valid authentication token (see Required Headers)
  • Account record must exist in the system
  • Investment record must exist and be active
  • Transaction date must be provided (cannot be empty or default value)

Considerations

  • Positive adjustment values increase account holdings; negative adjustment values decrease holdings
  • Transaction records are permanent - corrections require new offsetting transactions
  • AdjustmentReason field provides context for the adjustment (optional, for record-keeping)
  • PricePerUnit is recorded for transaction value calculation and reporting
  • ExternalBizTransactionId enables matching with external system records (dual-ID system)

Description

Creates an AdjustQuantity transaction that modifies account holdings by a specified adjustment amount. Use positive values to increase holdings or negative values to decrease holdings. Common use cases include correcting administrative errors or processing registry corrections.

The API validates that a transaction date is provided and returns the complete transaction record including system-generated identifiers (BizTransactionID) and external reference fields. The optional AdjustmentReason field allows documenting the purpose of the adjustment for record-keeping.

Required Headers - See Authentication

HeaderValueDescription
Content-Typeapplication/jsonRequest content type
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier

Request Body

Parameter Type Required Description
adjustmentType >
string
Adjustment method: 'I' for Increase (adds to current holdings), 'D' for Decrease (subtracts from current holdings), 'A' for Absolute (sets exact value).
quantity >
number (double)
Quantity value for the adjustment. For 'I' and 'D' types, this is the amount to add or subtract from current holdings. For 'A' type, this is the absolute value to set holdings to.
amount
number (double)
Optional
Optional monetary amount for financial reporting. Not used for pricing - quantity parameter is authoritative.
comment
string
Optional
Optional field to document the reason for the adjustment. Useful for internal record-keeping and appears on account statements.
transactionDate >
string (date)
Date of the adjustment transaction. Format: YYYY-MM-DD. Cannot be empty or default value.
accountID >
integer (int32)
Account identifier for the adjustment transaction. Account must exist in the system.
externalAccountId >
string
External account identifier for dual-ID integration. Used to match with records in external systems.
externalBizTransactionId
string
Optional
External system reference for dual-ID integration. Optional field to match transactions with records in external systems.
investmentID >
integer (int32)
Investment identifier for the adjustment transaction. Investment must exist and be active.
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).
adjustmentType
string
Adjustment method: 'I' for Increase (adds to current holdings), 'D' for Decrease (subtracts from current holdings), 'A' for Absolute (sets exact value).
quantity
number (double)
Quantity value for the adjustment. For 'I' and 'D' types, this is the amount to add or subtract from current holdings. For 'A' type, this is the absolute value to set holdings to.
amount
number (double)
Optional
Optional monetary amount for financial reporting. Not used for pricing - quantity parameter is authoritative.
comment
string
Optional
Optional field to document the reason for the adjustment. Useful for internal record-keeping and appears on account statements.
transactionDate
string (date)
Date of the adjustment transaction. Format: YYYY-MM-DD. Cannot be empty or default value.
accountID
integer (int32)
Account identifier for the adjustment transaction. Account must exist in the system.
externalAccountId
string
External account identifier for dual-ID integration. Used to match with records in external systems.
externalBizTransactionId
string
Optional
External system reference for dual-ID integration. Optional field to match transactions with records in external systems.
investmentID
integer (int32)
Investment identifier for the adjustment transaction. Investment must exist and be active.
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).

Example Requests

json
{
  "adjustmentType": "I",
  "quantity": 1000.00,
  "amount": 1250.00,
  "comment": "Reconciliation adjustment - stock split 1:1.25",
  "transactionDate": "2025-08-14",
  "accountID": 12345,
  "externalAccountId": "",
  "externalBizTransactionId": "ADJ-2024-001",
  "investmentID": 25,
  "externalInvestmentId": "",
  "productID": 10,
  "externalProductId": ""
}

Response Examples

json
{
  "result": true,
  "message": "Quantity adjustment processed successfully",
  "recordCount": 1,
  "data": {
    "bizTransactionID": 1001,
    "externalBizTransactionId": "ADJ-2024-001",
    "bizTransactionTypeID": 5,
    "typeName": "Quantity Adjustment",
    "movementReasonCode": "RECONCILIATION",
    "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": "Reconciliation adjustment - stock split 1:1.25",
    "corporateActionID": null,
    "externalCorporateActionId": null,
    "corporateActionName": null,
    "amount": 1250.00,
    "quantity": 1000.00,
    "transactionClosingAmount": null,
    "transactionClosingQuantity": null,
    "accountClosingAmount": null,
    "accountClosingQuantity": null,
    "createdDate": "2025-08-14T10:30:15Z",
    "updatedDate": null,
    "bizTransactionStatusID": 1,
    "statusName": "Complete"
  }
}