/v1/cash-flowsList cash flows
The money expected to move on a deal and whether it actually did: per flow, the type (payment, disbursement, commission, fee, refund, adjustment), the direction (inbound or outbound), the method, the expected amount and due date, its place in the run, what actually landed and when, and its status — expected, pending, completed, failed, missed, cancelled or reversed. Filters: ?facilityId=, ?dealRowId= (a deal record on our own board), ?scheduleId=, ?status=, ?direction=, ?limit=. Cash flows are ALSO one of the four money boards: to show them as a page of rows with the app's own columns, saved views and facet filters, read get_definitions_key_rows with the key cash-flows. Come here for the ledger read and for the flow's own lifecycle verbs.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": [
"string"
]
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}