API documentation | API docs for agents | OpenAPI 3.1

preview

ark.preview_ar_invoice_revision

Preview current load values for an invoice

Availability: Expanded preview
Scopes: billing:read
ARK permissions: canViewBillingcanMakeAdjustments
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

None.

Request body

obligationIdstringrequired

format: uuid

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/invoice-revisions/preview' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "obligationId": "<obligationId>"
}'

Success response

Scoped invoice differences, eligibility, and a versioned acceptance fingerprint.

No response body.

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