Statistics

Settled, outstanding and projected cash flow bucketed over a period

get/v1/statistics/cashflowbyperiodicity

Request

Base URL
https://api.altoviz.com
Auth
none required
TypeScript
https://skmtc.dev/altoviz/apis/altoviz-api/docs/v1/statistics/cashflowbyperiodicity/get.ts
A function with typed inputs. Its response is checked against the schema.

fromstring date

First day of the period. Combined with to, takes precedence over year.

tostring date

Last day of the period, included

yearinteger

Shorthand for a whole calendar year (defaults to the current one). Ignored when a range is given.

periodicity'Daily' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Annually'

Bucket size: Daily, Weekly, Monthly (default), Quarterly or Annually

cumulativeboolean

Return running totals instead of per-bucket values

periodicity'Daily' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Annually'