v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Invoices

Create sale/purchase entry (Multiple plans)

Create a new sale/purchase entry with multiple analytic plans in the accounting

post/consumers/{consumer_id}/accounting/invoices/multi-analytic-plans

Path parameters

consumer_idstring uuid 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.

force_financial_periodstring nullable

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'true' | 'false'

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

ignore_accounting_idboolean

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_exchangeboolean nullable

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

Request body

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.

invoice_datestring date required

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

due_datestring date required

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

partner_idstring nullable

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.

journal_idstring nullable

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.

status'draft' | 'posted'

pdfstring nullable

Base 64 string representing the PDF attached to the invoice.

pdf_namestring nullable

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

currency_exchange_ratenumber nullable

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

shipping_countrystring nullable

Format: ISO 3166-1 codes.

start_datestring date nullable

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.

end_datestring date nullable

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.

payment_method_idstring nullable

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.

Response

Successful Response

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

invoice_numberstring nullable

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

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"
  }
}