CloudPOS

Authentication

The license name and token must be included in the header with every call. You can obtain this via our support service. We use the POST method in every endpoint. This is done because almost all endpoints can either pass data or apply filters. All endpoints must be called via an https url.

Error codes

1001: License name and token cannot be empty
1002: Invalid license name or token
1003: Limit of total requests per day reached, next request possible 'datetime'
1004: 5 bad logins reached, your ip adress is blocked till 'datetime'
1005: No license for this module
1006: This method is not allowed in this endpoint
1007: Invalid url

2000: Called endpoint returned an error

Changelog

Version 3.6.0.30, 19-08-2026
└►weborder.select endpoint added
└►order_reference added in document.select
└►hasvatticket added in document.select
└►API and license version added to result

Version 3.6.0.20, 13-01-2026
└►delivery_address added to customer.select

Version 3.6.0.17, 19-09-2025
└►kioskorder added to weborder.insert

Version 3.6.0.16, 12-09-2025
└►vatticketpdf.select endpoint added
└►documentnr filter added in documentpdf.select
└►documentnr filter added in documentubl.select

Version 3.6.0.13, 08-01-2025
└►productpopup.update endpoint added
└►category.delete endpoint added
└►product.delete endpoint added
└►subproduct.delete endpoint added
└►Bugfix, deleted categories were shown in category.select

Version 3.5.5.18, 13-06-2024
└►documentpdf.select endpoint added
└►documentubl.select endpoint added

Version 3.5.5.16, 28-05-2024
└►orderv2.select endpoint added (order.select deprecated)
└►zreportsv2.select endpoint added (zreports.select deprecated)
└►email filter added to customer.select
└►webdescription, webshopshow, webshoporderable added to product.select
└►paymenttype added to giftvoucher.select

Version 3.5.5.15, 17-01-2024
└►productpopup.select endpoint added
└►use of standard product tax if not filled in producttax field in weborder.insert

Version 3.5.4.41, 08-07-2023
└►Bugfix, subid was always 0 in order.select
└►tablenumber added in order.select

Version 3.5.4.38, 02-01-2023
└►dbid, establishmentid, kassaid filters added to order.select
└►res, payconiq payments output added to order.select
└►modtime, vatticketnr output added to document.select
└►establishmentid, kassaid, payments, taxable amount output added to zreports.select

Version 3.5.4.36, 24-10-2022
└►weborder.update endpoint added
└►weborder.delete endpoint added

Version 3.5.4.15, 25-04-2022
└►tableorder, tablenumber added in weborder.insert
└►lasthour filter added to confirmedweborder.select
└►status output added to confirmedweborder.select

Version 3.5.4.12, 18-01-2022
└►category_multi_ids added in product.insert, product.update

Version 3.5.4.7, 25-11-2021
└►country added in customer.select, customer.insert, customer.update

Version 3.5.4.6, 10-11-2021
└►category_multi_ids added in product.select

Version 3.5.3.2, 04-08-2021
└►Release new API v2

Name	Type	Example	Description
`id`	number	10	Filter on category id

Name	Type	Example	Description
`id`	number	10	Category id
`name`	string	Hamburgers	Category name
`modtime`	number	1617040180000	Last modified, unix micro timestamp

Name	Type	Example	Description
`name`	required	Hamburgers	Category name

Name	Type	Example	Description
`id`	number	10	Category id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

Name	Type	Example	Description
`id`	number, required	10	Category id
`name`	required	Hamburgers	Category name

Name	Type	Example	Description
`id`	number	10	Category id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

Name	Type	Example	Description
`id`	number, required	100	Category id

Products

/product

Get list of products

POST/product.select

product.select

Get list of products

Request attributes

Name	Type	Example	Description
`category_id`	number	10	Filter on category id
`id`	number	100	Filter on product id
`show_deleted`	boolean	false	Show deleted products

Response 200

Name	Type	Example	Description
`id`	number	100	Product id
`name`	string	Cheese Burger	Product name
`category_id`	number	10	Main category id
`category_multi_ids`	array		All coupled categories
`price`	string	20.00	Selling price
`purchaseprice`	string	10.00	Purchase price
`tax`	enum		Product VAT
`tax_table`	enum		Product VAT Table
`barcode`	string	12345678	Barcode
`quantity`	number	23	Product stock
`popup`	boolean	false	Product has popup sub-products
`menupopup`	boolean	false	Product has menu subproducten
`openprice`	boolean	false	Product has open price
`webdescription`	string	very nice product	Info about product
`webshopshow`	boolean	false	Show product in webshop
`webshoporderable`	boolean	false	Product in stock and available to order in webshop
`modtime`	number	1617040180000	Last modified, unix micro timestamp

REQUEST

https://cloudpos.be/api/v2/product.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "category_id": 10,
  "id": 100,
  "show_deleted": false
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/product.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "category_id": 10,   "id": 100,   "show_deleted": false }'

RESPONSE 200

{
  "id": 100,
  "name": "Cheese Burger",
  "category_id": 10,
  "category_multi_ids": [
    10,
    20
  ],
  "price": "20.00",
  "purchaseprice": "10.00",
  "tax": 21,
  "tax_table": 21,
  "barcode": "12345678",
  "quantity": 23,
  "popup": false,
  "menupopup": false,
  "openprice": false,
  "webdescription": "very nice product",
  "webshopshow": false,
  "webshoporderable": false,
  "modtime": 1617040180000
}

Create a new product

POST/product.insert

product.insert

Create a new product

Request attributes

Name	Type	Example	Description
`name`	string, required	Cheese Burger	Product name
`category_id`	number, required	10	Category id
`category_multi_ids`	array		All coupled categories, if something is entered here "category_id" will be replaced by the first value in this array
`price`	string, required	20.00	Selling price
`purchaseprice`	string	10.00	Purchase price
`tax`	enum		Product VAT
`tax_table`	enum		Product VAT Table
`barcode`	string	12345678	Barcode
`quantity`	number	23	Product stock

Response 200

Name	Type	Example	Description
`id`	number	100	Product id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/product.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "name": "Cheese Burger",
  "category_id": 10,
  "category_multi_ids": [
    10,
    20
  ],
  "price": "20.00",
  "purchaseprice": "10.00",
  "tax": 21,
  "tax_table": 21,
  "barcode": "12345678",
  "quantity": 23
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/product.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "name": "Cheese Burger",   "category_id": 10,   "category_multi_ids": [
    10,
    20
  ],   "price": "20.00",   "purchaseprice": "10.00",   "tax": 21,   "tax_table": 21,   "barcode": "12345678",   "quantity": 23 }'

RESPONSE 200

{
  "id": 100,
  "modtime": 1617040180000,
  "success": 1
}

Update a product

POST/product.update

product.update

Update a product

Request attributes

Name	Type	Example	Description
`id`	number, required	100	Product id
`name`	string, required	Cheese Burger	Product name
`category_id`	number	10	Category id
`category_multi_ids`	array		All coupled categories, if something is entered here "category_id" will be replaced by the first value in this array
`price`	string	20.00	Selling price
`purchaseprice`	string	10.00	Purchase price
`tax`	enum		Product VAT
`tax_table`	enum		Product VAT Table
`barcode`	string	12345678	Barcode
`quantity`	number	23	Product stock

