MCP documentation | MCP docs for agents
ark_record_carrier_payment
ark.record_carrier_payment
Record a READY or INVOICED ARK carrier payment as PAID for a visible load dispatch, assigning or reusing its settlement number and saving paid date/reference details.
- 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
loadIdstringrequiredVisible ARK load ID whose carrier payment should be recorded.
format: uuid
dispatchIdstringrequiredVisible dispatch ID for the carrier payment.
format: uuid
carrierPaymentIdstringOptional carrier payment ID. Omit to use the carrier payment for the load dispatch.
format: uuid
referenceNumberstring | nullOptional payment reference number.
max length: 100
paidDatestringrequiredPayment date in YYYY-MM-DD format.
Result
The tool returns the canonical ark.record_carrier_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.