What is a side?

A side is a plug-and-play component of a movement, which itself is a component of a transaction type.

A side determines which holding is impacted by all the transactions belonging to that transaction type, and which transaction attributes (built-in data fields, properties or calculated fields) are used to update the quantity and/or cost of the holding.

Note the following:

LUSID provides a set of built-in sides which you can use as-is or modify. Alternatively, you can create your own custom sides.
The same side can be used in movements belonging to multiple transaction types.
A side is domiciled in a scope and can only ultimately belong to transaction types domiciled in the same scope.
A side has a set of mandatory and optional data fields. See below for allowed and default values.

`security`

Mandatory. Identifies the underlying instrument, whether security or currency. Allowed values are as follows:

Allowed values	Explanation	Example value	Default value (if missing)
`Txn:LusidInstrumentId`	Returns the `instrumentUid` field on a transaction.	`LUID_98ABCDJK`	The unknown instrument, `LUID_ZZZZZZZZ`
`Txn:TradeCurrency`	Returns the `transactionCurrency` field on a transaction.	`CCY_USD`
`Txn:SettlementCurrency` or `Txn:SettleCcy`	Returns the `totalConsideration.currency` field on a transaction, for circumstances in which the settlement currency is different to the trade currency.	`CCY_GBP`
`Txn:PortfolioCurrency`	Returns the `baseCurrency` field on a transaction portfolio.	`CCY_JPY`
A transaction property	Returns the value of a custom property added to a transaction using its 3-stage key, for example `Transaction/Demo/BuyAmountCcy`. The property must either use the built-in `String` data type or have a custom data type with a primitive `valueType` of `String`. The property value must contain a valid instrument LUID, currency LUID, or ISO 4217 currency code.	`LUID_98ABCDJK` or `CCY_GBP` or `GBP`

`currency`

Mandatory. Identifies the currency.

Allowed values	Explanation	Example value	Default value (if missing)
`Txn:TradeCurrency`	Returns the `transactionCurrency` field on a transaction.	`GBP`	The unknown currency, `CCY_ZZZ`
`Txn:SettlementCurrency` or `Txn:SettleCcy`	Returns the `totalConsideration.currency` field on a transaction, for circumstances in which the settlement currency is different to the trade currency.	`USD`
`Txn:PortfolioCurrency`	Returns the `baseCurrency` field on a transaction portfolio.	`EUR`
A transaction property	Returns the value of a custom property added to a transaction using its 3-stage key, for example `Transaction/Demo/BuyAmountCcy`. The property must either use the built-in `currency` or `iso4217Currency` data type, or have a custom data type with a primitive `valueType` of `String`. The property value must contain a valid ISO 4217 currency code or currency LUID.	`JPY` or `CCY_JPY`

`rate`

Mandatory. Fixes the exchange rate between the currency and the portfolio's base currency, if different.

Allowed values	Explanation	Example value	Default value (if missing)
`Txn:TradeToPortfolioRate`	Returns the value of the `Transaction/default/TradeToPortfolioRate` system property added to a transaction to represent the exchange rate between the transaction's trade currency and the portfolio's base currency.	`1.09`	`0`
`SettledToPortfolioRate`	This is a calculated field representing the rate from the settlement currency to the portfolio currency. It is calculated as `TradeToPortfolioRate/ExchangeRate`, where `ExchangeRate` is the rate from trade currency to settlement currency.
A transaction property	Returns the value of a custom property added to a transaction using its 3-stage key, for example `Transaction/Demo/FxRate`. The property must either use the built-in `number` or `currencyAndAmount` data type, or have a custom data type with a primitive `valueType` of `Decimal` or `Int`. The property value must contain a parsable numeric value.
A constant value	For example, `1.0` when using `Txn:PortfolioCurrency` as the currency.

`units`, `amount`

Mandatory. Determines the number of units and their value respectively. The allowed values for both fields are the same.

Allowed values	Explanation	Example value	Default value (if missing)
`Txn:Units`	Returns the `units` field on a transaction.	`2500`	`0`
`Txn:TotalConsideration`	Returns the `totalConsideration.amount` field on a transaction.
`Txn:TradeAmount`	This is a calculated field representing the total value (after fees) of a transaction in the trade currency: If the underlying instrument is a currency, the number of `units` on a transaction is returned. Otherwise the `totalConsideration.amount` less any bond interest is returned, converted at the `exchangeRate` on the transaction. When the `totalConsideration.amount` is zero (or not populated), the number of `units` multiplied by `transactionPrice.price` is returned. Note the calculated value has the same sign as the `units` field.
`Txn:TotalConsiderationInTradeCurrency`	This is the same as `Txn:TradeAmount` except it respects the sign of `totalConsideration.amount` on a transaction, in circumstances where this is different to `units`. See an example for FxForwards.
`Txn:GrossConsideration`	Returns the value of the `Transaction/default/GrossConsideration` system property added to a transaction to represent the gross amount (before fees).
`Txn:GrossTradeAmount`	This is a calculated field representing the gross amount (before fees) of a transaction in the trade currency. The value of the `Transaction/default/GrossConsideration` system property less any bond interest is returned, converted at the `exchangeRate` on the transaction.
`Txn:BondInterest`	Returns the value of the `Transaction/default/BondInterest` system property added to a transaction to represent the accrued interest in the settlement currency included in the purchase/sale of a bond.
`BaseOnSeparateBondInterest`	This is a calculated field representing total consideration minus bond interest, where the latter is the value of the `Transaction/default/BondInterest` system property.
`Txn:BondInterestPortfolio`	This is a calculated field representing bond interest converted to the portfolio's base currency, where the former is the value of the `Transaction/default/BondInterest` system property.
`Txn:NotionalAmount`	Returns the `Transaction/default/NotionalAmount` system property added to a transaction. See the `notionalAmount` field, below.
A transaction property	Returns the value of a custom property added to a transaction using its 3-stage key, for example `Transaction/Demo/Commission`. The property must either use the built-in `number` or `currencyAndAmount` data type, or have a custom data type with a primitive `valueType` of `Decimal` or `Int`. The property value must contain a parsable numeric value.
A constant value	For example, `0` when the units are not updated i.e. a cost adjustment.

`notionalAmount`

Optional. Determines the notional value. Future and ContractForDifference instruments only.

Typical behaviour is to configure this field to use Txn:NotionalAmount, which returns the value of the Transaction/default/NotionalAmount system property added to a transaction. However, it can accept any of the other allowed values for the units and amount fields, above. The default value is 0.

`currentFace`

Optional. Determines the outstanding notional of a holding. MBS only (modelled as asset-backed ComplexBond instrument).

Allowed values	Explanation	Example value	Default value (if missing)
`Txn:CurrentFace`	Returns the `Transaction/default/CurrentFace` system property added to a transaction.	`2500`	`0`
`Txn:Units`	Returns the `units` field on a transaction.
`Txn:TotalConsideration`	Returns the `totalConsideration.amount` field on a transaction.
A transaction property	Returns the value of a custom property added to a transaction using its 3-stage key, for example `Transaction/Demo/Commission`. The property must either use the built-in `number` data type, or have a custom data type with a primitive `valueType` of `Decimal`. The property value must contain a parsable numeric value.
A constant value	A parsable numeric value, for example `2500`.

What is a side?

security

currency

rate

units, amount

notionalAmount