ShRepBillOfBalance

Назначение	Запрос отчета «Ведомость остатков»
Тип запроса	Асинхронный
Поддерживаемая версия агента, SH	v1(SH4, SH5), v2(SH5)
PluggetSystemType	StoreHouse

В SH5 группировки значительно отличаются.

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

{
   "taskType":"ShRepBillOfBalance",
   "params":{
      "async":{
         "objectId": number,
         "timeout": number
      },
      "sync": {
        "objectId": number,
         "timeout": number
      },
      "reportParams":{
         "reportDate":{
            "date": "YYYY-MM-DD"
         },
         "goodsGroup":{
            "rid": number,
            "withNestedGroups": number
         },
         "category":{
            "mainRid": number,
            "bookeepingRid": number
         },
         "classify":{
            "itemRid": number
         },
         "store":{
            "rid": number,
            "groupRid": number
         },
         "currency":{
            "rid": number
         },
         "constraints":{
            "groupFor": "string",
            "onlyWithMovementForStore": number
         },
         "remnants":{
            "condition": "string",
            "value": "string"
         }
      }
   }
}

CODE

Параметр	Тип	Обязательный	Описание
taskType	string	+	Тип задачи
async			Асинхронный метод
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
objectId	int	+	Код ресторана в системе лицензирования
reportParams
reportDate		+
date	string	+	Дата, за которую будет создана накладная
goodsGroup
rid	int		rid товарной группы
withNestedGroups	int		включить в отчет данные по вложенным группам (0 - нет, 1 - да)
category
mainRid	int_or_null		rid основной категории
bookeepingRid	int_or_null		rid бухгалтерской категории
classify
itemRid	int_or_null		rid значения товарного классификатора
store
rid	int_or_null		rid склада. Если присутствует этот атрибут, то атрибута STORE.group_rid не должно быть
groupRid	int_or_null		rid группы складов. Если присутствует этот атрибут, то атрибута STORE.rid не должно быть
store		+
rid	int	+	rid валюты
constraints
groupFor	enum		По какому значению группировать отчет. Атрибут может принимать значения: - None - не группировать (используется, если атрибут отсутствует); - ForStores - группировать по складам; - ForGoodGroups - группировать группам товаров;
onlyWithMovementForStore	int_or_null		выводить только товары, по которым есть операции по складу/складам (0 - нет, 1 - да)
remnants			Условие на наличие/отсутствие остатков
condition	enum		Условие, может принимать значения: - Less - меньше; - NotMore - не более; - Equal - равно; - NotLess - не менее; - More - больше; - NotEqual - не равно;
value	enum		Атрибут может принимать значения: - Zero - нуля; - MinimumStock - мин. товарного запаса; - MaximumStock - макс. товарного запаса; Если REMNANTS.condition не заполнен, то значение атрибута REMNANTS.value игнорируется.

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

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

CODE

Параметр	Тип	Описание
taskGuid	guid	Уникальный код этой задачи используется при получении задачи через очередь
taskType	string enum	Тип задачи
objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, см. Описание ошибок

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

// Успешный ответ
{
   "taskResponse":{
      "groups":[
         {
            "name": "string",
            "id": number
         }
      ],
      "lines":[
         {
            "rid": number,
            "goodName": "string",
            "attributeText": "string",
            "attributeNumber": "string",
            "mUnitsRid": number,
            "mUnitsName": "string",
            "quantity": number,
            "sumWithoutTax": number,
            "sumNds": number,
            "sumNsp": number,
            "minReserve": number,
            "maxReserve": number,
            "groupId": "int_or_null"
         }
      ]
   },
   "responseCommon":{
      "taskGuid": "string",
      "taskType": "ShRepBillOfBalance",
      "objectId": number
   }
}
   
// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShRepBillOfBalance",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр	Тип параметра	Описание
groups	array
name	string	Название группы
id	int	Идентификатор группы
lines	array
rid	int	rid товара
goodName	string	Название товара
attributeText	string	Аббревиатура товара префикс
attributeNumber	string	Аббревиатура товара номер
mUnitsRid	int	rid единицы измерения
mUnitsName	string	Название единицы измерения
quantity	float	Количество (с точностью до 3-х знаков после запятой)
sumWithoutTax	float	Сумма без налогов
sumNds	float	Сумма НДС
sumNsp	float	Сумма НСП
minReserve	float	Минимальный запас. Если атрибута нет в ответе, то минимальный запас не ограничен
maxReserve	float	Максимальный запас. Если атрибута нет в ответе, то максимальный запас не ограничен
groupId	int_or_null	Идентификатор группы. Если запрошен отчет без группировок, то это поле не возвращается
error		Контейнер ошибок, см. Описание ошибок