You can load a complete or partial settlement instruction to settle units for a particular holding in a portfolio.
Methods
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), specify a Cash settlement instruction ID that is unique in this portfolio, and choose an Amount to settle that is no more than the number of unsettled units and has the same sign (so in this case, -500
):