API documentation | API docs for agents | OpenAPI 3.1

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

ark.get_cash_flow_float_exposure

Lists visible loads where carrier cash has been paid while customer receivables remain open.

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

currency_codequerystring

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

team_idsquerystring

customer_idsquerystring

carrier_idsquerystring

factoring_idsquerystring

statusesquerystring

float_date_fromquerystring

format: date

float_date_toquerystring

format: date

min_amountquerynumber

min: 0

min_days_of_floatqueryinteger

min: 0

searchquerystring

max length: 200

sort_columnquerystring

one of: loadNumber, customerName, carrierName, factoringName, recipientName, currencyCode, receivableCurrencyCode, paidCurrencyCode, customerPaymentStatuses, carrierPaidAmount, carrierPaidDate, remainingCustomerBalance, daysOfFloatExposure, teamId; default: "daysOfFloatExposure"

sort_directionquerystring

one of: asc, desc; default: "desc"

limitqueryinteger

default: 25; min: 1; max: 500

cursorquerystring

Opaque JSON cursor returned by the previous page.

Request body

None.

Example request

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

Success response

Cash flow float exposure rows

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