API documentation | API docs for agents | OpenAPI 3.1

generate

ark.generate_carrier_payment_packet

Generates and stores a carrier payment packet PDF for a visible load dispatch by combining selected supporting documents, then optionally attaches it to the carrier payment and marks it invoiced.

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

loadIdpathstringrequired: format: uuid
dispatchIdpathstringrequired: 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

carrierPaymentIdstring

Optional carrier payment ID. Omit to use the carrier payment for the load dispatch.

format: uuid

sourceFileIdsarray<string>required

Load file IDs to merge into the carrier payment packet.

min items: 1; max items: 100

fileNamestring

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

min length: 1; max length: 200

attachToCarrierPaymentboolean

Attach the generated packet to the carrier payment and mark it INVOICED.

default: true

Example request

Shell

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

Success response

Generated carrier payment packet

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.loadIdstringrequired

format: uuid

data.dispatchIdstringrequired

format: uuid

data.carrierPaymentIdstringrequired

format: uuid

data.fileIdstringrequired

format: uuid

data.fileobjectrequired

data.loadobjectrequired

data.includedFilesarray<object>required

data.attachedToCarrierPaymentbooleanrequired

data.statusstring | nullrequired

data.paymentAmountstring | nullrequired

data.dueDatestring | nullrequired

format: date-time

data.messagestringrequired

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