GET
/
consumers
/
{consumer_id}
/
accounting
/
invoices
/
type
/
{invoice_type}
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/invoices/type/{invoice_type} \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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": false,
          "communication": "<string>",
          "matching_number": "<string>"
        }
      ],
      "status": "cancelled",
      "lines": [
        {
          "line_number": 1,
          "description": "<string>",
          "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>",
          "analytic_account": "<string>"
        }
      ]
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

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
required
invoice_type
enum<string>
required

An enumeration.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund

Query Parameters

page
integer
default:1
Required range: x >= 1
size
integer
default:50
Required range: 1 <= x <= 100
folder_id
string
date_from
string
date_to
string
journal_ids
string
include_payments
enum<string>
default:false

An enumeration.

Available options:
true,
false
payment_status
enum<string>
default:all

An enumeration.

Available options:
all,
unpaid,
paid
updated_after
string

Response

200
application/json
Successful Response
items
object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1