Response 200

Name	Type	Example	Description
`id`	number	100	Product id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/product.update

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 100,
  "name": "Cheese Burger",
  "category_id": 10,
  "category_multi_ids": [
    10,
    20
  ],
  "price": "20.00",
  "purchaseprice": "10.00",
  "tax": 21,
  "tax_table": 21,
  "barcode": "12345678",
  "quantity": 23
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/product.update' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 100,   "name": "Cheese Burger",   "category_id": 10,   "category_multi_ids": [
    10,
    20
  ],   "price": "20.00",   "purchaseprice": "10.00",   "tax": 21,   "tax_table": 21,   "barcode": "12345678",   "quantity": 23 }'

RESPONSE 200

{
  "id": 100,
  "modtime": 1617040180000,
  "success": 1
}

Delete a product

POST/product.delete

product.delete

Delete a product

Request attributes

Name	Type	Example	Description
`id`	number, required	100	Product id

Response 200

Name	Type	Example	Description
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/product.delete

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 100
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/product.delete' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 100 }'

RESPONSE 200

{
  "success": 1
}

Get list of coupled subproducts in popup menu's

POST/productpopup.select

productpopup.select

Get list of coupled subproducts in popup menu's

Request attributes

Name	Type	Example	Description
`id`	number, required	100	Product id

Response 200

Name	Type	Example	Description
`popupid`	number	1	Popup column id
`popup_titel`	string	Choose your sauce	Popup column name
`multiselect`	boolean	false	Allow to choose multiple options
`required_option_cashregister`	boolean	false	Required to select option on cash register
`required_option_webshop`	boolean	false	Required to select option on webshop
`minimum_option`	number	0	If higher than 0, this is the minimum amount options to select
`maximum_option`	number	0	If higher than 0, this is the maximum amount options to select
`default_checked_subproduct_id`	number	1000	If higher than 0, this is the default checked subproductid
`subproduct_ids`	array		Coupled subproduct id's

REQUEST

https://cloudpos.be/api/v2/productpopup.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 100
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/productpopup.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 100 }'

RESPONSE 200

{
  "popupid": 1,
  "popup_titel": "Choose your sauce",
  "multiselect": false,
  "required_option_cashregister": false,
  "required_option_webshop": false,
  "minimum_option": 0,
  "maximum_option": 0,
  "default_checked_subproduct_id": 1000,
  "subproduct_ids": null
}

Update coupled subproducts in popup menu's

POST/productpopup.update

productpopup.update

Update coupled subproducts in popup menu's

Request attributes

Name	Type	Example	Description
`id`	number, required	100	Product id
`popupid`	number, required	1	Popup column id
`popup_titel`	string	column name	Popup column name
`multiselect`	boolean	false	Allow to choose multiple options
`required_option_cashregister`	boolean	false	Required to select option on cash register
`required_option_webshop`	boolean	false	Required to select option on webshop
`minimum_option`	number	0	If higher than 0, this is the minimum amount options to select
`maximum_option`	number	0	If higher than 0, this is the maximum amount options to select
`default_checked_subproduct_id`	number	0	If higher than 0, this is the default checked subproductid
`subproduct_ids`	array		Coupled subproduct id's

Response 200

No attributes

REQUEST

https://cloudpos.be/api/v2/productpopup.update

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 100,
  "popupid": 1,
  "popup_titel": "column name",
  "multiselect": false,
  "required_option_cashregister": false,
  "required_option_webshop": false,
  "minimum_option": 0,
  "maximum_option": 0,
  "default_checked_subproduct_id": 0,
  "subproduct_ids": null
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/productpopup.update' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 100,   "popupid": 1,   "popup_titel": "column name",   "multiselect": false,   "required_option_cashregister": false,   "required_option_webshop": false,   "minimum_option": 0,   "maximum_option": 0,   "default_checked_subproduct_id": 0,   "subproduct_ids": null }'

RESPONSE 200

{}

Subproducts

/subproduct

Get list of subproducts

POST/subproduct.select

subproduct.select

Get list of subproducts

Request attributes

Name	Type	Example	Description
`product_id`	number	100	Filter on product id
`id`	number	1000	Filter on subproduct id

Response 200

Name	Type	Example	Description
`id`	number	1000	Subproduct id
`name`	string	Ketchup	Subproduct name
`price`	string	20.00	Selling price
`tax`	enum		Subproduct VAT
`tax_table`	enum		Subproduct VAT Table
`quantity`	number	23	Subproduct stock
`product_ids`	array		Coupled product id's
`modtime`	number	1617040180000	Last modified, unix micro timestamp

REQUEST

https://cloudpos.be/api/v2/subproduct.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "product_id": 100,
  "id": 1000
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/subproduct.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "product_id": 100,   "id": 1000 }'

RESPONSE 200

{
  "id": 1000,
  "name": "Ketchup",
  "price": "20.00",
  "tax": 21,
  "tax_table": 21,
  "quantity": 23,
  "product_ids": null,
  "modtime": 1617040180000
}

Create a new subproduct

POST/subproduct.insert

subproduct.insert

Create a new subproduct

Request attributes

Name	Type	Example	Description
`name`	string, required	Ketchup	Subproduct name
`price`	string, required	20.00	Selling price
`tax`	enum		Subproduct VAT
`tax_table`	enum		Subproduct VAT Table
`quantity`	number	23	Subproduct stock

Response 200

Name	Type	Example	Description
`id`	number	1000	Subproduct id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/subproduct.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "name": "Ketchup",
  "price": "20.00",
  "tax": 21,
  "tax_table": 21,
  "quantity": 23
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/subproduct.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "name": "Ketchup",   "price": "20.00",   "tax": 21,   "tax_table": 21,   "quantity": 23 }'

RESPONSE 200

{
  "id": 1000,
  "modtime": 1617040180000,
  "success": 1
}

Update a subproduct

POST/subproduct.update

subproduct.update

Update a subproduct

Request attributes

Name	Type	Example	Description
`id`	number, required	100	Product id
`name`	string, required	Ketchup	Subproduct name
`price`	string	20.00	Selling price
`tax`	enum		Subproduct VAT
`tax_table`	enum		Subproduct VAT Table
`quantity`	number	23	Subproduct stock

Response 200

Name	Type	Example	Description
`id`	number	1000	Subproduct id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/subproduct.update

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 100,
  "name": "Ketchup",
  "price": "20.00",
  "tax": 21,
  "tax_table": 21,
  "quantity": 23
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/subproduct.update' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 100,   "name": "Ketchup",   "price": "20.00",   "tax": 21,   "tax_table": 21,   "quantity": 23 }'

RESPONSE 200

{
  "id": 1000,
  "modtime": 1617040180000,
  "success": 1
}

Delete a subproduct

POST/subproduct.delete

subproduct.delete

Delete a subproduct

Request attributes

Name	Type	Example	Description
`id`	number, required	100	Subproduct id

Response 200

Name	Type	Example	Description
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/subproduct.delete

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 100
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/subproduct.delete' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 100 }'

RESPONSE 200

{
  "success": 1
}

Customers

/customers

Get list of customers

POST/customer.select

customer.select

Get list of customers

Request attributes

Name	Type	Example	Description
`id`	number	10000	Filter on customer id
`email`	string	email@mail.com	Filter on Email

