Views:

When you configure your transaction types inside LUSID you can specify one or more of the built-in 'movement types'.

Every transaction that is entered into LUSID is deconstructed into a set of underlying economic movements. Each movement has one or more movement types associated with. The movement type controls how the movement is categorised and when it is applied.

For example, on the sale of an equity you typically have two movements: a reduction in the quantity of the equity that you just sold, and an increase in your cash balance. For each movement you can control when the movement is applied using movement types. 

  • For the reduction in the equity you should specify the StockMovement type. This ensures the movement is first updated on the trade date and then settled on the settlement date. 
  • For the increase in your cash balance you could specify the CashReceivable type. This ensures the cash shows as receivable from the trade date and settled from the settlement date.

You can combine any of the movement types below to reflect the underlying movements made by a transaction type. 

An up-to-date list can be found by searching for "MovementType" in the REST API documentation. At the time of writing, these are:

Movement typeEffect on holdings on trade dateEffect on holdings on settlement date
StockMovementUpdates the number of units in the instrument holding (with a holding type of P for Position).Updates the number of settled units.
CashCommitmentCreates a temporary holding of type C (for Cash Commitment) to reflect the commitment to settling a trade.

Updates the cash balance (holding type B for Cash Balance) and removes the temporary holding.

 

Note there is no functional difference between these three movement types. They simply report activity differently on the trade date.

CashReceivableCreates a temporary holding of type R (for Cash Receivable) to reflect the expectation of income from settling a trade.
CashAccrualCreates a temporary holding of type A (for Cash Accrual) to reflect accrual of income from an interest-bearing instrument.
CashForwardCreates two holdings of type F (for Forward FX) to represent each leg of the forward.Updates the cash balances (holding type B) of both currencies. Note that in a valuation, this movement type preserves the two legs of the forward.
CashFxForwardCreates two holdings of type F to represent each leg of the forward.Updates the cash balances (holding type B) of both currencies. Note that in a valuation, this movement type collapses the forward to a single leg.
VariationMarginThis movement type has no effect on the units of a holding. Instead, it can be used to adjust the notional cost basis of a holding in a Future or CFD instrument up or down as part of a mark-to-market valuation strategy for realizing daily PnL. For a demonstration, see this Jupyter Notebook.
CarryThese movement types have no effect on a holding. Instead, they can be used to model carry activity in an AtoB report.
CarryAsPnl

The following movement types are now deprecated:

  • Traded. Please use StockMovement.
  • Settlement. Please use StockMovement.
  • ForwardFx. Please use CashFxForward.
  • Commitment. Please use CashCommitment.
  • Receivable. Please use CashReceivable.
  • Accrual. Please use CashAccrual.
  • CashSettlement. Please use one of CashCommitmentCashReceivableCashAccrual.
  • FutureCash. Please use CashForward.
  • UnsettledCashTypes. Please use one of the Cash* types.