Skip to main content
POST
Invoices Report
Generate a report for the paid and pending invoices in a date range. The endpoint sends an Excel .xls file to each valid recipient. It does not return the file in the HTTP response. The full endpoint is POST /api/v1/reports/invoices.

Endpoint errors

For authentication, permissions, rate limits, and safe retries, see Errors and Retries.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Body

application/json
recipients
string[]
required

Items are trimmed and lowercased; empty strings are ignored and duplicates are removed. Every remaining value must be an email address, and at most 10 unique nonempty recipients may remain.

Minimum array length: 1
start_date
string<date>
required
end_date
string<date>
required

Response

Report send attempts completed.

success
boolean
required
data
object
required
message
string
pagination
object
Last modified on September 8, 2026