Navbar
cURL
Search

Отчеты

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

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

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

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

Все Остатки

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

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

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

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

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

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

Группа

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

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

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

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

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

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

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

Пример фильтрации по дополнительному полю типа справочник складов: 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/<id>=<Значение>

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

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

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

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

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

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

Параметры

Параметр Описание
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!=<URL>&includeRelated=true выводит остатки товаров, модификаций, серий за исключением конкретной модификации указанной в URL.
filter=product=<URL>&includeRelated=true выводит остатки конкретного товара указанного в URL, его модификации и серии.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример фильтрации по дополнительному полю типа справочник складов: 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/<id>=<Значение>

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

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

Результаты отчета можно отсортировать, используя параметр 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 - выдает товары, модификации, серии

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Отчет Деньги

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

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

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

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

Показатели

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Организация

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

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

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

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

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

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

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

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

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

Показатели

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Контрагент

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

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

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

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

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

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

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

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

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

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив 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 можно запросить показатели за день, месяц и неделю. Подробнее о разделе "Показатели" вы можете прочитать на портале поддержки по этой ссылке.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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