API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/billing/customer-payments

ark.list_customer_payments

Lists visible customer billing rows with invoice, payment, hold, POD, remit profile, and carrier payment context for AR workflows.

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: DELIVERED, READY, INVOICED, FACTORED, PAID

customer_idquerystring

format: uuid

pay_holdquerystring

one of: all, yes, no; default: "all"

has_podquerystring

one of: all, yes, no; default: "all"

delivery_date_fromquerystring

delivery_date_toquerystring

invoiced_date_fromquerystring

invoiced_date_toquerystring

paid_date_fromquerystring

paid_date_toquerystring

searchquerystring

Search across load number, customer, invoice, reference, document number, remit profile, pickup number, PO, BOL, origin, and destination.

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/customer-payments' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Customer payments

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied