What built-in transaction types and sides are provided with LUSID?

LUSID has a number of built-in transaction types and sides that model basic economic behavior.

These are useful to get started, but we recommend creating your own universe of custom transaction types for a production system. See how to remove the built-in types.

Note: Built-in transaction types and sides are domiciled in the default scope and in the default and alt1 sources. More information on scopes and sources.

Built-in transaction types

LUSID provides a number of built-in transaction types such as Buy and Sell.

To list the built-in transaction types, obtain an API access token and call the ListTransactionTypes API for the default scope, for example:

curl -X GET 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types?scope=default'
  -H 'Authorization: Bearer <your-API-access-token>'

Note it is possible to domicile your own custom transaction types in the default scope.

To get the definition (aliases, movements and sides) of a built-in transaction type such as Buy, call the GetTransactionType API for the default source and default scope, for example:

curl -X GET 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/Buy?scope=default'
  -H 'Authorization: Bearer <your-API-access-token>'

For an in-depth explanation of the built-in Buy transaction type, see this article.

Built-in sides

At the time of writing, LUSID has four built-in sides: Side1, Side2, BondInt and Side2WithoutBondInterest.

These are domiciled in the default scope and can only ultimately belong to transaction types also domiciled in the default scope. If you want to use a built-in side with your own transaction type in a custom scope, you must recreate the side in that scope.

To get the definition of a built-in side such as Side1, call the GetSideDefinition API for the default scope, for example:

curl -X GET 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/sides/Side1?scope=default'
  -H 'Authorization: Bearer <your-API-access-token>'

For convenience, definitions for the built-in sides are summarised below. See this article for more information on the allowed values.