API documentation | API docs for agents | OpenAPI 3.1

send

ark.send_carrier_remittance_email

Sends carrier or factoring remittance emails for selected visible carrier payments or settlement numbers using grouped AP remittance details.

Availability: Expanded preview
Scopes: loads:readbilling:write
ARK permissions: canViewLoadscanViewBillingcanMakeAdjustments
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

remittanceTypestringrequired

Send remittance for selected carrier settlement numbers.

carrierPaymentIdsarray<string>

Visible carrier payment IDs to include in the remittance email.

min items: 1; max items: 100

paymentDatestringrequired

Payment date shown in the email, in YYYY-MM-DD format.

settlementNumbersarray<integer>

Visible carrier settlement numbers to include in the remittance email.

min items: 1; max items: 50

Example request

Shell

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

Success response

Sent carrier remittance email

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.remittanceTypestringrequired

one of: payment, settlement

data.requestedCountintegerrequired

min: 1

data.carrierPaymentCountintegerrequired

min: 1

data.sentGroupCountintegerrequired

min: 0

data.paymentDatestringrequired

data.sentAtstringrequired

format: date-time

data.groupsarray<object>required

data.messagestringrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry
HTTP 422: Invalid request