GET
/
consumers
/
{consumer_id}
/
invoicing
/
invoices
Retrieve all invoices
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "currency": "<string>",
      "invoice_type": "customer_invoice",
      "status": "cancelled",
      "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,
          "reason": "RT01",
          "payment_reason": "A"
        },
        "welfare_fund": {
          "rate": 123,
          "amount": 123,
          "type": "TC01"
        },
        "payment_reporting": {
          "method": "MP01",
          "conditions": "TP01"
        }
      },
      "last_updated_on": "2023-11-07T05:31:56Z",
      "outstanding_amount": 123,
      "accounting_date": "2023-12-25",
      "payment_method_id": "<string>",
      "currency_exchange_rate": 123
    }
  ],
  "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<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

Response

Successful Response

​
items
InvoiceItemOut · object[]
required
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
total
integer | null
Required range: x >= 0