API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/reports/aging/summary

ark.list_aging_summary

Lists AR customer or AP carrier aging summary rows with search, bucket, hold, currency, team, pagination, and sort controls.

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

directionquerystringrequired

one of: receivables, payables

team_idsquerystring

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

searchquerystring

max length: 200

bucketquerystring

one of: 0-30, 31-60, 61-90, 90+

on_hold_onlyqueryboolean

currency_codequerystring

one of: USD, CAD, MXN

pagequeryinteger

default: 1; min: 1

page_sizequeryinteger

default: 25; min: 1; max: 500

sort_columnquerystring

one of: entityName, currencyCode, totalOutstanding, oldestAgeDays, oldestBucket, itemCount, onHoldCount; default: "totalOutstanding"

sort_directionquerystring

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

Request body

None.

Example request

curl 'https://arktms.com/api/v1/reports/aging/summary?direction=<direction>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Aging summary rows

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied