API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/billing/carrier-settlements

ark.list_carrier_settlements

Lists visible carrier settlement groups with AP recipient, due date, paid date, amount, and NACHA metadata.

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

statusquerystring

one of: PENDING, PAID

carrier_idquerystring

format: uuid

customer_idquerystring

format: uuid

factoring_idquerystring

format: uuid

payment_methodquerystring

max length: 50

due_date_fromquerystring

due_date_toquerystring

paid_date_fromquerystring

paid_date_toquerystring

nacha_file_idquerystring

format: uuid

nacha_batch_numberqueryinteger

min: 1

searchquerystring

Search across settlement number, load number, carrier, customer, factoring company, invoice, reference, vendor invoice, document number, and NACHA batch.

min length: 1; max length: 100

limitqueryinteger

default: 25; min: 1; max: 100

offsetqueryinteger

default: 0; min: 0

Request body

None.

Example request

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

Success response

Carrier settlements

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied