Отчеты

Отчет Остатки

Отчет об остатках в МоемСкладе доступен в расширенном и кратком виде. Запросить отчет можно с помощью JSON API. Также можно подписаться на вебхуки на изменение остатков. Используйте JSON API, если остатки меняются часто, и вы хотите запрашивать их каждые несколько минут. Если остатки меняются реже, чем раз в несколько минут, и вы хотите получать уведомления об изменениях, используйте вебхуки.

Для работы с отчетом дополнительных прав не требуется.

На содержание отчета влияют настройки видимости документов, доступных пользователю, который запросил отчет. При отсутствии соответствующих прав видимости у пользователя в отчете могут не отображаться:

• данные по конкретным товарам и складам;
• себестоимость, цена закупки, прибыль.

Подробнее об остатках и работе с ними читайте в статье Остатки.

Расширенный отчет об остатках

Расширенный отчет об остатках — это подробный отчет, в котором собраны данные обо всех товарах с указанием всей необходимой информации о товаре (штрихкод, цены, изображение и тд.). Используйте отчет, чтобы получить детальную информацию о товарах или периодически проводить полную синхронизацию с МоимСкладом, например один раз в день. Однако это достаточно долгий и тяжелый запрос, использовать его часто не рекомендуется.

Атрибуты объекта отчета:

Название	Тип	Описание
article	String(255)	Артикул
code	String(255)	Код Обязательное при ответе
externalCode	String(255)	Внешний код сущности, по которой выводится остаток Обязательное при ответе
folder	Object	Группа Товара/Модификации/Cерии. Подробнее тут Обязательное при ответе
image	Meta	Метаданные изображения Товара/Модификации/Серии
inTransit	Float	Ожидание Обязательное при ответе
meta	Meta	Метаданные Товара/Модификации/Серии по которой выдается остаток Обязательное при ответе
name	String(255)	Наименование Обязательное при ответе
price	Float	Себестоимость
quantity	Float	Доступно Обязательное при ответе
reserve	Float	Резерв Обязательное при ответе
salePrice	Float	Цена продажи
stock	Float	Остаток Обязательное при ответе
stockDays	Int	Количество дней на складе Обязательное при ответе
uom	Object	Единица измерения. Подробнее тут Обязательное при ответе

Атрибуты вложенных сущностей

Единица измерения

Название	Тип	Описание
meta	Meta	Метаданные единицы измерений Обязательное при ответе
name	String(255)	Наименование единицы измерений Обязательное при ответе

Группа

Название	Тип	Описание
meta	Meta	Метаданные группы товара Обязательное при ответе
name	String(255)	Наименование группы Обязательное при ответе
pathName	String	Наименование родительской группы Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter.

Название	Тип	Фильтрация	Описание
archived	Boolean	=	параметр для фильтрации по архивности товаров. Возможные значения: true, false. Для выдачи как архивных, так и не архивных товаров нужно передать сразу два значения true и false.
consignment	Object	= !=	параметр для фильтрации по нескольким сериям. Значение параметра - ссылка на серию, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений. Данный параметр фильтрации можно комбинировать с параметрами product и variant.
inTransitOnly	Boolean	=	параметр для фильтрации по значению ожидания. Если передать true, в выборку попадут только товары с ожиданием.
moment	DateTime	=	момент времени, на который нужно вывести остатки. Передается в виде строки в формате дата-время
product	Object	= !=	параметр для фильтрации по нескольким товарам. Значение параметра - ссылка на товар, который должен быть включен в выборку или исключен из нее. Можно передать несколько значений. Данный параметр фильтрации можно комбинировать с параметрами consignment и variant.
productFolder	Object	= !=	параметр для фильтрации по нескольким группам товаров. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
withSubFolders	Boolean	=	параметр учета вложенных подгрупп. Работает только при наличии фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
quantityMode	Enum	=	параметр для фильтрации по значению доступно. Значение по умолчанию nonEmpty. Доступные значения
reserveOnly	Boolean	=	параметр для фильтрации по значению резерва. Если передать true, в выборку попадут только товары с резервом.
search	String(255)	= !~	специальный параметр текстового поиска. Поиск осуществляется по вхождению подстроки в названия товаров, модификаций, серий.
soldByWeight	Boolean	=	параметр для фильтрации по признаку весового товара. Возможные значения: true, false.
stockDaysFrom	Int	=	параметр для фильтрации по количеству дней на складе. Передавать нужно целое число. В выборку попадут товары, у которых количество дней на складе больше или равно указанному. Данный параметр фильтрации можно комбинировать с параметром stockDaysTo.
stockDaysTo	Int	=	параметр для фильтрации по количеству дней на складе. Передавать нужно целое число. В выборку попадут товары, у которых количество дней на складе меньше или равно указанному. Данный параметр фильтрации можно комбинировать с параметром stockDaysFrom.
stockMode	Enum	=	параметр для фильтрации по значению остатка. Значение по умолчанию all. Доступные значения
store	Object	= !=	параметр для фильтрации по нескольким складам. Значение параметра - ссылка на склад, который должен быть учтен в выборке или исключен из нее. Можно передать несколько значений.
supplier	Object	= !=	параметр для фильтрации по нескольким поставщикам. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены или исключены товары с указанными поставщиками. Можно передать пустое значение, тогда в выборку попадут товары с незаполненным или заполненным поставщиком.
variant	Object	= !=	параметр для фильтрации по нескольким модификациям. Значение параметра - ссылка на модификацию, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений. Данный параметр фильтрации можно комбинировать с параметрами product и consignment.

Доступные значения для stockMode

Значение по умолчанию all.

Значение	Описание
all	Любое значение остатка
positiveOnly	Положительный остаток
negativeOnly	Отрицательный остаток
empty	Нулевой остаток
nonEmpty	Ненулевой остаток
underMinimum	Остаток ниже неснижаемого остатка

Доступные значения для quantityMode

Значение по умолчанию nonEmpty.

Значение	Описание
all	Любое значение остатка
positiveOnly	Положительный остаток
negativeOnly	Отрицательный остаток
empty	Нулевой остаток
nonEmpty	Ненулевой остаток
underMinimum	Остаток ниже неснижаемого остатка

Для параметров фильтрации product, variant, consignment, productFolder и search в рамках одного запроса можно использовать только одинаковые операторы (для search оператор !~ сочетается с оператором != остальных полей).

Примеры фильтрации:

• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2;withSubFolders=false
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/656c4032-8552-11e6-8a84-bae500000044;consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/product/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=variant=https://online.moysklad.ru/api/remap/1.2/entity/variant/656c4032-8552-11e6-8a84-bae500000044;consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/product/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;variant=https://online.moysklad.ru/api/remap/1.2/entity/variant/656c4032-8552-11e6-8a84-bae500000044;consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/product/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=stockMode=all
• filter=quantityMode=all
• filter=stockMode=all;quantityMode=all
• filter=moment=2019-07-10 12:00:00
• filter=stockDaysFrom=10;stockDaysTo=50
• filter=soldByWeight=true
• filter=reserveOnly=true
• filter=inTransitOnly=true
• filter=archived=true
• filter=archived=false;archived=true
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/656c4032-8667-11e6-8a84-bae5000033aa
• filter=search=див

Фильтрация по дополнительным полям и характеристикам

C помощью параметра filter выборку также можно фильтровать по значениям дополнительных полей товаров и характеристик модификаций.

Для фильтрации по значению дополнительного поля, нужно передать ссылку на дополнительное поле и его значение:

filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/=<Значение>

Для фильтрации по значению дополнительных полей типа строка, текст и ссылка нужно использовать оператор =. Также можно использовать операторы = и != с пустым значением, чтобы получить товары только с незаполненным дополнительным полем или только заполненным, соответственно.

Для фильтрации по значению дополнительных полей типа целое число, вещественное число, дата можно использовать операторы =, >=, <=. Также можно использовать операторы = и != с пустым значением, чтобы получить товары только с незаполненным дополнительным полем или только заполненным, соответственно. Для дополнительного поля типа дата-время значение передается в виде строки в формате дата-время.

Для фильтрации по значению дополнительных полей типа справочник можно использовать операторы = и !=. В качестве значения нужно передавать ссылку на объект справочника. Также можно использовать операторы = и != с пустым значением, чтобы получить товары только с незаполненным дополнительным полем или только заполненным, соответственно.

Пример фильтрации по дополнительному полю типа справочник складов: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://online.moysklad.ru/api/remap/1.2/entity/store/302f2a81-9977-11e9-9109-f8fc00020e02

Пример фильтрации по дополнительному полю типа пользовательский справочник: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://online.moysklad.ru/api/remap/1.2/entity/customentity/8955249d-997d-11e9-9ff4-3150000e65c3/8955314d-997d-11e9-9ff4-3150000e65c4

Для фильтрации по значению дополнительных полей типа флажок нужно использовать оператор =. Возможные значения: true, false.

Фильтрация по дополнительным полям типа файл не поддерживается.

Для фильтрации по значению характеристики нужно передать ссылку на характеристику и значение:

filter=https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics/=<Значение>

Для фильтрации по значению характеристики нужно использовать оператор =. Также можно использовать операторы = и != с пустым значением, чтобы получить товары или модификации только с незаполненной характеристикой или только заполненной, соответственно.

Атрибуты доступные для сортировки

Результаты отчета можно отсортировать, используя параметр order.

Название	Описание
avgStockDays	по количеству дней на складе
code	по коду
inTransit	по значению ожидания
minimumBalance	по неснижаемому остатку
name	по наименованию
pathName	по группе товаров
price	по себестоимости
productCode	по артикулу
quantity	по значению доступно
reserve	по значению резерва
salePrice	по цене продажи
stock	по значению остатка
sumTotal	по сумме себестоимости

По умолчанию выборка сортируется по группе товара и имени товара.

Получить Расширенный отчет об остатках

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
groupBy	string (optional) тип, по которому нужно сгруппировать выдачу.По умолчанию параметр groupBy имеет значение variant. Если вы хотите увидеть объекты типа consignment, или только объекты типа product, необходимо выставить соответствующее значение параметра. groupBy=product - выдает только товары groupBy=variant - выдает товары и модификации groupBy=consignment - выдает товары, модификации, серии
includeRelated	boolean (optional) Вывод остатков по модификациям и сериям товаров. Параметр позволяет включить в выборку остатки по модификациям и сериям для товаров. Необходимым условием для применения параметра является обязательное наличие фильтрации по товарам или модификациям или их комбинации. При выбранном значении includeRelated=true будут включены все остатки для товаров, модификаций и серий, указанных в параметрах фильтрации. При использовании параметра устанавливается параметр группировки groupBy=consignment, переданные значения для groupBy будут проигнорированы.

Примеры использования параметра includeRelated:
filter=variant!=&includeRelated=true выводит остатки товаров, модификаций, серий за исключением конкретной модификации указанной в URL.
filter=product=&includeRelated=true выводит остатки конкретного товара указанного в URL, его модификации и серии.

