2.6.3. Response
field | Description | type |
status | success " | " error | |
message | error text , optional | string |
data | array |
data
array​
Parameter | Description | type | Is it Mandatory to complete the field? |
shift_open | current shift state | boolean | |
shift_id | Shift ID , optional | string | |
cash | amount of cash on hand in kopecks | integer | |
shift_totals | array |
shift_totals
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
startShift | array | ||
endShift | array | ||
firstDocNumber | number of the first document in the shift | integer | |
lastDocNumber | number of the last document in the shift | integer | |
totals | array | ||
taxes | taxes | array | |
payments | payment types details | array |
startShift
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
openTime | shift opening time, format yyyy-mm-dd HH:MM:SS | string | |
cash | the amount of cash on hand at the time of opening the shift in kopecks | integer | |
openOrdersCnt | number of open accounts when opening a shift | integer |
endShift
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
closeTime | shift closing time, format yyyy-mm-dd HH:MM:SS | string | |
Cash | the amount of cash on hand at the time of closing the shift in kopecks | integer | |
operaCount | number of operations per shift | integer | |
openOrdersCnt | number of open accounts when closing a shift | integer |
totals
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
sale | sales | arrary | |
withdraw | collection | arrary |
sale
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
count | quantity | ||
amount | amount in kopecks |
withdraw
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
count | quantity | ||
amount | amount in kopecks |
taxes
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
sale | from sale | array |
sale
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
A | array |
A
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
taxCode | tax code | string | |
taxVal | tax percentage * 100 | integer | |
taxName | tax name | string | |
amount | amount of turnover in kopecks | integer | |
taxAmount | amount of tax in kopecks | integer |
payments
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
sale | sales | array |
sale
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
C | in cash | array |
C
Array​
Parameter | Description | type | Is it Mandatory to complete the field? |
count | quantity | integer | |
amount | amount in kopecks | integer | |
change | change amount in kopecks | integer |
Code:​
{
"status": "success" | "error",
"message": "string, error text, optional",
"data": {
"shift_open": "boolean, current shift state",
"shift_id": "integer, shift ID",
"cash": "integer, amount of cash in the cash register in kopecks",
"shift_totals": {
"startShift": {
"openTime": "string, shift opening time, format yyyy-mm-dd HH:MM:SS",
"cash": "integer, amount of cash in the cash register at the start of the shift in kopecks",
"openOrdersCnt": "integer, number of open orders at the start of the shift"
},
"endShift": {
"closeTime": "string, shift closing time, format yyyy-mm-dd HH:MM:SS",
"cash": "integer, amount of cash in the cash register at the end of the shift in kopecks",
"operCount": "integer, number of operations during the shift",
"openOrdersCnt": "integer, number of open orders at the end of the shift"
},
"firstDocNumber": "integer, number of the first document in the shift",
"lastDocNumber": "integer, number of the last document in the shift",
"totals": {
"sale": {
"count": "integer, quantity",
"amount": "integer, amount in kopecks"
},
"withdraw": {
"count": "integer, quantity",
"amount": "integer, amount in kopecks"
}
},
"taxes": {
"sale": {
"A": {
"taxCode": "string, tax code",
"taxVal": "integer, tax rate * 100",
"taxName": "string, tax name",
"amount": "integer, turnover amount in kopecks",
"taxAmount": "integer, tax amount in kopecks"
},
...
}
},
"payments": {
"sale": {
"C": {
"count": "integer, quantity",
"amount": "integer, amount in kopecks",
"change": "integer, change amount in kopecks"
},
...
}
}
}
}
}