ARK TMS

MCP documentation | MCP docs for agents

ark_update_carrier_vendor_invoice_number

ark.update_carrier_vendor_invoice_number

Update the vendor invoice number for a DELIVERED or READY ARK carrier payment tied to a visible load dispatch.

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 vendor invoice number should be updated.

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 | nullrequired

Vendor invoice number to save. Use null to clear it.

max length: 100

Result

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