API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/billing/carrier-settlements/{settlementNumber}

ark.get_carrier_settlement

Returns one visible carrier settlement group with the payment rows needed to review or confirm AP settlement actions.

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

settlementNumberpathintegerrequired

min: 1

Request body

None.

Example request

curl 'https://arktms.com/api/v1/billing/carrier-settlements/<settlementNumber>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Carrier settlement

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied

HTTP 404

Resource not found