API documentation | API docs for agents | OpenAPI 3.1

billing-adjustment

ark.update_billed_load_details

Updates a visible load after customer billing has started, then regenerates the revised customer invoice and optionally queues a QuickBooks customer invoice update for READY or INVOICED payments.

Availability: Expanded preview
Scopes: loads:readloads:writebilling:write
ARK permissions: canViewLoadscanEditLoadcanViewBillingcanMakeAdjustments
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

loadIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

customerIdstring | null

format: uuid

teamIdstring

format: uuid

brokerIdstring | null

format: uuid

customerServiceRepIdstring | null

format: uuid

temperaturenumber | null

internalCommentsstring | null

max length: 5000

externalCommentsstring | null

max length: 5000

hotCommentsstring | null

max length: 5000

pickupNumberstring | null

max length: 100

purchaseOrderNumberstring | null

max length: 100

billOfLadingstring | null

max length: 100

productstring | null

max length: 200

valuenumber | null

descriptionstring | null

max length: 5000

sizestring | null

max length: 100

trailerstring | null

max length: 100

weightnumber | null

weightUnitstring

one of: lbs, kg

lengthnumber | null

widthnumber | null

heightnumber | null

numberOfPiecesinteger | null

min: 0

hazmatboolean

docHighboolean

stackableboolean

tsaboolean

teamDriverRequiredboolean

milesnumber | null

min: 0

maximumBuyAmountnumber | null

Maximum carrier buy amount for load-board and market-intelligence workflows.

min: 0

customerCurrencystring

one of: USD, CAD, MXN

carrierCurrencystring

one 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

refreshCustomerBillingboolean

When true, regenerate the revised invoice for READY or INVOICED customer payments.

default: true

queueQuickBooksSyncboolean

When true, queue a QuickBooks customer_invoice_update job after the load update.

default: true

invoiceRemitProfileIdstring

Optional invoice remit profile ID for the regenerated revised invoice.

format: uuid

invoiceFileNamestring

Optional regenerated revised invoice PDF file name.

max length: 200

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/loads/<loadId>/billing-adjustment' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Updated billed load details

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.loadobjectrequired

data.billingRefreshobjectrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry
HTTP 502: External provider or worker queue could not be reached