Recommended transaction types for corporate action events

  • Updated on Nov 8, 2024
  • Published on Oct 18, 2024

If you use the default transaction templates provided by LUSID for corporate action events then you must create transaction types with specific names residing in the default source.

If you wish to change transaction type names and/or sources then you cannot use the default transaction templates and must instead create custom transaction templates for the events you wish to handle.

The transaction types on this page are suggestions only. You can design a transaction type to have any economic impact you like.

The default transaction template for this corporate action event specifies one transaction type.

This transaction type is always required. See also: Movement types | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/FundAccumulationIncome?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "FundAccumulationIncome",
      "description": "Transaction type for accumulation event",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Adjust cost basis of security",
      "movementTypes": "StockMovement",
      "side": "AccumulationCustomSide",    # <--Custom side, see below
      "direction": 1
    },
    {
      "name": "Report income as a flow out of the security",
      "movementTypes": "Carry",
      "side": "AccumulationCustomSide",    # <--Custom side, see below
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

Both movements use the same custom side:

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/sides/AccumulationCustomSide?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "security": "Txn:LusidInstrumentId",
  "currency": "Txn:TradeCurrency",
  "rate": "Txn:TradeToPortfolioRate",
  "units": 0,
  "amount": "Txn:TradeAmount"
}'
JSON

The default transaction template for this corporate action event specifies three transaction types, all conditional.

