TradeID
A unique identifier for this trade
CurrencyPair
The currency pair for the trade. For example, EURUSD
DealtCurrency
The currency of the Amount of a trade or order.
SpotMidRate
The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
SpotRateDPS
The number of decimal places to display after the decimal point.
ExecutionDateTime
string
Example: 20160322123621
Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
TraderUsername
string
Example: sales_trader@novobank.co.za
The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.
TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
FullName
The full name of the user the trade is on behalf of
EntityId
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]
TradingType
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
DeliverableType
Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)
DigitsBeforePips
Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this field will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
NumberOfPips
Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.
OrderID
The id of the order.
WarningCode
The code for the warning regarding a quote request.
WarningMessage
string
Example: You do not have sufficient credit for EUR
The message to display for any warnings regarding a quote request
Client
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
CostCurrency
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
CostPercentage
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
ContraCostAmount
The actual transactional cost of performing the trade to the client on the contra currency
ContraCostCurrency
The contra currency that the cost is displayed in
ContraCostPercentage
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
CanAllocate
Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL
AllocationSettlementDateOptions
string
Example: ORIGINAL,EARLIER,LATER
Comma-separated list, defines available settlement dates for an allocation.
IsAllocated
Define if a trade is already allocated or rolled
IsReversible
Whether a trade can be reversed.
IsAmendable
Whether a trade can be amended.
IsCancellable
Whether a trade can be cancelled.
CostCurrencyDPS
The number of decimal places to display after the decimal point.
Remarks
The text content of a comment left on a leg of a trade or order.
ForceReporting
Indicates whether a trade is flagged for reporting
UTI
Unique Transaction Identifier.
BackOfficeID
Back office trade identifier.
PriceSource
string
Example: st1@caplin.com
Identifies the person or system that priced the trade.
Venue
Where the trade was placed.
Purpose
string
Example: Commercial
The purpose of a trade.
Tags
string
Example: method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}
Tags for a trade.
DisplayFields
string
Example: method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAllocationDetailsUpdateFields','name':'addDefaultSalesAllocationDetailsUpdateFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}
Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.
ClientAgreementDateTime
Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
PostTradeType
The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION
OriginalTradeID
TradeID of the trade that this trade was created from.