ARK TMS

MCP documentation | MCP docs for agents

ark_list_customer_payments

ark.list_customer_payments

List visible ARK customer billing rows with invoice, payment, hold, POD, remit profile, and carrier payment context before AR actions.

Availability
Expanded preview
Scopes
loads:readbilling:read
ARK permissions
canViewLoadscanViewBilling
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

statusstring

Optional customer payment status filter.

one of: DELIVERED, READY, INVOICED, FACTORED, PAID

customerIdstring

Optional customer ID filter.

format: uuid

payHoldstring

one of: all, yes, no; default: "all"

hasPodstring

one of: all, yes, no; default: "all"

deliveryDateFromstring
deliveryDateTostring
invoicedDateFromstring
invoicedDateTostring
paidDateFromstring
paidDateTostring
searchstring

Optional search across load number, customer, invoice, reference, document number, remit profile, pickup number, PO, BOL, origin, and destination.

min length: 1; max length: 100

limitinteger

default: 25; min: 1; max: 100

offsetinteger

default: 0; min: 0

Result

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