Запрос на получение Расширенного отчета об остатках.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/all"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/stock/all",
    "type": "stock",
    "mediaType": "application/json",
    "size": 26,
    "limit": 10,
    "offset": 0,
    "nextHref": "http://online.moysklad.ru/api/remap/1.2/report/stock/all?limit=10&offset=10"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/c02e3a5c-007e-11e6-9464-e4de00000006?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": -30,
      "inTransit": 0,
      "reserve": 0,
      "quantity": -30,
      "name": "Товар",
      "code": "one1",
      "article": "Ar23",
      "price": 0,
      "salePrice": 346347237000,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/cc99c055-fa34-11e5-9464-e4de00000069?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": 4,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 4,
      "name": "ТоварБезШК",
      "code": "00006",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/e8f5f9ff-fa34-11e5-9464-e4de0000008a?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "Товар с модой без ШК",
      "code": "00008",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8f9d714-fa34-11e5-9464-e4de0000008d?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "Товар с модой без ШК (1)",
      "code": "00208",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8fc24b5-fa34-11e5-9464-e4de00000091?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "Товар с модой без ШК (2)",
      "code": "00209",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e91042b4-fa34-11e5-9464-e4de00000095?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "Товар с модой без ШК (3)",
      "code": "00210",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/daf1186d-fa34-11e5-9464-e4de0000006f?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "ТоварСМодой_и_ШК",
      "code": "00007",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/db1a888a-fa34-11e5-9464-e4de00000073?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "ТоварСМодой_и_ШК (1)",
      "code": "00205",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/db2066c8-fa34-11e5-9464-e4de00000077?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "ТоварСМодой_и_ШК (2)",
      "code": "00206",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/db22f3e8-fa34-11e5-9464-e4de0000007b?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": 1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": 1,
      "name": "ТоварСМодой_и_ШК (3)",
      "code": "00207",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/d3e2dcd6-f648-11e5-8a84-bae500000074?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": -6438,
      "inTransit": 0,
      "reserve": 0,
      "quantity": -6438,
      "name": "ТоварСоСтраной",
      "code": "00002",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/eeef177f-f648-11e5-8a84-bae50000007a?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": -113,
      "inTransit": 0,
      "reserve": 0,
      "quantity": -113,
      "name": "Мяч",
      "code": "00003",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/fd867506-f67d-11e5-8a84-bae50000006e?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": -21,
      "inTransit": 0,
      "reserve": 0,
      "quantity": -21,
      "name": "Мяч (Футбольный)",
      "code": "00002",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/fd92dbb9-f67d-11e5-8a84-bae500000076?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": -1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": -1,
      "name": "Мяч (Волейбольный)",
      "code": "00004",
      "price": 0,
      "salePrice": 0,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/be903062-f504-11e5-8a84-bae50000019a?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stock": 69,
      "inTransit": 0,
      "reserve": 20,
      "quantity": 49,
      "name": "Трололоша",
      "code": "00001",
      "price": 50260.86956521739,
      "salePrice": 123000,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/d1bef0a1-ffe7-11e5-9464-e4de0000001c?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stock": -1,
      "inTransit": 0,
      "reserve": 0,
      "quantity": -1,
      "name": "ТОварИщ (10)",
      "code": "00214",
      "article": "Артикулс",
      "price": 0,
      "salePrice": 346347237000,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        },
        "name": "шт"
      },
      "folder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/productfolder/0c78adde-ffe3-11e5-9464-e4de000000a2",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/productFolder/metadata",
          "type": "productfolder",
          "mediaType": "application/json"
        },
        "name": "Товары Из кастомной группы",
        "pathName": "Группа"
      },
      "images": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/d1bef0a1-ffe7-11e5-9464-e4de0000001c/images",
          "type": "image",
          "mediaType": "application/json",
          "size": 1,
          "limit": 1000,
          "offset": 0
        }
      },
      "externalCode": "ibWbdtWWhXiIwfZVEal6z2"
    }
  ]
}

Краткий отчет об остатках

Краткий отчет об остатках — это отчет, в котором указываются только ID товара и его остаток на складе на момент запроса. Используйте отчет, если нужно следить за остатками большого количества товаров и запрашивать данные каждые 5-15 минут.

Отличия от Расширенного отчета об остатках:

• Краткий отчет об остатках может запросить только администратор.
• Получить отчет с большим объемом данных можно гораздо быстрее.
• Все данные передаются в одном ответе, без необходимости листания.
• Количество складов указываются без учета вложенных складов.
• При разделении по складам строка без склада содержит резервы, не привязанные к складу.
• Возвращается только один вид остатков, указанный в параметре stockType.
• Нет сортировки, данные отображаются в произвольном порядке.

Получить Краткий отчет об остатках

Чтобы получить отчет, используйте эндпоинты /report/stock/all/current и /report/stock/bystore/current.

Эндпоинты предназначены для частого и быстрого обновления остатков для большого количества товаров.

Параметр include

По умолчанию выводятся только результаты с ненулевым значением остатка. Для вывода нулевых остатков, необходимо добавить параметр include=zeroLines.

Параметр changedSince

По умолчанию выводятся остатки на текущий момент. Параметром changedSince можно получить остатки, которые изменились в интервале между временем указанным в параметре changedSince и текущим моментом. Остатки в ответах на эндпоинты /report/stock/all/current и /report/stock/bystore/current это фактический остаток на текущий момент времени на всех складах и с разбивкой по складам соответственно, не дельта за период, не остаток на момент времени changedSince, а фактический остаток по номенклатуре, у которой изменился остаток за интервал. Формат значения параметра - строка вида "гггг-мм-дд чч-мм-сс". Пример: changedSince=2016-08-23 15:21:09. Подробнее тут

Ограничения и рекомендации, накладываемые на параметр:

• При использовании параметра changedSince всегда включен вывод нулевых остатков.
• Максимальное значение параметра changedSince в прошлое от текущего момента не должно превышать 24 часа.
• Минимальное значение параметра changedSince в прошлое от текущего момента не ограничено.
• Параметр changedSince не может превышать текущий момент.
• Небольшое перекрытие интервалов запросов поможет исключить потерю обновления остатков на границах интервалов (пример: запрос остатков каждые 30 минут за прошедшие 35 минут).
• Рекомендуется проводить полную синхронизацию остатков без параметра changedSince раз в сутки и чаще, в зависимости от частоты изменения остатков.

Важно: если за запрашиваемый интервал был удален (не архивирован) товар или склад, то будет выведен остаток равный 0. Стоит учитывать, что по id запросить этот товар или склад уже не получится.

Параметр stockType

Параметром stockType выбирается тип остатка, который необходимо рассчитать. На данный момент возможно получить только один тип остатка. Значение по умолчанию - stock

Значение	Описание
stock	Физический остаток на складах, без учёта резерва и ожидания
freeStock	Остаток на складах за вычетом резерва
quantity	Доступно. Учитывает резерв и ожидания

Доступные фильтры отчёта Текущие Остатки

Можно ограничить отчёт несколькими товарами или складами. Указывается id сущности, а не url.

Значение	Тип	Фильтрация	Описание
assortmentId	UUID	=	Выдать в отчёте только указанные товары, модификации и серии
storeId	UUID	=	Выдать в отчёте только указанные склады

Несколько значений можно указать через запятую или через несколько параметров:

• filter=assortmentId=00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
• filter=assortmentId=00000000-0000-0000-0000-000000000001;assortmentId=00000000-0000-0000-0000-000000000002
• filter=assortmentId=00000000-0000-0000-0000-000000000001&filter=assortmentId=00000000-0000-0000-0000-000000000002

Примеры запросов

Запрос на получение текущих остатков без разбиения по складам.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/all/current"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

[
  {"assortmentId":"12345678-5838-aaeb-0a80-003a003ef439","stock":11},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f847c","stock":46.5}
]

Запрос на получение текущих остатков "доступно" с выводом нулевых значений.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/all/current?stockType=quantity&include=zeroLines"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

[
  {"assortmentId":"12345678-5838-aaeb-0a80-003a003ef439","quantity":11},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f1981","quantity":0},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f847c","quantity":46.5},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f3215","quantity":0}
]

Запрос на получение остатков с параметром "changedSince".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/all/current?changedSince=2022-08-23 15:00:00"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

[
  {"assortmentId":"12345678-5838-aaeb-0a80-003a003ef439","quantity":1},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f847c","quantity":4.5}
]

Запрос на получение текущих остатков по складам с указанием типа остатка.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/bystore/current?stockType=freeStock"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета. Строка со "storeId":null соответствует резерву для Заказа Покупателя без указания склада.

ПоказатьСвернуть

[
  {"assortmentId":"12345678-5838-aaeb-0a80-003a003ef439","storeId":"12345678-b123-aaee-0a80-012b0001bb10","freeStock":4},
  {"assortmentId":"12345678-5838-aaeb-0a80-003a003ef439","storeId":"12345678-b123-aaee-0a80-012b0001bb12","freeStock":7},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f847c","storeId":null, "freeStock":-5},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f847c","storeId":"12345678-b123-aaee-0a80-012b0001bb10","freeStock":46}
]

Запрос на получение текущих остатков с фильтрацией.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/bystore/current?filter=assortmentId=12345678-5838-aaeb-0a80-003a003ef439,12345678-279c-aaeb-0a80-00d6001f847c;storeId=12345678-b123-aaee-0a80-012b0001bb10,12345678-b123-aaee-0a80-012b0001bb13"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

[
  {"assortmentId":"12345678-5838-aaeb-0a80-003a003ef439","storeId":"12345678-b123-aaee-0a80-012b0001bb10","stock":1},
  {"assortmentId":"12345678-279c-aaeb-0a80-00d6001f847c","storeId":"12345678-b123-aaee-0a80-012b0001bb10","stock":3}
]

Остатки по складам

Отчет "Остатки по складам" представляет собой массив объектов, каждый из которых показывает Остаток по каждому из товаров на каждом из складов.

Атрибуты объекта отчета:

Название	Тип	Описание
meta	Meta	Метаданные позиции, по которой выдается Остаток Обязательное при ответе
stockByStore	Object	Остатки по складам. Подробнее тут Обязательное при ответе

Остатки по складам

Поле "Остатки по складам" (stockByStore) представляет собой выдачу из объектов со следующими атрибутами:

Название	Тип	Описание
meta	Meta	Метаданные склада, по которому выводится Остаток Обязательное при ответе
stock	Int	Остаток Обязательное при ответе
inTransit	Int	Ожидание Обязательное при ответе
reserve	Int	Резерв Обязательное при ответе
name	String(255)	Наименование склада Обязательное при ответе

Размерность этого поля всегда равна количеству складов в системе.

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
consignment	Object	= !=	ссылка на серию, по которой нужно произвести фильтрацию.
moment	DateTime	=	момент времени, на который нужно вывести остатки. Передается в виде строки в формате дата-время
product	Object	= !=	ссылка на товар, по которому нужно произвести фильтрацию.
productFolder	Object	= !=	ссылка на группу товаров, по которой нужно произвести фильтрацию.
search	String(255)	=	специальный параметр текстового поиска. Поиск осуществляется по вхождению подстроки в названия товаров, модификаций, серий.
soldByWeight	Boolean	=	параметр для фильтрации по признаку весового товара. Возможные значения: true, false.
stockMode	Enum	=	параметр для фильтрации по значению остатка. Значение по умолчанию nonEmpty. Доступные значения
store	Object	= !=	ссылка на склад, для которого нужно построить отчет.
supplier	Object	= !=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
variant	Object	= !=	ссылка на модификация, по которой нужно произвести фильтрацию.

Доступные значения для stockMode

Значение по умолчанию all.

Значение	Описание
all	Любое значение остатка
positiveOnly	Положительный остаток
negativeOnly	Отрицательный остаток
empty	Нулевой остаток
nonEmpty	Ненулевой остаток
underMinimum	Остаток ниже неснижаемого остатка

В одном запросе можно использовать только один из параметров product, variant, consignment, productFolder и search.

Примеры фильтрации:

• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8552-11e6-8a84-bae500000043
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044
• filter=variant=https://online.moysklad.ru/api/remap/1.2/entity/variant/656c4032-8552-11e6-8a84-bae500000045
• filter=consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/656c4032-8552-11e6-8a84-bae500000046
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=stockMode=all
• filter=moment=2019-07-10 12:00:00
• filter=soldByWeight=true
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/656c4032-8667-11e6-8a84-bae5000033aa
• filter=search=див

Фильтрация по дополнительным полям и характеристикам

C помощью параметра filter выборку также можно фильтровать по значениям дополнительных полей товаров и характеристик модификаций.

Для фильтрации по значению дополнительного поля, нужно передать ссылку на дополнительное поле и его значение:

filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/=<Значение>

Для фильтрации по значению дополнительных полей типа строка, текст и ссылка нужно использовать оператор =.

Для фильтрации по значению дополнительных полей типа целое число, вещественное число, дата можно использовать операторы =, >=, <=. Для дополнительного поля типа дата-время значение передается в виде строки в формате дата-время.

Для фильтрации по значению дополнительных полей типа справочник нужно использовать оператор =. В качестве значения нужно передавать ссылку на объект справочника.

Пример фильтрации по дополнительному полю типа справочник складов: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=https://online.moysklad.ru/api/remap/1.2/entity/store/302f2a81-9977-11e9-9109-f8fc00020e02