Response 200

Name	Type	Example	Description
`id`	number	10000	Customer id
`firstname`	string	Walter	Firstname
`name`	string	White	Name
`companyname`	string	Madrigal Electromotive	Company
`street_number`	string	Hermanos Street 20	Street and number
`phone`	string	+32478809887	Phone
`zipcode`	string	2000	Zipcode
`city`	string	Antwerp	Town
`country`	enum		Country
`vatnumber`	string	BE0123456789	VAT Number
`email`	string	g.fring@lospolloshermanos.be	Email
`tagid`	string	123	Tagid
`tagtype`	enum		Tagtype
`tagfamid`	string	123	Tagfamily
`delivery_address`	object		delivery address
`firstname`	string	Walter	Firstname
`name`	string	White	Name
`companyname`	string	Madrigal Electromotive	Company
`street_number`	string	Hermanos Street 20	Street and number
`zipcode`	string	2000	Zipcode
`city`	string	Antwerp	Town
`country`	enum		Country
`modtime`	number	1617040180000	Last modified, unix micro timestamp

REQUEST

https://cloudpos.be/api/v2/customer.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 10000,
  "email": "email@mail.com"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/customer.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 10000,   "email": "email@mail.com" }'

RESPONSE 200

{
  "id": 10000,
  "firstname": "Walter",
  "name": "White",
  "companyname": "Madrigal Electromotive",
  "street_number": "Hermanos Street 20",
  "phone": "+32478809887",
  "zipcode": "2000",
  "city": "Antwerp",
  "country": null,
  "vatnumber": "BE0123456789",
  "email": "g.fring@lospolloshermanos.be",
  "tagid": "123",
  "tagtype": null,
  "tagfamid": "123",
  "delivery_address": null,
  "modtime": 1617040180000
}

Create a new customer

POST/customer.insert

customer.insert

Create a new customer

Request attributes

Name	Type	Example	Description
`firstname`	string, required	Walter	Firstname
`name`	string, required	White	Name
`companyname`	string	Madrigal Electromotive	Company
`street_number`	string	Hermanos Street 20	Street and number
`phone`	string	+32478809887	Phone
`zipcode`	string	2000	Zipcode
`town`	string	Antwerp	Town
`country`	enum		Country
`vatnumber`	string	BE0123456789	VAT Number
`email`	string	g.fring@lospolloshermanos.be	Email
`tagid`	string	123	Tagid
`tagtype`	enum		Tagtype
`tagfamid`	string	123	Tagfamily

Response 200

Name	Type	Example	Description
`id`	number	10000	Customer id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/customer.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "firstname": "Walter",
  "name": "White",
  "companyname": "Madrigal Electromotive",
  "street_number": "Hermanos Street 20",
  "phone": "+32478809887",
  "zipcode": "2000",
  "town": "Antwerp",
  "country": null,
  "vatnumber": "BE0123456789",
  "email": "g.fring@lospolloshermanos.be",
  "tagid": "123",
  "tagtype": null,
  "tagfamid": "123"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/customer.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "firstname": "Walter",   "name": "White",   "companyname": "Madrigal Electromotive",   "street_number": "Hermanos Street 20",   "phone": "+32478809887",   "zipcode": "2000",   "town": "Antwerp",   "country": null,   "vatnumber": "BE0123456789",   "email": "g.fring@lospolloshermanos.be",   "tagid": "123",   "tagtype": null,   "tagfamid": "123" }'

RESPONSE 200

{
  "id": 10000,
  "modtime": 1617040180000,
  "success": 1
}

Update a customer

POST/customer.update

customer.update

Update a customer

Request attributes

Name	Type	Example	Description
`id`	number, required	10000	Customer id
`firstname`	string, required	Walter	Firstname
`name`	string, required	White	Name
`companyname`	string	Madrigal Electromotive	Company
`street_number`	string	Hermanos Street 20	Street and number
`phone`	string	+32478809887	Phone
`zipcode`	string	2000	Zipcode
`town`	string	Antwerp	Town
`country`	enum		Country
`vatnumber`	string	BE0123456789	VAT Number
`email`	string	g.fring@lospolloshermanos.be	Email
`tagid`	string	123	Tagid
`tagtype`	enum		Tagtype
`tagfamid`	string	123	Tagfamily

Response 200

Name	Type	Example	Description
`id`	number	10000	Customer id
`modtime`	number	1617040180000	Last modified, unix micro timestamp
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/customer.update

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 10000,
  "firstname": "Walter",
  "name": "White",
  "companyname": "Madrigal Electromotive",
  "street_number": "Hermanos Street 20",
  "phone": "+32478809887",
  "zipcode": "2000",
  "town": "Antwerp",
  "country": null,
  "vatnumber": "BE0123456789",
  "email": "g.fring@lospolloshermanos.be",
  "tagid": "123",
  "tagtype": null,
  "tagfamid": "123"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/customer.update' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 10000,   "firstname": "Walter",   "name": "White",   "companyname": "Madrigal Electromotive",   "street_number": "Hermanos Street 20",   "phone": "+32478809887",   "zipcode": "2000",   "town": "Antwerp",   "country": null,   "vatnumber": "BE0123456789",   "email": "g.fring@lospolloshermanos.be",   "tagid": "123",   "tagtype": null,   "tagfamid": "123" }'

RESPONSE 200

{
  "id": 10000,
  "modtime": 1617040180000,
  "success": 1
}

Orders

/orders

Get list of cashregister orders

POST/orderv2.select

orderv2.select

Get list of cashregister orders

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin order id
`end_id`	number	10	End order id
`date`	string	`2020-12-01`	Filter on date
`clockinclockout`	boolean	false	Filter on clockinclockout
`dbid`	number	10	Unique ticket database id
`kassaid`	number	1	Cash register id
`establishmentid`	number	1	Establishment id

Response 200

Name	Type	Example	Description
`dbid`	number	1	Unique ticket database id
`id`	number	1	Ticket number
`customerid`	number	10000	Customer id
`establishmentid`	number	1	Establishment id
`kassaid`	number	1	Cash register id
`totalprice`	string	100.00	Total price incl. tax
`user`	number	100	User id
`ordertime`	string	`2020-12-01 12:00:00`	Order date time
`tablenumber`	number	10	Table number
`clockin`	boolean	false	Clockin
`clockout`	boolean	false	Clockout
`orderdetail`	array		Order details array
`id`	number	1	Unique id
`quantity`	number	1	quantity
`productid`	number	100	Product id
`productprice`	string	90.00	Product price
`producttax`	enum		Product tax
`subproducts`	array		Subproducts details array
`subproductid`	number	1	Subproduct id
`subproductprice`	string	10.00	Subproduct price
`subproducttax`	enum		Subproduct tax
`payments`	array		Payments array
`id`	number	1	Payment id
`name`	string	Cash	Payment name
`amount`	string	100.00	Amount incl. vat

REQUEST

https://cloudpos.be/api/v2/orderv2.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10,
  "date": "`2020-12-01`",
  "clockinclockout": false,
  "dbid": 10,
  "kassaid": 1,
  "establishmentid": 1
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/orderv2.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10,   "date": "`2020-12-01`",   "clockinclockout": false,   "dbid": 10,   "kassaid": 1,   "establishmentid": 1 }'

