MCP documentation | MCP docs for agents

ark_record_carrier_settlement_payment

ark.record_carrier_settlement_payment

Record one or more PENDING ARK carrier settlements as PAID across the visible loads in those settlements.

Availability
Expanded preview
Scopes
loads:readbilling:write
ARK permissions
canViewLoadscanViewBillingcanMakeAdjustments
Team visibility
Required and enforced
Approval policy
ask_before_write
ARK approval request
Required before execution
Idempotency
Required for external execution
Read-only
No
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

settlementNumbersarray<integer>required

Pending carrier settlement numbers to record as paid.

min items: 1; max items: 50

referenceNumberstring | null

Optional payment reference number.

max length: 100

paidDatestringrequired

Payment date in YYYY-MM-DD format.

Result

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