{"openapi":"3.0.4","info":{"title":"Get portfolio cash flows","description":"Get the set of cash flows that occur in a window for the transaction portfolio's instruments.\r\n            \r\nNote that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique\r\ntransaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is\r\nnot split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/transactionportfolios/{scope}/{code}/cashflows":{"get":{"tags":["Transaction Portfolios"],"summary":"Get portfolio cash flows","description":"Get the set of cash flows that occur in a window for the transaction portfolio's instruments.\r\n            \r\nNote that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique\r\ntransaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is\r\nnot split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows.","operationId":"GetPortfolioCashFlows","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":"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.","schema":{"type":"string","format":"dateorcutlabel"}},{"name":"windowStart","in":"query","description":"The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.\r\n             There is no lower bound if this is not specified. i.e. it is the minimum date.","schema":{"type":"string","format":"dateorcutlabel"}},{"name":"windowEnd","in":"query","description":"The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.\r\n             The upper bound defaults to 'max date' if it is not specified","schema":{"type":"string","format":"dateorcutlabel"}},{"name":"asAt","in":"query","description":"The asAt datetime at which to retrieve the data. 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},{"name":"cashFlowCalculationVersion","in":"query","description":"The version of the cash flow calculation logic to use. Defaults to '1' if not specified; valid values are '1' (the current production behaviour)\r\n             and '2' (cash flows resolved via a deterministic source waterfall, with factual cash flows classified by transaction trade date and corporate action date filtering applied).\r\n             Under '2' the waterfall governs resolution only: this endpoint returns the de-duplicated instrument and structured result store stream, so a cash flow booked as a transaction\r\n             is removed rather than re-listed. Transaction-sourced cash flows are returned by the bucket cash flow drill-down endpoint and by requests using the PortfolioCashFlow or\r\n             TransactionCashFlow representation.","schema":{"maxLength":1,"minLength":1,"type":"string"}}],"responses":{"200":{"description":"The requested portfolio instruments' cash flow data","headers":{"Deprecation":{"description":"Only present when the request resolved to cashFlowCalculationVersion=1 (explicitly or by default): an RFC 9745 structured-field date marking when version 1 was deprecated. Set cashFlowCalculationVersion=2, its successor.","schema":{"type":"string"}},"Link":{"description":"Only present when the request resolved to cashFlowCalculationVersion=1: an RFC 8288 link with rel=\"deprecation\" pointing at the version 1 to version 2 migration documentation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfInstrumentCashFlow"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfInstrumentCashFlow"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfInstrumentCashFlow"}}}},"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"}}}}