RESPONSE 200

{
  "dbid": 1,
  "id": 1,
  "customerid": 10000,
  "establishmentid": 1,
  "kassaid": 1,
  "totalprice": "100.00",
  "user": 100,
  "ordertime": "`2020-12-01 12:00:00`",
  "tablenumber": 10,
  "clockin": false,
  "clockout": false,
  "orderdetail": null,
  "quantity": 1,
  "productid": 100,
  "productprice": "90.00",
  "producttax": null,
  "subproducts": null,
  "subproductid": 1,
  "subproductprice": "10.00",
  "subproducttax": null,
  "payments": null,
  "name": "Cash",
  "amount": "100.00"
}

Check confirmed weborder

POST/confirmedweborder.select

confirmedweborder.select

Check confirmed weborder

Request attributes

Name	Type	Example	Description
`lasthour`	boolean	true	All orders from the past hour
`weborderid`	number	10	Weborder id

Response 200

Name	Type	Example	Description
`weborderid`	number	10	Weborder id
`ordertime`	string	`2020-12-01 12:00:00`	Weborder date time
`status`	enum		Status of the weborder
`1`	number		Arrived, the order exists but has not been processed
`3`	number		Processed, the order has been send to kitchen/bar
`5`	number		Finished, VAT ticket created
`webordertime`	string	17:00	Confirmed time when the web order can be picked up or delivered

REQUEST

https://cloudpos.be/api/v2/confirmedweborder.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "lasthour": true,
  "weborderid": 10
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/confirmedweborder.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "lasthour": true,   "weborderid": 10 }'

RESPONSE 200

{
  "weborderid": 10,
  "ordertime": "`2020-12-01 12:00:00`",
  "status": null,
  "1": null,
  "3": null,
  "5": null,
  "webordertime": "17:00"
}

Get list of weborders

POST/weborder.select

weborder.select

Get list of weborders

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin order id
`end_id`	number	10	End order id
`date`	string	`2020-12-01`	Filter on date
`establishmentid`	number	1	Establishment id

Response 200

Name	Type	Example	Description
`id`	number	1	Ticket number
`customerid`	number	10000	Customer id
`establishmentid`	number	1	Establishment id
`totalprice`	string	100.00	Total price incl. tax
`ordertime`	string	`2020-12-01 12:00:00`	Order date time
`plannedorderdatetime`	string	`2020-12-05 12:00:00`	Planned order date time
`discountamount`	string	1.00	Discountamount
`remark`	string	With extra salad	Remark
`delivery`	number	0	0 = pickup, 1 = delivery , 2 = eatin
`weborderdetail`	array		Weborder details array
`id`	number	1	Unique id
`quantity`	number	1	quantity
`productid`	number	100	Product id
`productprice`	string	90.00	Product price
`producttax`	enum		Product tax
`subproducts`	array		Subproducts details array
`subproductid`	number	1	Subproduct id
`subproductprice`	string	10.00	Subproduct price
`subproducttax`	enum		Subproduct tax

REQUEST

https://cloudpos.be/api/v2/weborder.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10,
  "date": "`2020-12-01`",
  "establishmentid": 1
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/weborder.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10,   "date": "`2020-12-01`",   "establishmentid": 1 }'

RESPONSE 200

{
  "id": 1,
  "customerid": 10000,
  "establishmentid": 1,
  "totalprice": "100.00",
  "ordertime": "`2020-12-01 12:00:00`",
  "plannedorderdatetime": "`2020-12-05 12:00:00`",
  "discountamount": "1.00",
  "remark": "With extra salad",
  "delivery": 0,
  "weborderdetail": null,
  "quantity": 1,
  "productid": 100,
  "productprice": "90.00",
  "producttax": null,
  "subproducts": null,
  "subproductid": 1,
  "subproductprice": "10.00",
  "subproducttax": null
}

Create a new weborder

POST/weborder.insert

weborder.insert

Create a new weborder

Request attributes

Name	Type	Example	Description
`plannedorder`	boolean	false	Planned order
`plannedorderdatetime`	string	`2020-12-01 12:00:00`	Planned order date time
`autoconfirmation`	boolean	false	No interaction with the customer required
`customerid`	number	10000	Customer id
`delivery`	number	0	0 = pickup, 1 = delivery , 2 = eatin
`tableorder`	boolean	true	Weborder made at a table, QR code scan
`tablenumber`	number	10	Table number
`kioskorder`	boolean	true	Weborder made at a kiosk
`kioskid`	number	1	Kiosk id, unique number per kiosk
`kioskorderid`	number	100	Order id to show on tickets, customer identification
`onlinepaid`	boolean	false	Online paid
`discountamount`	string	0.00	Discount amount, the given amount will be reduced on total sum of all productprice, this only works for non planned orders
`remark`	string	With extra salad	Remark
`weborderdetail`	array		Weborder details array
`quantity`	number	1	Quantity
`productid`	number	100	Product id
`productprice`	string	90.00	Product unit price
`producttax`	enum		Product tax
`sub1id`	number	2	Subproduct id 1-10
`sub1price`	string	10.00	Subproduct unit price 1-10
`sub1tax`	enum		Subproduct tax 1-10
`extrainfo`	string	no cheese, extra sauce	Comma separated, extra info for the kitchen ticket

Response 200

Name	Type	Example	Description
`weborderid`	number	28	Weborder id
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/weborder.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "plannedorder": false,
  "plannedorderdatetime": "`2020-12-01 12:00:00`",
  "autoconfirmation": false,
  "customerid": 10000,
  "delivery": 0,
  "tableorder": true,
  "tablenumber": 10,
  "kioskorder": true,
  "kioskid": 1,
  "kioskorderid": 100,
  "onlinepaid": false,
  "discountamount": "0.00",
  "remark": "With extra salad",
  "weborderdetail": null,
  "quantity": 1,
  "productid": 100,
  "productprice": "90.00",
  "producttax": null,
  "sub1id": 2,
  "sub1price": "10.00",
  "sub1tax": null,
  "extrainfo": "no cheese, extra sauce"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/weborder.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "plannedorder": false,   "plannedorderdatetime": "`2020-12-01 12:00:00`",   "autoconfirmation": false,   "customerid": 10000,   "delivery": 0,   "tableorder": true,   "tablenumber": 10,   "kioskorder": true,   "kioskid": 1,   "kioskorderid": 100,   "onlinepaid": false,   "discountamount": "0.00",   "remark": "With extra salad",   "weborderdetail": null,   "quantity": 1,   "productid": 100,   "productprice": "90.00",   "producttax": null,   "sub1id": 2,   "sub1price": "10.00",   "sub1tax": null,   "extrainfo": "no cheese, extra sauce" }'

RESPONSE 200

{
  "weborderid": 28,
  "success": 1
}

Update a weborder

POST/weborder.update

weborder.update

Update a weborder

Request attributes

