MCP documentation | MCP docs for agents

ark_mark_carrier_payment_ready

ark.mark_carrier_payment_ready

Validate a delivered carrier payment, optionally save a vendor invoice number, assign dispatch pay rows, and move the payment to READY for packet creation.

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

loadIdstringrequired

Visible ARK load ID whose carrier payment should be marked READY.

format: uuid

dispatchIdstringrequired

Visible dispatch ID for the carrier payment.

format: uuid

carrierPaymentIdstring

Optional carrier payment ID. Omit to use the carrier payment for the load dispatch.

format: uuid

vendorInvoiceNumberstring | null

Optional vendor invoice number to save before moving the payment to READY.

max length: 100

Result

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