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",
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"quantity": 123,
"unit_price": 123,
"total": 123,
"tax_amount": 123,
"type": "product",
"menu_id": "456",
"tax_rate": 10,
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"payments": [
{
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"total": 123,
"id": "payment-123",
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"tip": 1,
"status": "Completed",
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"partner_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"description": "Payment for invoice INV-12345"
}
],
"tax_amount": 123,
"untaxed_amount": 123,
"total": 123,
"creation_date": "2023-10-01T12:00:00",
"closing_date": "2023-10-10T12:00:00",
"partners": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "owner",
"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"
}
],
"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"
}
}
],
"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",
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"quantity": 123,
"unit_price": 123,
"total": 123,
"tax_amount": 123,
"type": "product",
"menu_id": "456",
"tax_rate": 10,
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"payments": [
{
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"total": 123,
"id": "payment-123",
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"tip": 1,
"status": "Completed",
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"partner_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"description": "Payment for invoice INV-12345"
}
],
"tax_amount": 123,
"untaxed_amount": 123,
"total": 123,
"creation_date": "2023-10-01T12:00:00",
"closing_date": "2023-10-10T12:00:00",
"partners": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "owner",
"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"
}
],
"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"
}
}
],
"total": 1,
"page": 2,
"size": 2
}This access token needs to be included in each of your request to the Chift API.
Page number Page number
x >= 1Page size Page size
1 <= x <= 100Successful Response
Show child attributes
Technical id in Chift
Number/sequence
"INV-12345"
List of items related to the invoice
Show child attributes
Unique identifier of the order line item
Quantity of the order line item
Unit price (without tax) of the order line item
Total amount including tax of the order line item
Total amount of the taxes of the order line item
Type of the order line item
menu, product, service, general_discount "product"
Unique identifier of the menu
"456"
Tax rate of the order line item
10
Description of the order line item
"Pizza"
List of discounts of the order line item. Discounts of items are always part of the total discount of the order
[]Reference to the product related to this item
"789"
Sometimes used by a POS to give a specific accounting category to an order item
"123"
List of payments related to the invoice
Show child attributes
Total amount of the payment
Unique identifier of the payment
"payment-123"
Unique identifier of the payment method used for the payment
"payment-method-123"
Chift's name of the payment method used for the payment
"Cash"
Total amount of the tips of the payment. Tips are not part of the total of the payment
1
Status of the payment
Pending, Completed, Canceled, Failed, Unknown, Authorised "Completed"
Currency of the payment
"EUR"
Date of the payment
"2025-01-01T00:00:00Z"
Reference to the customer related to this payment
Show child attributes
Technical id in Chift
Description of the payment
"Payment for invoice INV-12345"
Taxes amount
Untaxed amount
Total amount incl. taxes
Creation date of the invoice
"2023-10-01T12:00:00"
Closing date of the invoice
"2023-10-10T12:00:00"
List of partners related to the invoice
Show child attributes
Technical id in Chift
Type of the partner
owner, account Address of the partner
Show child attributes
Type of the address
"home"
Name given to the address (e.g. 'home')
"Home"
Street name
"Main Street"
Number of the address
"123"
Box of the address
"A"
City name
"Paris"
Postal code of the address
"75000"
Country, format: ISO 3166-1 codes.
"FR"
First name of the partner. In case the partner is an individual.
"John"
Last name of the partner. In case the partner is an individual.
"Doe"
Company name of the partner. In case the partner is a company.
"Acme Corp"
Reference to the service related to this order
Reference to the reservation related to this order
Show child attributes
Technical id in Chift
Start date of the reservation
"2024-10-01T12:00:00"
End date of the reservation
"2024-10-10T12:00:00"
Creation date of the reservation
"2024-09-25T12:00:00"
Unique reference to the resource related to the reservation
Show child attributes
Technical id in Chift
Name of the resource related to the reservation
"Room 101"
Identifier of the resource related to the reservation
"R101"
x >= 0x >= 1x >= 1