Пример фильтрации по дополнительному полю типа пользовательский справочник: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://online.moysklad.ru/api/remap/1.2/entity/customentity/8955249d-997d-11e9-9ff4-3150000e65c3/8955314d-997d-11e9-9ff4-3150000e65c4

Для фильтрации по значению дополнительных полей типа флажок нужно использовать оператор =. Возможные значения: true, false.

Фильтрация по дополнительным полям типа файл не поддерживается.

Для фильтрации по значению характеристики нужно передать ссылку на характеристику и значение:

filter=https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics/=<Значение>

Для фильтрации по значению характеристики нужно использовать оператор =.

Атрибуты доступные для сортировки

Результаты отчета можно отсортировать, используя параметр order.

Название	Описание
pathName	по группе товара
name	по наименованию
code	по коду
productCode	по артикулу
stockOnAllStores	по количеству остатка на всех складах

По умолчанию выборка сортируется по группе товара и имени товара.

Получить Остатки по складам

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
groupBy	string (optional) тип, по которому нужно сгруппировать выдачу.По умолчанию параметр groupBy имеет значение variant. Если вы хотите увидеть объекты типа consignment, или только объекты типа product, необходимо выставить соответствующее значение параметра. groupBy=product - выдает только товары groupBy=variant - выдает товары и модификации groupBy=consignment - выдает товары, модификации, серии

Запрос на получение отчета "Остатки по складам".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/bystore"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/stock/bystore",
    "type": "stockbystore",
    "mediaType": "application/json",
    "size": 225,
    "limit": 1000,
    "offset": 0,
    "nextHref": "http://online.moysklad.ru/api/remap/1.2/report/stock/bystore?limit=25&offset=25"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/c02e3a5c-007e-11e6-9464-e4de00000006?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": -30,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/cc99c055-fa34-11e5-9464-e4de00000069?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 4,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/e8f5f9ff-fa34-11e5-9464-e4de0000008a?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 1,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8f9d714-fa34-11e5-9464-e4de0000008d?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 1,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8fc24b5-fa34-11e5-9464-e4de00000091?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 1,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e91042b4-fa34-11e5-9464-e4de00000095?expand=product.supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 1,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/daf1186d-fa34-11e5-9464-e4de0000006f?expand=supplier",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "stockByStore": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Не основной склад",
          "stock": 0,
          "reserve": 0,
          "inTransit": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
            "type": "store",
            "mediaType": "application/json"
          },
          "name": "Основной склад",
          "stock": 1,
          "reserve": 0,
          "inTransit": 0
        }
      ]
    }
  ]
}

Остатки по документам

Отчёт "Остатки по документам" представляет собой выдачу Остатков по позициям указанного в пути документа. Остатки можно получить по следующим документам: [Отгрузка, Заказ Покупателя, Розничная продажа, Счет поставщика, Заказ поставщику, Приемка, Розничный возврат, Возврат поставщику/покупателю] Остатки для документа Отгрузка, Розничная продажа, Приемка, Возврат поставщика/покупателя и Розничный возврат рассчитываются на момент поля moment в данных документах. Для Заказа покупателя, Счета покупателя, Заказа поставщику и Счета поставщику остатки рассчитываются на текущий момент времени.

Атрибуты объекта отчёта:

Значение	Тпи	Описание
meta	Meta	Метаданные, представляющие собой ссылку на документ, по которому выдаются Остатки Обязательное при ответе
positions	Array(Object)	Массив объектов, представляющий собой Остаток по каждой из позиций. Обязательное при ответе

Атрибуты позиции

Значение	Тпи	Описание
meta	Meta	Метаданные, представляющие собой ссылку на позицию, по которой выдаётся Остаток Обязательное при ответе
name	String(255)	Наименование позиции Обязательное при ответе
stock	Float	Остаток Обязательное при ответе
cost	Float	Себестоимость Обязательное при ответе
inTransit	Float	Ожидание Обязательное при ответе
reserve	Float	Резерв Обязательное при ответе
quantity	Float	Доступно. У сущности Комплект значение всегда 0. Обязательное при ответе

Получить Остатки по документу

Запрос на получение отчёта "Остатки по документу". Остатки для документа Отгрузка и Розничная продажа расчитываются на момент поля moment в данных документах. Для Заказа покупателя остатки рассчитываются на текущий момент времени.

Данный запрос работает со следующими типами документов:

• Отгрузка
• Заказ покупателя
• Розничная продажа
• Счет поставщика
• Розничная продажа
• Заказ поставщику
• Приемка
• Розничный возврат
• Возврат поставщику
• Возврат покупателя

Результат запроса - остатки по позициям документа, на дату документа, со склада, указанного в документе, а также себестоимость позиций документа по FIFO с учётом количества.

Примеры запросов

Запрос на получение текущих остатков без разбиения по складам.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/stock/byoperation?operation.id=34efe2ee-015e-11e6-9464-e4de0000006b"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/stock/byoperation?operation.id=34efe2ee-015e-11e6-9464-e4de0000006b",
    "type": "stockbyoperation",
    "mediaType": "application/json",
    "size": 1,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/customerorder/34efe2ee-015e-11e6-9464-e4de0000006b",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/customerOrder/metadata",
        "type": "customerorder",
        "mediaType": "application/json"
      },
      "positions": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/eeef177f-f648-11e5-8a84-bae50000007a",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
            "type": "product",
            "mediaType": "application/json"
          },
          "name": "Клюшка хоккейная",
          "stock": -2,
          "cost": 0,
          "inTransit": 0,
          "reserve": 0,
          "quantity": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/60fc3826-00d7-11e6-9464-e4de00000097",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
            "type": "product",
            "mediaType": "application/json"
          },
          "name": "Поднимание пингвинов",
          "stock": 0,
          "cost": 0,
          "inTransit": 0,
          "reserve": 0,
          "quantity": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/d1bed68b-ffe7-11e5-9464-e4de0000001a",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
            "type": "variant",
            "mediaType": "application/json"
          },
          "name": "ТОварИщ (10)",
          "stock": 0,
          "cost": 0,
          "inTransit": 0,
          "reserve": 0,
          "quantity": 0
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/671b3522-f7d2-11e5-8a84-bae500000084",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
            "type": "variant",
            "mediaType": "application/json"
          },
          "name": "ТоварМногоМодификаций (1, 100, 30)",
          "stock": 3,
          "cost": 0,
          "inTransit": 0,
          "reserve": 0,
          "quantity": 3
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/66ccbc9f-f7d2-11e5-8a84-bae500000076",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
            "type": "product",
            "mediaType": "application/json"
          },
          "name": "ТоварМногоМодификаций",
          "stock": 3,
          "cost": 0,
          "inTransit": 0,
          "reserve": 1,
          "quantity": 2
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/8b382799-f7d2-11e5-8a84-bae5000003a5",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
            "type": "product",
            "mediaType": "application/json"
          },
          "name": "ТоварМногоМодификаций2",
          "stock": 0,
          "cost": 0,
          "inTransit": 0,
          "reserve": 0,
          "quantity": 0
        }
      ]
    }
  ]
}

Отчет Прибыльность

Средствами JSON API можно запросить отчет "Прибыльность" по всем товарам, услугам, модификациям, сотрудникам, покупателям и каналам продаж. Для доступа к отчету через API требуется право на просмотр отчета Прибыли и убытки. О том, что представляет собой отчет "Прибыльность" вы можете прочитать по этой ссылке.

Прибыльность по товарам

Атрибуты объекта отчета:

Название	Тип	Описание
assortment	Object	Краткое представление Товара или Услуги в отчете. Подробнее тут и тут Обязательное при ответе
margin	Float	Рентабельность Обязательное при ответе
profit	Float	Прибыль Обязательное при ответе
returnCost	Float	Себестоимость возвратов Обязательное при ответе
returnCostSum	Float	Сумма себестоимостей возвратов Обязательное при ответе
returnPrice	Float	Цена возвратов Обязательное при ответе
returnQuantity	Int	Количество возвратов Обязательное при ответе
returnSum	Float	Сумма возвратов Обязательное при ответе
sellCost	Float	Себестоимость Обязательное при ответе
sellCostSum	Float	Сумма себестоимостей продаж Обязательное при ответе
sellPrice	Float	Цена продаж (средняя) Обязательное при ответе
sellQuantity	Int	Проданное количество Обязательное при ответе
sellSum	Float	Сумма продаж Обязательное при ответе

Структура объекта assortment

Название	Тип	Описание
meta	Meta	Метаданные Товара или Услуги Обязательное при ответе
name	String(255)	Наименование Товара или Услуги Обязательное при ответе
code	String(255)	Код товара или услуги
uom	Object	Единица измерения
article	String(255)	Артикул товара
image	Object	Изображение товара

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра, кроме канала продаж, можно указать только одно значение. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
product	Object	= !=	ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию. Можно передать несколько значений.
productFolder	Object	= !=	параметр для фильтрации по нескольким группам товаров. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
withSubFolders	Boolean	=	параметр учета вложенных подгрупп. Работает только при наличии фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
counterparty	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	Object	=	ссылка на точку продаж, по которой нужно произвести фильтрацию.
supplier	Object	=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
salesChannel	Object	=	ссылка на канал продаж, по которому нужно провести фильтрацию. Допустимо повторное использование фильтра, когда требуется фильтрация по нескольким каналам продаж.

Одновременная фильтрация по product и productFolder не поддерживается.

Примеры фильтрации:

• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2;withSubFolders=false
• filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/ea012b09-4df3-439b-acf7-7d0464fbf603
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9

Получить Прибыльность по товарам

Отчет прибыльности по товарам включает: товары, комплекты, услуги. В товаре учитывается прибыльность по его модификациям, но без указания самих модификаций.

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
momentFrom	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.
momentTo	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.

При отсутствии параметров momentFrom и momentTo отображаются отчеты за последний месяц.
При отсутствии параметра momentFrom и указании параметра momentTo отображаются отчеты с начала текущего года по momentTo.
При отсутствии параметра momentTo и указании параметра momentFrom отображаются отчеты с momentFrom по текущий день.

Запрос на получение отчета "Прибыльность по товарам".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/profit/byproduct"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/profit/byproduct",
    "type": "salesbyproduct",
    "mediaType": "application/json",
    "size": 5,
    "limit": 2,
    "offset": 0,
    "nextHref": "https://online.moysklad.ru/api/remap/1.2/report/profit/byproduct?limit=2&offset=2"
  },
  "rows": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/6af0f1c9-4814-11e6-8a84-bae5000006b4",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json"
        },
        "name": "Курево",
        "code": "00067",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        }
      },
      "sellQuantity": 8643,
      "sellPrice": 216174.97396737244,
      "sellCost": 0,
      "sellSum": 1868400300,
      "sellCostSum": 0,
      "returnQuantity": 0,
      "returnPrice": 0,
      "returnCost": 0,
      "returnSum": 0,
      "returnCostSum": 0,
      "profit": 1868400300,
      "margin": 0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/6a9bdfe4-4814-11e6-8a84-bae500000503",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json"
        },
        "name": "Ногтеточка",
        "code": "00198",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        }
      },
      "sellQuantity": 4765,
      "sellPrice": 100000000,
      "sellCost": 0,
      "sellSum": 476500000000,
      "sellCostSum": 0,
      "returnQuantity": 0,
      "returnPrice": 0,
      "returnCost": 0,
      "returnSum": 0,
      "returnCostSum": 0,
      "profit": 476500000000,
      "margin": 0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/service/3413f2dd-484e-11e8-6a80-332a00000091",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "service",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=3412d794-484e-11e8-6a80-332a0000008f"
        },
        "name": "Заточка коньков",
        "code": "00045",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        }
      },
      "sellQuantity": 10,
      "sellPrice": 500000,
      "sellCost": 300000,
      "sellSum": 5000000,
      "sellCostSum": 3000000,
      "returnQuantity": 3,
      "returnPrice": 500000,
      "returnCost": 300000,
      "returnSum": 1500000,
      "returnCostSum": 900000,
      "profit": 1400000,
      "margin": 0.6666666666666666
    }
  ]
}

Прибыльность по модификациям

Атрибуты объекта отчета:

