ARK TMS

MCP documentation | MCP docs for agents

ark_generate_customer_invoice

ark.generate_customer_invoice

Generate and store an ARK customer invoice PDF for a visible load using customer pay and the selected or locked invoice remit profile.

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
Yes
Rate limit
OAuth MCP credential and organization budgets

Input

loadIdstringrequired

Visible ARK load ID to generate the customer invoice for.

format: uuid

customerPaymentIdstring

Optional customer payment ID. Omit to use the latest payment for the load.

format: uuid

invoiceRemitProfileIdstring

Optional invoice remit profile ID. Omit to use the locked/default profile.

format: uuid

fileNamestring

Optional PDF file name. A .pdf extension is added when omitted.

max length: 200

revisedboolean

Mark the generated PDF as a revised invoice.

default: false

Result

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