API documentation | API docs for agents | OpenAPI 3.1

workbench

ark.get_billing_workbench

Get Billing Workbench 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

None.

Request body

sidestringrequired

one of: ap, ar

stagesarray<string>required

min items: 1; max items: 6

teamIdsarray<string>

max items: 100

searchstring

max length: 500

savedViewstring

one of: all, factored, needs-documents, on-hold, integration-exceptions, payment-exceptions, suspense

filtersobject

sortobject

limitinteger

min: 1; max: 500

cursorstring

min length: 1; max length: 1000

includeInvoicedCustomerAggregatesboolean

canceledNachaVersionIdstring

format: uuid

agingAsOfstring

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/workbench' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "side": "ap",
  "stages": [
    "delivered"
  ]
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.contractVersionstringrequired

data.scopeobjectrequired

data.rowsarray<object>required

data.pageobjectrequired

data.countsobjectrequired

data.totalsarray<object>required

data.invoicedCustomerAggregatesarray<object>required

data.parityGapsarray<object>required

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