Name	Type	Example	Description
`id`	number, required	28	Weborder id
`plannedorderdatetime`	string	`2020-12-01 12:00:00`	Planned order date time
`delivery`	number	0	0 = pickup, 1 = delivery , 2 = eatin
`onlinepaid`	boolean	false	Online paid
`discountamount`	string	0.00	Discount amount, the given amount will be reduced on total sum of all productprice, this only works for non planned orders
`remark`	string	With extra salad	Remark
`weborderdetail`	array		Weborder details array
`quantity`	number	1	Quantity
`productid`	number	100	Product id
`productprice`	string	90.00	Product unit price
`producttax`	enum		Product tax
`sub1id`	number	2	Subproduct id 1-10
`sub1price`	string	10.00	Subproduct unit price 1-10
`sub1tax`	enum		Subproduct tax 1-10
`extrainfo`	string	no cheese, extra sauce	Comma separated, extra info for the kitchen ticket

Response 200

Name	Type	Example	Description
`weborderid`	number	28	Weborder id
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/weborder.update

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 28,
  "plannedorderdatetime": "`2020-12-01 12:00:00`",
  "delivery": 0,
  "onlinepaid": false,
  "discountamount": "0.00",
  "remark": "With extra salad",
  "weborderdetail": null,
  "quantity": 1,
  "productid": 100,
  "productprice": "90.00",
  "producttax": null,
  "sub1id": 2,
  "sub1price": "10.00",
  "sub1tax": null,
  "extrainfo": "no cheese, extra sauce"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/weborder.update' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 28,   "plannedorderdatetime": "`2020-12-01 12:00:00`",   "delivery": 0,   "onlinepaid": false,   "discountamount": "0.00",   "remark": "With extra salad",   "weborderdetail": null,   "quantity": 1,   "productid": 100,   "productprice": "90.00",   "producttax": null,   "sub1id": 2,   "sub1price": "10.00",   "sub1tax": null,   "extrainfo": "no cheese, extra sauce" }'

RESPONSE 200

{
  "weborderid": 28,
  "success": 1
}

Delete a weborder

POST/weborder.delete

weborder.delete

Delete a weborder

Request attributes

Name	Type	Example	Description
`id`	number, required	28	Weborder id

Response 200

Name	Type	Example	Description
`weborderid`	number	28	Weborder id
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/weborder.delete

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 28
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/weborder.delete' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 28 }'

RESPONSE 200

{
  "weborderid": 28,
  "success": 1
}

Reservations

/reservations

Get list of reservation dates

POST/reservationdate.select

reservationdate.select

Get list of reservation dates

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`mon`	boolean	true	Monday
`tue`	boolean	true	Tuesday
`wed`	boolean	true	Wednesday
`thu`	boolean	true	Thursday
`fri`	boolean	true	Friday
`sat`	boolean	true	Saturday
`sun`	boolean	true	Sunday
`exceptionallyopen`	array		Exceptionally open dates
`nomoreplace`	array		No more place to make a reservation
`holiday`	array
`start_date`	string	`2020-12-24`	Start date
`end_date`	string	`2021-01-02`	End date
`reservationfrom`	string	`2020-12-03`	Reserve possible from
`reservationuntil`	string	`2020-12-03`	Reserve possible until

REQUEST

https://cloudpos.be/api/v2/reservationdate.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/reservationdate.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "mon": true,
  "tue": true,
  "wed": true,
  "thu": true,
  "fri": true,
  "sat": true,
  "sun": true,
  "exceptionallyopen": null,
  "nomoreplace": null,
  "holiday": null,
  "start_date": "`2020-12-24`",
  "end_date": "`2021-01-02`",
  "reservationfrom": "`2020-12-03`",
  "reservationuntil": "`2020-12-03`"
}

Get list of reservation persons

POST/reservationpersons.select

reservationpersons.select

Get list of reservation persons

Request attributes

Name	Type	Example	Description
`date`	string, required	`2020-12-01`	Date

Response 200

Name	Type	Description
`persons`	array	Array of persons
`1`	number
`2`	number
`3`	number

REQUEST

https://cloudpos.be/api/v2/reservationpersons.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "date": "`2020-12-01`"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/reservationpersons.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "date": "`2020-12-01`" }'

RESPONSE 200

{
  "persons": null,
  "1": null,
  "2": null,
  "3": null
}

Get list of reservation hours

POST/reservationhours.select

reservationhours.select

Get list of reservation hours

Request attributes

Name	Type	Example	Description
`date`	string, required	`2020-12-01`	Date
`persons`	number, required	2	Persons

Response 200

Name	Type	Example	Description
`hours`	array		Array of hours
`17`	string	00
`17`	string	15
`17`	string	30

REQUEST

https://cloudpos.be/api/v2/reservationhours.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "date": "`2020-12-01`",
  "persons": 2
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/reservationhours.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "date": "`2020-12-01`",   "persons": 2 }'

RESPONSE 200

{
  "hours": null,
  "17": "30"
}

Create a new reservation entry

POST/reservationentry.insert

reservationentry.insert

Create a new reservation entry

Request attributes

Name	Type	Example	Description
`date`	string, required	`2020-12-01`	Date
`persons`	number, required	2	Persons
`hour`	string, required	17:00	Hour
`name`	string, required	Walter White	Name
`phone`	string, required	0476839912	Phone

Response 200

Name	Type	Example	Description
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/reservationentry.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "date": "`2020-12-01`",
  "persons": 2,
  "hour": "17:00",
  "name": "Walter White",
  "phone": "0476839912"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/reservationentry.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "date": "`2020-12-01`",   "persons": 2,   "hour": "17:00",   "name": "Walter White",   "phone": "0476839912" }'

RESPONSE 200

{
  "success": 1
}

Reports

/reports

Select zreports

POST/zreportsv2.select

zreportsv2.select

Select zreports

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin id
`end_id`	number	10	End id

Response 200

Name	Type	Example	Description
`id`	number	1	Report id
`establishmentid`	number	1	Establishment id
`kassaid`	number	1	Cash register id
`startdate`	string	`2020-12-01 08:00:00`	Begin of report
`enddate`	string	`2020-12-01 18:00:00`	End of report
`startticket`	number	1	Begin order id
`endticket`	number	200	End order id
`ticketcount`	number	200	Ticket count
`vatamounts`	array		Vat amounts array
`percentage`	enum		Percentage
`inclvat`	string	1210.00	Amount incl. vat
`exclvat`	string	1000.00	Amount excl. vat
`vatamount`	string	210.00	Amount vat amount
`payments`	array		Payments array
`id`	number	1	Payment id
`name`	string	Cash	Payment name
`amount`	string	1210.00	Amount incl. vat
`totalinclvat`	string	1210.00	Total price incl. vat
`totalexclvat`	string	1000.00	Total price excl. vat
`totalvatamount`	string	210.00	Total vat amount

REQUEST

https://cloudpos.be/api/v2/zreportsv2.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/zreportsv2.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10 }'

RESPONSE 200

{
  "id": 1,
  "establishmentid": 1,
  "kassaid": 1,
  "startdate": "`2020-12-01 08:00:00`",
  "enddate": "`2020-12-01 18:00:00`",
  "startticket": 1,
  "endticket": 200,
  "ticketcount": 200,
  "vatamounts": null,
  "percentage": null,
  "inclvat": "1210.00",
  "exclvat": "1000.00",
  "vatamount": "210.00",
  "payments": null,
  "name": "Cash",
  "amount": "1210.00",
  "totalinclvat": "1210.00",
  "totalexclvat": "1000.00",
  "totalvatamount": "210.00"
}

Select xreports

POST/xreports.select

