Skip to main content
POST
Send AR statement to a single customer

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.

Path Parameters

account_id
string<uuid>
required

Customer account UUID. Must belong to the calling entity (Layer 1).

Body

application/json
to_email
string<email>

Override recipient. Defaults to accounts.email lookup. Required if account has no email on file.

from
string<date>

Statement period start (ISO date).

to
string<date>

Statement period end (ISO date).

custom_message
string

Optional one-time message rendered into the statement_email template.

Response

Send result

success
boolean
sent_to
string<email>
send_result
object

Postmark send response (message_id + accepted_at).

skipped
boolean

True when gated by notification preference; success=false in that case.

reason
string | null

Populated when skipped=true (e.g. 'notification_disabled').

preference
string | null

Populated when skipped=true (the notification key that gated).