POST
/
consumers
/
{consumer_id}
/
accounting
/
invoices

Authorizations

Authorization
string
header
required

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

Path Parameters

consumer_id
string
required

Query Parameters

force_financial_period
string

Financial period in which the invoice must be created. The format is the following: mmYYYY.

regroup_lines
enum<string>
default:
true

Regroup lines by account number, tax code and analytic account in the accounting system.

Available options:
true,
false
folder_id
string

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

Body

application/json
currency
string
required

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

due_date
string
required
invoice_date
string
required
invoice_type
enum<string>
required

An enumeration.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund
lines
object[]
required
partner_id
string
required
Minimum length: 1
tax_amount
number
required
total
number
required
untaxed_amount
number
required
currency_exchange_rate
number
default:
1

Indicates the exchange rate at the date of the invoice. Must be filled in when creating the invoice in another currency from the default currency of the accounting system.

customer_memo
string
invoice_correction
object

Information used to add a correction line when roundings have an impact on the total amount of the invoice.

invoice_number
string

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

journal_id
string

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.

nl_payment_terms_split
object
payment_communication
string
pdf
string

Base 64 string representing the PDF attached to the sale/purchase entry.

reference
string
shipping_country
string
status
enum<string>
default:
posted

An enumeration.

Available options:
draft,
posted

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