AuctionAccount
The AuctionAccount table is used to assign Accounts to Auctions, i.e., to allow one or more Accounts to participate in an Auction. The table stores the specific Auction-related parameters for each Account on the Auction along with data about each Account's participation.
- Section: CartaX
Metadata
- Base Table Class: Static
- Default Size: Auction * Account = 50000
Fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| Id | Integer (signed) | 8 | The unique identifier of this AuctionAccount. |
| Status | Set of Status | 4 | |
| Auction | Foreign key to Auction | 8 | A foreign key to the Auction table for the Auction to which the Account is given access. |
| Account | Foreign key to Account | 8 | A foreign key to the Account table. |
| AccountName | String | 254 | The name of the Account. |
| IsTopLevel | Integer (unsigned) | 1 | This will be true if the Account is the top-level Account in a hierarchical group. For a single Brokerage Account that is not part of a hierarcy, this will always be true. Otherwise, it will be true for the Firm-level Account in the hierarchy. |
| ParticipantId | Integer (unsigned) | 8 | CCMX Participant Id for pass through to other services. This field should inherit down through the account hierarchy so that all AuctionAccounts with the same top level parent Account have the same ParticipantId. |
| AccountRelationship | One of CcmxAccountRelationship | 1 | CCMX-defined relationship for this AuctionAccount. |
| WorkingStatus | Set of Status | 4 | The Status for an AuctionAccount taking into account the status of AuctionAccounts higher in the hierarchy of accounts (if applicable). |
| ConsentRequired | Integer (unsigned) | 1 | Set true when the AuctionAccount is pending spousal consent. Orders for an AuctionAccount in this state will be pending and withdrawn at the end of the session if consent is not given (this field -> false). |
| SignatureRequired | Integer (unsigned) | 1 | Set true when the AuctionAccount is pending a signature. Orders for an AuctionAccount in this state will be pending and withdrawn at the end of the session if signature is not provided (this field -> false). |
| ParticipatePreMarket | Integer (unsigned) | 1 | If true, the Account may participate in the pre-market Session for a Carta Cross. |
| NoParticipateInitialEntry | Integer (unsigned) | 1 | If true, the Account may NOT participate in the initial entry Session for a Carta Cross. |
| Instrument | Foreign key to Instrument | 8 | The Instrument for the Auction, allows distribution of the code and name for the Instrument which is required by other services. |
| TopLevelParent | Foreign key to Account | 8 | The top-level (Firm-level) Account for this Account. |
| TopLevelParentAuctionAccount | Foreign key to AuctionAccount | 8 | The top-level (Firm-level) AuctionAccount for this AuctionAccount. |
| PriceDecimals | Integer (unsigned) | 1 | The PriceDecimals for the Auction, this value will be populated automatically from the Auction. |
| QuantityDecimals | Integer (unsigned) | 1 | The QuantityDecimals for the Auction, this value will be populated automatically from the Auction. |
| ValueDecimals | Integer (unsigned) | 1 | The ValueDecimals for the cash for the Auction, this value will be populated auotmatically from the Auction. |
| UnoptimisedPlannedBuy | Integer (signed) | 8 | The PlannedBuy amount for cash. |
| UnoptimisedPlannedSell | Integer (signed) | 8 | The raw PlannedSell amount for cash. |
| ElectedValue | Integer (signed) | 8 | Calculated value to be traded prior to Auction close. |
| ElectedFees | Integer (signed) | 8 | Calculated value of fees prior to Auction close. |
| UnoptimisedPendingBuyTradeCosts | Integer (signed) | 8 | The PendingTradeCosts amount. |
| UnoptimisedPendingSellTradeCosts | Integer (signed) | 8 | The PendingTradeCosts amount. |
| OptimisedPlannedSellCash | Integer (signed) | 8 | For a single price auction, we can optimise the amount of cash that needs to be reserved for buy orders and use this instead of planned sell. |
| OptimisedReservedCashRequired | Integer (signed) | 8 | For a single price auction, we can optimise the amount of cash that needs to be reserved for buy orders and use this instead of planned sell. This amount includes the MaxResidual value. |
| OptimisedReservedCash | Integer (signed) | 8 | Reserved cash required less unfunded bids. |
| MaxResidual | Integer (signed) | 8 | This is the maximum amount (highest bid + fees) which may be residually allocated to this AuctionAccount. |
| ResidualPrice | Integer (signed) | 8 | |
| EligibleQuantity | Integer (signed) | 8 | This is the maximum quantity that the Account can sell, regardless of the AvailableBalance deposited in Holdings. |
| Side | One of OrderSide | 1 | Order types allowed for the Account in the Auction, support values are ORDER_SIDE_BUY, ORDER_SIDE_SELL, ORDER_SIDE_BOTH. |
| AllocationFromParentBuy | Integer (signed) | 8 | The percentage of the Account's parent buy orders to be allocated to this Account. |
| AllocationFromParentSell | Integer (signed) | 8 | The percentage of the Account's parent buy orders to be allocated to this Account. |
| AccountSortOrder | Integer (unsigned) | 4 | This field is used to manage the sorting of accounts when generating trade pairs to provide a simple means to prevent specific account parings. Buy accounts are sorted on this field ascending and sell account desceding in an attempt to keep prohibited pairs apart. This will be replaced with a more sophisticated trade prevention strategy in future. |
| AccountPriorityBuy | Integer (unsigned) | 4 | Priority value for the Account's buy orders in the Auction for tie-break purposes. |
| AccountHoldingRatioBuy | Integer (unsigned) | 4 | Holding ratio for the Account's buy orders in the Auction for tie-break purposes. |
| MinimumQuantityBuy | Integer (signed) | 8 | Account's minimum fill quantity for buy orders in the Auction. |
| OriginalMinimumQuantityBuy | Integer (signed) | 8 | Copy of Account's minimum fill quantity for buy orders in the Auction, used to restore if required when changed by an issuer during a tender offer. |
| AccountPrioritySell | Integer (unsigned) | 4 | Priority value for the Account's sell orders in the Auction for tie-break purposes. |
| AccountHoldingRatioSell | Integer (unsigned) | 4 | Holding ratio for the Account's sell orders in the Auction for tie-break purposes. |
| MinimumQuantitySell | Integer (signed) | 8 | Account's minimum fill quantity for sell orders in the Auction. |
| OriginalMinimumQuantitySell | Integer (signed) | 8 | Copy of Account's minimum fill quantity for buy orders in the Auction, used to restore if required when changed by an issuer during a tender offer. |
| QuantityRequestedBuy | Integer (signed) | 8 | Total quantity of Account's buy orders in the Auction. |
| QuantityRemainingBuy | Integer (signed) | 8 | |
| QuantityAllocatedBuy | Integer (signed) | 8 | Total quantity allocated from the Account's buy orders in the Auction. |
| QuantityRequestedSell | Integer (signed) | 8 | Total quantity of Account's sell orders in the Auction. |
| QuantityRemainingSell | Integer (signed) | 8 | |
| QuantityRemainingSellPrioritised | Integer (signed) | 8 | For a Tender Offer, the prioritised sell quantity for the Account |
| QuantityAllocatedSell | Integer (signed) | 8 | Total quantity allocated from the Account's sell orders in the Auction. |
| FinalQuantityAllocated | Integer (signed) | 8 | |
| FinalQuantityAllocatedPrevious | Integer (signed) | 8 | |
| FullyAllocated | Integer (unsigned) | 1 | When allocating orders per allocation ratios across accounts, indicates that the parent account is fully allocated. |
| OrdersCancelled | Integer (unsigned) | 4 | Count of the number of orders automatically cancelled during a change of phase of an Auction for the Auction Account. |
| TotalQuantity | Integer (signed) | 8 | Final total quantity traded for the AuctionAccount. |
| TotalValue | Integer (signed) | 8 | Final total value traded for the AuctionAccount. |
| TotalFees | Integer (signed) | 8 | Final total fees for the AuctionAccount. |
| TotalTaxWithholdings | Integer (signed) | 8 | Final total tax withholdings for the AuctionAccount. |
| TotalExerciseCost | Integer (signed) | 8 | Final total exercise costs for the AuctionAccount. |
| IsFunding | Integer (unsigned) | 1 | Set to true when the AuctionAccount (for a buyer) moves to a funding state. |
| FundingEnabledStartTime | Integer (unsigned) | 8 | The time at which the AuctionAccount was moved to a funding state. |
| UnfundedBids | Integer (signed) | 8 | Total value of unfunded bids for the AuctionAccount. |
| NettingFundsReceivable | Integer (signed) | 8 | For a CCMX issuer, this is seller amounts that will be transferred to the issuer's account and can be used to offset the issuer's buy trade costs. |
| NettingFundsReceived | Integer (signed) | 8 | For a CCMX issuer, this is the actual amount of funds received for netting in the Auction. |
| PendingNettingFundsReceivable | Integer (signed) | 8 | For a CCMX issuer, this is the amount of funds to be received for netting in the Auction, before the Auction is closed. |
| NettingFundsUsed | Integer (signed) | 8 | For a CCMX issuer, this is the amount of funds received for netting actually used to net the buyer's obligations. It may be less than or equal to the NettingFundsReceived. |
| ExcessFundsReceivedForNetting | Integer (signed) | 8 | For a CCMX issuer, this is the total funds received for netting in excess of the NettingFundsUsed. |
| ExternalTaxCostsReceivedForNetting | Integer (signed) | 8 | For a CCMX issuer, this is the portion of the total funds received for netting attributable to tax costs. |
| ExternalExerciseCostsReceivedForNetting | Integer (signed) | 8 | For a CCMX issuer, this is the portion of the total funds received for netting attributable to exercise costs. |
| PayrollProceedsReceivedForNetting | Integer (signed) | 8 | For a CCMX issuer, this is the portion of the total funds received for netting attributable to sale proceeds. |
| FundingChanged | Integer (unsigned) | 1 | Set to true when the funding state for a top-level AuctionAccount is changed, forcing recalculation of funding requirements for all AuctionAccounts in its hierarchy. |
| MayNotBecomeUnfunded | Integer (unsigned) | 1 | During each ascending round for a CartaX this will be set if an Account's holding allocation is changed across its AuctionAccounts to prevent any amendment that has insufficient funds during that round. |
| AllocationFromParentBuyAtPhaseStart | Integer (signed) | 8 | Used during each ascending round for a CartaX to track whether the AuctionAccount's buy allocation has been changed during the round. |
| FeeBasis | One of FeeBasis | 1 | Sets the FeeBasis for the AuctionAccount. This will override the default FeeBasis for the Auction and the AuctionAccountRelationship. |
| FeeBuy | Integer (signed) | 8 | Sets the buy Fee amount for the AuctionAccount. This will override the default amount for the Auction and the AuctionAccountRelationship. |
| FeeSell | Integer (signed) | 8 | Sets the sell Fee amount for the AuctionAccount. This will override the default amount for the Auction and the AuctionAccountRelationship. |
| FeeMaker | Integer (signed) | 8 | Not currently used as Maker-Taker fees are not used for CCMX. |
| FeeTaker | Integer (signed) | 8 | Not currently used as Maker-Taker fees are not used for CCMX. |
| FeeType | One of FeeType | 1 | Sets the FeeType for the AuctionAccount. This will override the default FeeType for the Auction and the AuctionAccountRelationship. |
| IgnoreRelationshipPriority | Integer (unsigned) | 1 | If a priority has been set for this AuctionAccount's relationship, this field if true will cause that priority setting to be ignored. |
| ForcePayrollProceeds | Integer (unsigned) | 1 | For the proceeds for this AuctionAccount (if a seller) to be transferred to the Issuer for later payment through payroll. |
| UseRelationshipPayrollProceeds | Integer (unsigned) | 1 | If true, use the payroll proceeds setting from the AuctionAccount's relationship record. |
| UpdateNumber | Integer (unsigned) | 8 | A number that records every change that happens to a record. It is primarily used to avoid write after read problems when an intermediate write has changed the originally read record. |
| OwnerUser | Foreign key to User | 8 | The Id of the User that owns this AuctionAccount. |
| OwnerGroup | Foreign key to Group | 8 | The Id of the Group that owns this AuctionAccount. |
| OwnerFirm | Foreign key to Firm | 8 | The Id of the Firm that owns this AuctionAccount. |
| CreateUser | Foreign key to User | 8 | The Id of the User that created this AuctionAccount. |
| CreateTimestamp | Integer (unsigned) | 8 | The time at which this AuctionAccount was created. |
| UpdateUser | Foreign key to User | 8 | The Id of the User that last updated this AuctionAccount. |
| UpdateTimestamp | Integer (unsigned) | 8 | The time at which this AuctionAccount was last updated. |
Foreign Keys
The following diagram shows the tables that have a foreign key link to the AuctionAccount table. All Table nodes can be clicked to take you to that table's definition page.
graph LR; AuctionAccount_children-->|Child|AuctionAccount click AuctionAccount_children "/marketgrid/developer/model/tables/AuctionAccount_children" AuctionAccountDetail-->|AuctionAccount|AuctionAccount click AuctionAccountDetail "/marketgrid/developer/model/tables/AuctionAccountDetail" AuctionAccountAllocation-->|AuctionAccount|AuctionAccount click AuctionAccountAllocation "/marketgrid/developer/model/tables/AuctionAccountAllocation" Order-->|AuctionAccount|AuctionAccount click Order "/marketgrid/developer/model/tables/Order" Trade-->|AuctionAccount|AuctionAccount click Trade "/marketgrid/developer/model/tables/Trade" Trade_children-->|AuctionAccount|AuctionAccount click Trade_children "/marketgrid/developer/model/tables/Trade_children"