Skip to main content
POST
Create sale/purchase entry (Multiple plans)
Learn more:
  • How do sales and purchase entries work? ↗
  • What is analytical accounting? ↗
  • How to select the right accounts in invoices? ↗
  • How to use analytical plans and accounts in Chift? ↗
  • What are the invoice amounts validation rules? ↗

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
folder_id
string | null

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

​
force_financial_period
string | null

Forces financial period in which the invoice must be created. This will create the invoice in the forced financial period rather than the current period. The format is: mmYYYY.

​
regroup_lines
enum<string> | null
default:true

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

Available options:
true,
false
​
ignore_accounting_id
boolean
default:false

If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call.

​
force_currency_exchange
boolean | null
default:false

Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software.

Body

application/json
​
invoice_type
enum<string>
required

Specifies the type of invoice

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

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

Example:

"EUR"

​
untaxed_amount
number
required

Total amount of the invoice excluding taxes.

Example:

200

​
tax_amount
number
required

Total amount of tax applied to the invoice

Example:

42

​
total
number
required

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

Example:

242

​
invoice_date
string<date>
required

Accounting date of the invoice (format: YYYY-MM-DD).

Example:

"2026-01-15"

​
due_date
string<date>
required

Due date for payment or settlement (format: YYYY-MM-DD).

Example:

"2026-02-14"

​
lines
InvoiceLineItemInMultiAnalyticPlans · object[]
required
​
invoice_number
string | null

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. On the purchase side some tools store the supplier's own invoice number here, so it is not necessarily unique across suppliers.

​
reference
string | null

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.

Example:

"INV-2026-0001"

​
payment_communication
string | null

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

Example:

"+++000/0000/00000+++"

​
customer_memo
string | null

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.

Example:

"Thank you for your business."

​
payment_term_id
string | null

Technical ID of the payment term associated with the invoice.

Example:

"<accounting-payment-term-id>"

​
withholding_tax
WithholdingTax · object | null

Withholding-tax information for the invoice. A withholding tax is paid to the government directly by the payer rather than by the recipient: the payer deducts it before paying the recipient, reducing the amount received (e.g. an employer remitting salary tax). In Chift use cases this is mainly seen in Spain.

​
partner_id
string | null

Id of the related third party (supplier or customer) in the accounting software. Used to link the invoice to the corresponding client or supplier record in the accounting system.

Minimum string length: 1
Example:

"<accounting-client-id>"

​
journal_id
string | null

Identifier of the journal for the invoice. If not provided, the journal will be set automatically if only one exists; otherwise, an error will be thrown.

Example:

"<accounting-journal-id>"

​
status
enum<string> | null
default:posted

string indicating if invoice has been posted (finalized) in the accounting system.

Available options:
draft,
posted
​
pdf
string | null

Base 64 string representing the PDF attached to the invoice.

​
pdf_name
string | null

A name for the PDF file to be created for accounting software that support it.

Required string length: 1 - 200
Pattern: ^[a-zA-Z0-9\-_ ]{1,196}(?:.pdf)?$
​
currency_exchange_rate
number | null
default:1

Exchange rate from the invoice currency to the folder's base currency, applicable at the date of the invoice. Required when the invoice currency is different from the folder's default currency.

​
invoice_correction
InvoiceCorrection · object | null

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

​
nl_payment_terms_split
NlPaymentTermsSplit · object | null

NL only - For Dutch split payment compliance (G/N-rekening): use to specify how invoice amounts are divided between a blocked (G) and normal (N) account in high-risk sectors (e.g., construction, staffing).

​
shipping_country
string | null

Format: ISO 3166-1 codes.

Example:

"BE"

​
partner_info
AccountToCreate · object | null

Information about the client/supplier that must be created. In some tools we cannot create a client/supplier by API. Missing clients/suppliers must be explicitly provided during the invoice creation and will be automatically created by the accounting software. This is for example the case for Tiime.

