Get invoices by type (sale/purchase entries)

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

required

invoice_type

enum<string>

required

Available options:

customer_invoice,

customer_refund,

supplier_invoice,

supplier_refund

Query Parameters

page

integer

default:1

Page number Page number

Required range: x >= 1

size

integer

default:50

Page size Page size

Required range: 1 <= x <= 100

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.

date_from

string<date> | null

date_to

string<date> | null

journal_ids

string | null

Journal Ids used to filter the invoices. The Ids are separated by ','

include_payments

enum<string> | null

default:false

Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null.

Available options:

true,

false

payment_status

enum<string> | null

default:all

Extra filter to retrieve invoices with a specific payment status.

Available options:

all,

unpaid,

paid

updated_after

string<date-time> | null

Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

include_invoice_lines

enum<string> | null

default:false

Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API.

Available options:

true,

false

include_partner_info

enum<string> | null

default:false

Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved.

Available options:

true,

false

Response

Successful Response

items

InvoiceItemOutMonoAnalyticPlan · object[]

required

Show child attributes

items.invoice_type

enum<string>

required

Specifies the type of invoice

Available options:

customer_invoice,

customer_refund,

supplier_invoice,

supplier_refund

items.currency

string

required

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

items.untaxed_amount

number

required

Total amount of the invoice excluding taxes.

items.tax_amount

number

required

Total amount of tax applied to the invoice

items.total

number

required

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

items.invoice_date

string<date>

required

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

items.due_date

string<date>

required

Last Due date of the invoice. The invoice date is used when this information is not given by the software.

items.partner_id

string | null

required

items.lines

InvoiceLineItemOutMonoAnalyticPlan · object[]

required

Show child attributes

items.lines.unit_price

number

required

Unit price of the item, before tax.

items.lines.quantity

number

required

Quantity of items. This is the amount of units sold or purchased.

items.lines.untaxed_amount

number

required

Amount excluding tax for the line item (i.e., unit_price × quantity).

items.lines.tax_rate

number

required

Tax rate used for the line (e.g., 21.0).

items.lines.tax_amount

number

required

Tax amount calculated for the line (i.e. untaxed_amount * tax_rate).

items.lines.total

number

required

Total amount for the item, including tax (untaxed_amount + tax_amount).

items.lines.line_number

integer | null

default:1

Optional line sequence number used to preserve the order of invoice items.

items.lines.unit_of_measure

string | null

A list of default units can be used for which an advanced mapping has been done (units: 'hour', 'day', 'cm', 'm2', 'm3', 'm', 'km', 'mile', 'g', 'kg', 'ton', 'box', 'pallet', 'roll', 'liter', 'unit'). Custom units of measure must have an identical name in the target software.

items.lines.account_number

string | null

Ledger account number (of type general) used for the line (e.g., 701000).

items.lines.tax_code

string | null

Indicates the tax code used for the line. This is the Id of the Tax Code in the accounting software.

items.lines.description

string | null

default:""

Text description for this line.

items.lines.analytic_account

string | null

Analytic account in the default analytic plan.

items.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

items.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.

items.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.

items.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.

items.id

string | null

items.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.

items.payments

Payment · object[] | null

Show child attributes

items.payments.id

string

required

items.payments.name

string

required

items.payments.currency

string

required

items.payments.amount

number

required

Total amount of the payment. A part of this amount could be reconciled with another invoice.

items.payments.payment_date

string<date>

required

items.payments.journal_type

enum<string>

required

Available options:

customer_invoice,

customer_refund,

supplier_invoice,

supplier_refund,

financial_operation,

miscellaneous_operation,

unknown

items.payments.journal_id

string

required

items.payments.journal_name

string

required

items.payments.dedicated_amount

number

default:0

Amount of the payment dedicated to the invoice.

items.payments.reconciled

boolean | null

default:false

items.payments.communication

string | null

items.payments.matching_number

