Preview Customer Statement Email
POST/api/customers/:customer/statement/preview
Preview the statement email that a send would produce — the exact From and Reply-To addresses, resolved recipient, subject and body — WITHOUT sending it or logging anything. Use it to show the sender and content before committing to send.
Body is identical to Send Customer Statement: type (required — open_item or activity); for activity, from and to (Y-m-d) are required; as_at (Y-m-d) optionally dates an open-item statement; recipient overrides the customer's billing email; subject and body override the defaults and support the placeholders {customer_name}, {total_due}, {payment_instructions}.
Authentication: Requires Bearer token (PAT).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.