​
start_date
string<date> | null

Start date of the period covered by the invoice (format: YYYY-MM-DD). This field should be used when the invoice relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins.

Example:

"2026-01-01"

​
end_date
string<date> | null

End date of the period covered by the invoice (format: YYYY-MM-DD). This field should be used when the invoice relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends.

Example:

"2026-01-31"

​
payment_method_id
string | null

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

Example:

"<accounting-payment-method-id>"

​
delivery_date
string<date> | null

Date on which the goods were delivered or the service was provided (format: YYYY-MM-DD). Used to assign the invoice and its tax to the correct period when it differs from the invoice date.

Example:

"2026-01-15"

Response

Successful Response

​
invoice_type
enum<string>
required

Specifies the type of invoice

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

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

Example:

"EUR"

​
untaxed_amount
number
required

Total amount of the invoice excluding taxes.

Example:

200

​
tax_amount
number
required

Total amount of tax applied to the invoice

Example:

42

​
total
number
required

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

Example:

242

​
invoice_date
string<date>
required

Document date of the invoice. It can differ from the accounting date/period that determines the book year. It is automatically set to '1970-01-01' if the value is empty in the accounting system.

Example:

"2026-01-15"

​
due_date
string<date>
required

Last due date of the invoice, normally on or after the invoice date. The invoice date is used when this information is not given by the software.

Example:

"2026-02-14"

​
lines
InvoiceLineItemOutMultiAnalyticPlans · object[]
required
​
invoice_number
string | null

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. On the purchase side some tools store the supplier's own invoice number here, so it is not necessarily unique across suppliers.

​
reference
string | null

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.

Example:

"INV-2026-0001"

​
payment_communication
string | null

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

Example:

"+++000/0000/00000+++"

​
customer_memo
string | null

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.

Example:

"Thank you for your business."

​
payment_term_id
string | null

Technical ID of the payment term associated with the invoice.

Example:

"<accounting-payment-term-id>"

​
withholding_tax
WithholdingTax · object | null

Withholding-tax information for the invoice. A withholding tax is paid to the government directly by the payer rather than by the recipient: the payer deducts it before paying the recipient, reducing the amount received (e.g. an employer remitting salary tax). In Chift use cases this is mainly seen in Spain.

​
id
string | null
Example:

"<this-invoice-id>"

​
delivery_date
string<date> | null

Date on which the goods were delivered or the service was provided (format: YYYY-MM-DD), when the accounting system exposes it.

Example:

"2026-01-15"

​
partner_id
string | null
Example:

"<accounting-client-id>"

​
journal_id
string | null

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.

Example:

"<accounting-journal-id>"

​
payments
Payment · object[] | null
​
status
enum<string> | null
default:posted
Available options:
cancelled,
draft,
posted,
paid
​
last_updated_on
string<date-time> | null

The last time the invoice has been updated.

Example:

"2026-01-15T10:30:00Z"

​
partner
Partner · object | null

Extra information about the partner (client/supplier) linked to the invoice. To ensure this information is returned, you need to use the include_partner_info query parameter.

​
due_dates
InvoiceItemDueDatesOut · object[] | null

List of all due dates of the invoice.

​
attachments_info
ItemAttachmentInfoOut · object

Indicates whether a file attachment (e.g. PDF or image) is linked to this invoice and how to retrieve it. Check the status field: 'yes' means a direct download URL is available in the attachments array; 'yes_to_request' means the file exists but must be fetched separately via GET /accounting/attachments?type=invoice&document_id={id}, which returns the file as a base64-encoded string. 'no' means no attachment is linked. 'unknown' means the connector does not support this.

​
accounting_info
AccountingInfoOut · object | null

Additional information about the invoice.

​
payment_method_id
string | null

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.

Example:

"<accounting-payment-method-id>"

​
approval_status
enum<string>
default:unknown

Approval status of the invoice.

Available options:
unknown,
pending,
approved,
rejected