Retrieve all invoices

Returns a list of invoices. Optionally invoice type and dates can be defined to retrieve invoices of a certain type from a certain date to another date

GET /consumers/{consumer_id}/invoicing/invoices

Retrieve all invoices

cURL

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices

200

{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "currency": "<string>",
      "invoice_date": "2023-12-25",
      "tax_amount": 123,
      "untaxed_amount": 123,
      "total": 123,
      "lines": [],
      "partner_id": "<string>",
      "invoice_number": "<string>",
      "due_date": "2023-12-25",
      "reference": "<string>",
      "payment_communication": "<string>",
      "customer_memo": "<string>",
      "journal_ref": {
        "id": "<string>",
        "model": "<string>",
        "name": "<string>"
      },
      "italian_specificities": {
        "stamp_duty_amount": 123,
        "withholding_tax": {
          "rate": 123,
          "amount": 123
        },
        "welfare_fund": {
          "rate": 123,
          "amount": 123
        },
        "payment_reporting": {}
      },
      "last_updated_on": "2023-11-07T05:31:56Z",
      "outstanding_amount": 123,
      "last_payment_date": "2023-12-25",
      "accounting_date": "2023-12-25",
      "payment_method_id": "<string>",
      "currency_exchange_rate": 1
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Path Parameters

consumer_id · string<uuid> · required

Query Parameters

page · integer · default: 1

Page number

Required range: x >= 1

size · integer · default: 50

Page size

Required range: 1 <= x <= 100

date_from · string<date> | null

date_to · string<date> | null

invoice_type · enum<string> | null · default: all

Available options: customer_invoice, customer_refund, supplier_invoice, supplier_refund, all

payment_status · enum<string> | null · default: all

Available options: all, unpaid, paid

updated_after · string<date-time> | null

include_invoice_lines · enum<string> | null · default: false

Include the invoice lines in the response. By default, invoice lines are included when no extra request is needed to fetch them. If you want to include them explicitly, set this parameter to true.

Available options: true, false

include_analytic_accounts · enum<string> | null · default: false

Include analytic accounts in the response

Available options: true, false

Response

200

application/json

Successful Response

items · InvoiceItemOut · object[] · required

Show child attributes

total · integer · required

Required range: x >= 0

page · integer · required

Required range: x >= 1

size · integer · required

Required range: x >= 1