API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/billing/carrier-ach-files

ark.list_carrier_ach_files

Lists visible carrier ACH/NACHA batches for reconciliation with status, effective-date, file-name, and batch-number filters.

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: GENERATED, UPLOADED, PROCESSED, REJECTED
date_fromquerystring
date_toquerystring
searchquerystring
File-name or batch-number search.
min length: 1; max length: 100
limitqueryinteger
default: 25; min: 1; max: 100
offsetqueryinteger
default: 0; min: 0

Request body

None.

Example request

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

Success response

Carrier ACH files

objectstringrequired
okbooleanrequired
api_versionstringrequired
request_idstringrequired
dataobjectrequired

Errors

HTTP 400
Invalid request
HTTP 401
Authentication required
HTTP 403
Permission, scope, team, or entitlement denied