v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Invoicing

Invoices

Retrieve one invoice

Returns a invoice

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

Path parameters

consumer_idstring uuid required

invoice_idstring required

Query parameters

include_pdf'true' | 'false'

Include the invoice PDF as a base64 encoded string in the response

include_analytic_accounts'true' | 'false'

Include analytic accounts in the response

Response

Successful Response

idstring required

Technical id in Chift

currencystring required

Currency matching target sofware name

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

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

invoice_datestring date required

Invoicing date

tax_amountnumber required

Taxes amount

untaxed_amountnumber required

Untaxed amount

totalnumber required

Total amount incl. taxes

partner_idstring nullable

Technical id of the vendor/customer in Chift

invoice_numberstring nullable

Number/sequence

due_datestring date nullable

Due date

referencestring nullable

Reference

payment_communicationstring nullable

Payment communication

customer_memostring nullable

Customer note/memo

last_updated_onstring date-time nullable

outstanding_amountnumber nullable

Amount left to be paid

last_payment_datestring date nullable

Date of the last payment linked to the invoice

accounting_datestring date nullable

Accounting date

payment_method_idstring nullable

Technical id of the payment method in Chift

currency_exchange_ratenumber nullable

Indicates the exchange rate at the date of the invoice.

pdfstring nullable

PDF document in base64