ARK TMS

MCP documentation | MCP docs for agents

ark_get_cash_flow_forecast_v2

ark.get_cash_flow_forecast_v2

Return currency-separated cash-flow totals, aging, float exposure, and a daily forecast for visible teams.

Availability
Expanded preview
Scopes
reports:read
ARK permissions
canViewReportscanViewCashFlowForecast
Team visibility
Required and enforced
Approval policy
none
ARK approval request
Not required
Idempotency
Not required
Read-only
Yes
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

includeOverdueboolean

Include payments due before today in projected cash flows. Defaults to true; open balances always include overdue.

scenariostring

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

modestring

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

horizonDaysinteger

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

currencyCodestring

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

startingCashnumber

default: 0

teamIdsarray<string>

Optional visible team IDs. Omit to use all teams available to the connection.

min items: 1; max items: 100

Result

The tool returns the canonical ark.get_cash_flow_forecast_v2 operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.