Отчеты
Отчет Остатки
Средствами JSON API можно запросить отчет "Остатки" по всем товарам и по складам.
Больше об Остатках и работе с ними в основном интерфейсе
вы можете прочитать в нашей службе поддержки по по этой ссылке.
Доступ к отчету Остатки
Для доступа к отчету Остатки через API каких-либо дополнительных прав не требуется.
На отображение товаров в отчете Остатки влияют настройки видимости товаров и складов для пользователя,
под именем которого запрашивается отчет Остатки.
Себестоимость, цена закупки, прибыль отображаются в Остатках при наличии у пользователя права <Видеть себестоимость, цену закупки и прибыль товаров>.
Все Остатки
Отчет "Все Остатки" представляет собой выдачу из объектов, каждый из
которых показывает Остаток по каждому из товаров.
Атрибуты объекта отчета:
- meta - Метаданные, представляющие собой ссылку на товар, модификацию или серию, по которой выдается Остаток
- stock - Остаток
- inTransit - Ожидание
- reserve - Резерв
- quantity - Доступно
- name - Наименование
- code - Код
- article - Артикул (если имеется)
- price - Себестоимость
- salePrice - Цена продажи
- uom - Единица измерения
- meta - Метаданные единицы измерений
- name - Наименование единицы измерений
- folder - Ссылка на группу товара/модификации/серии
- meta - Метаданные группы товара
- name - Наименование группы
- pathName - Наименование родительской группы
- image - Ссылка на изображение товара/модификации/серии
- externalCode - Внешний код сущности, по которой выводится остаток
Атрибуты доступные для фильтрации
Результаты отчета можно отфильтровать, используя параметр filter.
- store - параметр для фильтрации по нескольким складам. Можно использовать операторы
= и !=. Значение параметра - ссылка на склад, который должен быть учтен в выборке или исключен из нее. Можно передать несколько значений.
- product - параметр для фильтрации по нескольким товарам. Можно использовать операторы
= и !=. Значение параметра - ссылка на товар, который должен быть включен в выборку или исключен из нее. Можно передать несколько значений. Данный параметр фильтрации можно комбинировать с параметрами consignment и variant.
- variant - параметр для фильтрации по нескольким модификациям. Можно использовать операторы
= и !=. Значение параметра - ссылка на модификацию, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений. Данный параметр фильтрации можно комбинировать с параметрами product и consignment.
- consignment - параметр для фильтрации по нескольким сериям. Можно использовать операторы
= и !=. Значение параметра - ссылка на серию, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений. Данный параметр фильтрации можно комбинировать с параметрами product и variant.
- productFolder - параметр для фильтрации по нескольким группам товаров. Можно использовать операторы
= и !=. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений.
- stockMode - параметр для фильтрации по значению остатка. Значение по умолчанию all. Доступные значения:
- all - любое значение остатка
- positiveOnly - положительный остаток
- negativeOnly - отрицательный остаток
- empty - нулевой остаток
- nonEmpty - ненулевой остаток
- underMinimum - остаток ниже неснижаемого остатка
- quantityMode - параметр для фильтрации по значению доступно. Значение по умолчанию nonEmpty. Доступные значения:
- all - любое значение доступно
- positiveOnly - положительное доступно
- negativeOnly - отрицательное доступно
- empty - нулевое доступно
- nonEmpty - ненулевое доступно
- underMinimum - доступно ниже неснижаемого остатка
- moment - момент времени, на который нужно вывести остатки. Передается в виде строки в формате дата-время
- stockDaysFrom - параметр для фильтрации по количеству дней на складе. Передавать нужно целое число. В выборку попадут товары, у которых количество дней на складе больше или равно указанному. Данный параметр фильтрации можно комбинировать с параметром
stockDaysTo.
- stockDaysTo - параметр для фильтрации по количеству дней на складе. Передавать нужно целое число. В выборку попадут товары, у которых количество дней на складе меньше или равно указанному. Данный параметр фильтрации можно комбинировать с параметром
stockDaysFrom.
- soldByWeight - параметр для фильтрации по признаку весового товара. Возможные значения: true, false.
- reserveOnly - параметр для фильтрации по значению резерва. Если передать true, в выборку попадут только товары с резервом.
- inTransitOnly - параметр для фильтрации по значению ожидания. Если передать true, в выборку попадут только товары с ожиданием.
- archived - параметр для фильтрации по архивности товаров. Возможные значения: true, false. Для выдачи как архивных, так и не архивных товаров нужно передать сразу два значения true и false.
- supplier - параметр для фильтрации по нескольким поставщикам. Можно использовать операторы
= и !=. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены или исключены товары с указанными поставщиками. Можно передать пустое значение, тогда в выборку попадут товары с незаполненным или заполненным поставщиком.
- search - специальный параметр текстового поиска. Поиск осуществлятся по вхождению подстроки в названия товаров, модификаций, серий. Для данного параметра можно использовать оператор
= и специальный оператор !~, который исключит из выборки товары с вхождением указанной подстроки.
Для параметров фильтрации product, variant, consignment, productFolder и search в рамках одного запроса можно использовать только одинаковые операторы (для search оператор !~ сочетается с оператором != остальных полей).
Примеры фильтрации:
filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b2filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;product=https://online.moysklad.ru/api/remap/1.2/entity/service/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/bundle/7a5f0ed5-8552-11e6-8a84-bae500000046filter=consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/656c4032-8552-11e6-8a84-bae500000044;consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/product/7a5f0ed5-8552-11e6-8a84-bae500000046filter=variant=https://online.moysklad.ru/api/remap/1.2/entity/variant/656c4032-8552-11e6-8a84-bae500000044;consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/product/7a5f0ed5-8552-11e6-8a84-bae500000046filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;variant=https://online.moysklad.ru/api/remap/1.2/entity/variant/656c4032-8552-11e6-8a84-bae500000044;consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/706b9cd3-8552-11e6-8a84-bae500000045;product=https://online.moysklad.ru/api/remap/1.2/entity/product/7a5f0ed5-8552-11e6-8a84-bae500000046filter=stockMode=allfilter=quantityMode=allfilter=stockMode=all;quantityMode=allfilter=moment=2019-07-10 12:00:00filter=stockDaysFrom=10;stockDaysTo=50filter=soldByWeight=truefilter=reserveOnly=truefilter=inTransitOnly=truefilter=archived=truefilter=archived=false;archived=truefilter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/656c4032-8667-11e6-8a84-bae5000033aafilter=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.
- 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 будут проигнорированы. |
Запрос на получение отчета "Все Остатки".
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/stock/all"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"type": "employee",
"mediaType": "application/json"
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/stock/all",
"type": "stock",
"mediaType": "application/json",
"size": 26,
"limit": 10,
"offset": 0,
"nextHref": "http://online.moysklad.ru/api/remap/1.2/report/stock/all?limit=10&offset=10"
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/c02e3a5c-007e-11e6-9464-e4de00000006?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": -30,
"inTransit": 0,
"reserve": 0,
"quantity": -30,
"name": "Товар",
"code": "one1",
"article": "Ar23",
"price": 0,
"salePrice": 346347237000,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/cc99c055-fa34-11e5-9464-e4de00000069?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": 4,
"inTransit": 0,
"reserve": 0,
"quantity": 4,
"name": "ТоварБезШК",
"code": "00006",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/e8f5f9ff-fa34-11e5-9464-e4de0000008a?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "Товар с модой без ШК",
"code": "00008",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8f9d714-fa34-11e5-9464-e4de0000008d?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "Товар с модой без ШК (1)",
"code": "00208",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8fc24b5-fa34-11e5-9464-e4de00000091?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "Товар с модой без ШК (2)",
"code": "00209",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e91042b4-fa34-11e5-9464-e4de00000095?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "Товар с модой без ШК (3)",
"code": "00210",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/daf1186d-fa34-11e5-9464-e4de0000006f?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "ТоварСМодой_и_ШК",
"code": "00007",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/db1a888a-fa34-11e5-9464-e4de00000073?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "ТоварСМодой_и_ШК (1)",
"code": "00205",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/db2066c8-fa34-11e5-9464-e4de00000077?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "ТоварСМодой_и_ШК (2)",
"code": "00206",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/db22f3e8-fa34-11e5-9464-e4de0000007b?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": 1,
"inTransit": 0,
"reserve": 0,
"quantity": 1,
"name": "ТоварСМодой_и_ШК (3)",
"code": "00207",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/d3e2dcd6-f648-11e5-8a84-bae500000074?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": -6438,
"inTransit": 0,
"reserve": 0,
"quantity": -6438,
"name": "ТоварСоСтраной",
"code": "00002",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/eeef177f-f648-11e5-8a84-bae50000007a?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": -113,
"inTransit": 0,
"reserve": 0,
"quantity": -113,
"name": "Мяч",
"code": "00003",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/fd867506-f67d-11e5-8a84-bae50000006e?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": -21,
"inTransit": 0,
"reserve": 0,
"quantity": -21,
"name": "Мяч (Футбольный)",
"code": "00002",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/fd92dbb9-f67d-11e5-8a84-bae500000076?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": -1,
"inTransit": 0,
"reserve": 0,
"quantity": -1,
"name": "Мяч (Волейбольный)",
"code": "00004",
"price": 0,
"salePrice": 0,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/be903062-f504-11e5-8a84-bae50000019a?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stock": 69,
"inTransit": 0,
"reserve": 20,
"quantity": 49,
"name": "Трололоша",
"code": "00001",
"price": 50260.86956521739,
"salePrice": 123000,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/d1bef0a1-ffe7-11e5-9464-e4de0000001c?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stock": -1,
"inTransit": 0,
"reserve": 0,
"quantity": -1,
"name": "ТОварИщ (10)",
"code": "00214",
"article": "Артикулс",
"price": 0,
"salePrice": 346347237000,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
},
"folder": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/productfolder/0c78adde-ffe3-11e5-9464-e4de000000a2",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/productFolder/metadata",
"type": "productfolder",
"mediaType": "application/json"
},
"name": "Товары Из кастомной группы",
"pathName": "Группа"
},
"images": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/d1bef0a1-ffe7-11e5-9464-e4de0000001c/images",
"type": "image",
"mediaType": "application/json",
"size": 1,
"limit": 1000,
"offset": 0
}
},
"externalCode": "ibWbdtWWhXiIwfZVEal6z2"
}
]
}
Остатки по складам
Отчет "Остатки по складам" представляет собой массив объектов, каждый из
которых показывает Остаток по каждому из товаров на каждом из складов.
Атрибуты объекта отчета:
- meta - Метаданные, представляющие собой ссылку на позицию, по которой выдается Остаток
- stockByStore - Объект, представляющие собой Остатки по складам (описание ниже).
Остатки по складам
Поле "Остатки по складам" (stockByStore) представляет собой выдачу из объектов со следующими атрибутами:
- meta - Метаданные, представляющие собой ссылку на склад, по которому выводится Остаток
- name - Наименование склада
- stock - Остаток
- reserve - Резерв
- inTransit - Ожидание
Размерность этого поля всегда равна количеству складов в системе.
Атрибуты доступные для фильтрации
Результаты отчета можно отфильтровать, используя параметр filter. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.
- store - ссылка на склад, для которого нужно построить отчет.
- product - ссылка на товар которыму нужно произвести фильтрацию.
- variant - ссылка на модификация, по которой нужно произвести фильтрацию.
- consignment - ссылка на серию, по которой нужно произвести фильтрацию.
- productFolder - ссылка на группу товаров, по которой нужно произвести фильтрацию.
- stockMode - параметр для фильтрации по значению остатка. Значение по умолчанию nonEmpty. Доступные значения:
- all - любое значение остатка
- positiveOnly - положительный остаток
- negativeOnly - отрицательный остаток
- empty - нулевой остаток
- nonEmpty - ненулевой остаток
- underMinimum - остаток ниже неснижаемого остатка
- moment - момент времени, на который нужно вывести остатки. Передается в виде строки в формате дата-время
- soldByWeight - параметр для фильтрации по признаку весового товара. Возможные значения: true, false.
- supplier - параметр для фильтрации по поставщику. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены товары с указанным поставщиком.
- search - специальный параметр текстового поиска. Поиск осуществлятся по вхождению подстроки в названия товаров, модификаций, серий.
В одном запросе можно использовать только один из параметров product, variant, consignment, productFolder и search.
Примеры фильтрации:
filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8552-11e6-8a84-bae500000043filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044filter=variant=https://online.moysklad.ru/api/remap/1.2/entity/variant/656c4032-8552-11e6-8a84-bae500000045filter=consignment=https://online.moysklad.ru/api/remap/1.2/entity/consignment/656c4032-8552-11e6-8a84-bae500000046filter=productFolder=https://online.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1filter=stockMode=allfilter=moment=2019-07-10 12:00:00filter=soldByWeight=truefilter=supplier=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/656c4032-8667-11e6-8a84-bae5000033aafilter=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.
- pathName - по группе товара
- name - по наименованию
- code - по коду
- productCode - по артикулу
- stockOnAllStores - по количеству остатка на всех складах
По умолчанию выборка сортируется по группе товара и имени товара.
Получить Остатки по складам
Параметры
| Параметр |
Описание |
| limit |
number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000. |
| offset |
number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей. |
| groupBy |
string (optional) тип, по которому нужно сгруппировать выдачу.По умолчанию параметр groupBy имеет значение variant. Если вы хотите увидеть объекты типа consignment, или только объекты типа product, необходимо выставить соответствующее значение параметра. - groupBy=product - выдает только товары
- groupBy=variant - выдает товары и модификации
- groupBy=consignment - выдает товары, модификации, серии
|
Запрос на получение отчета "Остатки по складам".
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/stock/bystore"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"type": "employee",
"mediaType": "application/json"
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/stock/bystore",
"type": "stockbystore",
"mediaType": "application/json",
"size": 225,
"limit": 1000,
"offset": 0,
"nextHref": "http://online.moysklad.ru/api/remap/1.2/report/stock/bystore?limit=25&offset=25"
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/c02e3a5c-007e-11e6-9464-e4de00000006?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": -30,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
}
]
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/cc99c055-fa34-11e5-9464-e4de00000069?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 4,
"reserve": 0,
"inTransit": 0
}
]
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/e8f5f9ff-fa34-11e5-9464-e4de0000008a?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 1,
"reserve": 0,
"inTransit": 0
}
]
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8f9d714-fa34-11e5-9464-e4de0000008d?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 1,
"reserve": 0,
"inTransit": 0
}
]
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e8fc24b5-fa34-11e5-9464-e4de00000091?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 1,
"reserve": 0,
"inTransit": 0
}
]
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/e91042b4-fa34-11e5-9464-e4de00000095?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 1,
"reserve": 0,
"inTransit": 0
}
]
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/daf1186d-fa34-11e5-9464-e4de0000006f?expand=supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"stockByStore": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/86c857d6-0302-11e6-9464-e4de00000072",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Не основной склад",
"stock": 0,
"reserve": 0,
"inTransit": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/store/metadata",
"type": "store",
"mediaType": "application/json"
},
"name": "Основной склад",
"stock": 1,
"reserve": 0,
"inTransit": 0
}
]
}
]
}
Отчет Прибыльность
Средствами JSON API можно запросить отчет "Прибыльность" по всем товарам, услугам, модификациям, сотрудникам и покупателям. Для доступа к отчету через API требуется право на просмотр отчета Прибыли и убытки.
О том, что представляет собой отчет "Прибыльность" вы можете прочитать по этой ссылке.
Прибыльность по товарам
Атрибуты объекта отчета:
- assortment- Краткое представление товара или услуги в отчете (структура ниже)
- sellQuantity - Проданное количество
- sellPrice - Цена продаж (средняя)
- sellCost - Себестоимость
- sellSum - Сумма продаж
- sellCostSum - Сумма себестоимостей продаж
- returnQuantity - Количество возвратов
- returnPrice - Цена возвратов
- returnCost - Себестоимость возвратов
- returnSum - Сумма возвратов
- returnCostSum - Сумма себестоимостей возвратов
- profit - Прибыль
- margin - Рентабельность
Структура объекта assortment
- meta - Метаданные, представляющие собой ссылку на товар или услугу
- name - Наименование товара или услуги
- code - Код товара или услуги
- uom - Единица измерения
- article - Артикул товара
- image - Изображение товара
Атрибуты доступные для фильтрации
Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.
- product - ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
- counterparty - ссылка на контрагента, по которому нужно произвести фильтрацию.
- organization - ссылка на юрлицо, по которому нужно произвести фильтрацию.
- store - ссылка на склад, по которому нужно произвести фильтрацию.
- project - ссылка на проект, по которому нужно произвести фильтрацию.
- retailStore - ссылка на точку продаж, по которой нужно произвести фильтрацию.
Примеры фильтрации:
filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
Получить Прибыльность по товарам
Параметры
| Параметр |
Описание |
| 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 Один из параметров фильтрации выборки. |
Запрос на получение отчета "Прибыльность по товарам".
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/profit/byproduct"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/profit/byproduct",
"type": "salesbyproduct",
"mediaType": "application/json",
"size": 5,
"limit": 2,
"offset": 0,
"nextHref": "https://online.moysklad.ru/api/remap/1.2/report/profit/byproduct?limit=2&offset=2"
},
"rows": [
{
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/6af0f1c9-4814-11e6-8a84-bae5000006b4",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"name": "Курево",
"code": "00067",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
}
},
"sellQuantity": 8643,
"sellPrice": 216174.97396737244,
"sellCost": 0,
"sellSum": 1868400300,
"sellCostSum": 0,
"returnQuantity": 0,
"returnPrice": 0,
"returnCost": 0,
"returnSum": 0,
"returnCostSum": 0,
"profit": 1868400300,
"margin": 0
},
{
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/product/6a9bdfe4-4814-11e6-8a84-bae500000503",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"name": "Ногтеточка",
"code": "00198",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
}
},
"sellQuantity": 4765,
"sellPrice": 100000000,
"sellCost": 0,
"sellSum": 476500000000,
"sellCostSum": 0,
"returnQuantity": 0,
"returnPrice": 0,
"returnCost": 0,
"returnSum": 0,
"returnCostSum": 0,
"profit": 476500000000,
"margin": 0
},
{
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/service/3413f2dd-484e-11e8-6a80-332a00000091",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/service/metadata",
"type": "service",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#good/edit?id=3412d794-484e-11e8-6a80-332a0000008f"
},
"name": "Заточка коньков",
"code": "00045",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
}
},
"sellQuantity": 10,
"sellPrice": 500000,
"sellCost": 300000,
"sellSum": 5000000,
"sellCostSum": 3000000,
"returnQuantity": 3,
"returnPrice": 500000,
"returnCost": 300000,
"returnSum": 1500000,
"returnCostSum": 900000,
"profit": 1400000,
"margin": 0.6666666666666666
}
]
}
Прибыльность по модификациям
Атрибуты объекта отчета:
- assortment- Краткое представление модификации, услуги или комплекта в отчете (структура ниже)
- sellQuantity - Проданное количество
- sellPrice - Цена продаж (средняя)
- sellCost - Себестоимость
- sellSum - Сумма продаж
- sellCostSum - Сумма себестоимостей продаж
- returnQuantity - Количество возвратов
- returnPrice - Цена возвратов
- returnCost - Себестоимость возвратов
- returnSum - Сумма возвратов
- returnCostSum - Сумма себестоимостей возвратов
- profit - Прибыль
- margin - Рентабельность
Структура объекта assortment
- meta - Метаданные, представляющие собой ссылку на модификацию, услугу или комплект
- name - Наименование сущности
- code - Код сущности
- article - Артикул модификации или комплекта
- image - Изображение модификации
Атрибуты доступные для фильтрации
Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.
- product - ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
- counterparty - ссылка на контрагента, по которому нужно произвести фильтрацию.
- organization - ссылка на юрлицо, по которому нужно произвести фильтрацию.
- store - ссылка на склад, по которому нужно произвести фильтрацию.
- project - ссылка на проект, по которому нужно произвести фильтрацию.
- retailStore - ссылка на точку продаж, по которой нужно произвести фильтрацию.
Примеры фильтрации:
filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
Получить Прибыльность по модификациям
Параметры
| Параметр |
Описание |
| 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 Один из параметров фильтрации выборки. |
Запрос на получение отчета "Прибыльность по модификациям".
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/profit/byvariant"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/profit/byvariant",
"type": "salesbyvariant",
"mediaType": "application/json",
"size": 5,
"limit": 2,
"offset": 0,
"nextHref": "https://online.moysklad.ru/api/remap/1.2/report/profit/byvariant?limit=2&offset=2"
},
"rows": [
{
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/6af0f1c9-4814-11e6-8a84-bae5000006b4?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"name": "Курево (Африка, 0.2, Комбайны)",
"code": "00067",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
}
},
"sellQuantity": 8643,
"sellPrice": 216174.97396737244,
"sellCost": 0,
"sellSum": 1868400300,
"sellCostSum": 0,
"returnQuantity": 0,
"returnPrice": 0,
"returnCost": 0,
"returnSum": 0,
"returnCostSum": 0,
"profit": 1868400300,
"margin": 0
},
{
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/variant/6a9bdfe4-4814-11e6-8a84-bae500000503?expand=product.supplier",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"name": "Ногтеточка (Белый, 20, Нет, 1000)",
"code": "00198",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
}
},
"sellQuantity": 4765,
"sellPrice": 100000000,
"sellCost": 0,
"sellSum": 476500000000,
"sellCostSum": 0,
"returnQuantity": 0,
"returnPrice": 0,
"returnCost": 0,
"returnSum": 0,
"returnCostSum": 0,
"profit": 476500000000,
"margin": 0
},
{
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/service/3413f2dd-484e-11e8-6a80-332a00000091",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/service/metadata",
"type": "service",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#good/edit?id=3412d794-484e-11e8-6a80-332a0000008f"
},
"name": "Заточка коньков",
"code": "00045",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
},
"name": "шт"
}
},
"sellQuantity": 10,
"sellPrice": 500000,
"sellCost": 300000,
"sellSum": 5000000,
"sellCostSum": 3000000,
"returnQuantity": 3,
"returnPrice": 500000,
"returnCost": 300000,
"returnSum": 1500000,
"returnCostSum": 900000,
"profit": 1400000,
"margin": 0.6666666666666666
}
]
}
Прибыльность по сотрудникам
Атрибуты объекта отчета:
- employee- Краткое представление сотрудника в отчете (структура ниже)
- salesCount - Количество продаж
- salesAvgCheck - Средний чек продаж
- sellSum - Сумма продаж
- sellCostSum - Сумма себестоимостей продаж
- returnCount - Количество возвратов
- returnAvgCheck - Средний чек возврата
- returnSum - Сумма возвратов
- returnCostSum - Сумма себестоимостей возвратов
- profit - Прибыль
- margin - Рентабельность
Структура объекта employee
- meta - Метаданные, представляющие собой ссылку на сотрудника
- name - Имя сотрудника
Атрибуты доступные для фильтрации
Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.
- product - ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
- counterparty - ссылка на контрагента, по которому нужно произвести фильтрацию.
- organization - ссылка на юрлицо, по которому нужно произвести фильтрацию.
- store - ссылка на склад, по которому нужно произвести фильтрацию.
- project - ссылка на проект, по которому нужно произвести фильтрацию.
- retailStore - ссылка на точку продаж, по которой нужно произвести фильтрацию.
Примеры фильтрации:
filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
Получить Прибыльность по сотрудникам
Параметры
| Параметр |
Описание |
| 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 Один из параметров фильтрации выборки. |
Запрос на получение отчета "Прибыльность по сотрудникам".
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/profit/byemployee"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/profit/byEmployee",
"type": "salesbyemployee",
"mediaType": "application/json",
"size": 1,
"limit": 1000,
"offset": 0
},
"rows": [
{
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/3c9ef5be-4814-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
},
"name": "Администратор"
},
"salesCount": 3,
"salesAvgCheck": 104498369718788910,
"sellSum": 313495109156366700,
"sellCostSum": 0,
"returnCount": 0,
"returnAvgCheck": 0,
"returnSum": 0,
"returnCostSum": 0,
"profit": 313495109156366700,
"margin": 0
}
]
}
Прибыльность по покупателям
Атрибуты объекта отчета:
- counterparty- Краткое представление покупателя в отчете (структура ниже)
- salesCount - Количество продаж
- salesAvgCheck - Средний чек продаж
- sellSum - Сумма продаж
- sellCostSum - Сумма себестоимостей продаж
- returnCount - Количество возвратов
- returnAvgCheck - Средний чек возврата
- returnSum - Сумма возвратов
- returnCostSum - Сумма себестоимостей возвратов
- profit - Прибыль
- margin - Рентабельность
Структура объекта counterparty
- meta - Метаданные, представляющие собой ссылку на покупателя
- name - Имя покупателя
Атрибуты доступные для фильтрации
Результаты отчета можно отфильтровать, используя параметр filter. Для каждого параметра можно указать только одно значение. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.
- product - ссылка на товар, услугу, комплект, модификацию или серию, по которой нужно произвести фильтрацию.
- counterparty - ссылка на контрагента, по которому нужно произвести фильтрацию.
- organization - ссылка на юрлицо, по которому нужно произвести фильтрацию.
- store - ссылка на склад, по которому нужно произвести фильтрацию.
- project - ссылка на проект, по которому нужно произвести фильтрацию.
- retailStore - ссылка на точку продаж, по которой нужно произвести фильтрацию.
Примеры фильтрации:
filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044filter=counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000filter=organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003filter=store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321filter=project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030filter=product=https://online.moysklad.ru/api/remap/1.2/entity/product/656c4032-8552-11e6-8a84-bae500000044;counterparty=https://online.moysklad.ru/api/remap/1.2/entity/counterparty/f8f729a5-a784-11e9-ac12-000800000000;organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/0347beb0-a785-11e9-ac12-000800000003;store=https://online.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321;project=https://online.moysklad.ru/api/remap/1.2/entity/project/7a5f0ed5-8552-11e6-8a84-bae500000046;retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/9ca74859-85c7-11e9-ac12-000d00000030
Получить Прибыльность по покупателям
Параметры
| Параметр |
Описание |
| 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 Один из параметров фильтрации выборки. |
Запрос на получение отчета "Прибыльность по покупателям".
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/profit/bycounterparty"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/profit/bycounterparty",
"type": "salesbyCounterparty",
"mediaType": "application/json",
"size": 3,
"limit": 1,
"offset": 0,
"nextHref": "https://online.moysklad.ru/api/remap/1.2/report/profit/bycounterparty?limit=1&offset=1"
},
"rows": [
{
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/3cd88c00-4814-11e6-8a84-bae500000053",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"name": "ООО \"Покупатель\""
},
"salesCount": 1,
"salesAvgCheck": 310390615323104640,
"sellSum": 310390615323104640,
"sellCostSum": 0,
"returnCount": 0,
"returnAvgCheck": 0,
"returnSum": 0,
"returnCostSum": 0,
"profit": 310390615323104640,
"margin": 0
}
]
}
Отчет Деньги
Средствами JSON API можно запросить отчеты, отражающие движение денежных средств за заданный период и текущие остатки средств по кассам и счетам.
Для получения отчетов необходимо, чтобы для сотрудника была включена пермиссия "Видеть остатки денег".
Движение денежных средств
Атрибуты отчета:
- credit - доход
- debit - расход
- series - Массив данных показателей
- date - дата
- credit - доход за период
- debit - расход за период
- balance - баланс (доход-расход)
Параметры доступные для фильтрации
Документы, попадающие в отчет, можно отфильтровать, используя параметр 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. |
Запрос на получение графика движения денежных средств
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context":{
"employee":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type":"employee",
"mediaType":"application/json"
}
}
},
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day",
"type":"moneyplotseries",
"mediaType":"application/json"
},
"credit":400,
"debit":200,
"series":[
{
"date":"2018-09-01 00:00:00",
"credit":100,
"debit":50,
"balance":50
},
{
"date":"2018-09-02 00:00:00",
"credit":100,
"debit":50,
"balance":50
},
{
"date":"2018-09-03 00:00:00",
"credit":100,
"debit":50,
"balance":50
},
{
"date":"2018-09-04 00:00:00",
"credit":100,
"debit":50,
"balance":50
}
]
}
Запрос графика с фильтрацией
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day&filter=organization=https://online.moysklad.ru/api/remap/1.1/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.1/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context":{
"employee":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type":"employee",
"mediaType":"application/json"
}
}
},
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/report/money/plotseries?momentFrom=2018-09-01&momentTo=2018-09-04&interval=day&filter=organization=https://online.moysklad.ru/api/remap/1.1/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.1/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448",
"type":"moneyplotseries",
"mediaType":"application/json"
},
"credit":60,
"debit":20,
"series":[
{
"date":"2018-09-01 00:00:00",
"credit":50,
"debit":0,
"balance":50
},
{
"date":"2018-09-02 00:00:00",
"credit":10,
"debit":20,
"balance":-10
},
{
"date":"2018-09-03 00:00:00",
"credit":0,
"debit":0,
"balance":0
},
{
"date":"2018-09-04 00:00:00",
"credit":0,
"debit":0,
"balance":0
}
]
}
Остатки денежных средств
Атрибуты объекта отчета:
- account - счет организации (не выводится для остатка кассы, так как касса одна на организацию)
- meta - Метаданные счета организации
- name - Номер счета
- organization - организация
- meta - Метаданные организации
- name - Наименование организации
- balance - текущий остаток денежных средств
Запрос на получение остатков денежных средств по кассам и счетам
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/money/byaccount"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context":{
"employee":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type":"employee",
"mediaType":"application/json"
}
}
},
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/report/money/byaccount",
"type":"moneyreport",
"mediaType":"application/json"
},
"rows":[
{
"organization":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type":"organization",
"mediaType":"application/json"
},
"name":"OOO Ромашка"
},
"balance":100
},
{
"organization":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type":"organization",
"mediaType":"application/json"
},
"name":"OOO Серьезное Юридическое Лицо"
},
"balance":100
},
{
"account":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/4b9d5bec-0575-11e6-9464-e4de00000008/accounts/4b9d69b7-0575-11e6-9464-e4de00000009",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type":"account",
"mediaType":"application/json"
},
"name":"00000"
},
"organization":{
"meta":{
"href":"https://online.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref":"https://online.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type":"organization",
"mediaType":"application/json"
},
"name":"OOO Серьезное Юридическое Лицо"
},
"balance":200
}
]
}
Показатели продаж и заказов
Средствами JSON API можно запросить показатели продаж и заказов - количество и суммы за определенный период с разбивкой по часам, дням или месяцам.
Атрибуты отчета:
- series - Массив данных показателей
- date - дата
- quantity - Количество
- sum - Сумма
Параметры
| Параметр |
Описание |
| 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 - ссылка на проект
Запрос на получение показателей заказов
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-06 01:00:01&interval=hour"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2016-09-06 01:00:01&interval=hour",
"type": "ordersplotseries",
"mediaType": "application/json"
},
"series": [
{
"date": "2018-09-06 00:00:00",
"quantity": 3,
"sum": 600
},
{
"date": "2018-09-06 01:00:00",
"quantity": 2,
"sum": 200
}
]
}
Запрос на получение показателей заказов с фильтрацией
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-06 01:00:01&interval=hour&filter=organization=https://online.moysklad.ru/api/remap/1.1/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.1/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448;store=https://online.moysklad.ru/api/remap/1.1/entity/store/32213d37-8101-11e8-9107-50480004c6c1"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/context/employee",
"metaseriesHref": "https://online.moysklad.ru/employee/metaseries",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/report/orders/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2016-09-06 01:00:01&interval=hour&filter=organization=https://online.moysklad.ru/api/remap/1.1/entity/organization/00cd5a99-6897-11e7-7a6c-d2a9000c4fc0;project=https://online.moysklad.ru/api/remap/1.1/entity/project/02e64f51-6897-11e7-7a34-5acf000c8448;store=https://online.moysklad.ru/api/remap/1.1/entity/store/32213d37-8101-11e8-9107-50480004c6c1",
"type": "ordersplotseries",
"mediaType": "application/json"
},
"series": [
{
"date": "2018-09-06 00:00:00",
"quantity": 1,
"sum": 100
},
{
"date": "2018-09-06 01:00:00",
"quantity": 1,
"sum": 100
}
]
}
Показатели продаж
В показателях продаж учитываются отгрузки, розничные продажи, полученные отчеты комиссионера.
Параметры доступные для фильтрации
Документы, попадающие в отчет, можно отфильтровать, используя параметр filter. Для каждого параметра можно указать несколько значений. Нельзя указывать пустые значения. Поддерживается фильтрация только на равенство.
- organization - ссылка на юр. лицо
- store - ссылка на склад
- project - ссылка на проект
- retailStore - ссылка на Точку продаж. При использовании этого параметра учитываются только розничные продажи.
Запрос на получение показателей продаж c фильтрацией
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/sales/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-10 01:00:01&interval=hour&filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/d9a8a213-6703-11e7-9464-e4de00000060&project=https://online.moysklad.ru/api/remap/1.2/entity/project/d9a8a213-6703-11e7-9464-e4de00000060&store=https://online.moysklad.ru/api/remap/1.2/entity/store/d9a8a213-6703-11e7-9464-e4de00000060&organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/d9a8a213-6703-11e7-9464-e4de00000060"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metaseriesHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metaseries",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/sales/plotseries?momentFrom=2018-09-06 00:00:00&momentTo=2018-09-10 01:00:01&interval=hour&filter=retailStore=https://online.moysklad.ru/api/remap/1.2/entity/retailstore/d9a8a213-6703-11e7-9464-e4de00000060&project=https://online.moysklad.ru/api/remap/1.2/entity/project/d9a8a213-6703-11e7-9464-e4de00000060&store=https://online.moysklad.ru/api/remap/1.2/entity/store/d9a8a213-6703-11e7-9464-e4de00000060&organization=https://online.moysklad.ru/api/remap/1.2/entity/organization/d9a8a213-6703-11e7-9464-e4de00000060",
"type": "salesplotseries",
"mediaType": "application/json"
},
"series": [
{
"date": "2018-09-06 00:00:00",
"quantity": 3,
"sum": 900
},
{
"date": "2018-09-06 01:00:00",
"quantity": 4,
"sum": 400
}
]
}
Отчет Показатели контрагентов
Средствами JSON API можно запросить отчет "Показатели контрагентов" по всем или по отдельному контрагенту.
О том, что представляет собой отчет "Показатели контрагентов" вы можете прочитать по этой ссылке.
Показатели контрагентов
Атрибуты показателей
- meta - Метаданные отчета по данному контрагенту
- counterparty - Контрагент
- meta - Метаданные контрагента
- id - id контрагента
- name - Имя контрагента
- externalCode - Внешний код контрагента
- companyType - Тип контрагента
- firstDemandDate - Дата первой продажи
- lastDemandDate - Дата последней продажи
- demandsCount - Количество продаж
- demandsSum - Сумма продаж
- averageReceipt - Средний чек
- returnsCount - Количество возвратов
- returnsSum - Сумма возвратов
- discountsSum - Сумма скидок
- balance - Баланс
- bonusBalance - Баллы
- profit - Прибыль
- lastEventDate - Дата последнего события
- lastEventText - Текст последнего события
- updated - Момент последнего изменения контрагента
Атрибуты доступные для фильтрации
- 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 Метаданные отчета,
- context - Метаданные о сотруднике, выполнившем запрос.
- rows - Массив JSON объектов, представляющих собой отчеты по отдельным контрагентам.
Параметры
| Параметр |
Описание |
| limit |
number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000. |
| offset |
number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей. |
Запрос на получение отчета по контрагентам.
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/counterparty"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета по контрагентам.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty",
"type": "counterparty",
"mediaType": "application/json",
"size": 5,
"limit": 1000,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"type": "counterparty",
"mediaType": "application/json"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "b80ea81b-7058-11e6-8a84-bae500000000",
"name": "ООО Радуга",
"externalCode": "o7732zkki541HDkZZD1Yt3",
"companyType": "legal"
},
"firstDemandDate": null,
"lastDemandDate": null,
"demandsCount": 0,
"demandsSum": 0,
"averageReceipt": 0,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 0,
"profit": 0,
"lastEventDate": null,
"lastEventText": null,
"updated": "2016-09-01 18:32:17"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
"type": "counterparty",
"mediaType": "application/json"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "df2fdd2d-6934-11e6-8a84-bae500000049",
"name": "rtr",
"externalCode": "rRlzrdZmjql9r9dveXPE43",
"companyType": "legal"
},
"firstDemandDate": null,
"lastDemandDate": null,
"demandsCount": 0,
"demandsSum": 0,
"averageReceipt": 0,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 0,
"profit": 0,
"lastEventDate": "2016-09-08 13:07:30",
"lastEventText": "продажа",
"updated": "2016-08-23 16:24:08"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d",
"type": "counterparty",
"mediaType": "application/json"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "12c9ebcf-692c-11e6-8a84-bae50000005d",
"name": "Розничный покупатель",
"externalCode": "lBvYwLWMiBsct7sVRrFnJ2",
"companyType": "legal"
},
"firstDemandDate": "2016-08-26 15:49:00",
"lastDemandDate": "2016-08-26 15:49:00",
"demandsCount": 1,
"demandsSum": 80000,
"averageReceipt": 80000,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 0,
"bonusBalance": 120,
"profit": -103040600,
"lastEventDate": null,
"lastEventText": null,
"updated": "2016-08-23 15:21:09"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/12a8e347-692c-11e6-8a84-bae500000055",
"type": "counterparty",
"mediaType": "application/json"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "12a8e347-692c-11e6-8a84-bae500000055",
"name": "ООО \"Покупатель\"",
"externalCode": "DTItQRbDhyl472ZqC5OWw2",
"inn": "7736570902",
"companyType": "legal"
},
"firstDemandDate": "2016-09-01 17:54:00",
"lastDemandDate": "2016-09-01 17:54:00",
"demandsCount": 1,
"demandsSum": 60000,
"averageReceipt": 60000,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 1241255000,
"bonusBalance": 298,
"profit": 50000,
"lastEventDate": null,
"lastEventText": null,
"updated": "2016-08-23 15:21:09"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/12a8b923-692c-11e6-8a84-bae500000053",
"type": "counterparty",
"mediaType": "application/json"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "12a8b923-692c-11e6-8a84-bae500000053",
"name": "ООО \"Поставщик\"",
"externalCode": "aZBfWOKzj-lcq7c7IWZON3",
"inn": "7736570901",
"companyType": "legal"
},
"firstDemandDate": null,
"lastDemandDate": null,
"demandsCount": 0,
"demandsSum": 0,
"averageReceipt": 0,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 0,
"profit": 0,
"lastEventDate": null,
"lastEventText": null,
"updated": "2016-08-23 15:21:09"
}
]
}
Выборочные показатели контрагентов
Запрос на получение отчета по указанным контрагентам. Необходимо передать массив counterparties,
содержащий метаданные контрагентов, по которым требуются отчеты.
Результат успешного запроса - JSON представление списка отчетов по указанным котрагентам:
- meta Метаданные отчета,
- context - Метаданные о сотруднике, выполнившем запрос.
- rows - Массив JSON объектов, представляющих собой отчеты по отдельным контрагентам.
Пример запроса отчетов для нескольких контрагентов.
СвернутьПоказать
curl -X POST
"https://online.moysklad.ru/api/remap/1.2/report/counterparty"
-H "Authorization: Basic <Credentials>"
-H "Content-Type: application/json"
-d '{
"counterparties": [
{
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/49b40d55-66cc-11e7-6adb-ede500000054",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
},
{
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/37e4efe0-6ade-11e7-6adb-ede50000001a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
}
]
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета по контрагентам.
СвернутьПоказать
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty",
"type": "counterparty",
"mediaType": "application/json",
"size": 2,
"limit": 1000,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/49b40d55-66cc-11e7-6adb-ede500000054",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=49b40d55-66cc-11e7-6adb-ede500000054"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/49b40d55-66cc-11e7-6adb-ede500000054",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=49b40d55-66cc-11e7-6adb-ede500000054"
},
"id": "49b40d55-66cc-11e7-6adb-ede500000054",
"name": "ООО \"Поставщик\"",
"externalCode": "btkD664AiiIaIYMdI50OW3",
"inn": "7736570901",
"companyType": "legal"
},
"firstDemandDate": null,
"lastDemandDate": null,
"demandsCount": 0,
"demandsSum": 0,
"averageReceipt": 0,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 0,
"profit": 0,
"lastEventDate": null,
"lastEventText": null,
"updated": "2017-07-12 09:35:26"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/37e4efe0-6ade-11e7-6adb-ede50000001a",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=37e4efe0-6ade-11e7-6adb-ede50000001a"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/37e4efe0-6ade-11e7-6adb-ede50000001a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=37e4efe0-6ade-11e7-6adb-ede50000001a"
},
"id": "37e4efe0-6ade-11e7-6adb-ede50000001a",
"name": "ООО \"Поставщик 2\"",
"externalCode": "WG4JRabzgb6aW9asZ20yy3",
"inn": "7736570901",
"companyType": "legal"
},
"firstDemandDate": null,
"lastDemandDate": null,
"demandsCount": 0,
"demandsSum": 0,
"averageReceipt": 0,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": 0,
"profit": 0,
"lastEventDate": null,
"lastEventText": null,
"updated": "2017-07-17 13:54:30"
}
]
}
Показатели контрагента
Показатели контрагента
Параметры
| Параметр |
Описание |
| limit |
number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000. |
| offset |
number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей. |
Запрос на получение отчета по контрагенту с указанным id.
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/counterparty/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отчета по контрагенту.
СвернутьПоказать
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/report/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
"type": "counterparty",
"mediaType": "application/json"
},
"counterparty": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
"metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "df2fdd2d-6934-11e6-8a84-bae500000049",
"name": "rtr",
"externalCode": "rRlzrdZmjql9r9dveXPE43",
"companyType": "legal"
},
"firstDemandDate": "2016-09-01 17:54:00",
"lastDemandDate": "2016-09-01 17:54:00",
"demandsCount": 1,
"demandsSum": 60000,
"averageReceipt": 60000,
"returnsCount": 0,
"returnsSum": 0,
"discountsSum": 0,
"balance": -60000,
"bonusBalance": 200,
"profit": 50000,
"lastEventDate": "2016-09-08 13:07:30",
"lastEventText": "продажа",
"updated": "2016-08-23 16:24:08"
}
Показатели
В рамках JSON API можно запросить показатели за день, месяц и неделю. Подробнее о разделе "Показатели"
вы можете прочитать на портале поддержки по этой ссылке.
Структура объекта показателей
- sales - Вложенный объект, представляющий собой информацию о продажах за указанный период
- count - Количество продаж
- amount - Прибыль
- movementAmount - Дельта по сравнению с прошлым аналогичным периодом
- orders - Вложенный объект, представляющий собой информацию о заказах за указанный период
- count - Количество заказов
- amount - Прибыль
- movementAmount - Дельта по сравнению с прошлым аналогичным периодом
- money - Вложенный объект, представляющий собой информацию о деньгах за указанный период
- income - Доходы за период
- outcome - Расходы за период
- balance - Текущий баланс
- todayMovement - Дельта за сегодня
- movement - Дельта за период
День
Получить показатели за день
Запрос на получение показателей за день.
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/dashboard/day"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление показателей.
СвернутьПоказать
{
"sales": {
"count": 0,
"amount": 0,
"movementAmount": -80000
},
"orders": {
"count": 0,
"amount": 0,
"movementAmount": 0
},
"money": {
"income": 0,
"outcome": 0,
"balance": 69700,
"todayMovement": 0,
"movement": 0
}
}
Неделя
Получить показатели за неделю
Запрос на получение показателей за неделю.
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/dasboard/week"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление показателей.
СвернутьПоказать
{
"sales": {
"count": 0,
"amount": 0,
"movementAmount": -80000
},
"orders": {
"count": 0,
"amount": 0,
"movementAmount": 0
},
"money": {
"income": 0,
"outcome": 0,
"balance": 69700,
"todayMovement": 0,
"movement": 0
}
}
Месяц
Получить показатели за месяц
Запрос на получение показателей за месяц.
СвернутьПоказать
curl -X GET
"https://online.moysklad.ru/api/remap/1.2/report/dashboard/month"
-H "Authorization: Basic <Credentials>"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление показателей.
СвернутьПоказать
{
"sales": {
"count": 0,
"amount": 0,
"movementAmount": -80000
},
"orders": {
"count": 0,
"amount": 0,
"movementAmount": 0
},
"money": {
"income": 0,
"outcome": 0,
"balance": 69700,
"todayMovement": 0,
"movement": 0
}
}