Название	Тип	Описание
assortment	Object	Краткое представление Модификации, Услуги или Комплекта в отчете. Подробнее тут, тут и тут Обязательное при ответе
margin	Float	Рентабельность Обязательное при ответе
profit	Float	Прибыль Обязательное при ответе
returnCost	Float	Себестоимость возвратов Обязательное при ответе
returnCostSum	Float	Сумма себестоимостей возвратов Обязательное при ответе
returnPrice	Float	Цена возвратов Обязательное при ответе
returnQuantity	Int	Количество возвратов Обязательное при ответе
returnSum	Float	Сумма возвратов Обязательное при ответе
sellCost	Float	Себестоимость Обязательное при ответе
sellCostSum	Float	Сумма себестоимостей продаж Обязательное при ответе
sellPrice	Float	Цена продаж (средняя) Обязательное при ответе
sellQuantity	Int	Проданное количество Обязательное при ответе
sellSum	Float	Сумма продаж Обязательное при ответе

Структура объекта assortment

Название	Тип	Описание
meta	Meta	Метаданные Модификации, Услуги или Комплекта Обязательное при ответе
name	String(255)	Наименование сущности Обязательное при ответе
code	String(255)	Код сущности Обязательное при ответе
article	String(255)	Артикул Модификации или Комплекта Обязательное при ответе
image	Object	Изображение Модификации Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра, кроме канала продаж, можно указать только одно значение. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
product	Object	= !=	ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию. Можно передать несколько значений.
productFolder	Object	= !=	параметр для фильтрации по нескольким группам товаров. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
withSubFolders	Boolean	=	параметр учета вложенных подгрупп. Работает только при наличии фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
counterparty	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	Object	=	ссылка на точку продаж, по которой нужно произвести фильтрацию.
supplier	Object	=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
salesChannel	Object	=	ссылка на канал продаж, по которому нужно провести фильтрацию. Допустимо повторное использование фильтра, когда требуется фильтрация по нескольким каналам продаж.

Одновременная фильтрация по product и productFolder не поддерживается.

Примеры фильтрации:

• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2;withSubFolders=false
• filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/ea012b09-4df3-439b-acf7-7d0464fbf603
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9

Получить Прибыльность по модификациям

Отчет прибыльности по товарам включает: товары, комплекты, услуги и модификации (выводится сама модификация, не родительский товар).

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
momentFrom	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.
momentTo	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.

При отсутствии параметров momentFrom и momentTo отображаются отчеты за последний месяц.
При отсутствии параметра momentFrom и указании параметра momentTo отображаются отчеты с начала текущего года по momentTo.
При отсутствии параметра momentTo и указании параметра momentFrom отображаются отчеты с momentFrom по текущий день.

Запрос на получение отчета "Прибыльность по модификациям".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/profit/byvariant"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/profit/byvariant",
    "type": "salesbyvariant",
    "mediaType": "application/json",
    "size": 5,
    "limit": 2,
    "offset": 0,
    "nextHref": "https://online.moysklad.ru/api/remap/1.2/report/profit/byvariant?limit=2&offset=2"
  },
  "rows": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/6af0f1c9-4814-11e6-8a84-bae5000006b4?expand=product.supplier",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
          "type": "variant",
          "mediaType": "application/json"
        },
        "name": "Курево (Африка, 0.2, Комбайны)",
        "code": "00067",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        }
      },
      "sellQuantity": 8643,
      "sellPrice": 216174.97396737244,
      "sellCost": 0,
      "sellSum": 1868400300,
      "sellCostSum": 0,
      "returnQuantity": 0,
      "returnPrice": 0,
      "returnCost": 0,
      "returnSum": 0,
      "returnCostSum": 0,
      "profit": 1868400300,
      "margin": 0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/6a9bdfe4-4814-11e6-8a84-bae500000503?expand=product.supplier",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
          "type": "variant",
          "mediaType": "application/json"
        },
        "name": "Ногтеточка (Белый, 20, Нет, 1000)",
        "code": "00198",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        }
      },
      "sellQuantity": 4765,
      "sellPrice": 100000000,
      "sellCost": 0,
      "sellSum": 476500000000,
      "sellCostSum": 0,
      "returnQuantity": 0,
      "returnPrice": 0,
      "returnCost": 0,
      "returnSum": 0,
      "returnCostSum": 0,
      "profit": 476500000000,
      "margin": 0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/service/3413f2dd-484e-11e8-6a80-332a00000091",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "service",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=3412d794-484e-11e8-6a80-332a0000008f"
        },
        "name": "Заточка коньков",
        "code": "00045",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        }
      },
      "sellQuantity": 10,
      "sellPrice": 500000,
      "sellCost": 300000,
      "sellSum": 5000000,
      "sellCostSum": 3000000,
      "returnQuantity": 3,
      "returnPrice": 500000,
      "returnCost": 300000,
      "returnSum": 1500000,
      "returnCostSum": 900000,
      "profit": 1400000,
      "margin": 0.6666666666666666
    }
  ]
}

Прибыльность по сотрудникам

Атрибуты объекта отчета:

Название	Тип	Описание
employee	Object	Краткое представление Сотрудника в отчете. Подробнее тут Обязательное при ответе
margin	Float	Рентабельность Обязательное при ответе
profit	Float	Прибыль Обязательное при ответе
returnAvgCheck	Float	Средний чек возврата Обязательное при ответе
returnCostSum	Float	Сумма себестоимостей возвратов Обязательное при ответе
returnCount	Int	Количество возвратов Обязательное при ответе
returnSum	Float	Сумма возвратов Обязательное при ответе
salesAvgCheck	Float	Средний чек продаж Обязательное при ответе
salesCount	Int	Количество продаж Обязательное при ответе
sellCostSum	Float	Сумма себестоимостей продаж Обязательное при ответе
sellSum	Float	Сумма продаж Обязательное при ответе

Структура объекта employee

Название	Тип	Описание
meta	Meta	Метаданные Сотрудника Обязательное при ответе
name	String(255)	Имя Сотрудника Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра, кроме канала продаж, можно указать только одно значение. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
product	Object	= !=	ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию. Можно передать несколько значений.
productFolder	Object	= !=	параметр для фильтрации по нескольким группам товаров. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
withSubFolders	Boolean	=	параметр учета вложенных подгрупп. Работает только при наличии фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
counterparty	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	Object	=	ссылка на точку продаж, по которой нужно произвести фильтрацию.
supplier	Object	=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
salesChannel	Object	=	ссылка на канал продаж, по которому нужно провести фильтрацию. Допустимо повторное использование фильтра, когда требуется фильтрация по нескольким каналам продаж.

Одновременная фильтрация по product и productFolder не поддерживается.

Примеры фильтрации:

• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2;withSubFolders=false
• filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/ea012b09-4df3-439b-acf7-7d0464fbf603
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9

Получить Прибыльность по сотрудникам

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
momentFrom	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.
momentTo	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.

При отсутствии параметров momentFrom и momentTo отображаются отчеты за последний месяц.
При отсутствии параметра momentFrom и указании параметра momentTo отображаются отчеты с начала текущего года по momentTo.
При отсутствии параметра momentTo и указании параметра momentFrom отображаются отчеты с momentFrom по текущий день.

Запрос на получение отчета "Прибыльность по сотрудникам".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/profit/byemployee"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/profit/byEmployee",
    "type": "salesbyemployee",
    "mediaType": "application/json",
    "size": 1,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "employee": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/3c9ef5be-4814-11e6-8a84-bae500000028",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        },
        "name": "Администратор"
      },
      "salesCount": 3,
      "salesAvgCheck": 104498369718788910,
      "sellSum": 313495109156366700,
      "sellCostSum": 0,
      "returnCount": 0,
      "returnAvgCheck": 0,
      "returnSum": 0,
      "returnCostSum": 0,
      "profit": 313495109156366700,
      "margin": 0
    }
  ]
}

Прибыльность по покупателям

Атрибуты объекта отчета:

Название	Тип	Описание
counterparty	Object	Краткое представление Покупателя в отчете. Подробнее тут Обязательное при ответе
margin	Float	Рентабельность Обязательное при ответе
profit	Float	Прибыль Обязательное при ответе
returnAvgCheck	Float	Средний чек возврата Обязательное при ответе
returnCostSum	Float	Сумма себестоимостей возвратов Обязательное при ответе
returnCount	Int	Количество возвратов Обязательное при ответе
returnSum	Float	Сумма возвратов Обязательное при ответе
salesAvgCheck	Float	Средний чек продаж Обязательное при ответе
salesCount	Int	Количество продаж Обязательное при ответе
sellCostSum	Float	Сумма себестоимостей продаж Обязательное при ответе
sellSum	Float	Сумма продаж Обязательное при ответе

Структура объекта counterparty

Название	Тип	Описание
meta	Meta	Метаданные Покупателя Обязательное при ответе
name	String(255)	Наименование Покупателя Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра, кроме канала продаж, можно указать только одно значение. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
product	Object	= !=	ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию. Можно передать несколько значений.
productFolder	Object	= !=	параметр для фильтрации по нескольким группам товаров. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
withSubFolders	Boolean	=	параметр учета вложенных подгрупп. Работает только при наличии фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
counterparty	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	Object	=	ссылка на точку продаж, по которой нужно произвести фильтрацию.
supplier	Object	=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
salesChannel	Object	=	ссылка на канал продаж, по которому нужно провести фильтрацию. Допустимо повторное использование фильтра, когда требуется фильтрация по нескольким каналам продаж.

Одновременная фильтрация по product и productFolder не поддерживается.

Примеры фильтрации:

• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2;withSubFolders=false
• filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/ea012b09-4df3-439b-acf7-7d0464fbf603
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9

Получить Прибыльность по покупателям

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
momentFrom	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.
momentTo	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.

При отсутствии параметров momentFrom и momentTo отображаются отчеты за последний месяц.
При отсутствии параметра momentFrom и указании параметра momentTo отображаются отчеты с начала текущего года по momentTo.
При отсутствии параметра momentTo и указании параметра momentFrom отображаются отчеты с momentFrom по текущий день.

Запрос на получение отчета "Прибыльность по покупателям".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/profit/bycounterparty"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/profit/bycounterparty",
    "type": "salesbyCounterparty",
    "mediaType": "application/json",
    "size": 3,
    "limit": 1,
    "offset": 0,
    "nextHref": "https://online.moysklad.ru/api/remap/1.2/report/profit/bycounterparty?limit=1&offset=1"
  },
  "rows": [
    {
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/3cd88c00-4814-11e6-8a84-bae500000053",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        },
        "name": "ООО \"Покупатель\""
      },
      "salesCount": 1,
      "salesAvgCheck": 310390615323104640,
      "sellSum": 310390615323104640,
      "sellCostSum": 0,
      "returnCount": 0,
      "returnAvgCheck": 0,
      "returnSum": 0,
      "returnCostSum": 0,
      "profit": 310390615323104640,
      "margin": 0
    }
  ]
}

Прибыльность по каналам продаж

Атрибуты объекта отчета:

Название	Тип	Описание
salesChannel	Object	Краткое представление Канала продаж в отчете. Подробнее тут Обязательное при ответе
margin	Float	Рентабельность Обязательное при ответе
profit	Float	Прибыль Обязательное при ответе
returnAvgCheck	Float	Средний чек возврата Обязательное при ответе
returnCostSum	Float	Сумма себестоимостей возвратов Обязательное при ответе
returnCount	Int	Количество возвратов Обязательное при ответе
returnSum	Float	Сумма возвратов Обязательное при ответе
salesAvgCheck	Float	Средний чек продаж Обязательное при ответе
salesCount	Int	Количество продаж Обязательное при ответе
sellCostSum	Float	Сумма себестоимостей продаж Обязательное при ответе
sellSum	Float	Сумма продаж Обязательное при ответе

Структура объекта salesChannel

Название	Тип	Описание
meta	Meta	Метаданные Канала продаж Обязательное при ответе
name	String(255)	Наименование Канала продаж Обязательное при ответе
type	Enum	Тип Канала продаж Подробнее тут Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра, кроме канала продаж, можно указать только одно значение. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
product	Object	= !=	ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию. Можно передать несколько значений.
productFolder	Object	= !=	параметр для фильтрации по нескольким группам товаров. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
withSubFolders	Boolean	=	параметр учета вложенных подгрупп. Работает только при наличии фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
counterparty	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
supplier	Object	=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
salesChannel	Object	=	ссылка на канал продаж, по которому нужно провести фильтрацию. Допустимо повторное использование фильтра, когда требуется фильтрация по нескольким каналам продаж.

