Get Started

Email customer statement

POST/api/v1/customer-statements/{customer_id}/send

Build and email an A/R statement to the customer.

Operation ID: send_customer_statement_api_v1_customer_statements__customer_id__send_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

customer_idstringrequired

Request body

Schema: SendStatementRequest

start_datestring · date
end_datestring · date
as_of_datestring · date
custom_messagestring

Optional note included in the email body.

cc_emailstring

Optional address to CC.

Responses

201Successful Response

Schema: SendStatementResponse

statusstringrequired
sent_tostringrequired
closing_balanceintegerrequired

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject