OrderAllocation Class Reference

View as MarkdownOpen in Claude

The OrderAllocation class to denote an advisor’s allocations while trading subaccounts.

NameTypeDescription
AccountStringReferences the Account ID, i.e. U1234567, being allocated to.
PositionDecimalReferences the current position of the account being allocated to.
PositionDesiredDecimalStates the full position increase intended by the current trade.
PosiionAfterDecimalReferences the increase to position from the current trade. Unless the order is partially filled, this should reflect the PositionDesired value.
DesiredAllocQtyDecimalReference the quantity to increase by based on allocation.
AllowedAllocQtyDecimalReferences the maximum allowed quantity increase.
IsMonetaryBooleanDenotes whether the order is a monetary allocation (true) or whole share allocation (false).