ShGetReceivingReports
Назначение | Получение списка приходных накладных за период |
---|---|
Тип запроса | Асинхронный/синхронный |
Поддерживаемая версия агента, SH | v2 — SH5 |
PluggetSystemType | StoreHouse |
Формат запроса
{
"taskType":"ShGetReceivingReports",
"params":{
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
},
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
}
}
CODE
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
taskType | string | да | Тип задачи |
async | Асинхронный вызов метода: либо синхронный, либо асинхронный | ||
sync | Синхронный вызов метода: либо синхронный, либо асинхронный | ||
timeout | int | нет | Время ожидания ответа от агента в секундах. По умолчанию 120 секунд |
objectId | int | да | Код ресторана в системе лицензирования |
startDate | date | да | Первый день запрашиваемого периода |
endDate | date | да | Последний день запрашиваемого периода |
Формат ответа
{
"responseCommon":{
"taskGuid": "guid",
"taskType": "ShGetReceivingReports",
"objectId": number
},
"error":{
"wsError":{
"code": "string",
"desc": "string"
}
}
}
CODE
Параметр | Тип | Описание |
---|---|---|
taskGuid | guid | Уникальный код этой задачи используется при получении задачи через очередь |
taskType | string enum | Тип задачи |
objectId | int | Код ресторана в системе лицензирования |
error | Контейнер ошибок |
Формат асинхронного ответа
// Успешный ответ
{
"taskResponse": {
"reports": [
{
"rid": "rid",
"date": "YYYY-MM-DD",
"corr": "rid",
"store": "rid",
"active": "0,1",
"items": [
{
"rid": "rid",
"quantity": "number",
"mu": "rid",
"sum": "number",
"vatSum": "number",
"vatrate": "number"
}
]
}
]
},
"responseCommon": {
"taskGuid": "string",
"taskType": "ShGetReceivingReports",
"objectId": "number"
}
}
// Ответ с ошибкой от сервера
{
"responseCommon": {
"taskGuid": "string",
"taskType": "ShGetReceivingReports",
"objectId": "number"
},
"error": {
"wsError": {
"code": "string",
"desc": "string"
}
}
}
// Ответ с ошибкой от агента
{
"responseCommon": {
"taskGuid": "string",
"taskType": "ShGetReceivingReports",
"objectId": "number"
},
"error": {
"agentError": {
"code": "string",
"desc": "string"
}
}
}
CODE
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
reports | да | Приходные накладные | |
rid | int | да | rid накладной |
date | string | да | Дата накладной |
corr | int | да | rid поставщика |
store | int | да | rid склада |
active | int | Активна ли накладная: 0 — нет, 1 — да | |
items | array | ||
rid | int | rid товара | |
quantity | decimal | Количество, поддерживаются дробные значения | |
mu | int | rid единицы измерения | |
sum | int | Сумма без НДС * 100 | |
vatSum | int | нет | Сумма НДС * 100 |
vatRate | int | нет | Ставка НДС * 100 В SH5 уже должна быть заведена такая ставка в качестве стандартной |