API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Get invoices (PMS)
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": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"closing_date": "2023-11-07T05:31:56Z",
"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": "<string>",
"last_name": "<string>",
"company_name": "<string>"
}
],
"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": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"creation_date": "2023-11-07T05:31:56Z",
"resource_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"resource_name": "<string>",
"resource_identifier": "<string>"
}
}
],
"total": 1,
"page": 2,
"size": 2
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
x >= 1
1 <= x <= 100
Response
Technical id in Chift
List of items related to the invoice
Unique identifier of the order line item
"123"
Quantity of the order line item
1
Unit price (without tax) of the order line item
10
Total amount including tax of the order line item
11
Total amount of the taxes of the order line item
1
Type of the order line item
menu
, product
"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
Total amount of the payment
11
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
Technical id in Chift
Number/sequence
Creation date of the invoice
Closing date of the invoice
List of partners related to the invoice
Technical id in Chift
Type of the partner
owner
, account
Address of the partner
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.
Last name of the partner. In case the partner is an individual.
Company name of the partner. In case the partner is a company.
Reference to the service related to this order
Reference to the reservation related to this order
Technical id in Chift
Start date of the reservation
End date of the reservation
Creation date of the reservation
Uniuqe reference to the resource related to the reservation
Technical id in Chift
Name of the resource related to the reservation
Identifier of the resource related to the reservation
x >= 0
x >= 1
x >= 1
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": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"closing_date": "2023-11-07T05:31:56Z",
"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": "<string>",
"last_name": "<string>",
"company_name": "<string>"
}
],
"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": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"creation_date": "2023-11-07T05:31:56Z",
"resource_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"resource_name": "<string>",
"resource_identifier": "<string>"
}
}
],
"total": 1,
"page": 2,
"size": 2
}