ARK TMS

MCP documentation | MCP docs for agents

ark_list_carrier_settlements

ark.list_carrier_settlements

List visible ARK carrier settlement groups with AP recipient, due date, paid date, amount, and NACHA metadata.

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 settlement status filter.

one of: PENDING, PAID

carrierIdstring

Optional carrier ID filter.

format: uuid

customerIdstring

Optional customer ID filter across settlement payment rows.

format: uuid

factoringIdstring

Optional factoring company ID filter.

format: uuid

paymentMethodstring

Optional payment method filter, such as ACH or Check.

max length: 50

dueDateFromstring
dueDateTostring
paidDateFromstring
paidDateTostring
nachaFileIdstring

Optional NACHA file ID filter.

format: uuid

nachaBatchNumberinteger

Optional NACHA batch number filter.

min: 1

searchstring

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

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