API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/loads/{loadId}/billing-readiness
ark.get_load_billing_readiness
Returns billing readiness for a visible load, including required file coverage, missing document types, customer payment state, and blocking reasons.
- Availability
- Core 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
loadIdpathstringrequired- format: uuid
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/loads/<loadId>/billing-readiness' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Load billing readiness
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.loadIdstringrequiredformat: uuid
data.loadobjectrequireddata.statusstring | nullrequireddata.loadSizestring | nullrequireddata.requiredFileTypesarray<string>requireddata.presentFileTypesarray<string>requireddata.missingRequiredFileTypesarray<string>requireddata.podRequirementExemptbooleanrequireddata.filesarray<object>requireddata.dispatchStatusesarray<string>requireddata.customerPaymentobject | nullrequireddata.readyForBillingPacketbooleanrequireddata.blockingReasonsarray<string>requiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found