Одновременная фильтрация по product и productFolder не поддерживается.

Примеры фильтрации:

• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2
• filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2;withSubFolders=false
• filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9
• filter=salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/ea012b09-4df3-439b-acf7-7d0464fbf603
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;salesChannel=https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/65cc7e08-ea79-4ad7-9cde-3cc053f1c1b9

Получить Прибыльность по каналам продаж

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
momentFrom	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.
momentTo	date (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки.

При отсутствии параметров momentFrom и momentTo отображаются отчеты за последний месяц.
При отсутствии параметра momentFrom и указании параметра momentTo отображаются отчеты с начала текущего года по momentTo.
При отсутствии параметра momentTo и указании параметра momentFrom отображаются отчеты с momentFrom по текущий день.

Запрос на получение отчета "Прибыльность по каналам продаж".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/profit/bysaleschannel"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context" : {
    "employee" : {
      "meta" : {
        "href" : "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref" : "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type" : "employee",
        "mediaType" : "application/json"
      }
    }
  },
  "meta" : {
    "href" : "https://online.moysklad.ru/api/remap/1.2/report/profit/bysaleschannel",
    "type" : "salesbysaleschannel",
    "mediaType" : "application/json",
    "size" : 1,
    "limit" : 1000,
    "offset" : 0
  },
  "rows" : [ {
    "salesChannel" : {
      "meta" : {
        "href" : "https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/656c4032-8552-11e6-8a84-bae500000044",
        "metadataHref" : "https://online.moysklad.ru/api/remap/1.2/entity/saleschannel/metadata",
        "type" : "saleschannel",
        "mediaType" : "application/json",
        "uuidHref" : "https://online.moysklad.ru/app/#saleschannel/edit?id=656c4032-8552-11e6-8a84-bae500000044"
      },
      "name" : "ijk-shop.ru",
      "type" : "ECOMMERCE"
    },
    "salesCount" : 1.0,
    "salesAvgCheck" : 252500.0,
    "sellSum" : 252500.0,
    "sellCostSum" : 0.0,
    "returnCount" : 0.0,
    "returnAvgCheck" : 0.0,
    "returnSum" : 0.0,
    "returnCostSum" : 0.0,
    "profit" : 252500.0,
    "margin" : 0.0
  } ]
}

Отчет Деньги

Средствами JSON API можно запросить отчеты, отражающие движение денежных средств за заданный период и текущие остатки средств по кассам и счетам. Для доступа к отчету через API требуется право на просмотр показателей viewDashboard и право "Видеть остатки денег" viewMoneyDashboard.

Движение денежных средств

Атрибуты отчета:

Название	Тип	Описание
credit	Float	Доход Обязательное при ответе
debit	Float	Расход Обязательное при ответе
series	Array(Object)	Массив показателей. Подробнее в таблице ниже Обязательное при ответе

Показатели (series)

Название	Тип	Описание
date	DateTime	Дата Обязательное при ответе
credit	Float	Доход за период Обязательное при ответе
debit	Float	Расход за период Обязательное при ответе
balance	Float	Баланс (доход-расход) Обязательное при ответе

Параметры доступные для фильтрации

Документы, попадающие в отчет, можно отфильтровать, используя параметр filter. Для каждого параметра можно указать несколько значений. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
organization	Object	=	ссылка на юр. лицо
project	Object	=	ссылка на проект

Параметры

Параметр	Описание
momentFrom	date (required) Example: 2018-09-01 00:00:00 Начало периода отчета
momentTo	date (required) Example: 2018-10-01 00:00:00 Конец периода отчета
interval	string (required) Интервал, с которым будет построен отчет. Может принимать значения hour, day, month для разбиения указанного периода по часам, дням и месяцам соответственно

Заголовки

Заговок	Описание
X-Lognex-Accept-Timezone	Опциональный заголовок, в котором указана текущая дата на клиенте в RFC 3522. Таймзону обязательно указывать в формате знак и 4 символа (не в Obsolete Date and Time). Пример даты: Wed, 16 Aug 2017 23:07:01 +0700. При подсчете показателей даты операций смещаются в таймзону клиента.
X-Lognex-Content-Timezone	Заголовок ответа. В нем указывается (как думает сервер) текущая дата на клиенте в RFC 3522.

Запрос на получение графика движения денежных средств

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{  
  "context":{  
    "employee":{  
      "meta":{  
        "href":"https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type":"employee",
        "mediaType":"application/json"
      }
    }
  },
  "meta":{  
    "href":"https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day",
    "type":"moneyplotseries",
    "mediaType":"application/json"
  },
  "credit":400,
  "debit":200,
  "series":[  
    {  
      "date":"2018-09-01 00:00:00",
      "credit":100,
      "debit":50,
      "balance":50
    },
    {  
      "date":"2018-09-02 00:00:00",
      "credit":100,
      "debit":50,
      "balance":50
    },
    {  
      "date":"2018-09-03 00:00:00",
      "credit":100,
      "debit":50,
      "balance":50
    },
    {  
      "date":"2018-09-04 00:00:00",
      "credit":100,
      "debit":50,
      "balance":50
    }
  ]
}

Запрос графика с фильтрацией

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day&filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.2/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{  
  "context":{  
    "employee":{  
      "meta":{  
        "href":"https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type":"employee",
        "mediaType":"application/json"
      }
    }
  },
  "meta":{  
    "href":"https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day&filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.2/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448",
    "type":"moneyplotseries",
    "mediaType":"application/json"
  },
  "credit":60,
  "debit":20,
  "series":[  
    {  
      "date":"2018-09-01 00:00:00",
      "credit":50,
      "debit":0,
      "balance":50
    },
    {  
      "date":"2018-09-02 00:00:00",
      "credit":10,
      "debit":20,
      "balance":-10
    },
    {  
      "date":"2018-09-03 00:00:00",
      "credit":0,
      "debit":0,
      "balance":0
    },
    {  
      "date":"2018-09-04 00:00:00",
      "credit":0,
      "debit":0,
      "balance":0
    }
  ]
}

Остатки денежных средств

Атрибуты объекта отчета:

Единица измерения

Название	Тип	Описание
account	Object	Счет организации (не выводится для остатка кассы, так как касса одна на организацию). Подробнее тут Обязательное при ответе
organization	Object	Организация. Подробнее тут Обязательное при ответе
balance	Float	Текущий остаток денежных средств Обязательное при ответе

Счет организации

Название	Тип	Описание
meta	Meta	Метаданные организации Обязательное при ответе
name	String(255)	Номер счета Обязательное при ответе

Организация

Название	Тип	Описание
meta	Meta	Метаданные организации Обязательное при ответе
name	String(255)	Наименование организации Обязательное при ответе

Запрос на получение остатков денежных средств по кассам и счетам

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/money/byaccount"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{  
  "context":{  
    "employee":{  
      "meta":{  
        "href":"https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type":"employee",
        "mediaType":"application/json"
      }
    }
  },
  "meta":{  
    "href":"https://online.moysklad.ru/api/remap/1.2/report/money/byaccount",
    "type":"moneyreport",
    "mediaType":"application/json"
  },
  "rows":[  
    {  
      "organization":{  
        "meta":{  
          "href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
          "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
          "type":"organization",
          "mediaType":"application/json"
        },
        "name":"OOO Ромашка"
      },
      "balance":100
    },
    {  
      "organization":{  
        "meta":{  
          "href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
          "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
          "type":"organization",
          "mediaType":"application/json"
        },
        "name":"OOO Серьезное Юридическое Лицо"
      },
      "balance":100
    },
    {  
      "account":{  
        "meta":{  
          "href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/4b9d5bec-0575-11e6-9464-e4de00000008/accounts/4b9d69b7-0575-11e6-9464-e4de00000009",
          "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
          "type":"account",
          "mediaType":"application/json"
        },
        "name":"00000"
      },
      "organization":{  
        "meta":{  
          "href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
          "metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
          "type":"organization",
          "mediaType":"application/json"
        },
        "name":"OOO Серьезное Юридическое Лицо"
      },
      "balance":200
    }
  ]
}

Показатели продаж и заказов

Средствами JSON API можно запросить показатели продаж и заказов - количество и суммы за определенный период с разбивкой по часам, дням или месяцам. Для доступа к отчету через API требуется право на просмотр показателей viewDashboard.

Атрибуты отчета:

Название	Тип	Описание
series	Array(Object)	Массив показателей. Подробнее в таблице ниже Обязательное при ответе

Показатели (series)

Название	Тип	Описание
date	DateTime	Дата Обязательное при ответе
quantity	Int	Количество Обязательное при ответе
sum	Float	Сумма Обязательное при ответе

Параметры

Параметр	Описание
momentFrom	date (required) Example: 2018-09-01 00:00:00 Начало периода отчета
momentTo	date (required) Example: 2018-10-01 00:00:00 Конец периода отчета
interval	string (required) Интервал, с которым будет построен отчет. Может принимать значения hour, day, month для разбиения указанного периода по часам, дням и месяцам соответственно

Заголовки

Заголовок	Описание
X-Lognex-Accept-Timezone	Опциональный заголовок, в котором указана текущая дата на клиенте в RFC 3522. Таймзону обязательно указывать в формате знак и 4 символа (не в Obsolete Date and Time). Пример даты: Wed, 16 Aug 2017 23:07:01 +0700. При подсчете показателей даты операций смещаются в таймзону клиента.
X-Lognex-Content-Timezone	Заголовок ответа. В нем указывается (как думает сервер) текущая дата на клиенте в RFC 3522.

Показатели заказов

В показателях заказов учитываются только заказы покупателей.

Параметры доступные для фильтрации

Документы, попадающие в отчет, можно отфильтровать, используя параметр filter. Для каждого параметра можно указать несколько значений. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
organization	Object	=	ссылка на юр. лицо
store	Object	=	ссылка на склад
project	Object	=	ссылка на проект

Запрос на получение показателей заказов

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-06 01:00:01&interval=hour"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2016-09-06 01:00:01&interval=hour",
    "type": "ordersplotseries",
    "mediaType": "application/json"
  },
  "series": [
    {
      "date": "2018-09-06 00:00:00",
      "quantity": 3,
      "sum": 600
    },
    {
      "date": "2018-09-06 01:00:00",
      "quantity": 2,
      "sum": 200
    }
  ]
}

Запрос на получение показателей заказов с фильтрацией

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-06 01:00:01&interval=hour&filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.2/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448;store=https://online.moysklad.ru/api/remap/1.2/entity/store/32213d37-8101-11e8-9107-50480004c6c1"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/context/employee",
        "metaseriesHref": "https://online.moysklad.ru/employee/metaseries",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2016-09-06 01:00:01&interval=hour&filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.2/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448;store=https://online.moysklad.ru/api/remap/1.2/entity/store/32213d37-8101-11e8-9107-50480004c6c1",
    "type": "ordersplotseries",
    "mediaType": "application/json"
  },
  "series": [
    {
      "date": "2018-09-06 00:00:00",
      "quantity": 1,
      "sum": 100
    },
    {
      "date": "2018-09-06 01:00:00",
      "quantity": 1,
      "sum": 100
    }
  ]
}

Показатели продаж

В показателях продаж учитываются отгрузки, розничные продажи, полученные отчеты комиссионера.

Параметры доступные для фильтрации

Документы, попадающие в отчет, можно отфильтровать, используя параметр filter. Для каждого параметра можно указать несколько значений. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
organization	Object	=	ссылка на юр. лицо
store	Object	=	ссылка на склад
project	Object	=	ссылка на проект
retailStore	Object	=	ссылка на Точку продаж. При использовании этого параметра учитываются только розничные продажи.

