Назначение

Получение списка приходных накладных за период

Тип запросаАсинхронный/синхронный
Поддерживаемая версия агента, SHv2 — SH5
PluggetSystemTypeStoreHouse

Формат запроса

{
   "taskType":"ShGetReceivingReports",
   "params":{
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
      "startDate": "YYYY-MM-DD",
      "endDate": "YYYY-MM-DD"
   }
}
CODE

Параметр

Тип

Обязательный

Описание

taskTypestringдаТип задачи
async

Асинхронный вызов метода: либо синхронный, либо асинхронный
sync

Синхронный вызов метода: либо синхронный, либо асинхронный
timeoutintнетВремя ожидания ответа от агента в секундах. По умолчанию 120 секунд
objectIdintдаКод ресторана в системе лицензирования
startDatedateдаПервый день запрашиваемого периода
endDatedateдаПоследний день запрашиваемого периода

Формат ответа

{ 
   "responseCommon":{ 
      "taskGuid": "guid",
      "taskType": "ShGetReceivingReports",
      "objectId": number
   },
   "error":{ 
      "wsError":{ 
         "code": "string",
         "desc": "string"
      }
   }
}
CODE

Параметр

Тип

Описание

taskGuidguidУникальный код этой задачи используется при получении задачи через очередь
taskTypestring enumТип задачи
objectIdintКод ресторана в системе лицензирования
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
даПриходные накладные
ridintдаrid накладной
datestringдаДата накладной
corrintдаrid поставщика
storeintдаrid склада
activeint
Активна ли накладная: 0 — нет, 1 — да
itemsarray

ridint
rid товара
quantitydecimal
Количество, поддерживаются дробные значения
muint
rid единицы измерения
sumint
Сумма без НДС * 100
vatSumintнетСумма НДС * 100
vatRateintнетСтавка НДС * 100
В SH5 уже должна быть заведена такая ставка в качестве стандартной