API documentation | API docs for agents | OpenAPI 3.1

preflight

ark.preflight_carrier_remittance_email

Checks grouped carrier or factoring remittance recipients before sending AP remittance email.

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

None.

Request body

remittanceTypestringrequired

Preflight selected carrier settlement numbers.

carrierPaymentIdsarray<string>

Visible carrier payment IDs to check before sending remittance email.

min items: 1; max items: 100

settlementNumbersarray<integer>

Visible carrier settlement numbers to check before sending remittance email.

min items: 1; max items: 50

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/carrier-remittance-emails/preflight' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "remittanceType": "payment",
  "carrierPaymentIds": [
    "<carrierPaymentIds>"
  ]
}'

Success response

Carrier remittance email preflight

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

Errors

No operation-specific error responses.