Запрос на получение показателей продаж c фильтрацией

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/sales/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-10 01:00:01&interval=hour&filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/d9a8a213-6703-11e7-9464-e4de00000060&project=https://online.moysklad.ru/api/remap/1.2/entity/project/d9a8a213-6703-11e7-9464-e4de00000060&store=https://online.moysklad.ru/api/remap/1.2/entity/store/d9a8a213-6703-11e7-9464-e4de00000060&organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/d9a8a213-6703-11e7-9464-e4de00000060"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metaseriesHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metaseries",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/sales/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-10 01:00:01&interval=hour&filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/d9a8a213-6703-11e7-9464-e4de00000060&project=https://online.moysklad.ru/api/remap/1.2/entity/project/d9a8a213-6703-11e7-9464-e4de00000060&store=https://online.moysklad.ru/api/remap/1.2/entity/store/d9a8a213-6703-11e7-9464-e4de00000060&organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/d9a8a213-6703-11e7-9464-e4de00000060",
    "type": "salesplotseries",
    "mediaType": "application/json"
  },
  "series": [
    {
      "date": "2018-09-06 00:00:00",
      "quantity": 3,
      "sum": 900
    },
    {
      "date": "2018-09-06 01:00:00",
      "quantity": 4,
      "sum": 400
    }
  ]
}

Отчет Показатели контрагентов

Средствами JSON API можно запросить отчет "Показатели контрагентов" по всем или по отдельному контрагенту. Для доступа к отчету через API требуется право на просмотр показателей CRM для контрагентов viewCompanyCRM. Для получения значения в поле Прибыль profit дополнительно требуется право видеть себестоимость, цену закупки и прибыль товаров viewProductCostAndProfit. О том, что представляет собой отчет "Показатели контрагентов" вы можете прочитать по этой ссылке.

Показатели контрагентов

Атрибуты показателей

Название	Тип	Фильтрация	Описание
averageReceipt	Float	= != < > <= >=	Средний чек Обязательное при ответе
balance	Float	= != < > <= >=	Баланс Обязательное при ответе
bonusBalance	Float		Баллы Обязательное при ответе
counterparty	Object		Контрагент. Подробнее тут Обязательное при ответе
demandsCount	Int	= != < > <= >=	Количество продаж Обязательное при ответе
demandsSum	Float	= != < > <= >=	Сумма продаж Обязательное при ответе
discountsSum	Float	= != < > <= >=	Сумма скидок Обязательное при ответе
firstDemandDate	DateTime	= != < > <= >=	Дата первой продажи Обязательное при ответе
lastDemandDate	DateTime	= != < > <= >=	Дата последней продажи Обязательное при ответе
lastEventDate	DateTime	= != < > <= >=	Дата последнего события Обязательное при ответе
lastEventText	String(255)	= != ~ ~= =~	Текст последнего события Обязательное при ответе
meta	Meta		Метаданные Отчета по данному контрагенту Обязательное при ответе
profit	Float	= != < > <= >=	Прибыль Обязательное при ответе
returnsCount	Int	= != < > <= >=	Количество возвратов Обязательное при ответе
returnsSum	Float	= != < > <= >=	Сумма возвратов Обязательное при ответе
updated	DateTime	= != < > <= >=	Момент последнего изменения контрагента Обязательное при ответе

Дополнительные атрибуты доступные для фильтрации

Название	Тип	Фильтрация	Описание
counterparty.name	String(255)	= != ~ ~= =~	Имя контрагента
counterparty.companyType	Enum	= !=	Тип контрагента
counterparty.description	String(4096)	= != ~ ~= =~	Комментарий к Контрагенту
counterparty.email	String(255)	= != ~ ~= =~	Адрес электронной почты
counterparty.inn	String(255)	= != ~ ~= =~	Тип контрагента
counterparty.phone	String(255)	= != ~ ~= =~	Номер телефона
id	UUID	= !=	id контрагента

Контрагент

Название	Тип	Описание
companyType	Enum	Тип контрагента Обязательное при ответе
externalCode	String(255)	Внешний код контрагента Обязательное при ответе
id	UUID	ID Контрагента Обязательное при ответе
meta	Meta	Метаданные Контрагента Обязательное при ответе
name	String(255)	Наименование Контрагента Обязательное при ответе

Тарифные ограничения

Если в вашем тарифе не предусмотрена опция CRM, вы не сможете получить этот запрос через API.

Получить показатели контрагентов

Запрос на получение отчета по контрагентам. Результат успешного запроса - JSON представление списка отчетов по отдельным котрагентам:

Название	Тип	Описание
meta	Meta	Метаданные о выдаче,
context	Meta	Метаданные о сотруднике, выполнившем запрос.
rows	Array(Object)	Массив JSON объектов, представляющих отчеты по отдельным контрагентам.

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Запрос на получение отчета по контрагентам.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/counterparty"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета по контрагентам.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty",
    "type": "counterparty",
    "mediaType": "application/json",
    "size": 5,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        },
        "id": "b80ea81b-7058-11e6-8a84-bae500000000",
        "name": "ООО Радуга",
        "externalCode": "o7732zkki541HDkZZD1Yt3",
        "companyType": "legal"
      },
      "firstDemandDate": null,
      "lastDemandDate": null,
      "demandsCount": 0,
      "demandsSum": 0,
      "averageReceipt": 0,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 0,
      "profit": 0,
      "lastEventDate": null,
      "lastEventText": null,
      "updated": "2016-09-01 18:32:17"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        },
        "id": "df2fdd2d-6934-11e6-8a84-bae500000049",
        "name": "rtr",
        "externalCode": "rRlzrdZmjql9r9dveXPE43",
        "companyType": "legal"
      },
      "firstDemandDate": null,
      "lastDemandDate": null,
      "demandsCount": 0,
      "demandsSum": 0,
      "averageReceipt": 0,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 0,
      "profit": 0,
      "lastEventDate": "2016-09-08 13:07:30",
      "lastEventText": "продажа",
      "updated": "2016-08-23 16:24:08"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        },
        "id": "12c9ebcf-692c-11e6-8a84-bae50000005d",
        "name": "Розничный покупатель",
        "externalCode": "lBvYwLWMiBsct7sVRrFnJ2",
        "companyType": "legal"
      },
      "firstDemandDate": "2016-08-26 15:49:00",
      "lastDemandDate": "2016-08-26 15:49:00",
      "demandsCount": 1,
      "demandsSum": 80000,
      "averageReceipt": 80000,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 0,
      "bonusBalance": 120,
      "profit": -103040600,
      "lastEventDate": null,
      "lastEventText": null,
      "updated": "2016-08-23 15:21:09"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/12a8e347-692c-11e6-8a84-bae500000055",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        },
        "id": "12a8e347-692c-11e6-8a84-bae500000055",
        "name": "ООО \"Покупатель\"",
        "externalCode": "DTItQRbDhyl472ZqC5OWw2",
        "inn": "7736570902",
        "companyType": "legal"
      },
      "firstDemandDate": "2016-09-01 17:54:00",
      "lastDemandDate": "2016-09-01 17:54:00",
      "demandsCount": 1,
      "demandsSum": 60000,
      "averageReceipt": 60000,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 1241255000,
      "bonusBalance": 298,
      "profit": 50000,
      "lastEventDate": null,
      "lastEventText": null,
      "updated": "2016-08-23 15:21:09"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/12a8b923-692c-11e6-8a84-bae500000053",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        },
        "id": "12a8b923-692c-11e6-8a84-bae500000053",
        "name": "ООО \"Поставщик\"",
        "externalCode": "aZBfWOKzj-lcq7c7IWZON3",
        "inn": "7736570901",
        "companyType": "legal"
      },
      "firstDemandDate": null,
      "lastDemandDate": null,
      "demandsCount": 0,
      "demandsSum": 0,
      "averageReceipt": 0,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 0,
      "profit": 0,
      "lastEventDate": null,
      "lastEventText": null,
      "updated": "2016-08-23 15:21:09"
    }
  ]
}

Выборочные показатели контрагентов

Запрос на получение отчета по указанным контрагентам. Необходимо передать массив counterparties, содержащий метаданные контрагентов, по которым требуются отчеты. Результат успешного запроса - JSON представление списка отчетов по указанным котрагентам:

Название	Тип	Описание
meta	Meta	Метаданные о выдаче,
context	Meta	Метаданные о сотруднике, выполнившем запрос.
rows	Array(Object)	Массив JSON объектов, представляющих отчеты по отдельным контрагентам.

Пример запроса отчетов для нескольких контрагентов.

ПоказатьСвернуть

  curl -X POST
    "https://online.moysklad.ru/api/remap/1.2/report/counterparty"
    -H "Authorization: Basic <Credentials>"
    -H "Content-Type: application/json"
      -d '{
            "counterparties": [
              {
                "counterparty": {
                  "meta": {
                    "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/49b40d55-66cc-11e7-6adb-ede500000054",
                    "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
                    "type": "counterparty",
                    "mediaType": "application/json"
                  }
                }
              },
              {
                "counterparty": {
                  "meta": {
                    "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/37e4efe0-6ade-11e7-6adb-ede50000001a",
                    "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
                    "type": "counterparty",
                    "mediaType": "application/json"
                  }
                }
              }
            ]
          }'  

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета по контрагентам.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty",
    "type": "counterparty",
    "mediaType": "application/json",
    "size": 2,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/49b40d55-66cc-11e7-6adb-ede500000054",
        "type": "counterparty",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=49b40d55-66cc-11e7-6adb-ede500000054"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/49b40d55-66cc-11e7-6adb-ede500000054",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=49b40d55-66cc-11e7-6adb-ede500000054"
        },
        "id": "49b40d55-66cc-11e7-6adb-ede500000054",
        "name": "ООО \"Поставщик\"",
        "externalCode": "btkD664AiiIaIYMdI50OW3",
        "inn": "7736570901",
        "companyType": "legal"
      },
      "firstDemandDate": null,
      "lastDemandDate": null,
      "demandsCount": 0,
      "demandsSum": 0,
      "averageReceipt": 0,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 0,
      "profit": 0,
      "lastEventDate": null,
      "lastEventText": null,
      "updated": "2017-07-12 09:35:26"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/37e4efe0-6ade-11e7-6adb-ede50000001a",
        "type": "counterparty",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=37e4efe0-6ade-11e7-6adb-ede50000001a"
      },
      "counterparty": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/37e4efe0-6ade-11e7-6adb-ede50000001a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=37e4efe0-6ade-11e7-6adb-ede50000001a"
        },
        "id": "37e4efe0-6ade-11e7-6adb-ede50000001a",
        "name": "ООО \"Поставщик 2\"",
        "externalCode": "WG4JRabzgb6aW9asZ20yy3",
        "inn": "7736570901",
        "companyType": "legal"
      },
      "firstDemandDate": null,
      "lastDemandDate": null,
      "demandsCount": 0,
      "demandsSum": 0,
      "averageReceipt": 0,
      "returnsCount": 0,
      "returnsSum": 0,
      "discountsSum": 0,
      "balance": 0,
      "profit": 0,
      "lastEventDate": null,
      "lastEventText": null,
      "updated": "2017-07-17 13:54:30"
    }
  ]
}

Показатели контрагента

Показатели контрагента

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Запрос на получение отчета по контрагенту с указанным id.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/counterparty/7944ef04-f831-11e5-7a69-971500188b19"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета по контрагенту.

ПоказатьСвернуть

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "counterparty": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json"
    },
    "id": "df2fdd2d-6934-11e6-8a84-bae500000049",
    "name": "rtr",
    "externalCode": "rRlzrdZmjql9r9dveXPE43",
    "companyType": "legal"
  },
  "firstDemandDate": "2016-09-01 17:54:00",
  "lastDemandDate": "2016-09-01 17:54:00",
  "demandsCount": 1,
  "demandsSum": 60000,
  "averageReceipt": 60000,
  "returnsCount": 0,
  "returnsSum": 0,
  "discountsSum": 0,
  "balance": -60000,
  "bonusBalance": 200,
  "profit": 50000,
  "lastEventDate": "2016-09-08 13:07:30",
  "lastEventText": "продажа",
  "updated": "2016-08-23 16:24:08"
}

Отчет Обороты

Средствами JSON API можно запросить отчет "Обороты" по всем товарам и модификациям. Для доступа к отчету через API требуется право на просмотр отчета Обороты. О том, что представляет собой отчет "Обороты" вы можете прочитать по этой ссылке.

Обороты по товарам

Общий отчет по оборотам товаров и модификаций без детализации по складам.

Атрибуты объекта отчета

