Get the cash flow plan

Returns the cash flow plan for the next 13 weeks, as Reports, Cash flow in Cybooks shows it, from the plan's own engine for the person asking: cash_today, amount_to_keep, the lowest_point with its day and the payment that causes it, each short stretch (days cash is below the amount to keep, at most five), days_short, and plan_link. With day alone: that day's money in, money out, end of day and payments (at most ten), each with its payment_key. The what-if as a read: day with a payment (its supplier or customer name or its number), a payment_key or an amount (with direction, default out) returns tried, the plan with it (after) and as planned (before); nothing is saved, moved or sent. A name that matches several payments answers status several_payments with the candidates to choose from by payment_key, more_candidates, as_of and read_only, and tries none. Amounts include VAT, in the base currency. Without view_payroll, salaries, social insurance and PAYE are one folded payroll total (payroll_totals_only, a day's payroll_totals) and no payroll payment can be tried. A day outside the 13 weeks or a try on today or earlier is a 422 cash_flow_day_out_of_range; a payment the plan does not have is cash_flow_unknown_payment; one whose date is fixed (set by law, in Payroll, already in the bank) is cash_flow_payment_locked; an amount the plan has no bank account to try on is cash_flow_no_account; a try the plan's engine refuses for another reason is cash_flow_try_refused; an argument it cannot use (an amount without a day, a payment and an amount together) is validation_failed. A 404 cash_flow_plan_unavailable while Cash flow is closed, a 409 cash_flow_plan_not_started before the company started its plan. Read only. Requires the reports:read OAuth scope with view_reports.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date

A day inside the next 13 weeks, YYYY-MM-DD. Alone: that day's money in, money out and payments. With payment, payment_key or amount: the day to try it on, after today

string
length ≤ 120

A payment already in the plan to try on the day: its supplier or customer name, or its number (for example BILL-0461). Needs day

string
length ≤ 161
^[a-z_]{1,40}:[A-Za-z0-9_.:-]{1,120}$

The payment_key of a payment the plan listed (a day's payments, or the candidates a name matched). Needs day

number
≤ 100000000

An amount to try on the day, in the base currency, VAT included, greater than zero and at most 100000000. Needs day; not with payment

string
enum

Whether the amount goes out or comes in. Default: out

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*