This transaction type is required if the corporate action loaded into LUSID has a chosen election of either cash or security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/BonusIssueAdditionalUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "BonusIssueAdditionalUnits",
      "description": "Transaction type for bonus issue event - additional units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security holding",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of security and fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/BonusIssueCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "BonusIssueCashInLieu",
      "description": "Transaction type for bonus issue event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of cash. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/BonusIssueCashOffer?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "BonusIssueCashOffer",
      "description": "Transaction type for bonus issue event - cash offer",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Increase cash balance",
      "movementTypes": "CashAccrual",
      "side": "Side2",
      "direction": 1
    },
    {
      "name": "Report income as a flow out of the security",
      "movementTypes": "Carry",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is required if the corporate action loaded into LUSID has a chosen election of option exercise. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/ExerciseIntermediateSecurities?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "ExerciseIntermediateSecurities",
      "description": "Transaction type for call on intermediate securities event - buy new instrument",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units of new security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    },
    {
      "name": "Decrease cash balance",
      "movementTypes": "CashCommitment",
      "side": "Side2",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/ExpireIntermediateSecurities?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "ExpireIntermediateSecurities",
      "description": "Transaction type for call on intermediate securities event - expire old instrument",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units of old security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies one transaction type.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/DividendIncome?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "DividendIncome",
      "description": "Transaction type for capital distribution event",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Adjust cost basis of security",
      "movementTypes": "StockMovement",
      "side": "CapitalDistributionStockCustomSide",   # <--Custom side, see below
      "direction": -1
    },
    {
      "name": "Add income to cash balance",
      "movementTypes": "CashAccrual",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The StockMovement uses a custom side:

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/sides/CapitalDistributionStockCustomSide?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "security": "Txn:LusidInstrumentId",
  "currency": "Txn:TradeCurrency",
  "rate": "Txn:TradeToPortfolioRate",
  "units": 0,
  "amount": "Txn:TradeAmount"
}'
JSON

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/DividendIncome?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "DividendIncome",
      "description": "Transaction type for cash dividend event",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Increase cash balance",
      "movementTypes": "CashAccrual",
      "side": "Side2",
      "direction": 1
    },
    {
      "name": "Report income as a flow out of the security",
      "movementTypes": "Carry",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/DvopCashIncome?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "DvopCashIncome",
      "description": "Transaction type for dividend option event - cash income",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add income to cash balance",
      "movementTypes": "CashAccrual",
      "side": "Side2",
      "direction": 1
    },
    {
      "name": "Report income as a flow out of the security",
      "movementTypes": "Carry",
      "side": "DvopCashIncomeCarryCustomSide",   # <--Custom side, see below
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The Carry movement uses a custom side:

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/sides/DvopCashIncomeCarryCustomSide?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "security": "Txn:LusidInstrumentId",
  "currency": "Txn:TradeCurrency",
  "rate": "Txn:TradeToPortfolioRate",
  "units": 0,
  "amount": "Txn:TotalConsideration"
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/DvopSecurityOption?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "DvopSecurityOption",
      "description": "Transaction type for dividend option event - security option",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    },
    {
      "name": "Decrease cash balance",
      "movementTypes": "CashCommitment",
      "side": "Side2",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/DripCashIncome?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "DripCashIncome",
      "description": "Transaction type for dividend reinvestment event - cash income",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add income to cash balance",
      "movementTypes": "CashAccrual",
      "side": "Side2",
      "direction": 1
    },
    {
      "name": "Report income as a flow out of the security",
      "movementTypes": "Carry",
      "side": "DripCashIncomeCarryCustomSide",    # <--Custom side, see below
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The Carry movement uses a custom side:

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/sides/DripCashIncomeCarryCustomSide?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "security": "Txn:LusidInstrumentId",
  "currency": "Txn:TradeCurrency",
  "rate": "Txn:TradeToPortfolioRate",
  "units": 0,
  "amount": "Txn:TotalConsideration"
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/DripSecurityReinvestment?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "DripSecurityReinvestment",
      "description": "Transaction type for dividend reinvestment event - security option",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    },
    {
      "name": "Decrease cash balance",
      "movementTypes": "CashCommitment",
      "side": "Side2",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/IntermediateSecurityUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "IntermediateSecurityUnits",
      "description": "Transaction type for intermediate securities distribution event - add units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/IntermediateSecurityCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "IntermediateSecurityCashInLieu",
      "description": "Transaction type for intermediate securities distribution event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies five transaction types, all conditional.

This transaction type is required if the corporate action loaded into LUSID has a chosen election of security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/MergerRemoveExisting?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "MergerRemoveExisting",
      "description": "Transaction type for merger event - remove existing units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of cash & security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/MergerAdjustCost?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "MergerAdjustCost",
      "description": "Transaction type for merger event - adjust cost",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Adjust cost of security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of cash or cash & security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/MergerReceiveCash?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "MergerReceiveCash",
      "description": "Transaction type for merger event - recieve cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Decrease units of security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has a chosen election of security or cash & security. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/MergerReceiveUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "MergerReceiveUnits",
      "description": "Transaction type for merger event - recieve units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Increase units of security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/MergerCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "MergerCashInLieu",
      "description": "Transaction type for merger event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/ReverseStockSplitUnitReduction?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "ReverseStockSplitUnitReduction",
      "description": "Transaction type for reverse stock split event - unit reduction",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/ReverseStockSplitCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "ReverseStockSplitCashInLieu",
      "description": "Transaction type for reverse stock split event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/ScripDividendAdditionalUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "ScripDividendAdditionalUnits",
      "description": "Transaction type for scrip dividend event - additional units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/ScripDividendCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "ScripDividendCashInLieu",
      "description": "Transaction type for scrip dividend event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies three transaction types, two mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/SpinOffAdjustCost?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "SpinOffAdjustCost",
      "description": "Transaction type for spin off event - adjust cost",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Adjust cost of security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/SpinOffNewUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "SpinOffNewUnits",
      "description": "Transaction type for spin off event - new units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/SpinOffCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "SpinOffCashInLieu",
      "description": "Transaction type for dividend option event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/StockDividendAdditionalUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "StockDividendAdditionalUnits",
      "description": "Transaction type for stock dividend event - additional units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/StockDividendCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "StockDividendCashInLieu",
      "description": "Transaction type for stock dividend event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

The default transaction template for this corporate action event specifies two transaction types, one mandatory and one conditional.

This transaction type is always required. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/StockSplitAdditionalUnits?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "StockSplitAdditionalUnits",
      "description": "Transaction type for stock split event - additional units",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Add units to security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON

This transaction type is required if the corporate action loaded into LUSID has fractional units. See also: Movement types | Built-in sides | Calculation types

curl -X PUT 'https://<your-domain>.lusid.com/api/api/transactionconfiguration/types/default/StockSplitCashInLieu?scope=default'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "aliases": [
    {
      "type": "StockSplitCashInLieu",
      "description": "Transaction type for stock split event - sell fractional units for cash",
      "transactionClass": "Basic",
      "transactionRoles": "AllRoles",
      "isDefault": false
    }
  ],
  "movements": [
    {
      "name": "Remove units from security",
      "movementTypes": "StockMovement",
      "side": "Side1",
      "direction": -1
    },
    {
      "name": "Increase cash balance",
      "movementTypes": "CashReceivable",
      "side": "Side2",
      "direction": 1
    }
  ],
  "calculations": [
    {
      "type": "Txn:TradeToPortfolioRate"
    },
    {
      "type": "Txn:ExchangeRate"
    }
  ]
}'
JSON