Название	Тип	Описание
assortment	Object	Краткое представление Товара или Модификации в отчете. Подробнее тут Обязательное при ответе
onPeriodStart	Object	Показатели на начало периода. Подробнее тут Обязательное при ответе
onPeriodEnd	Object	Показатели на конец периода. Подробнее тут Обязательное при ответе
income	Object	Показатели прихода в течение периода отчета. Подробнее тут Обязательное при ответе
outcome	Object	Показатели расхода в течение периода отчета. Подробнее тут Обязательное при ответе

Структура объекта assortment

Название	Тип	Описание
article	String(255)	Артикул Товара
code	String(255)	Код Товара
image	Object	Первое изображение Товара или Модификации
meta	Meta	Метаданные Товара или Модификации Обязательное при ответе
name	String(255)	Наименование Товара или Модификации Обязательное при ответе
productFolder	Object	Группа Товара или Модификации
uom	Object	Единица измерения

Структура объекта показатели (onPeriodStart, onPeriodEnd, income, outcome)

Название	Тип	Описание
sum	Float	Сумма себестоимости Обязательное при ответе
quantity	Float	Количество единиц товара Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения.

Название	Тип	Фильтрация	Описание
agent	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
agentTag	String(255)	=	строка с названием группы контрагентов, по которой нужно произвести фильтрацию.
contract	Object	=	ссылка на договор, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
product	Object	=	ссылка на товар, по которому нужно произвести фильтрацию. В выдаче будет товар вместе с его модификациями при groupBy=variant.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	Object	=	ссылка на точку продаж, по которой нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
supplier	Object	=	параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены или исключены товары с указанным поставщиком. Можно передать пустое значение, тогда в выборку попадут товары с незаполненным или заполненным поставщиком.
type	Enum	=	параметр для фильтрации "тип документа", по которому можно произвести фильтрацию. Возможные значения supply, purchasereturn, demand, salesreturn, loss, enter, move, processing, retaildemand, retailsalesreturn.
variant	Object	=	ссылка на модификацию, по которой нужно произвести фильтрацию.
withoutturnover	Boolean	=	параметр для фильтрации "Показывать товары без движения". Возможные значения: true, false.

Примеры фильтрации:

• filter=agent=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=contract=https://online.moysklad.ru/api/remap/1.2/entity/contract/7a5f0ed5-8552-11e6-8a84-bae500085742
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=agentTag=favorites
• filter=withoutturnover=true
• filter=type=supply
• filter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/656c4032-8667-11e6-8a84-bae5000033aa

Фильтрация по дополнительным полям

C помощью параметра filter выборку также можно фильтровать по значениям дополнительных полей товаров.

Для фильтрации по значению дополнительного поля, нужно передать ссылку на дополнительное поле и его значение:

filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/=<Значение>

Для фильтрации по значению дополнительных полей типа строка, текст и ссылка нужно использовать оператор =. Также можно использовать операторы = и != с пустым значением, чтобы получить товары только с незаполненным дополнительным полем или только заполненным, соответственно.

Для фильтрации по значению дополнительных полей типа целое число, вещественное число, дата можно использовать операторы =, >=, <=. Также можно использовать операторы = и != с пустым значением, чтобы получить товары только с незаполненным дополнительным полем или только заполненным, соответственно. Для дополнительного поля типа дата-время значение передается в виде строки в формате дата-время.

Для фильтрации по значению дополнительных полей типа справочник можно использовать операторы = и !=. В качестве значения нужно передавать ссылку на объект справочника. Также можно использовать операторы = и != с пустым значением, чтобы получить товары только с незаполненным дополнительным полем или только заполненным, соответственно.

Пример фильтрации по дополнительному полю типа справочник складов: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://online.moysklad.ru/api/remap/1.2/entity/store/302f2a81-9977-11e9-9109-f8fc00020e02

Пример фильтрации по дополнительному полю типа пользовательский справочник: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://online.moysklad.ru/api/remap/1.2/entity/customentity/8955249d-997d-11e9-9ff4-3150000e65c3/8955314d-997d-11e9-9ff4-3150000e65c4

Для фильтрации по значению дополнительных полей типа флажок нужно использовать оператор =. Возможные значения: true, false.

Фильтрация по дополнительным полям типа файл не поддерживается.

Получить Обороты по товарам

Запрос на получение отчета Обороты по товарам.

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
momentFrom	date (optional) Example: 2018-09-01 00:00:00 Начало периода отчета
momentTo	date (optional) Example: 2018-10-01 00:00:00 Конец периода отчета
groupBy	string (optional) тип, по которому нужно сгруппировать выдачу. По умолчанию параметр groupBy имеет значение product. Если вы хотите увидеть только объекты типа product, необходимо выставить соответствующее значение параметра. groupBy=product - только товары groupBy=variant - товары и модификации

Заголовки

Заголовок	Описание
X-Lognex-Accept-Timezone	Опциональный заголовок, в котором указана текущая дата на клиенте в RFC 3522. Таймзону обязательно указывать в формате знак и 4 символа (не в Obsolete Date and Time). Пример даты: Wed, 16 Aug 2017 23:07:01 +0700. При подсчете показателей даты операций смещаются в таймзону клиента.
X-Lognex-Content-Timezone	Заголовок ответа. В нем указывается (как думает сервер) текущая дата на клиенте в RFC 3522.

Запрос на получение отчета "Обороты по товарам".

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/turnover/all"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/turnover/all",
    "type": "turnover",
    "mediaType": "application/json",
    "size": 3,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=66989c14-bdfe-11eb-c0a8-800c00000014"
        },
        "name": "товар 2"
      },
      "onPeriodStart": {
        "quantity": 0.0,
        "sum": 0.0
      },
      "onPeriodEnd": {
        "quantity": 1.0,
        "sum": 0.0
      },
      "income": {
        "quantity": 3.0,
        "sum": 0.0
      },
      "outcome": {
        "quantity": 2.0,
        "sum": 0.0
      }
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/3e32ef51-c1f1-11eb-c0a8-800c00000003",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
          "type": "variant",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#feature/edit?id=3e3278e5-c1f1-11eb-c0a8-800c00000001"
        },
        "name": "2 (char)"
      },
      "onPeriodStart": {
        "quantity": 0.0,
        "sum": 0.0
      },
      "onPeriodEnd": {
        "quantity": 2.0,
        "sum": 20000.0
      },
      "income": {
        "quantity": 3.0,
        "sum": 30000.0
      },
      "outcome": {
        "quantity": 1.0,
        "sum": 10000.0
      }
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/b008915c-b977-11eb-c0a8-800a00000008",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=b0078621-b977-11eb-c0a8-800a00000006"
        },
        "name": "товар 1",
        "code": "00001",
        "article": "123",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "шт"
        },
        "productFolder": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/productfolder/e229bb59-c202-11eb-c0a8-800b00000002",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/productfolder/metadata",
            "type": "productfolder",
            "mediaType": "application/json",
            "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=e229bb59-c202-11eb-c0a8-800b00000002"
          },
          "name": "группа"
        }
      },
      "onPeriodStart": {
        "quantity": 0.0,
        "sum": 0.0
      },
      "onPeriodEnd": {
        "quantity": 2.0,
        "sum": 4400.0
      },
      "income": {
        "quantity": 3.0,
        "sum": 6600.0
      },
      "outcome": {
        "quantity": 1.0,
        "sum": 2200.0
      }
    }
  ]
}

Обороты по товару с детализацией по складам

Отчет обороты по товару и его модификациям с детализацией по складам.

Атрибуты объекта отчета

Название	Тип	Описание
assortment	Object	Краткое представление Товара или Модификации в отчете. Подробнее тут Обязательное при ответе
stockByStore	Object	Детализация оборотов по складам. Подробнее тут Обязательное при ответе

Структура объекта assortment

Название	Тип	Описание
article	String(255)	Артикул Товара
code	String(255)	Код Товара
image	Object	Первое изображение Товара или Модификации
meta	Meta	Метаданные Товара или Модификации Обязательное при ответе
name	String(255)	Наименование Товара или Модификации Обязательное при ответе
productFolder	Object	Группа Товара или Модификации
uom	Object	Единица измерения

Структура объекта детализация оборотов по складам

Название	Тип	Описание
store	Object	Склад. Обязательное при ответе
onPeriodStart	Object	Показатели на начало периода. Подробнее тут Обязательное при ответе
onPeriodEnd	Object	Показатели на конец периода. Подробнее тут Обязательное при ответе
income	Object	Показатели прихода в течение периода отчета. Подробнее тут Обязательное при ответе
outcome	Object	Показатели расхода в течение периода отчета. Подробнее тут Обязательное при ответе

Структура объекта показатели (onPeriodStart, onPeriodEnd, income, outcome)

Название	Тип	Описание
sum	Float	Сумма себестоимости Обязательное при ответе
quantity	Float	Количество единиц товара Обязательное при ответе

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения.

Является обязательным указание одного из параметров фильтрации product или variant.

Название	Тип	Фильтрация	Описание
agent	Object	=	ссылка на контрагента, по которому нужно произвести фильтрацию.
agentTag	String(255)	=	строка с названием группы контрагентов, по которой нужно произвести фильтрацию.
contract	Object	=	ссылка на договор, по которому нужно произвести фильтрацию.
organization	Object	=	ссылка на юрлицо, по которому нужно произвести фильтрацию.
product	Object	=	ссылка на товар, по которому нужно произвести фильтрацию. В выдаче будет товар вместе с его модификациями.
project	Object	=	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	Object	=	ссылка на точку продаж, по которой нужно произвести фильтрацию.
store	Object	=	ссылка на склад, по которому нужно произвести фильтрацию.
variant	Object	=	ссылка на модификацию, по которой нужно произвести фильтрацию.

Примеры фильтрации:

• filter=agent=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=contract=https://online.moysklad.ru/api/remap/1.2/entity/contract/7a5f0ed5-8552-11e6-8a84-bae500085742
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=agentTag=favorites

Получить Обороты по товару

Запрос на получение отчета Обороты по товару.

Для успешного выполнения запроса необходимо указание одного из параметров фильтрации product или variant.

Параметры

Параметр	Описание
momentFrom	date (optional) Example: 2018-09-01 00:00:00 Начало периода отчета
momentTo	date (optional) Example: 2018-10-01 00:00:00 Конец периода отчета

Заголовки

Заголовок	Описание
X-Lognex-Accept-Timezone	Опциональный заголовок, в котором указана текущая дата на клиенте в RFC 3522. Таймзону обязательно указывать в формате знак и 4 символа (не в Obsolete Date and Time). Пример даты: Wed, 16 Aug 2017 23:07:01 +0700. При подсчете показателей даты операций смещаются в таймзону клиента.
X-Lognex-Content-Timezone	Заголовок ответа. В нем указывается (как думает сервер) текущая дата на клиенте в RFC 3522.

Запрос на получение отчета "Обороты по товару" с указанным id товара.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/turnover/bystore?filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/turnover/bystore?filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016",
    "type": "turnoverbystore",
    "mediaType": "application/json",
    "size": 2,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=66989c14-bdfe-11eb-c0a8-800c00000014"
        },
        "name": "товар 2",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/af3b8110-5a23-4839-b3f7-a486f771a315",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "10^6 м3"
        }
      },
      "stockByStore": [
        {
          "store": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/9238b396-b719-11eb-c0a8-800c00000074",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
              "type": "store",
              "mediaType": "application/json",
              "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=9238b396-b719-11eb-c0a8-800c00000074"
            },
            "name": "Основной склад"
          },
          "onPeriodStart": {
            "quantity": 0.0,
            "sum": 0.0
          },
          "onPeriodEnd": {
            "quantity": 1.0,
            "sum": 0.0
          },
          "income": {
            "quantity": 3.0,
            "sum": 0.0
          },
          "outcome": {
            "quantity": 2.0,
            "sum": 0.0
          }
        }
      ]
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/3e32ef51-c1f1-11eb-c0a8-800c00000003",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
          "type": "variant",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#feature/edit?id=3e3278e5-c1f1-11eb-c0a8-800c00000001"
        },
        "name": "товар 2 (красный)",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/af3b8110-5a23-4839-b3f7-a486f771a315",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "10^6 м3"
        }
      },
      "stockByStore": [
        {
          "store": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/9238b396-b719-11eb-c0a8-800c00000074",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
              "type": "store",
              "mediaType": "application/json",
              "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=9238b396-b719-11eb-c0a8-800c00000074"
            },
            "name": "Основной склад"
          },
          "onPeriodStart": {
            "quantity": 0.0,
            "sum": 0.0
          },
          "onPeriodEnd": {
            "quantity": 2.0,
            "sum": 20000.0
          },
          "income": {
            "quantity": 3.0,
            "sum": 30000.0
          },
          "outcome": {
            "quantity": 1.0,
            "sum": 10000.0
          }
        },
        {
          "store": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/8d3d4ad8-be02-11eb-c0a8-800c00000025",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
              "type": "store",
              "mediaType": "application/json",
              "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=8d3d4ad8-be02-11eb-c0a8-800c00000025"
            },
            "name": "склад 2"
          },
          "onPeriodStart": {
            "quantity": 0.0,
            "sum": 0.0
          },
          "onPeriodEnd": {
            "quantity": -5.0,
            "sum": 0.0
          },
          "income": {
            "quantity": 0.0,
            "sum": 0.0
          },
          "outcome": {
            "quantity": 5.0,
            "sum": 0.0
          }
        }
      ]
    }
  ]
}

Обороты по товару с детализацией по документам

Отчет обороты по товару и его модификациям с детализацией по складам и документам.

Атрибуты объекта отчета

Название	Тип	Описание
assortment	Object	Краткое представление Товара или Модификации в отчете. Подробнее тут Обязательное при ответе
store	Object	Склад. Обязательное при ответе
operation	Object	Документ, связанный с Товаром. Подробнее тут Обязательное при ответе
quantity	Float	Количество товара в документе. Обязательное при ответе
cost	Float	Себестоимость товара в документе. Обязательное при ответе
sum	Float	Сумма себестоимостей. Обязательное при ответе

Структура объекта assortment

Название	Тип	Описание
meta	Meta	Метаданные Товара или Модификации Обязательное при ответе
name	String(255)	Наименование Товара или Модификации Обязательное при ответе
code	String(255)	Код Товара
article	String(255)	Артикул Товара
productFolder	Object	Группа Товара или Модификации
uom	Object	Единица измерения

Структура объекта operation

Название	Тип	Описание
meta	Meta	Метаданные документа Обязательное при ответе
name	String(255)	Номер документа Обязательное при ответе
description	String(255)	Комментарий к документу
moment	Object	Дата проведения документа Обязательное при ответе
agent	Object	Контрагент документа

Атрибуты доступные для фильтрации

Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения.

Является обязательным указание одного из параметров фильтрации product или variant.

Название	Описание
agent	ссылка на контрагента, по которому нужно произвести фильтрацию.
agentTag	строка с названием группы контрагентов, по которой нужно произвести фильтрацию.
contract	ссылка на договор, по которому нужно произвести фильтрацию.
organization	ссылка на юрлицо, по которому нужно произвести фильтрацию.
project	ссылка на проект, по которому нужно произвести фильтрацию.
retailStore	ссылка на точку продаж, по которой нужно произвести фильтрацию.
store	ссылка на склад, по которому нужно произвести фильтрацию.

Примеры фильтрации:

• filter=agent=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000
• filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003
• filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
• filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046
• filter=contract=https://online.moysklad.ru/api/remap/1.2/entity/contract/7a5f0ed5-8552-11e6-8a84-bae500085742
• filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
• filter=agentTag=favorites

Получить Обороты по товару с детализацией по документам

Запрос на получение отчета Обороты по товару с детализацией по документам.

Параметры

Параметр	Описание
momentFrom	date (required) Example: 2021-06-01 00:00:00 Начало периода отчета
momentTo	date (required) Example: 2021-07-01 00:00:00 Конец периода отчета

Заголовки

Заголовок	Описание
X-Lognex-Accept-Timezone	Опциональный заголовок, в котором указана текущая дата на клиенте в RFC 3522. Таймзону обязательно указывать в формате знак и 4 символа (не в Obsolete Date and Time). Пример даты: Wed, 16 Aug 2017 23:07:01 +0700. При подсчете показателей даты операций смещаются в таймзону клиента.
X-Lognex-Content-Timezone	Заголовок ответа. В нем указывается (как думает сервер) текущая дата на клиенте в RFC 3522.

Запрос на получение отчета "Обороты по товару с детализацией по документам" с указанным id товара.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/turnover/byoperations?filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление отчета.

ПоказатьСвернуть

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/report/turnover/byoperations?filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016",
    "type": "turnoverbyoperation",
    "mediaType": "application/json",
    "size": 4,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=66989c14-bdfe-11eb-c0a8-800c00000014"
        },
        "name": "2",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/af3b8110-5a23-4839-b3f7-a486f771a315",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "10^6 м3"
        }
      },
      "store": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/9238b396-b719-11eb-c0a8-800c00000074",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
          "type": "store",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=9238b396-b719-11eb-c0a8-800c00000074"
        },
        "name": "Основной склад"
      },
      "operation": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/supply/29d1cb69-bfb7-11eb-c0a8-800d00000039",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/supply/metadata",
          "type": "supply",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#supply/edit?id=29d1cb69-bfb7-11eb-c0a8-800d00000039"
        },
        "name": "00001",
        "moment": "2021-05-28 16:18:00.000",
        "agent": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/923916c6-b719-11eb-c0a8-800c00000075",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
            "type": "counterparty",
            "mediaType": "application/json",
            "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=923916c6-b719-11eb-c0a8-800c00000075"
          },
          "name": "ООО \"Поставщик\""
        }
      },
      "quantity": 3.0,
      "cost": 0.0,
      "sum": 0.0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/66990dc7-bdfe-11eb-c0a8-800c00000016",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=66989c14-bdfe-11eb-c0a8-800c00000014"
        },
        "name": "2",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/af3b8110-5a23-4839-b3f7-a486f771a315",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "10^6 м3"
        }
      },
      "store": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/9238b396-b719-11eb-c0a8-800c00000074",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
          "type": "store",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=9238b396-b719-11eb-c0a8-800c00000074"
        },
        "name": "Основной склад"
      },
      "operation": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/demand/0410e6b6-bfb7-11eb-c0a8-800d0000000f",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/demand/metadata",
          "type": "demand",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#demand/edit?id=0410e6b6-bfb7-11eb-c0a8-800d0000000f"
        },
        "name": "00001",
        "moment": "2021-05-28 16:25:00.000",
        "agent": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/92394ebc-b719-11eb-c0a8-800c00000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
            "type": "counterparty",
            "mediaType": "application/json",
            "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=92394ebc-b719-11eb-c0a8-800c00000077"
          },
          "name": "ООО \"Покупатель\""
        }
      },
      "quantity": -2.0,
      "cost": 0.0,
      "sum": 0.0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/3e32ef51-c1f1-11eb-c0a8-800c00000003",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
          "type": "variant",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#feature/edit?id=3e3278e5-c1f1-11eb-c0a8-800c00000001"
        },
        "name": "2 (char)",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/af3b8110-5a23-4839-b3f7-a486f771a315",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "10^6 м3"
        }
      },
      "store": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/9238b396-b719-11eb-c0a8-800c00000074",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
          "type": "store",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=9238b396-b719-11eb-c0a8-800c00000074"
        },
        "name": "Основной склад"
      },
      "operation": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/supply/5588e522-c1f1-11eb-c0a8-800c0000000c",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/supply/metadata",
          "type": "supply",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#supply/edit?id=5588e522-c1f1-11eb-c0a8-800c0000000c"
        },
        "name": "00002",
        "moment": "2021-05-31 12:19:00.000",
        "agent": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/923916c6-b719-11eb-c0a8-800c00000075",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
            "type": "counterparty",
            "mediaType": "application/json",
            "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=923916c6-b719-11eb-c0a8-800c00000075"
          },
          "name": "ООО \"Поставщик\""
        }
      },
      "quantity": 3.0,
      "cost": 10000.0,
      "sum": 30000.0
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/3e32ef51-c1f1-11eb-c0a8-800c00000003",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
          "type": "variant",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#feature/edit?id=3e3278e5-c1f1-11eb-c0a8-800c00000001"
        },
        "name": "2 (char)",
        "uom": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/af3b8110-5a23-4839-b3f7-a486f771a315",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
            "type": "uom",
            "mediaType": "application/json"
          },
          "name": "10^6 м3"
        }
      },
      "store": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/store/9238b396-b719-11eb-c0a8-800c00000074",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
          "type": "store",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=9238b396-b719-11eb-c0a8-800c00000074"
        },
        "name": "Основной склад"
      },
      "operation": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/demand/5d21e1a0-c1f1-11eb-c0a8-800c00000012",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/demand/metadata",
          "type": "demand",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#demand/edit?id=5d21e1a0-c1f1-11eb-c0a8-800c00000012"
        },
        "name": "00002",
        "moment": "2021-05-31 12:19:00.000",
        "agent": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/92394ebc-b719-11eb-c0a8-800c00000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
            "type": "counterparty",
            "mediaType": "application/json",
            "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=92394ebc-b719-11eb-c0a8-800c00000077"
          },
          "name": "ООО \"Покупатель\""
        }
      },
      "quantity": -1.0,
      "cost": -10000.0,
      "sum": -10000.0
    }
  ]
}

Показатели

В рамках JSON API можно запросить показатели за день, месяц и неделю. Для доступа к отчету через API требуется право на просмотр показателей viewDashboard.

Структура объекта показателей

Название	Тип	Описание
sales	Object	Вложенный объект, представляющий собой информацию о продажах за указанный период. Подробнее тут Обязательное при ответе
orders	Object	Вложенный объект, представляющий собой информацию о заказах за указанный период. Подробнее тут Обязательное при ответе
money	Object	Вложенный объект, представляющий собой информацию о деньгах за указанный период. Подробнее тут Обязательное при ответе

Продажи за период

Название	Тип	Описание
count	Int	Количество продаж Обязательное при ответе
amount	Int	Прибыль Обязательное при ответе
movementAmount	Int	Дельта по сравнению с прошлым аналогичным периодом Обязательное при ответе

Заказы за период

Название	Тип	Описание
count	Int	Количество продаж Обязательное при ответе
amount	Int	Прибыль Обязательное при ответе
movementAmount	Int	Дельта по сравнению с прошлым аналогичным периодом Обязательное при ответе

Деньги за период

Название	Тип	Описание
income	Int	Доходы за период Обязательное при ответе
outcome	Float	Расходы за период Обязательное при ответе
balance	Float	Текущий баланс Обязательное при ответе
todayMovement	Float	Дельта за сегодня Обязательное при ответе
movement	Float	Дельта за период Обязательное при ответе

Получить показатели за день

Запрос на получение показателей за день.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/dashboard/day"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление показателей.

ПоказатьСвернуть

{
  "sales": {
    "count": 0,
    "amount": 0,
    "movementAmount": -80000
  },
  "orders": {
    "count": 0,
    "amount": 0,
    "movementAmount": 0
  },
  "money": {
    "income": 0,
    "outcome": 0,
    "balance": 69700,
    "todayMovement": 0,
    "movement": 0
  }
}

Получить показатели за неделю

Запрос на получение показателей за неделю.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/dashboard/week"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление показателей.

ПоказатьСвернуть

{
  "sales": {
    "count": 0,
    "amount": 0,
    "movementAmount": -80000
  },
  "orders": {
    "count": 0,
    "amount": 0,
    "movementAmount": 0
  },
  "money": {
    "income": 0,
    "outcome": 0,
    "balance": 69700,
    "todayMovement": 0,
    "movement": 0
  }
}

Получить показатели за месяц

Запрос на получение показателей за месяц.

ПоказатьСвернуть

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/report/dashboard/month"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешный запрос. Результат - JSON представление показателей.

ПоказатьСвернуть

{
  "sales": {
    "count": 0,
    "amount": 0,
    "movementAmount": -80000
  },
  "orders": {
    "count": 0,
    "amount": 0,
    "movementAmount": 0
  },
  "money": {
    "income": 0,
    "outcome": 0,
    "balance": 69700,
    "todayMovement": 0,
    "movement": 0
  }
}