API documentation | API docs for agents | OpenAPI 3.1

PATCH /api/v1/billing/carrier-payments/vendor-invoice-numbers

ark.update_carrier_vendor_invoice_numbers

Updates vendor invoice numbers for selected delivered or ready carrier payments in one billing-grid workflow.

Availability

Expanded preview

Scopes

loads:readbilling:write

ARK permissions

canViewLoadscanViewBillingcanMakeAdjustments

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

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

Example request

curl -X PATCH 'https://arktms.com/api/v1/billing/carrier-payments/vendor-invoice-numbers' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "payments": [
    {
      "carrierPaymentId": "<carrierPaymentId>",
      "vendorInvoiceNumber": "<vendorInvoiceNumber>"
    }
  ]
}'

Success response

Updated carrier vendor invoice numbers

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 422

Invalid request