Skip to main content
POST
Bulk send AR statements

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Body

application/json
account_ids
string<uuid>[]

Explicit list of customer account UUIDs to send to. When set, overrides filter.

filter
object

Filter-driven eligibility when account_ids is omitted. Mirrors the AR Aging filter set.

from
string<date>

Statement period start (ISO date). Defaults to first day of previous calendar month.

to
string<date>

Statement period end (ISO date). Defaults to last day of previous calendar month.

dry_run
boolean
default:false

Preview mode: returns eligible recipients with skip reasons without sending any email.

Response

Batch send results

batch_id
string<uuid>
dry_run
boolean
period
object
summary
object
results
object[]