{"openapi":"3.0.4","info":{"title":"Upsert Settlement Instructions.","description":"Create or update instructions to settle specific transactions.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/transactionportfolios/{scope}/{code}/settlementinstructions":{"post":{"tags":["Transaction Portfolios"],"summary":"Upsert Settlement Instructions.","description":"Create or update instructions to settle specific transactions.","operationId":"UpsertSettlementInstructions","parameters":[{"name":"scope","in":"path","description":"The scope of the portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"code","in":"path","description":"The code of the portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}}],"requestBody":{"description":"The definition of the settlement instruction.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/SettlementInstructionRequest"}},"example":[{"settlementInstructionId":"settlementInstructionId","transactionId":"transactionId1","settlementCategory":"CashSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9","Instrument/default/Isin":"GB00BH4HKS39"},"contractualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]},{"settlementInstructionId":"settlementInstructionId-2","transactionId":"transactionId2","settlementCategory":"StockSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9"},"contractualSettlementDate":"2024-01-02T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-05T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]}]},"application/json":{"schema":{"type":"array","items":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/SettlementInstructionRequest"}},"example":[{"settlementInstructionId":"settlementInstructionId","transactionId":"transactionId1","settlementCategory":"CashSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9","Instrument/default/Isin":"GB00BH4HKS39"},"contractualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]},{"settlementInstructionId":"settlementInstructionId-2","transactionId":"transactionId2","settlementCategory":"StockSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9"},"contractualSettlementDate":"2024-01-02T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-05T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]}]},"text/json":{"schema":{"type":"array","items":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/SettlementInstructionRequest"}},"example":[{"settlementInstructionId":"settlementInstructionId","transactionId":"transactionId1","settlementCategory":"CashSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9","Instrument/default/Isin":"GB00BH4HKS39"},"contractualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]},{"settlementInstructionId":"settlementInstructionId-2","transactionId":"transactionId2","settlementCategory":"StockSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9"},"contractualSettlementDate":"2024-01-02T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-05T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]}]},"application/*+json":{"schema":{"type":"array","items":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/SettlementInstructionRequest"}},"example":[{"settlementInstructionId":"settlementInstructionId","transactionId":"transactionId1","settlementCategory":"CashSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9","Instrument/default/Isin":"GB00BH4HKS39"},"contractualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-01T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]},{"settlementInstructionId":"settlementInstructionId-2","transactionId":"transactionId2","settlementCategory":"StockSettlement","instructionType":"Complete","instrumentIdentifiers":{"Instrument/default/Figi":"BBG000C6K6G9"},"contractualSettlementDate":"2024-01-02T00:00:00.0000000+00:00","actualSettlementDate":"2024-01-05T00:00:00.0000000+00:00","units":10,"subHoldingKeyOverrides":{},"properties":[]}]}},"required":true},"responses":{"201":{"description":"The newly created or undated Settlement Instructions.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfTransactionSettlementInstruction"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfTransactionSettlementInstruction"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfTransactionSettlementInstruction"}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}