API documentation | API docs for agents | OpenAPI 3.1

previews

ark.create_customer_invoice_packet_preview

Create Customer Invoice Packet Preview through the authoritative Billing application boundary.

Availability: Expanded preview
Scopes: loads:readbilling:read
ARK permissions: canViewLoadscanViewBilling
Team visibility: Required and enforced
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired: Stable key for safe replay of this exact operation input.; min length: 8; max length: 200

Request body

reasonstring

default: "Billing workbench action"; min length: 1; max length: 1000

queueQuickBooksSyncboolean

default: false

targetsarray<object>required

min items: 1; max items: 1

payHoldAcknowledgementsarray<object>

max items: 100

packetPreparationFingerprintstringrequired

packetSourceVersionIdsarray<string>required

max items: 100

invoiceRenderModestringrequired

one of: system, custom_replace, custom_then_system

packetOverrideReasonstring

min length: 5; max length: 1000

existingPacketIdstring

format: uuid

existingPacketVersioninteger

max: 9007199254740991

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/invoice-packets/previews' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "targets": [
    {
      "obligationId": "<obligationId>",
      "expectedWorkflowVersion": 1,
      "expectedBalanceVersion": 1
    }
  ],
  "packetPreparationFingerprint": "<packetPreparationFingerprint>",
  "packetSourceVersionIds": [
    "<packetSourceVersionIds>"
  ],
  "invoiceRenderMode": "system"
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.okbooleanrequired

data.actionstringrequired

data.updatedCountintegerrequired

min: 0

data.messagestringrequired

data.failuresarray<object>required

Action-specific JSON-safe result, including current versions and fingerprints.

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