API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/billing/invoice-batches/status

ark.get_customer_invoice_batch_status

Get Customer Invoice Batch Status 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

batchIdquerystringrequired: format: uuid

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/billing/invoice-batches/status?batchId=<batchId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.batchobjectrequired

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