MCP documentation | MCP docs for agents

ark_list_aging_details

ark.list_aging_details

List unpaid invoice or settlement detail rows for one AR customer or AP carrier aging summary row with search, currency, pagination, and sort controls.

Availability
Expanded preview
Scopes
reports:read
ARK permissions
canViewReportscanViewAgingReport
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

directionstringrequired

receivables expects a customer entityId. payables expects a carrier entityId.

one of: receivables, payables

entityIdstringrequired

Customer ID for receivables or carrier ID for payables.

format: uuid

teamIdsarray<string>

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

min items: 1; max items: 100

searchstring

max length: 200

currencyCodestring

one of: USD, CAD, MXN

pageinteger

default: 1; min: 1

pageSizeinteger

default: 25; min: 1; max: 500

sortColumnstring

one of: docNumber, amountDue, ageDays, bucket, status, pickupNumber, loadNumber, settlementNumber; default: "ageDays"

sortDirectionstring

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

Result

The tool returns the canonical ark.list_aging_details 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.