GET
View official cash flow (client account)
Client space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller must have access to the book.
  • The fiscal_year_id is required and must be a fiscal year of the book.
  • An account with activity that no line of the statement layout claims makes the call fail with a business-rule error naming the account, rather than silently leaving it out.
Part of Official annual statements.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fiscal_year_id
string
required

Identifier of the fiscal year to report on (27-character KSUID string). Required. It must be a fiscal year of the selected book; a year of another book fails validation.

with_accounts
boolean | null

Opt-in so a filed statement keeps the plain document, without the per-line detail.

Response

book
object
required

The book (accounting owner) the statement was computed for.

fiscal_year
object
required

The fiscal year the statement covers, as requested by fiscal_year_id.

prior_fiscal_year
object | null
required

The fiscal year of the same book that ended before this one started (the most recent one), used for the N-1 comparative column. Null when the book has no earlier year.

opening
object
required

Net cash at the start of the year (line ZA of the statement).

lines
array
required

Lines of the cash flow statement between opening and closing cash, in layout order, each with code, label, section, level, n and n_1, plus an accounts list only when with_accounts is true. Amounts are integers in minor units; the lines are all 0 when the layouts are not available.

closing
object
required

Net cash at the end of the year (line ZH of the statement).

coherence
object
required

Cash check of the statement: expected, actual and ok. Closing cash should equal opening cash plus the variation; a mismatch is reported here, not refused.

currency_code
string
required

ISO currency code of the fiscal year. All amounts of the response are in this currency.

currency_exponent
integer
required

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.