Skip to main content
GET
/
consumers
/
{consumer_id}
/
accounting
/
invoices
/
{invoice_id}
Get one invoice (sale/purchase entry)
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'
{
  "invoice_type": "customer_invoice",
  "invoice_number": "<string>",
  "currency": "<string>",
  "untaxed_amount": 123,
  "tax_amount": 123,
  "total": 123,
  "reference": "<string>",
  "payment_communication": "<string>",
  "customer_memo": "<string>",
  "id": "<string>",
  "invoice_date": "2023-12-25",
  "due_date": "2023-12-25",
  "partner_id": "<string>",
  "journal_id": "<string>",
  "payments": [
    {
      "id": "<string>",
      "name": "<string>",
      "currency": "<string>",
      "amount": 123,
      "dedicated_amount": 0,
      "payment_date": "2023-12-25",
      "journal_type": "customer_invoice",
      "journal_id": "<string>",
      "journal_name": "<string>",
      "reconciled": true,
      "communication": "<string>",
      "matching_number": "<string>"
    }
  ],
  "status": "cancelled",
  "last_updated_on": "2023-11-07T05:31:56Z",
  "partner": {
    "external_reference": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "function": "<string>",
    "is_company": true,
    "company_id": "<string>",
    "phone": "<string>",
    "mobile": "<string>",
    "email": "<string>",
    "language": "<string>",
    "internal_notes": "<string>",
    "website": "<string>",
    "vat": "<string>",
    "iban": "<string>",
    "bank_account": "<string>",
    "currency": "<string>",
    "active": true,
    "account_number": "<string>",
    "company_number": "<string>",
    "id": "<string>",
    "last_updated_on": "2023-11-07T05:31:56Z",
    "addresses": [
      {
        "address_type": "main",
        "name": "<string>",
        "number": "<string>",
        "box": "<string>",
        "phone": "<string>",
        "mobile": "<string>",
        "email": "<string>",
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      }
    ]
  },
  "due_dates": [
    {
      "due_date": "2023-12-25",
      "payment_method": "<string>",
      "amount": 123
    }
  ],
  "lines": [
    {
      "line_number": 123,
      "unit_price": 123,
      "unit_of_measure": "<string>",
      "quantity": 123,
      "untaxed_amount": 123,
      "tax_rate": 123,
      "tax_amount": 123,
      "total": 123,
      "account_number": "<string>",
      "tax_code": "<string>",
      "description": "<string>",
      "analytic_account": "<string>"
    }
  ]
}

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_id
string
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.

​
include_payments
enum<string> | null
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
​
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

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

​
untaxed_amount
number
required

Total amount of the invoice excluding taxes.

​
tax_amount
number
required

Total amount of tax applied to the invoice

​
total
number
required

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

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

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

​
partner_id
string
required
​
lines
InvoiceLineItemOutMonoAnalyticPlan · 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

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

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

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

​
id
string | null
​
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.

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

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

⌘I