NAV Navbar
cURL

Отчеты

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

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

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

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

Все Остатки

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример фильтрации по дополнительному полю типа справочник складов: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://localhost/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/<id>=<Значение>

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

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

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

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

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

Параметры

Параметр Описание
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 будут проигнорированы.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример фильтрации по дополнительному полю типа справочник складов: filter=https://online.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/ea12a6dd-79e5-11e9-9ff4-31500040893d=http://localhost/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/<id>=<Значение>

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

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

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

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

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

Параметры

Параметр Описание
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 - выдает товары, модификации, серии

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

Отчет Деньги

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

Параметр Описание
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. Для каждого параметра можно указать несколько значений. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

Показатели

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

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

День

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

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

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

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

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

Неделя

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

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

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

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

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

Месяц

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

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

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

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

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