A settlement instruction (SI) settles some or all units for a particular transaction in a portfolio.
A settlement instruction must identify a category of either stock, cash or deferred cash. Typically, a category applies to a single movement generated by the original transaction type but there are circumstances in which a category applies to more than one movement.
Loading a settlement instruction
Note the following:
A SI must have an ID that is unique among all SIs loaded into the portfolio.
You can specify any number of units up to the total number to settle.
The units should have the same sign, so if the number of unsettled units is
-500then the SI must also be a negative number.
Call the UpsertSettlementInstructions API. Note the settlementInstructionId must be unique in the portfolio, and the units must be no more than the number of unsettled units and have the same sign, for example -500:
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-Txn01-10-Sep-2025",
"transactionId": "Txn01",
"settlementCategory": "CashSettlement",
"instrumentIdentifiers": {"Instrument/default/LusidInstrumentId": "CCY_GBP"},
"actualSettlementDate": "2025-09-10T00:00:00.0000000+00:00",
"units": -500
}
]'Navigate to the Data Management > Holdings dashboard, click the Units field of the holding to settle (in yellow) and then click the Transaction settlements button for the source transaction (in green):
Then, in the Settlements dialog for the source transaction, click the appropriate Create settlement button (in yellow below) and complete the form (making sure Amount to settle has the same sign as Unsettled amount, in this case negative):
