POST cashdesk/sale?Token={Token}
Store sales of products for current diner.
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
CashDeskSaleReq| Name | Description | Type | Additional information |
|---|---|---|---|
| CashDesk |
The cash desk identification. The cash desk identification is used to identify the cash desk where the request is coming from. |
string |
Required |
| PersonSystemId |
Person system internal identifier. |
globally unique identifier |
Required |
| SaleDate |
Date of sale. |
date |
Required |
| Receipt |
Receipt number. |
string |
None. |
| Refund |
Refund flag. |
boolean |
Required |
| Products |
List of products to sale. |
Collection of CashDeskProductSale |
Required |
Request Formats
application/json, text/json
{
"CashDesk": "sample string 1",
"PersonSystemId": "6228cb0e-c65c-4cc2-895f-31f546b8355d",
"SaleDate": "2026-05-25T05:58:40.64309+02:00",
"Receipt": "sample string 4",
"Refund": true,
"Products": [
{
"Order": 1,
"ProductPlu": "sample string 2",
"ProductId": "2675fd77-8ea5-4e75-b5b3-9ab39db03a2d",
"DeliveryDate": "2026-05-25T05:58:40.64309+02:00",
"Name": "sample string 5",
"Unit": "sample string 6",
"Amount": 7.0,
"Price": 8.0,
"VatRate": 9.0,
"PriceWithoutVat": 10.0
},
{
"Order": 1,
"ProductPlu": "sample string 2",
"ProductId": "2675fd77-8ea5-4e75-b5b3-9ab39db03a2d",
"DeliveryDate": "2026-05-25T05:58:40.64309+02:00",
"Name": "sample string 5",
"Unit": "sample string 6",
"Amount": 7.0,
"Price": 8.0,
"VatRate": 9.0,
"PriceWithoutVat": 10.0
}
]
}
application/xml, text/xml
<CashDeskSaleReq xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CashDesk>sample string 1</CashDesk>
<PersonSystemId>6228cb0e-c65c-4cc2-895f-31f546b8355d</PersonSystemId>
<SaleDate>2026-05-25T05:58:40.64309+02:00</SaleDate>
<Receipt>sample string 4</Receipt>
<Refund>true</Refund>
<Products>
<CashDeskProductSale>
<Order>1</Order>
<ProductPlu>sample string 2</ProductPlu>
<ProductId>2675fd77-8ea5-4e75-b5b3-9ab39db03a2d</ProductId>
<DeliveryDate>2026-05-25T05:58:40.64309+02:00</DeliveryDate>
<Name>sample string 5</Name>
<Unit>sample string 6</Unit>
<Amount>7</Amount>
<Price>8</Price>
<VatRate>9</VatRate>
<PriceWithoutVat>10</PriceWithoutVat>
</CashDeskProductSale>
<CashDeskProductSale>
<Order>1</Order>
<ProductPlu>sample string 2</ProductPlu>
<ProductId>2675fd77-8ea5-4e75-b5b3-9ab39db03a2d</ProductId>
<DeliveryDate>2026-05-25T05:58:40.64309+02:00</DeliveryDate>
<Name>sample string 5</Name>
<Unit>sample string 6</Unit>
<Amount>7</Amount>
<Price>8</Price>
<VatRate>9</VatRate>
<PriceWithoutVat>10</PriceWithoutVat>
</CashDeskProductSale>
</Products>
</CashDeskSaleReq>
Response Information
Response Codes
| Http Code | Error Number | Description |
|---|---|---|
| 200 request succesfully done | 0 | Successfully done |
| 400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
| 401 unauthorized | 1000 | Token {0} not found |
| 401 unauthorized | 1001 | Token {0} already expired |
| 401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
| 401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
| 401 unauthorized | 1008 | Request rate policy violated for [{0}] |
| 403 server refuses fo fulfill the request | 8 | Not licensed |
| 415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
| 500 internal error | Server exception description |
Resource Description
CashDeskSaleResp| Name | Description | Type | Additional information |
|---|---|---|---|
| ActualBalance |
The actual balance of the diner. |
decimal number |
None. |
| BalanceWarning |
The actual balance limit warning. |
decimal number |
None. |
| SpendingLimit |
Actual spending limit from deposit. |
decimal number |
None. |
| ErrorCode |
Error code. 0 - no error, 1 - not registered cashdesk, 2 - diner not found, 3 - not valid diner, 4 - not properly configured casdesk, 7 - no products specified, 8 - not rights to purchase, 9 - spending limit exceeded, 12 - closed period, 13 - no conversion rate specified |
integer |
None. |
| ErrorText |
Error description. |
string |
None. |
| WarnText |
Warning text. |
string |
None. |
Response Formats
application/json, text/json
{
"ActualBalance": 1.0,
"BalanceWarning": 1.0,
"SpendingLimit": 2.0,
"ErrorCode": 3,
"ErrorText": "sample string 4",
"WarnText": "sample string 5"
}
application/xml, text/xml
<CashDeskSaleResp xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ActualBalance>1</ActualBalance> <BalanceWarning>1</BalanceWarning> <SpendingLimit>2</SpendingLimit> <ErrorCode>3</ErrorCode> <ErrorText>sample string 4</ErrorText> <WarnText>sample string 5</WarnText> </CashDeskSaleResp>