xreports.select

Select xreports

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	1	Report id
`startdate`	string	`2020-12-01 08:00:00`	Begin of report
`startticket`	string	1	Begin order id
`totalexclvat`	string	900.00	Total price excl. vat
`totalinclvat`	string	1300.00	Total price incl. vat

REQUEST

https://cloudpos.be/api/v2/xreports.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/xreports.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 1,
  "startdate": "`2020-12-01 08:00:00`",
  "startticket": "1",
  "totalexclvat": "900.00",
  "totalinclvat": "1300.00"
}

Invoicing

/invoicing

Get list of documents

POST/document.select

document.select

Get list of documents

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin id
`end_id`	number	10	End id
`date`	string	`2020-12-01`	Filter on date

Response 200

Name	Type	Example	Description
`id`	number	1	Document id
`customerid`	number	10000	Customer id
`totalprice`	string	5.00	Total price incl. tax
`date`	string	`2020-12-01`	Document date
`expirationdate`	string	`2020-12-30`	Document expiration date
`number`	number	1001	Document number
`doctype`	enum
`note`	string	extra cheese	Note
`need_send_to_peppol`	boolean	true	Needs to be placed on the Peppol network by 3rd party
`invoicedetail`	array		Document details array
`quantity`	number	1	quantity
`productname`	string	Hamburgers	Product name
`productprice`	string	5.00	Product price
`producttax`	enum		Product vat
`vatticketnr`	number		Linked vat ticket (dbid in order.select)
`docfromvatticket`	boolean	false	Is document from vat tickets
`hasvatticket`	boolean	false	has a VAT receipt (turnover in zrapports)
`order_reference`	string	15689-369	order reference used for Peppol
`modtime`	number	1617040180000	Last modified, unix micro timestamp

REQUEST

https://cloudpos.be/api/v2/document.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10,
  "date": "`2020-12-01`"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/document.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10,   "date": "`2020-12-01`" }'

RESPONSE 200

{
  "id": 1,
  "customerid": 10000,
  "totalprice": "5.00",
  "date": "`2020-12-01`",
  "expirationdate": "`2020-12-30`",
  "number": 1001,
  "doctype": null,
  "note": "extra cheese",
  "need_send_to_peppol": true,
  "invoicedetail": null,
  "quantity": 1,
  "productname": "Hamburgers",
  "productprice": "5.00",
  "producttax": null,
  "vatticketnr": null,
  "docfromvatticket": false,
  "hasvatticket": false,
  "order_reference": "15689-369",
  "modtime": 1617040180000
}

Check document signed by fiscal data module

POST/documentsigned.select

documentsigned.select

Check document signed by fiscal data module

Request attributes

Name	Type	Example	Description
`documentnr`	number, required	1001	Document number
`doctype`	enum, required

Response 200

Name	Type	Example	Description
`vatticket`	number	100	Vat Ticket

REQUEST

https://cloudpos.be/api/v2/documentsigned.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "documentnr": 1001,
  "doctype": null
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/documentsigned.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "documentnr": 1001,   "doctype": null }'

RESPONSE 200

{
  "vatticket": 100
}

Create a new document

POST/document.insert

document.insert

Create a new document

Request attributes

Name	Type	Example	Description
`customerid`	number, required	10000	Customer id
`documentnr`	number, required	1001	Document number
`date`	string	`2020-12-01`	Document date, only available without fiscal data module
`expirationdate`	string	`2020-12-30`	Document expiration date
`doctype`	enum, required
`total`	string	5.00	Total
`productlines`	array, required		Document details array
`quantity`	number	1	Quantity
`name`	string	Hamburger	Product name
`productprice`	string	5.00	Product total price (unit price x quantity)
`productvat`	enum		Product vat

Response 200

Name	Type	Example	Description
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/document.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "customerid": 10000,
  "documentnr": 1001,
  "date": "`2020-12-01`",
  "expirationdate": "`2020-12-30`",
  "doctype": null,
  "total": "5.00",
  "productlines": null,
  "quantity": 1,
  "name": "Hamburger",
  "productprice": "5.00",
  "productvat": null
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/document.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "customerid": 10000,   "documentnr": 1001,   "date": "`2020-12-01`",   "expirationdate": "`2020-12-30`",   "doctype": null,   "total": "5.00",   "productlines": null,   "quantity": 1,   "name": "Hamburger",   "productprice": "5.00",   "productvat": null }'

RESPONSE 200

{
  "success": 1
}

Download document in pdf

POST/documentpdf.select

documentpdf.select

Download document in pdf

Request attributes

Name	Type	Example	Description
`id`	number, required	10	Document id
`documentnr`	number, required	1001	Document number

Response 200

Name	Type	Example	Description
`base64`	string	binary data	Document

REQUEST

https://cloudpos.be/api/v2/documentpdf.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 10,
  "documentnr": 1001
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/documentpdf.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 10,   "documentnr": 1001 }'

RESPONSE 200

{
  "base64": "binary data"
}

Download document in ubl

POST/documentubl.select

documentubl.select

Download document in ubl

Request attributes

Name	Type	Example	Description
`id`	number, required	10	Document id

Response 200

Name	Type	Example	Description
`base64`	string	binary data	Document

REQUEST

https://cloudpos.be/api/v2/documentubl.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 10
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/documentubl.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 10 }'

RESPONSE 200

{
  "base64": "binary data"
}

Download vatticket in pdf

POST/vatticketpdf.select

vatticketpdf.select

Download vatticket in pdf

Request attributes

Name	Type	Example	Description
`id`	number, required	10	Document id
`documentnr`	number, required	1001	Document number

Response 200

Name	Type	Example	Description
`base64`	string	binary data	Document

REQUEST

https://cloudpos.be/api/v2/vatticketpdf.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "id": 10,
  "documentnr": 1001
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/vatticketpdf.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "id": 10,   "documentnr": 1001 }'

RESPONSE 200

{
  "base64": "binary data"
}

Credits

/credits

Get list of coupons

POST/coupon.select

coupon.select

Get list of coupons

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin coupon id
`end_id`	number	10	End coupon id

Response 200

Name	Type	Example	Description
`id`	number	1	coupon id
`barcode`	string	12345678	Barcode
`value`	string	100.00	Value
`valuetype`	enum		Value type
`validfrom`	string	`2020-12-01`	Valid from
`validuntil`	string	`2020-12-30`	Valid until
`used`	boolean	false	Used

REQUEST

https://cloudpos.be/api/v2/coupon.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/coupon.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10 }'

RESPONSE 200

{
  "id": 1,
  "barcode": "12345678",
  "value": "100.00",
  "valuetype": null,
  "validfrom": "`2020-12-01`",
  "validuntil": "`2020-12-30`",
  "used": false
}

Create a new coupon

POST/coupon.insert

coupon.insert

Create a new coupon

Request attributes

Name	Type	Example	Description
`barcode`	string, required	12345678	Barcode
`value`	string, required	100.00	Value
`valuetype`	enum, required		Value type
`validfrom`	string, required	`2020-12-01`	Valid from
`validuntil`	string, required	`2020-12-30`	Valid until

Response 200

