v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Invoices

Get invoices by type (sale/purchase entries)

Returns a list of invoices by a specific type (=sale/purchase entries). Each line of the invoice will include the analytic account linked to default analytic plan. Optionally dates can be defined to retrieve invoice from a certain date to another date

get/consumers/{consumer_id}/accounting/invoices/type/{invoice_type}

Path parameters

consumer_idstring uuid required

invoice_type'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' required

Query parameters

pageinteger

Page number

sizeinteger

Page size

folder_idstring nullable

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

date_fromstring date nullable

date_tostring date nullable

journal_idsstring nullable

Journal Ids used to filter the invoices. The Ids are separated by ','

include_payments'true' | 'false'

Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null.

payment_status'all' | 'unpaid' | 'paid'

Extra filter to retrieve invoices with a specific payment status.

updated_afterstring date-time nullable

Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

include_invoice_lines'true' | 'false'

Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API.

include_partner_info'true' | 'false'

Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved.

approval_status'pending' | 'approved' | 'rejected'

Filter invoices by approval status.

Response

Successful Response

totalinteger required

pageinteger required

sizeinteger required

Example response

{
  "items": [
    {
      "accounting_info": {
        "main_currency": "EUR",
        "account_number": "411001"
      }
    }
  ]
}