Cashflow
All endpoints are scoped to a customer and require the customers:read scope.
Get cashflow
GET /api/v1/business/customers/{userId}/cashflowReturns income, expense and remaining over the smallest-granularity window.
| Query param | Type | Description |
|---|---|---|
granularity | string | weekly · fortnightly · monthly · quarterly · annual · fixed_period |
startDate | string | Window anchor, YYYY-MM-DD |
Get reference date
GET /api/v1/business/customers/{userId}/cashflow/reference-dateReturns referenceDate, incomeGranularity, expenseGranularity, combinedGranularity.
Update granularity settings
POST /api/v1/business/customers/{userId}/cashflow/granularity-settings| Body field | Type | Description |
|---|---|---|
incomeGranularity | string | One of the granularity values |
expenseGranularity | string | One of the granularity values |
Provide at least one.
See the Cashflow API guide for full examples.