Name	Type	Example	Description
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/coupon.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "barcode": "12345678",
  "value": "100.00",
  "valuetype": null,
  "validfrom": "`2020-12-01`",
  "validuntil": "`2020-12-30`"
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/coupon.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "barcode": "12345678",   "value": "100.00",   "valuetype": null,   "validfrom": "`2020-12-01`",   "validuntil": "`2020-12-30`" }'

RESPONSE 200

{
  "success": 1
}

Get list of giftvouchers

POST/giftvoucher.select

giftvoucher.select

Get list of giftvouchers

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	1	Voucher id
`barcode`	string	12345678	Barcode
`value`	string	100.00	Value
`validfrom`	string	`2020-12-01`	Valid from
`validuntil`	string	`2020-12-30`	Valid until
`paymenttype`	enum, required		Payment type

REQUEST

https://cloudpos.be/api/v2/giftvoucher.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/giftvoucher.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 1,
  "barcode": "12345678",
  "value": "100.00",
  "validfrom": "`2020-12-01`",
  "validuntil": "`2020-12-30`",
  "paymenttype": null
}

Create a new giftvoucher

POST/giftvoucher.insert

giftvoucher.insert

Create a new giftvoucher

Request attributes

Name	Type	Example	Description
`barcode`	string, required	12345678	Barcode
`value`	string, required	100.00	Value
`validfrom`	string, required	`2020-12-01`	Valid from
`validuntil`	string, required	`2020-12-30`	Valid until
`paymenttype`	enum, required		Payment type

Response 200

Name	Type	Example	Description
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/giftvoucher.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "barcode": "12345678",
  "value": "100.00",
  "validfrom": "`2020-12-01`",
  "validuntil": "`2020-12-30`",
  "paymenttype": null
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/giftvoucher.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "barcode": "12345678",   "value": "100.00",   "validfrom": "`2020-12-01`",   "validuntil": "`2020-12-30`",   "paymenttype": null }'

RESPONSE 200

{
  "success": 1
}

Get list of customercredits

POST/customercredits.select

customercredits.select

Get list of customercredits

Request attributes

Name	Type	Example	Description
`customerid`	number	1000	Customer id

Response 200

Name	Type	Example	Description
`id`	number	1	Customercredit id
`customerid`	number	1000	Customer id
`value`	string	100.00	Value
`tagid`	number	12345678	Tag number
`tagtype`	enum		Tag number
`productid`	number	100	Product id, only with customerid filter
`categoryid`	number	10	Category id, only with customerid filter

REQUEST

https://cloudpos.be/api/v2/customercredits.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "customerid": 1000
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/customercredits.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "customerid": 1000 }'

RESPONSE 200

{
  "id": 1,
  "customerid": 1000,
  "value": "100.00",
  "tagid": 12345678,
  "tagtype": null,
  "productid": 100,
  "categoryid": 10
}

Create a new customercredit

POST/customercredit.insert

customercredit.insert

Create a new customercredit

Request attributes

Name	Type	Example	Description
`customerid`	string, required	1000	Customer id
`value`	string, required	100.00	Value
`productid`	number	100	Product id, not use at the same time with Categorie id
`categoryid`	number	10	Categorie id, not use at the same time with Product id
`paymenttype`	enum, required		Payment type

Response 200

Name	Type	Example	Description
`id`	number	145	id of the new customercredit
`success`	number	1

REQUEST

https://cloudpos.be/api/v2/customercredit.insert

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "customerid": "1000",
  "value": "100.00",
  "productid": 100,
  "categoryid": 10,
  "paymenttype": null
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/customercredit.insert' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "customerid": "1000",   "value": "100.00",   "productid": 100,   "categoryid": 10,   "paymenttype": null }'

RESPONSE 200

{
  "id": 145,
  "success": 1
}

Others

/others

Get list of users

POST/users.select

users.select

Get list of users

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	100	User id
`username`	string	Jesse	Username
`admin`	enum		Admin or user
`secnr`	string	82032195321	Social Security number

REQUEST

https://cloudpos.be/api/v2/users.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/users.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 100,
  "username": "Jesse",
  "admin": null,
  "secnr": "82032195321"
}

Get list of tables

POST/tables.select

tables.select

Get list of tables

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	100	Table id
`table`	number	3	Number
`status`	enum		Admin or user

REQUEST

https://cloudpos.be/api/v2/tables.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/tables.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 100,
  "table": 3,
  "status": null
}

Get list of payment methods

POST/payment.select

payment.select

Get list of payment methods

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	1	Payment id
`payment`	string	Cash	Name

REQUEST

https://cloudpos.be/api/v2/payment.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/payment.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 1,
  "payment": "Cash"
}

Get list of printers

POST/printers.select

printers.select

Get list of printers

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	1	Printer id
`printername`	string	Kitchenprinter	Name

REQUEST

https://cloudpos.be/api/v2/printers.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/printers.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 1,
  "printername": "Kitchenprinter"
}

Get list of establishments

POST/establishments.select

establishments.select

Get list of establishments

Request attributes

No attributes

Response 200

Name	Type	Example	Description
`id`	number	1	Id
`name`	string	Standard establishment	Establishment name

REQUEST

https://cloudpos.be/api/v2/establishments.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{}

cURL

curl -X POST 'https://cloudpos.be/api/v2/establishments.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{}'

RESPONSE 200

{
  "id": 1,
  "name": "Standard establishment"
}

Deprecated

/deprecated

Deprecated, see v2

POST/order.select

order.select

Deprecated, see v2

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin order id
`end_id`	number	10	End order id
`date`	string	`2020-12-01`	Filter on date
`clockinclockout`	boolean	false	Filter on clockinclockout
`dbid`	number	10	Unique ticket database id
`kassaid`	number	1	Cash register id
`establishmentid`	number	1	Establishment id

Response 200

Name	Type	Example	Description
`dbid`	number	1	Unique ticket database id
`id`	number	1	Ticket number
`customerid`	number	10000	Customer id
`establishmentid`	number	1	Establishment id
`kassaid`	number	1	Cash register id
`totalprice`	string	100.00	Total price incl. tax
`user`	number	100	User id
`ordertime`	string	`2020-12-01 12:00:00`	Order date time
`tablenumber`	number	10	Table number
`clockin`	boolean	false	Clockin
`clockout`	boolean	false	Clockout
`orderdetail`	array		Order details array
`quantity`	number	1	quantity
`productid`	number	100	Product id
`productprice`	string	90.00	Product price
`producttax`	enum		Product tax
`subproduct1id`	number	2	Subproduct id 1-10
`subproduct1price`	string	10.00	Subproduct price 1-10
`subproduct1tax`	enum		Subproduct tax 1-10
`cashpayment`	string	100.00	Cash payment incl. vat
`bancontactpayment`	string	0.00	Bancontact payment incl. vat
`voucherpayment`	string	0.00	Voucher payment incl. vat
`transferpayment`	string	0.00	Transfer payment incl. vat
`visapayment`	string	0.00	Visa payment incl. vat
`chargecardpayment`	string	0.00	Chargecard payment incl. vat
`luncheoncardpayment`	string	0.00	Luncheoncard payment incl. vat
`americanexpresspayment`	string	0.00	Americanexpress payment incl. vat
`mastercardpayment`	string	0.00	Mastercard payment incl. vat
`respayment`	string	0.00	RES payment incl. vat
`payconiqpayment`	string	0.00	Payconiq payment incl. vat
`tgtgpayment`	string	0.00	Too Good To Go payment incl. vat
`paybonsaipayment`	string	0.00	Paybonsai payment incl. vat

