v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Invoices

Get one invoice (sale/purchase entry)

Returns a specific invoice (sale/purchase entry). Each line will include the analytic account linked to default analytic plan

get/consumers/{consumer_id}/accounting/invoices/{invoice_id}

Path parameters

consumer_idstring uuid required

invoice_idstring required

Query parameters

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.

include_payments'true' | 'false'

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

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.

Response

Successful Response

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

invoice_numberstring nullable

Unique 'number' of the invoice instance in the accounting software. This is an internal reference number. if not specified, will be automatically generated according to the system’s numbering rules. It does not necessarily match the number displayed on an invoice.It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details

currencystring required

Code (e.g., USD, EUR) of the currency used for invoice amounts.

untaxed_amountnumber required

Total amount of the invoice excluding taxes.

tax_amountnumber required

Total amount of tax applied to the invoice

totalnumber required

Total amount of the invoice, including taxes (untaxed_amount + tax_amount).

referencestring nullable

Optional reference field used to store an external or contextual identifier related to the entry. For purchase invoices, it typically contains the invoice number issued by the supplier. For sales invoices, it may reference a quote number or any other relevant document. Unlike number, this field is not subject to specific format or character restrictions and can hold free-form text.

payment_communicationstring nullable

Field containing the payment reference or communication associated with the invoice (e.g., bank transfer reference, SEPA remittance message). Often used for reconciliation purposes.

customer_memostring nullable

Internal or external note associated with the invoice, typically intended for the customer. Can include additional context, comments, or special instructions related to the transaction.

payment_term_idstring nullable

Technical ID of the payment term associated with the invoice.

idstring nullable

invoice_datestring date required

Accounting invoice date. It is automatically set to '1970-01-01' if the value is empty in the accounting system.

due_datestring date required

Last Due date of the invoice. The invoice date is used when this information is not given by the software.

partner_idstring nullable required

journal_idstring nullable

Indicates the journal used in for the invoice. If the journal is not given, the journal will be automatically set if only one journal exists otherwise an error will be thrown.

status'cancelled' | 'draft' | 'posted' | 'paid'

last_updated_onstring date-time nullable

The last time the invoice has been updated.

payment_method_idstring nullable

Technical ID of the payment method in the accounting system. This is the payment method currently linked to the invoice. It is not necessarily the payment method that will eventually be used to pay the invoice.

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

Example response

{
  "accounting_info": {
    "main_currency": "EUR",
    "account_number": "411001"
  }
}