MCP documentation | MCP docs for agents
ark_record_customer_payment
ark.record_customer_payment
Record an invoiced or factored ARK customer payment as PAID for a visible load, with paid date and optional reference number.
- 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 customer payment should be recorded.
format: uuid
customerPaymentIdstringOptional customer payment ID. Omit to use the latest payment for the load.
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_customer_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.