Get Invoice Statement

Changed on

Generates a customer account statement aggregated from payment transactions (not invoices directly) for a given customer or organization. Despite the name, this is a multi-mode endpoint: type: JSON returns the data inline, type: PDF synchronously renders and returns a PDF, and type: SEND synchronously renders and emails it — all three run fully in-request with no job queue, so large date ranges can be slow.

Fields are accepted interchangeably from the request body, query string, or path — the body is canonical.

post/invoice/statement

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/invoice/statement
  • Auth
    API key in header x-api-key

Request body

type'JSON' | 'PDF' | 'SEND'
emailstring

Required when type is SEND.

email_ccstring[]
email_bccstring[]
email_subjectstring
email_bodystring
email_config_uidstring
template_uidstring

A CUSTOMER_STATEMENT-type template uid. If omitted, a built-in fallback template is used.

Response

200

typestring
titlestring
messagestring
dataobject

Present for type=JSON only. type=PDF returns a raw application/pdf body instead.

Example response

{
  "type": "success"
}

Changes