Settling cash into different SHKs or custodian accounts

Prev Next

When you book a transaction you have the option to assign a sub-holding key (SHK) or custodian account in order to segregate holding(s) impacted by that transaction from others in the same underlying instruments.

When you load a settlement instruction (SI) for a cash movement generated by that transaction you can choose to override your trade date choice by assigning a different SHK or custodian account.

Note: SHKs not referenced in a SI are not affected.

For example, imagine we have a standard Buy transaction for 100 units of BP @ £5 per share with a Transaction/MySHKs/Strategy property set to Growth. On the trade date, both stock and temporary cash commitment holdings are segregated into a Growth strategy:

Changing or removing a SHK for a cash holding

Call the UpsertSettlementInstructions API and, for a SI with a settlementCategory of CashSettlement or DeferredCashReceipt, specify a subHoldingKeyOverrides object with a new property value, or alternatively null to remove the value and assign no strategy:

curl -X POST "https://<your-domain>.lusid.com/api/api/transactionportfolios/Equities/UK-Growth/settlementinstructions"
  -H "Authorization: Bearer <your-API-access-token>"
  -H "Content-Type: application/json-patch+json"
  -d '[
  {
    "settlementInstructionId": "settle-cash-txn01",
    "transactionId": "Txn01",
    "settlementCategory": "CashSettlement",
    "instrumentIdentifiers": {"Instrument/default/LusidInstrumentId": "CCY_GBP"},
    "actualSettlementDate": "2025-09-10T00:00:00.0000000+00:00",
    "units": -500,
    "subHoldingKeyOverrides": {
      "Transaction/MySHKs/Strategy": {
        "key": "Transaction/MySHKs/Strategy",
        "value": {
          "labelValue": "Income"
        }
      }
    }
  }
]'

Follow the instructions for creating a settlement instruction and, in the Create cash settlement dialog, specify a new value for the SHK property, or click the X button to remove the value and assign no strategy:

In our example, the units and cost of the now-settled cash balance holding are transferred over to an Income strategy:

Changing the custodian account for a cash holding

Call the UpsertSettlementInstructions API and, for a SI with a settlementCategory of CashSettlement or DeferredCashReceipt, specify a custodianAccountOverride object referencing the scope and code of a new CA:

curl -X POST "https://<your-domain>.lusid.com/api/api/transactionportfolios/Equities/UK-Growth/settlementinstructions"
  -H "Authorization: Bearer <your-API-access-token>"
  -H "Content-Type: application/json-patch+json"
  -d '[
  {
    "settlementInstructionId": "settle-cash-txn01",
    "transactionId": "Txn01",
    "settlementCategory": "CashSettlement",
    "instrumentIdentifiers": {"Instrument/default/LusidInstrumentId": "CCY_GBP"},
    "actualSettlementDate": "2025-09-10T00:00:00.0000000+00:00",
    "units": -500,
    "custodianAccountOverride": {
      "scope": "MyCAs",
      "code": "JPMorgan-LIFO"
    }
  }
]'

Follow the instructions for creating a settlement instruction and, in the Create cash settlement dialog, choose a new Custodian account from the dropdown: