API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/reports/cash-flow-v2

ark.get_cash_flow_forecast_v2

Returns a currency-separated cash-flow forecast with aging, float exposure, and daily projections for visible teams.

Availability

Expanded preview

Scopes

reports:read

ARK permissions

canViewReportscanViewCashFlowForecast

Team visibility

Required and enforced

Idempotency-Key

Not required

Approval

No MCP approval on REST API-token calls

Rate limit

API credential and organization budgets

Parameters

include_overduequeryboolean

Include payments due before today in the daily forecast. Open balances always include overdue.

default: true

scenarioquerystring

one of: expected, conservative, optimistic; default: "expected"

modequerystring

one of: historical, terms; default: "historical"

horizon_daysqueryinteger

one of: 30, 60, 90; default: 90

currency_codequerystring

one of: USD, CAD, MXN; default: "USD"

starting_cashquerynumber

default: 0

team_idsquerystring

Comma-separated visible team IDs. Omit to use every team available to the credential.

Request body

None.

Example request

curl 'https://arktms.com/api/v1/reports/cash-flow-v2' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Cash flow forecast v2

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied

HTTP 502

External provider or worker queue could not be reached