MCP documentation | MCP docs for agents
ark_update_billed_load_details
ark.update_billed_load_details
Update a visible ARK load after customer billing has started, regenerate the revised customer invoice when billing is READY or INVOICED, and optionally queue a QuickBooks customer invoice update.
- Availability
- Expanded preview
- Scopes
loads:readloads:writebilling:write- ARK permissions
canViewLoadscanEditLoadcanViewBillingcanMakeAdjustments- 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
loadIdstringrequiredVisible ARK load ID whose billed details should be updated.
format: uuid
customerIdstring | nullCustomer ID to assign to the load, or null to clear.
format: uuid
teamIdstringVisible team ID to assign to the load.
format: uuid
brokerIdstring | nullformat: uuid
customerServiceRepIdstring | nullformat: uuid
temperaturenumber | nullinternalCommentsstring | nullmax length: 5000
externalCommentsstring | nullmax length: 5000
hotCommentsstring | nullmax length: 5000
pickupNumberstring | nullmax length: 100
purchaseOrderNumberstring | nullmax length: 100
billOfLadingstring | nullmax length: 100
productstring | nullmax length: 200
valuenumber | nulldescriptionstring | nullmax length: 5000
sizestring | nullmax length: 100
trailerstring | nullmax length: 100
weightnumber | nullweightUnitstringone of: lbs, kg
lengthnumber | nullwidthnumber | nullheightnumber | nullnumberOfPiecesinteger | nullmin: 0
hazmatbooleandocHighbooleanstackablebooleantsabooleanteamDriverRequiredbooleanmilesnumber | nullmin: 0
maximumBuyAmountnumber | nullMaximum carrier buy amount for load-board and market-intelligence workflows.
min: 0
customerCurrencystringone of: USD, CAD, MXN
carrierCurrencystringone of: USD, CAD, MXN
customerPayarray<object>Replacement customer-pay lines. Omit to leave customer pay unchanged.
max items: 100
stopsarray<object>Replacement stop list. Omit to leave stops unchanged.
min items: 2; max items: 50
refreshCustomerBillingbooleanWhen true, regenerate the revised customer invoice for READY or INVOICED customer payments after updating the load.
default: true
queueQuickBooksSyncbooleanWhen true, queue a QuickBooks customer_invoice_update job after refreshing the revised invoice.
default: true
invoiceRemitProfileIdstringOptional invoice remit profile ID to use for the regenerated revised invoice.
format: uuid
invoiceFileNamestringOptional regenerated revised invoice PDF file name.
max length: 200
Result
The tool returns the canonical ark.update_billed_load_details 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.