Cashflow API

Three endpoints, all under a customer, all requiring the customers:read scope.

Get cashflow


GET /api/v1/business/customers/{userId}/cashflow

Returns income, expense and remaining over the smallest-granularity window, anchored at the customer’s reference date.

Query parameters

Param	Type	Description
`granularity`	string	Override the window: `weekly`, `fortnightly`, `monthly`, `quarterly`, `annual`, `fixed_period`
`startDate`	string	Override the window anchor, `YYYY-MM-DD`


curl "https://api.pouchlimited.com/api/v1/business/customers/123/cashflow?granularity=weekly" \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>"


{
  "success": true,
  "code": "business_cashflow_retrieved",
  "message": "Cashflow retrieved",
  "data": {
    "income": 500.0,
    "expense": 320.5,
    "remaining": 179.5,
    "granularity": "weekly",
    "startDate": "2026-07-06"
  }
}

remaining is income − expense. If you don’t pass granularity / startDate, Pouch uses the customer’s stored settings and reference date.

Get reference date


GET /api/v1/business/customers/{userId}/cashflow/reference-date

Returns the anchor date and the customer’s granularity settings.


{
  "success": true,
  "code": "business_cashflow_reference_date",
  "data": {
    "referenceDate": "2026-07-06",
    "incomeGranularity": "monthly",
    "expenseGranularity": "weekly",
    "combinedGranularity": "weekly"
  }
}

Update granularity settings


POST /api/v1/business/customers/{userId}/cashflow/granularity-settings

Persist a customer’s income and/or expense granularity. Provide at least one.


curl -X POST \
  "https://api.pouchlimited.com/api/v1/business/customers/123/cashflow/granularity-settings" \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>" \
  -H "Content-Type: application/json" \
  -d '{ "incomeGranularity": "monthly", "expenseGranularity": "weekly" }'