Get Invoice Statement

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
Defaults to JSON
Allowed:
filter
object
string

Required when type is SEND.

email_cc
array of strings
email_cc
email_bcc
array of strings
email_bcc
string
string
string
string

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/pdf