This API call lets you retrieve the list of POS settings. The response is an XML of the POS settings.
Request Fields
| Field Name |
Type |
Required |
Description |
| action |
String |
Yes |
posSettings |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
Response Fields
| Field Name |
Type |
Description |
| posSettings |
- |
XML structure |
| enabled |
Integer |
1 or 0. Whether the POS is enabled or not. |
| locationCountry |
String |
The country the POS is located in. |
| locationPorvince |
String |
The province the POS is located in. |
| allowDiscounts |
Integer |
1 or 0. Whether the POS allows discounts. |
| currency |
String |
The currency the POS uses. |
| terminalId |
Integer |
The terminal ID. |
| posLayoutId |
Integer |
The POS layout ID. |
| tax |
- |
XML structure |
| name |
String |
The name of the applicable tax. |
| rate |
Decimal |
The tax rate applied. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 0 |
- |
Invalid API Token1 |
The API Token is invalid, or not entered. |
| 0 |
- |
Missing or Invalid Fields - Account ID |
The Account ID is invalid, or not entered. |
