НазначениеСоздание расходной накладной
Тип запросаАсинхронный
Поддерживаемая версия агента, shv1 — SH4, SH5
v2 — SH5

В SH4 тип учета, в котором создается документ, получается из прав пользователя, через которого происходит авторизация — он указывается в конфигураторе на вкладке Store House.
Если у пользователя есть права и на учет и спец. учет, то будет выведена ошибка 210.

В SH5:

  • Код документа состоит только из одной части, которая заполняется в поле textcode
  • Нельзя добавить примечание к создаваемой накладной
  • Если указывается процентная ставка НДС, то она должна быть уже заведена в Store House как стандартная
  • Можно одновременно указывать и сумму НДС, и процентную ставку
  • Активность документа определяется признаком активирован получателем. Он передается через api.

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

{
   "taskType":"ShDocDashingReport",
   "params":{
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "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

Параметр

Тип

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

Описание

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

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

Синхронный вызов метода: либо синхронный, либо асинхронный
timeoutintнетВремя ожидания ответа от агента в секундах. По умолчанию — 120 секунд
objectIdintдаКод ресторана в системе лицензирования
doc
да
datestringдаДата, за которую будет создана накладная
corrintдаrid корреспондента
storeintдаrid склада/подразделения
activeint
Активировать ли накладную: 0 — нет, 1 — да
dueDateint
Поместить ли накладную первой за дату: 0 — нет, 1 — да
notestring

Комментарий
В SH5 не используется

textCodestring

Текстовая часть кода документа
В SH5 в поле нужно указать полный код документа

numCodestring

Цифровая часть номера документа
В SH5 поле не используется

itemsarray

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

Сумма НДС * 100
Если поле не заполнено, то сумма рассчитается исходя из процента НДС

vatRateint

Ставка НДС * 100
В SH5 уже должна быть заведена такая ставка в качестве стандартной

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

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

Параметр

Тип

Описание

taskGuidguidУникальный код этой задачи используется при получении задачи через очередь
taskTypestring enumТип задачи
objectIdintКод ресторана в системе лицензирования
error
Контейнер ошибок

Формат асинхронного ответа

// Успешный ответ
{
   "taskResponse":{
      "doc":{
         "rid": number,
         "textCode": "string",
         "numCode": "string"
      }
   },
   "responseCommon":{
      "taskGuid": "string",
      "taskType": "ShDocDashingReport",
      "objectId": number
   }
}
   
// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShDocDashingReport",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}
CODE

Параметр

Тип параметра

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

Описание

doc
да
ridint
rid созданного документа
textCodestring
Текстовая часть номера созданного документа
В SH5 в этом поле содержится весь номер документа
numCodestring
Цифровая часть номера созданного документа
В SH5 не заполняется
errorstring enum
Контейнер ошибок