ShRepBillOfBalance

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

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

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

{
   "taskType":"ShRepBillOfBalance",
   "params":{
      "async":{
         "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"
         }
      }
   }
}

Параметр	Тип	Обязательный	Описание
taskType	string	+	Тип задачи
async			Асинхронный метод
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"
      }
   }
}

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

// Успешный ответ
{
   "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"
    }
  }
}