string | null

items.status

enum<string> | null

default:posted

Available options:

cancelled,

draft,

posted,

paid

items.last_updated_on

string<date-time> | null

The last time the invoice has been updated.

items.partner

Partner · object

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.

Show child attributes

items.partner.external_reference

string | null

External identifier used to link the client in the accounting system with the corresponding client reference in your own system.

items.partner.first_name

string | null

Only used when the client is an individual (is_company=false). Indicates the first name of the client.

items.partner.last_name

string | null

Only used when the client is an individual (is_company=false). Indicates the last name of the client.

items.partner.name

string | null

Full name or legal name of the client (individual or company). This is the name displayed in the accounting software.

items.partner.function

string | null

Only used when the client is an individual (is_company=false). Indicates the function of the client.

items.partner.is_company

boolean | null

default:true

Indicates if the client is an individual or a company.

items.partner.company_id

string | null

Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client.

items.partner.phone

string | null

Phone number of the client.

items.partner.mobile

string | null

Mobile phone number of the client.

items.partner.email

string | null

Email address of the client.

items.partner.language

string | null

Language of the client. Format: ISO 639-1 codes.

items.partner.internal_notes

string | null

Internal notes about the client.

items.partner.website

string | null

Website of the client.

items.partner.vat

string | null

VAT number of the client.

items.partner.iban

string | null

IBAN account number of the client.

items.partner.bank_account

string | null

Bank account number of the client.

items.partner.currency

string | null

Indicates the currency of the client (e.g., EUR).

items.partner.active

boolean | null

default:true

Indicates if the client is active.

items.partner.account_number

string | null

Ledger account number assigned to the customer in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.).

items.partner.company_number

string | null

Id of the associated company, used when the record is a contact person linked to a company.

items.partner.id

string | null

Id of the client in the accounting software. This is the unique identifier used to reference the client in the system.

items.partner.last_updated_on

string<date-time> | null

The last time the client has been updated.

items.partner.addresses

AddressItemOut · object[] | null

List of addresses associated with the client.

Show child attributes

items.partner.addresses.address_type

enum<string>

required

Available options:

main,

delivery,

invoice

items.partner.addresses.name

string | null

items.partner.addresses.number

string | null

items.partner.addresses.box

string | null

items.partner.addresses.phone

string | null

items.partner.addresses.mobile

string | null

items.partner.addresses.email

string | null

items.partner.addresses.street

string | null

items.partner.addresses.city

string | null

items.partner.addresses.postal_code

string | null

items.partner.addresses.country

string | null

Format: ISO 3166-1 codes.

items.due_dates

InvoiceItemDueDatesOut · object[] | null

List of all due dates of the invoice.

Show child attributes

items.due_dates.due_date

string<date>

required

Due date of the item.

items.due_dates.amount

number

required

Amount due for the invoice on that due date. A positive amount represents debit on customer invoices and supplier refunds or credit on supplier invoices and customer refunds. A negative amount represents credit on customer invoices and supplier refunds or debit on supplier invoices and customer refunds.

items.due_dates.payment_method

string | null

Payment method used to pay the invoice on that due date.

items.attachments_info

ItemAttachmentInfoOut · object

Extra information about the attachments linked to the invoice.

Show child attributes

items.attachments_info.status

enum<string>

required

The status of the attachment.'yes' means the attachment can be returned directly.'yes_to_request' means an additional request is required.'no' means there is no attachment.'unknown' means we can not yet determine if an attachment is available.

Available options:

unknown,

yes,

yes_to_request,

no

items.attachments_info.attachments

ItemAttachmentInfoAttachment · object[] | null

Show child attributes

items.attachments_info.attachments.filename

string | null

The name of the attachment.

items.attachments_info.attachments.url

string | null

The URL to download the file.

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get invoices by type (sale/purchase entries)

Authorizations

Path Parameters

Query Parameters

Response