API documentation | API docs for agents | OpenAPI 3.1

send-invoices

ark.send_customer_invoices

Sends selected ready customer invoice emails in one AR workflow, marks successful customer payments invoiced, returns per-payment failures, and can optionally queue QuickBooks invoice sync.

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

customerPaymentIdsarray<string>required

Visible READY customer payment IDs whose invoice emails should be sent in one AR workflow.

min items: 1; max items: 100

queueQuickBooksSyncboolean

Queue QuickBooks customer invoice sync after each successful invoice email.

default: false

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/customer-payments/send-invoices' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "customerPaymentIds": [
    "<customerPaymentIds>"
  ]
}'

Success response

Sent customer invoices

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.customerPaymentIdsarray<string>required

data.requestedCountintegerrequired

min: 0

data.sentCountintegerrequired

min: 0

data.failedCountintegerrequired

min: 0

data.invoicesarray<object>required

data.failuresarray<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