v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Invoicing
Invoices

Retrieve all invoices

Returns a list of invoices. Optionally invoice type and dates can be defined to retrieve invoices of a certain type from a certain date to another date

get/consumers/{consumer_id}/invoicing/invoices

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

date_fromstring date nullable
date_tostring date nullable
invoice_type'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' | 'all'
payment_status'all' | 'unpaid' | 'paid'
updated_afterstring date-time nullable
include_invoice_lines'true' | 'false'

Include the invoice lines in the response. By default, invoice lines are included when no extra request is needed to fetch them. If you want to include them explicitly, set this parameter to true.

include_analytic_accounts'true' | 'false'

Include analytic accounts in the response

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required