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

200
application/json

Successful Response

The response is of type object.