{"openapi":"3.0.4","info":{"title":"Get portfolio cash ladder","description":"Get a cash ladder for a transaction portfolio.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/transactionportfolios/{scope}/{code}/cashladder":{"get":{"tags":["Transaction Portfolios"],"summary":"Get portfolio cash ladder","description":"Get a cash ladder for a transaction portfolio.","operationId":"GetPortfolioCashLadder","parameters":[{"name":"scope","in":"path","description":"The scope of the transaction portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"code","in":"path","description":"The code of the transaction portfolio. Together with the scope this\r\n            uniquely identifies the portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"fromEffectiveAt","in":"query","description":"The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.\r\n            There is no lower bound if this is not specified.","required":true,"schema":{"type":"string","format":"dateorcutlabel"}},{"name":"toEffectiveAt","in":"query","description":"The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.\r\n            There is no upper bound if this is not specified.","required":true,"schema":{"type":"string","format":"dateorcutlabel"}},{"name":"effectiveAt","in":"query","description":"The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.\r\nThis determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up.\r\nFor example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt\r\nis before the start of the range they are forward looking and will be expectations assuming the model supports that.\r\nThere is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.","required":true,"schema":{"type":"string","format":"dateorcutlabel"}},{"name":"asAt","in":"query","description":"The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version\r\n            of each transaction if not specified.","schema":{"type":"string","format":"date-time"},"x-nullable":true},{"name":"filter","in":"query","description":"Expression to filter the result set.\r\n            For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\".\r\n            For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.","schema":{"maxLength":16384,"minLength":0,"pattern":"^[\\s\\S]*$","type":"string"}},{"name":"recipeIdScope","in":"query","description":"The scope of the given recipeId","schema":{"type":"string"}},{"name":"recipeIdCode","in":"query","description":"The code of the given recipeID","schema":{"type":"string"}},{"name":"excludeUnsettledTrades","in":"query","description":"If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.","schema":{"type":"boolean","default":false},"x-nullable":true}],"responses":{"200":{"description":"The requested portfolio cash-ladder","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfPortfolioCashLadder"},"example":{"values":[{"currency":"USD","subHoldingKeys":{"Instrument/default/Strategy":{"key":"Instrument/default/Strategy","value":{"labelValue":"ABC"}}},"records":[{"effectiveDate":"2021-02-13T01:02:03.0040000+00:00","open":25000,"activities":{"Trades to settle":-8200,"Dividend":0,"Estimated funding":1500},"close":18300},{"effectiveDate":"2021-02-14T01:02:03.0040000+00:00","open":18300,"activities":{"Trades to settle":-19850,"Dividend":0,"Estimated funding":-500},"close":-2050},{"effectiveDate":"2021-02-15T01:02:03.0040000+00:00","open":-2050,"activities":{"Trades to settle":-5000,"Dividend":560,"Estimated funding":5000},"close":8510},{"effectiveDate":"2021-02-16T01:02:03.0040000+00:00","open":8510,"activities":{"Trades to settle":-2000,"Dividend":0,"Estimated funding":1500},"close":5010},{"effectiveDate":"2021-02-17T01:02:03.0040000+00:00","open":8510,"activities":{"Trades to settle":-1200,"Dividend":0,"Estimated funding":6700},"close":10510}],"failed":{}},{"currency":"EUR","subHoldingKeys":{"Instrument/default/Strategy":{"key":"Instrument/default/Strategy","value":{"labelValue":"CBA"}}},"records":[{"effectiveDate":"2021-02-13T01:02:03.0040000+00:00","open":-150000,"activities":{"Trades to settle":-15000,"Dividend":0,"Estimated funding":0},"close":135000},{"effectiveDate":"2021-02-15T01:02:03.0040000+00:00","open":135000,"activities":{"Trades to settle":25500,"Dividend":0,"Estimated funding":0},"close":160500},{"effectiveDate":"2021-02-17T01:02:03.0040000+00:00","open":160500,"activities":{"Trades to settle":0,"Dividend":5400,"Estimated funding":0},"close":165900}],"failed":{}}],"links":[]}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfPortfolioCashLadder"},"example":{"values":[{"currency":"USD","subHoldingKeys":{"Instrument/default/Strategy":{"key":"Instrument/default/Strategy","value":{"labelValue":"ABC"}}},"records":[{"effectiveDate":"2021-02-13T01:02:03.0040000+00:00","open":25000,"activities":{"Trades to settle":-8200,"Dividend":0,"Estimated funding":1500},"close":18300},{"effectiveDate":"2021-02-14T01:02:03.0040000+00:00","open":18300,"activities":{"Trades to settle":-19850,"Dividend":0,"Estimated funding":-500},"close":-2050},{"effectiveDate":"2021-02-15T01:02:03.0040000+00:00","open":-2050,"activities":{"Trades to settle":-5000,"Dividend":560,"Estimated funding":5000},"close":8510},{"effectiveDate":"2021-02-16T01:02:03.0040000+00:00","open":8510,"activities":{"Trades to settle":-2000,"Dividend":0,"Estimated funding":1500},"close":5010},{"effectiveDate":"2021-02-17T01:02:03.0040000+00:00","open":8510,"activities":{"Trades to settle":-1200,"Dividend":0,"Estimated funding":6700},"close":10510}],"failed":{}},{"currency":"EUR","subHoldingKeys":{"Instrument/default/Strategy":{"key":"Instrument/default/Strategy","value":{"labelValue":"CBA"}}},"records":[{"effectiveDate":"2021-02-13T01:02:03.0040000+00:00","open":-150000,"activities":{"Trades to settle":-15000,"Dividend":0,"Estimated funding":0},"close":135000},{"effectiveDate":"2021-02-15T01:02:03.0040000+00:00","open":135000,"activities":{"Trades to settle":25500,"Dividend":0,"Estimated funding":0},"close":160500},{"effectiveDate":"2021-02-17T01:02:03.0040000+00:00","open":160500,"activities":{"Trades to settle":0,"Dividend":5400,"Estimated funding":0},"close":165900}],"failed":{}}],"links":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfPortfolioCashLadder"},"example":{"values":[{"currency":"USD","subHoldingKeys":{"Instrument/default/Strategy":{"key":"Instrument/default/Strategy","value":{"labelValue":"ABC"}}},"records":[{"effectiveDate":"2021-02-13T01:02:03.0040000+00:00","open":25000,"activities":{"Trades to settle":-8200,"Dividend":0,"Estimated funding":1500},"close":18300},{"effectiveDate":"2021-02-14T01:02:03.0040000+00:00","open":18300,"activities":{"Trades to settle":-19850,"Dividend":0,"Estimated funding":-500},"close":-2050},{"effectiveDate":"2021-02-15T01:02:03.0040000+00:00","open":-2050,"activities":{"Trades to settle":-5000,"Dividend":560,"Estimated funding":5000},"close":8510},{"effectiveDate":"2021-02-16T01:02:03.0040000+00:00","open":8510,"activities":{"Trades to settle":-2000,"Dividend":0,"Estimated funding":1500},"close":5010},{"effectiveDate":"2021-02-17T01:02:03.0040000+00:00","open":8510,"activities":{"Trades to settle":-1200,"Dividend":0,"Estimated funding":6700},"close":10510}],"failed":{}},{"currency":"EUR","subHoldingKeys":{"Instrument/default/Strategy":{"key":"Instrument/default/Strategy","value":{"labelValue":"CBA"}}},"records":[{"effectiveDate":"2021-02-13T01:02:03.0040000+00:00","open":-150000,"activities":{"Trades to settle":-15000,"Dividend":0,"Estimated funding":0},"close":135000},{"effectiveDate":"2021-02-15T01:02:03.0040000+00:00","open":135000,"activities":{"Trades to settle":25500,"Dividend":0,"Estimated funding":0},"close":160500},{"effectiveDate":"2021-02-17T01:02:03.0040000+00:00","open":160500,"activities":{"Trades to settle":0,"Dividend":5400,"Estimated funding":0},"close":165900}],"failed":{}}],"links":[]}}}},"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":"Stable"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}