POST cashdesk/withdraw?Token={Token}
Withdraw money 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
CashDeskWithdrawReq| 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 |
| Amount |
The amount to withdraw. |
decimal number |
Required |
| Date |
Date of withdraw. |
date |
Required |
| Rounding |
Rounding cash for withdrawal to zero. If the rounding amount is to be subtracted, enter a plus amount. |
decimal number |
None. |
| PaymentMethod |
Payment method. 1 - cash, 8 - payment terminal, 9 - meal voucher |
integer |
Required |
| Receipt |
Receipt number. |
string |
None. |
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. |