> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Send AR statement to a single customer
> Required API key scope: `accounting:read`
Sends an AR statement to a single customer account for the requested period. The
per-account counterpart to the bulk endpoint above; mirrors the same template,
gating, and 4-layer customer-email guard.
**Industry parity:** NetSuite "Email Statement" single-customer action, QuickBooks
Online single-customer Statements view, Acumatica per-customer statement send.
**Email gating:** subject to the entity `statement_email` notification toggle
(default OFF) and per-account opt-out + global unsubscribe + template unsubscribe.
When gated, returns `{ skipped: true, reason: 'notification_disabled', preference }`
with HTTP 200; the call still succeeds at the API contract level.
## OpenAPI
````yaml /openapi.yaml post /accounting/statements/{account_id}/send
openapi: 3.1.0
info:
title: Arcus ERP Public API
version: 1.0.0
description: >
Arcus ERP public REST API. Designed for external integrations and data
migration.
**Authentication.** Bearer token (API key) via the `Authorization` header.
Format: `Authorization: Bearer ark_live_ent__` (or
`ark_test_*` for sandbox).
API keys are issued per-entity in **Settings > Developers > API Keys**.
**Entity scoping.** The entity is encoded in the API key prefix; routes are
flat
(e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
endpoints
(migration, reconciliation, events, webhook endpoints, API keys) use the
`/v1/entities/{entity_id}/...` form -- those are noted in their tags.
**Key capabilities.**
- Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
- Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
- Idempotency via the `Idempotency-Key` header.
- Webhook events for asynchronous notification.
- Conditional requests / ETag for cache validation.
servers:
- url: https://api.arcuserp.com/v1
description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
- url: https://dev-api.arcuserp.com/v1
description: >-
Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
RDS)
security: []
paths:
/accounting/statements/{account_id}/send:
post:
tags:
- Accounting
summary: Send AR statement to a single customer
description: >
Required API key scope: `accounting:read`
Sends an AR statement to a single customer account for the requested
period. The
per-account counterpart to the bulk endpoint above; mirrors the same
template,
gating, and 4-layer customer-email guard.
**Industry parity:** NetSuite "Email Statement" single-customer action,
QuickBooks
Online single-customer Statements view, Acumatica per-customer statement
send.
**Email gating:** subject to the entity `statement_email` notification
toggle
(default OFF) and per-account opt-out + global unsubscribe + template
unsubscribe.
When gated, returns `{ skipped: true, reason: 'notification_disabled',
preference }`
with HTTP 200; the call still succeeds at the API contract level.
operationId: sendStatementV1
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
description: Customer account UUID. Must belong to the calling entity (Layer 1).
requestBody:
content:
application/json:
schema:
type: object
properties:
to_email:
type: string
format: email
description: >-
Override recipient. Defaults to accounts.email lookup.
Required if account has no email on file.
from:
type: string
format: date
description: Statement period start (ISO date).
to:
type: string
format: date
description: Statement period end (ISO date).
custom_message:
type: string
description: >-
Optional one-time message rendered into the statement_email
template.
responses:
'200':
description: Send result
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
sent_to:
type: string
format: email
send_result:
type: object
description: Postmark send response (message_id + accepted_at).
skipped:
type: boolean
description: >-
True when gated by notification preference; success=false
in that case.
reason:
type: string
nullable: true
description: >-
Populated when skipped=true (e.g.
'notification_disabled').
preference:
type: string
nullable: true
description: >-
Populated when skipped=true (the notification key that
gated).
'400':
description: Missing email + no override, or invalid path param
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
$ref: '#/components/responses/Error'
'403':
$ref: '#/components/responses/Error'
'404':
description: Account not found for the calling entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- ApiKeyAuth: []
components:
schemas:
Error:
description: |
Alias for ErrorEnvelope. Canonical error response shape used by all
API endpoints. Refer to ErrorEnvelope for the full field definition.
allOf:
- $ref: '#/components/schemas/ErrorEnvelope'
ErrorEnvelope:
type: object
description: |
Canonical error response envelope. All API errors use this shape.
required:
- error
- code
properties:
error:
type: string
description: Machine-readable error key
example: not_found
code:
type: string
description: Machine-readable error code (often same as error)
example: not_found
type:
type: string
enum:
- validation_error
- permission_error
- not_found
- conflict
- rate_limit
- internal
- expand_error
- not_implemented
example: not_found
hint:
type: string
description: Human-readable one-sentence explanation (English)
example: >-
The requested order does not exist or does not belong to this
entity.
param:
type: string
description: The parameter that caused the error, if applicable
example: expand[0]
required:
type: string
description: The scope required (only on insufficient_scope errors)
example: accounts:read
request_id:
type: string
description: >-
Unique request ID for support tracing (maps to CloudWatch log
stream)
example: req_abc123
responses:
Error:
description: Error response (400/401/403/404/409/422/429/500)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
description: |
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.
````