2.1.2. Query string parameters
Parameter | Description | type | Is it Mandatory to complete the field? |
date | date and time of document creation, format: yyyy-MM- dd hh:mm:ss | string | yes |
docNumber | document number in the accounting system | string | yes |
wsName | checkout number to print on | string | |
departmentName | the name of the store to be printed on the check | string | |
employeeName | full name of the cashier | string | yes |
amount | document amount in minor currency units | integer | yes |
currency | currency name | string | |
genPreview | true – for generating a graphical image of the receipt, false – for printing | boolean | |
items | list of goods/services by invoice | array | yes |
taxes | list of taxes | array | yes |
payments | payment list | array | yes |
items
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
itemId | product/service code in the accounting system | string | yes |
itemName | product/service name | string | yes |
itemQRCode | QR-code product identification system | ||
itemCode | external code, classification code | ||
itemQty | qty*1000 | integer | yes |
itemPrice | price in minor currency units | integer | yes |
itemAmount | amount payable in minor currency units | integer | yes |
discount | discount(+)/increase(-) amount in minor currency units | integer | yes |
taxes | list of taxes by item | array |
taxes
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
taxName | tax name | string | |
taxCode | tax symbol (if applicable) | string | yes |
taxPrc | tax percentage | float | |
amount | amount to be taxed in minor currency units | integer | yes |
taxAmount | tax amount in minor currency units | integer | |
calcType | tax calculation type, possible values: 1 – including, 2 – fixed, 3 – simplified, default value – 1 | integer | yes |
payments
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
type | payment type code (C - cash, V - by card, other types of payments - see appendix) | string | yes |
name | payment type name | string | yes |
amount | payment amount in minor currency units | integer | yes |
change | change amount in minor currency units | integer | yes |
Code:​
{
"date": "string, document creation date and time, format: yyyy-MM-dd hh:mm:ss",
"docNumber": "string, document number in the accounting system",
"wsName": "string, cash register number for printing on the receipt (optional)",
"departmentName": "string, store name for printing on the receipt (optional)",
"employeeName": "string, cashier's full name",
"amount": "integer, document amount in minor currency units",
"currency": "string, currency name",
"genPreview": "boolean, true – for generating a graphical image of the receipt, false – for printing",
"items": [
{
"itemId": "string, product/service code in the accounting system",
"itemName": "string, product/service name",
"itemQRCode": "QR code for product identification",
"itemCode": "external code, classification code",
"itemQty": "integer, quantity*1000",
"itemPrice": "integer, price in minor currency units",
"itemAmount": "integer, amount to be paid in minor currency units",
"discount": "integer, discount amount in minor currency units",
"taxes": [
{
"taxName": "string, tax name",
"taxCode": "string, symbolic representation of the tax (if used)",
"taxPrc": "float, tax percentage",
"amount": "integer, amount to be taxed in minor currency units",
"taxAmount": "integer, tax amount in minor currency units",
"calcType": "integer, tax calculation type, possible values: 1 – inclusive, 2 – fixed, 3 – simplified. Default value - 1"
},
...
]
},
...
],
"taxes": [
{
"taxName": "string, tax name",
"taxCode": "string, symbolic representation of the tax (if used)",
"taxPrc": "float, tax percentage",
"amount": "integer, amount to be taxed in minor currency units",
"taxAmount": "integer, tax amount in minor currency units",
"calcType": "integer, tax calculation type, possible values: 1 – inclusive, 2 – fixed, 3 – simplified. Default value - 1"
},
],
"payments": [
{
"type": "string, payment type code (C – cash, V – card, other payment types – see the appendix)",
"name": "string, payment type name",
"amount": "integer, payment amount in minor currency units",
"change": "integer, change amount in minor currency units"
},
...
]
}