ShDocReceivingReport
Назначение | Создание приходной накладной |
Тип запроса | Асинхронный |
Поддерживаемая версия агента, SH | v1 — SH4, SH5 |
В SH4 тип учета, в котором создается документ, получается из прав пользователя, через которого происходит авторизация — он указывается в конфигураторе на вкладке Store House.
Если у пользователя есть права и на учет и спец. учет, то будет выведена ошибка 210.
В SH5:
- Код документа состоит только из одной части, которая заполняется в поле textcode
- Нельзя добавить примечание к создаваемой накладной
- Если указывается процентная ставка НДС, то она должна быть уже заведена в Store House как стандартная
- Можно одновременно указывать и сумму НДС, и процентную ставку
- Активность документа определяется признаком активирован получателем. Он передается через api.
Формат запроса
{
"taskType":"ShDocReceivingReport",
"params":{
"async": {
"objectId": "string",
"timeout": number
},
"sync": {
"objectId": "string",
"timeout": number
},
"doc":{
"items":[
{
"rid": number,
"quantity": number,
"mu": number,
"sum": number,
"vatSum": number,
"vatrate": number
}
],
"date": "YYYY-MM-DD",
"corr": number,
"store": number,
"active": number,
"dueDate": number,
"note": "string",
"textCode": "string",
"numCode": "string"
}
}
}
CODE
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
taskType | string | да | Тип задачи |
async | Асинхронный вызов метода: либо синхронный, либо асинхронный | ||
sync | Синхронный вызов метода: либо синхронный, либо асинхронный | ||
timeout | int | да | Время ожидания ответа от агента в секундах. По умолчанию — 120 секунд |
objectId | int | да | Код ресторана в системе лицензирования |
doc | string | ||
date | string | да | Дата, за которую будет создана накладная |
corr | int | да | rid корреспондента |
store | int | да | rid склада или подразделения |
active | int | Активировать ли накладную: 0 — нет, 1 — да | |
dueDate | int | Поместить ли накладную первой за дату: 0 — нет, 1 — да | |
note | string | Комментарий В SH5 не используется | |
textCode | string | Текстовая часть кода документа В SH5 в поле нужно указать полный код документа | |
numCode | string | Цифровая часть номера документа В SH5 поле не используется | |
items | array | ||
rid | int | rid товара | |
quantity | decimal | Количество, поддерживаются дробные значения | |
mu | int | rid единицы измерения | |
sum | Сумма без НДС * 100 | ||
vatSum | int | нет | Сумма НДС * 100 |
vatRate | int | нет | Ставка НДС * 100 В SH5 уже должна быть заведена такая ставка в качестве стандартной |
Формат ответа
{
"responseCommon":{
"taskGuid": "guid",
"taskType": "ShDocReceivingReport",
"objectId": number
},
"error":{
"wsError":{
"code": "string",
"desc": "string"
}
}
}
CODE
Параметр | Тип | Описание |
---|---|---|
error | Контейнер ошибок | |
objectId | int | Код ресторана в системе лицензирования |
taskGuid | guid | Уникальный код этой задач. Используется при получении задачи через очередь |
taskType | string enum | Тип задачи |
Формат асинхронного ответа
// Успешный ответ
{
"taskResponse":{
"doc":{
"rid": number,
"textCode": "string",
"numCode": "string"
}
},
"responseCommon":{
"taskGuid": "string",
"taskType": "ShDocReceivingReport",
"objectId": number
}
}
// Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "ShDocReceivingReport",
"objectId": number
},
"error": {
"wsError": {
"code": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}
CODE
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
doc | да | ||
rid | int | rid созданного документа | |
textCode | string | Текстовая часть номера созданного документа В SH5 в этом поле содержится весь номер документа | |
numCode | string | Цифровая часть номера созданного документа В SH5 не заполняется | |
error | string enum | Контейнер ошибок |