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

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
invoice_id
string
required
​
consumer_id
string
required

Query Parameters

​
include_payments
enum<string>
default:
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.

Available options:
true,
false
​
folder_id
string

Accounting folder ID, this needs to be passed when activating the multiple folders feature.

Response

200 - application/json
​
currency
string
required

Indicates the currency of the invoice (e.g. EUR).

​
due_date
string
required

Due date of the invoice. We use the value of the invoice date if the value is not available/empty in the accounting system.

​
invoice_date
string
required

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

​
invoice_type
enum<string>
required

An enumeration.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund
​
journal_id
string
required

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.

​
lines
object[]
required
​
partner_id
string
required
​
tax_amount
number
required
​
total
number
required
​
untaxed_amount
number
required
​
customer_memo
string
​
id
string
​
invoice_number
string

Number of the invoice. If left empty, will be automatically generated by the accounting system at creation.

​
payment_communication
string
​
payments
object[]
​
reference
string
​
status
enum<string>
default:
posted

An enumeration.

Available options:
cancelled,
draft,
posted,
paid
Get invoices by type (sale/purchase entries)Get one invoice (sale/purchase entry - Multiple Analytic Plans)