ARK TMS

MCP documentation | MCP docs for agents

ark_list_carrier_payments

ark.list_carrier_payments

List visible ARK carrier payable rows with billing, POD, hold, settlement, and NACHA metadata before AP 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 carrier payment status filter.

one of: DELIVERED, READY, PENDING, PAID

carrierIdstring

Optional carrier ID filter.

format: uuid

customerIdstring

Optional customer ID filter.

format: uuid

factoringIdstring

Optional factoring company ID filter.

format: uuid

paymentMethodstring

Optional payment method filter, such as ACH or Check.

max length: 50

payHoldstring

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

hasBillingInfostring

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

hasPodstring

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

dueDateFromstring
dueDateTostring
paidDateFromstring
paidDateTostring
searchstring

Optional search across load number, carrier, customer, factoring company, invoice, settlement, reference, vendor invoice, and document number.

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_carrier_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.