curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/pms/invoices \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"invoice_number": "INV-12345",
"creation_date": "2023-10-01T12:00:00",
"closing_date": "2023-10-10T12:00:00",
"partners": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "account",
"address": {
"address_type": "home",
"name": "Home",
"street": "Main Street",
"number": "123",
"box": "A",
"city": "Paris",
"postal_code": "75000",
"country": "FR"
},
"first_name": "John",
"last_name": "Doe",
"company_name": "Acme Corp"
}
],
"items": [
{
"id": "123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "product",
"menu_id": "456",
"quantity": 1,
"unit_price": 10,
"total": 11,
"tax_amount": 1,
"tax_rate": 10,
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"payments": [
{
"id": "payment-123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"total": 11,
"tip": 1,
"status": "Completed",
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"partner_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
}
}
],
"service_id": "<string>",
"reservation": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"start_date": "2024-10-01T12:00:00",
"end_date": "2024-10-10T12:00:00",
"creation_date": "2024-09-25T12:00:00",
"resource_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"resource_name": "Room 101",
"resource_identifier": "R101"
},
"tax_amount": 21,
"untaxed_amount": 100,
"total": 121
}
],
"total": 1,
"page": 2,
"size": 2
}
Returns a list of the invoices
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/pms/invoices \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"invoice_number": "INV-12345",
"creation_date": "2023-10-01T12:00:00",
"closing_date": "2023-10-10T12:00:00",
"partners": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "account",
"address": {
"address_type": "home",
"name": "Home",
"street": "Main Street",
"number": "123",
"box": "A",
"city": "Paris",
"postal_code": "75000",
"country": "FR"
},
"first_name": "John",
"last_name": "Doe",
"company_name": "Acme Corp"
}
],
"items": [
{
"id": "123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "product",
"menu_id": "456",
"quantity": 1,
"unit_price": 10,
"total": 11,
"tax_amount": 1,
"tax_rate": 10,
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"payments": [
{
"id": "payment-123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"total": 11,
"tip": 1,
"status": "Completed",
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"partner_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
}
}
],
"service_id": "<string>",
"reservation": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"start_date": "2024-10-01T12:00:00",
"end_date": "2024-10-10T12:00:00",
"creation_date": "2024-09-25T12:00:00",
"resource_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"resource_name": "Room 101",
"resource_identifier": "R101"
},
"tax_amount": 21,
"untaxed_amount": 100,
"total": 121
}
],
"total": 1,
"page": 2,
"size": 2
}
This access token needs to be included in each of your request to the Chift API.
Page number
x >= 1
Page size
1 <= x <= 100
Successful Response
The response is of type object
.