REQUEST

https://cloudpos.be/api/v2/order.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10,
  "date": "`2020-12-01`",
  "clockinclockout": false,
  "dbid": 10,
  "kassaid": 1,
  "establishmentid": 1
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/order.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10,   "date": "`2020-12-01`",   "clockinclockout": false,   "dbid": 10,   "kassaid": 1,   "establishmentid": 1 }'

RESPONSE 200

{
  "dbid": 1,
  "id": 1,
  "customerid": 10000,
  "establishmentid": 1,
  "kassaid": 1,
  "totalprice": "100.00",
  "user": 100,
  "ordertime": "`2020-12-01 12:00:00`",
  "tablenumber": 10,
  "clockin": false,
  "clockout": false,
  "orderdetail": null,
  "quantity": 1,
  "productid": 100,
  "productprice": "90.00",
  "producttax": null,
  "subproduct1id": 2,
  "subproduct1price": "10.00",
  "subproduct1tax": null,
  "cashpayment": "100.00",
  "bancontactpayment": "0.00",
  "voucherpayment": "0.00",
  "transferpayment": "0.00",
  "visapayment": "0.00",
  "chargecardpayment": "0.00",
  "luncheoncardpayment": "0.00",
  "americanexpresspayment": "0.00",
  "mastercardpayment": "0.00",
  "respayment": "0.00",
  "payconiqpayment": "0.00",
  "tgtgpayment": "0.00",
  "paybonsaipayment": "0.00"
}

Deprecated, see v2

POST/zreports.select

zreports.select

Deprecated, see v2

Request attributes

Name	Type	Example	Description
`start_id`	number	1	Begin id
`end_id`	number	10	End id

Response 200

Name	Type	Example	Description
`id`	number	1	Report id
`establishmentid`	number	1	Establishment id
`kassaid`	number	1	Cash register id
`startdate`	string	`2020-12-01 08:00:00`	Begin of report
`enddate`	string	`2020-12-01 18:00:00`	End of report
`startticket`	string	1	Begin order id
`endticket`	string	200	End order id
`ticketcount`	string	200	Ticket count
`ta0`	string	0.00	Taxable amount excl. vat 0%
`ta6`	string	0.00	Taxable amount excl. vat 6%
`ta12`	string	0.00	Taxable amount excl. vat 12%
`ta21`	string	1000.00	Taxable amount excl. vat 21%
`cashpayment`	string	1210.00	Cash payment incl. vat
`bancontactpayment`	string	0.00	Bancontact payment incl. vat
`voucherpayment`	string	0.00	Voucher payment incl. vat
`transferpayment`	string	0.00	Transfer payment incl. vat
`visapayment`	string	0.00	Visa payment incl. vat
`chargecardpayment`	string	0.00	Chargecard payment incl. vat
`luncheoncardpayment`	string	0.00	Luncheoncard payment incl. vat
`americanexpresspayment`	string	0.00	Americanexpress payment incl. vat
`mastercardpayment`	string	0.00	Mastercard payment incl. vat
`respayment`	string	0.00	RES payment incl. vat
`payconiqpayment`	string	0.00	Payconiq payment incl. vat
`totalexclvat`	string	1000.00	Total price excl. vat
`totalinclvat`	string	1210.00	Total price incl. vat
`100`	number
`200`	number
`1000`	number
`2000`	number
`10`	number
`20`	number
`21`	number
`12`	number
`9`	number
`6`	number
`0`	number
`barcode`	string
`rfid`	string
`1`	number		Invoice
`2`	number		Offer
`3`	number		Credit note
`5`	number		Delivery note
`1`	number		Money value
`2`	number		Percent
`1`	number		Admin
`0`	number		User
`0`	number		Not in use
`1`	number		In use
`2`	number		Wait for bill
`1`	number		Cash
`2`	number		Bancontact
`3`	number		Transfer
`4`	number		Visa
`5`	number		Meal vouchers
`6`	number		Gift voucher
`7`	number		Charging card
`8`	number		American Express
`9`	number		Mastercard
`10`	number		Seqr
`11`	number		RES
`12`	number		Payconiq
`13`	number		Too Good To Go
`14`	number		PayBonsai
`6`	number		Belgium
`29`	number		The Netherlands
`26`	number		Luxembourg

REQUEST

https://cloudpos.be/api/v2/zreports.select

HEADERS

Licensename: Licensename
Token: Token

BODY

{
  "start_id": 1,
  "end_id": 10
}

cURL

curl -X POST 'https://cloudpos.be/api/v2/zreports.select' \
  -H 'Content-Type: application/json' \
  -H 'Licensename: Licensename' \
  -H 'Token: Token' \
  -d '{   "start_id": 1,   "end_id": 10 }'

RESPONSE 200

{
  "id": 1,
  "establishmentid": 1,
  "kassaid": 1,
  "startdate": "`2020-12-01 08:00:00`",
  "enddate": "`2020-12-01 18:00:00`",
  "startticket": "1",
  "endticket": "200",
  "ticketcount": "200",
  "ta0": "0.00",
  "ta6": "0.00",
  "ta12": "0.00",
  "ta21": "1000.00",
  "cashpayment": "1210.00",
  "bancontactpayment": "0.00",
  "voucherpayment": "0.00",
  "transferpayment": "0.00",
  "visapayment": "0.00",
  "chargecardpayment": "0.00",
  "luncheoncardpayment": "0.00",
  "americanexpresspayment": "0.00",
  "mastercardpayment": "0.00",
  "respayment": "0.00",
  "payconiqpayment": "0.00",
  "totalexclvat": "1000.00",
  "totalinclvat": "1210.00",
  "100": null,
  "200": null,
  "1000": null,
  "2000": null,
  "10": null,
  "20": null,
  "21": null,
  "12": null,
  "9": null,
  "6": null,
  "0": null,
  "barcode": null,
  "rfid": null,
  "1": null,
  "2": null,
  "3": null,
  "5": null,
  "4": null,
  "7": null,
  "8": null,
  "11": null,
  "13": null,
  "14": null,
  "29": null,
  "26": null
}

CloudPOS

Authentication

Error codes

Changelog

Categories

category.select

Request attributes

Response 200

HEADERS

BODY

cURL

category.insert

Request attributes

Response 200

HEADERS

BODY

cURL

category.update

Request attributes

Response 200

HEADERS

BODY

cURL

category.delete

Request attributes

Response 200

HEADERS

BODY

cURL

Products

product.select

Request attributes

Response 200

HEADERS

BODY

cURL

product.insert

Request attributes

Response 200

HEADERS

BODY

cURL

product.update

Request attributes

Response 200

HEADERS

BODY

cURL

product.delete

Request attributes

Response 200

HEADERS

BODY

cURL

productpopup.select

Request attributes

Response 200

HEADERS

BODY

cURL

productpopup.update

Request attributes

Response 200

HEADERS

BODY

cURL

Subproducts

subproduct.select

Request attributes

Response 200

HEADERS

BODY

cURL

subproduct.insert

Request attributes

Response 200

HEADERS

BODY

cURL

subproduct.update