ARK TMS

MCP documentation | MCP docs for agents

ark_generate_customer_billing_packet

ark.generate_customer_billing_packet

Generate and store an ARK customer billing packet PDF by combining a generated or custom invoice with selected supporting load documents, then optionally attach it to the customer payment.

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 billing packet 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

supportingFileIdsarray<string>

Supporting load file IDs to merge after the invoice.

default: []; max items: 100

customInvoiceFileIdstring

Optional custom invoice PDF file ID.

format: uuid

customInvoiceModestring

Whether the custom invoice replaces or is merged before the generated invoice.

one of: replace_generated, include_with_generated; default: "replace_generated"

fileNamestring

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

max length: 200

revisedInvoiceboolean

Mark the generated invoice portion as revised.

default: false

attachToCustomerPaymentboolean

Attach the generated packet to the customer payment and mark it READY.

default: true

markCarrierPaymentsReadyboolean

Also mark delivered carrier payments on the load READY.

default: false

Result

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