API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/reports/aging

ark.get_aging_report

Returns permissioned AR/AP aging summaries with bounded outstanding invoice/payment details.

Availability

Expanded preview

Scopes

reports:read

ARK permissions

canViewReportscanViewAgingReport

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

directionquerystring

one of: receivables, payables, both; default: "both"

team_idsquerystring

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

detail_limitqueryinteger

min: 0; max: 1000

Request body

None.

Example request

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

Success response

Report result

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied