Navbar

Отчеты

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

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

Доступ к отчету Остатки

Для доступа к отчету Остатки через API каких-либо дополнительных прав не требуется. На отображение товаров в отчете Остатки влияют настройки видимости товаров и складов для пользователя, под именем которого запрашивается отчет Остатки. Себестоимость, цена закупки, прибыль отображаются в Остатках при наличии у пользователя права <Видеть себестоимость, цену закупки и прибыль товаров>.

Все Остатки

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

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

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

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

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

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

Группа

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

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

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

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

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

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

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

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

Для параметров фильтрации product, variant, consignment, productFolder и search в рамках одного запроса можно использовать только одинаковые операторы (для 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, его модификации и серии.

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

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

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

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

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

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

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

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

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

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

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

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

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

В одном запросе можно использовать только один из параметров product, variant, consignment, productFolder и 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 - выдает товары, модификации, серии

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

Средствами 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 ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
counterparty ссылка на контрагента, по которому нужно произвести фильтрацию.
organization ссылка на юрлицо, по которому нужно произвести фильтрацию.
store ссылка на склад, по которому нужно произвести фильтрацию.
project ссылка на проект, по которому нужно произвести фильтрацию.
retailStore ссылка на точку продаж, по которой нужно произвести фильтрацию.

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

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

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

Параметры

Параметр Описание
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 по текущий день.

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

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

Название Тип Описание
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 ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
counterparty ссылка на контрагента, по которому нужно произвести фильтрацию.
organization ссылка на юрлицо, по которому нужно произвести фильтрацию.
store ссылка на склад, по которому нужно произвести фильтрацию.
project ссылка на проект, по которому нужно произвести фильтрацию.
retailStore ссылка на точку продаж, по которой нужно произвести фильтрацию.

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

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

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

Параметры

Параметр Описание
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 по текущий день.

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

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

Название Тип Описание
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 ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
counterparty ссылка на контрагента, по которому нужно произвести фильтрацию.
organization ссылка на юрлицо, по которому нужно произвести фильтрацию.
store ссылка на склад, по которому нужно произвести фильтрацию.
project ссылка на проект, по которому нужно произвести фильтрацию.
retailStore ссылка на точку продаж, по которой нужно произвести фильтрацию.

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

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

Параметры

Параметр Описание
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 по текущий день.

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

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

Название Тип Описание
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 ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
counterparty ссылка на контрагента, по которому нужно произвести фильтрацию.
organization ссылка на юрлицо, по которому нужно произвести фильтрацию.
store ссылка на склад, по которому нужно произвести фильтрацию.
project ссылка на проект, по которому нужно произвести фильтрацию.
retailStore ссылка на точку продаж, по которой нужно произвести фильтрацию.

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

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

Параметры

Параметр Описание
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 по текущий день.

Отчет Деньги

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

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

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

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

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

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

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

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

Название Описание
organization ссылка на юр. лицо
project ссылка на проект

Параметры

Параметр Описание
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.

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

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

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

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

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

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

Организация

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

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

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

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

Название Тип Описание
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 ссылка на юр. лицо
store ссылка на склад
project ссылка на проект

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

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

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

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

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

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

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

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

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

Название Тип Описание
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 Момент последнего изменения контрагента
Обязательное при ответе

Контрагент

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

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

Значение Описание
averageReceipt Средний чек
balance Баланс
counterparty.name Имя контрагента
counterparty.companyType Тип контрагента
counterparty.description Комментарий к Контрагенту
counterparty.email Адрес электронной почты
counterparty.inn Тип контрагента
counterparty.phone Номер телефона
demandsCount Количество продаж
demandsSum Сумма продаж
discountsSum Сумма скидок
firstDemandDate Дата первой продажи
id id контрагента
lastDemandDate Дата последней продажи
lastEventDate Дата последнего события
lastEventText Текст последнего события
profit Прибыль
returnsCount Количество возвратов
returnsSum Сумма возвратов
updated Момент последнего изменения контрагента

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

Если в вашем тарифе не предусмотрена опция 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 Отступ в выдаваемом списке сущностей.

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

Запрос на получение отчета по указанным контрагентам. Необходимо передать массив counterparties, содержащий метаданные контрагентов, по которым требуются отчеты. Результат успешного запроса - 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 Отступ в выдаваемом списке сущностей.

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

Средствами 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 ссылка на контрагента, по которому нужно произвести фильтрацию.
agentTag строка с названием группы контрагентов, по которой нужно произвести фильтрацию.
contract ссылка на договор, по которому нужно произвести фильтрацию.
organization ссылка на юрлицо, по которому нужно произвести фильтрацию.
product ссылка на товар, по которому нужно произвести фильтрацию. В выдаче будет товар вместе с его модификациями при groupBy=variant.
project ссылка на проект, по которому нужно произвести фильтрацию.
retailStore ссылка на точку продаж, по которой нужно произвести фильтрацию.
store ссылка на склад, по которому нужно произвести фильтрацию.
supplier параметр для фильтрации по поставщику. Можно использовать операторы = и !=. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены или исключены товары с указанным поставщиком. Можно передать пустое значение, тогда в выборку попадут товары с незаполненным или заполненным поставщиком.
type параметр для фильтрации "тип документа", по которому можно произвести фильтрацию. Возможные значения supply, purchasereturn, demand, salesreturn, loss, enter, move, processing, retaildemand, retailsalesreturn.
variant ссылка на модификацию, по которой нужно произвести фильтрацию.
withoutturnover параметр для фильтрации "Показывать товары без движения". Возможные значения: true, false.

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

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

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.

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

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

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

Название Тип Описание
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 ссылка на контрагента, по которому нужно произвести фильтрацию.
agentTag строка с названием группы контрагентов, по которой нужно произвести фильтрацию.
contract ссылка на договор, по которому нужно произвести фильтрацию.
organization ссылка на юрлицо, по которому нужно произвести фильтрацию.
product ссылка на товар, по которому нужно произвести фильтрацию. В выдаче будет товар вместе с его модификациями.
project ссылка на проект, по которому нужно произвести фильтрацию.
retailStore ссылка на точку продаж, по которой нужно произвести фильтрацию.
store ссылка на склад, по которому нужно произвести фильтрацию.
variant ссылка на модификацию, по которой нужно произвести фильтрацию.

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

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

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

Для успешного выполнения запроса необходимо указание одного из параметров фильтрации 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.

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

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

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

Название Тип Описание
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 ссылка на склад, по которому нужно произвести фильтрацию.

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

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

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

Параметры

Параметр Описание
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.

Показатели

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

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

Название Тип Описание
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 Дельта за период
Обязательное при ответе

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

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

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