Аудит

Аудит

Сервис МойСклад накапливает сведения о всех событиях в системе. Эта часть сервиса называется аудит, а накопленные сведения - событиями аудита. Изменения по конкретной сущности доступны пользователям при наличии прав на просмотр, подробная информация о всех изменениях доступна только пользователям с правами администратора.

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

Пользователь может получить подробную информацию об изменениях в системе через JSON API двумя способами:

• Просмотр общей ленты аудита

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

• Просмотр событий по отдельной сущности

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

Контексты

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

Атрибуты сущности

• meta - Метаданные сущности Контекста Только для чтения
• id - ID Контекста в формате UUID Только для чтения
• uid - Логин Сотрудника Только для чтения
• supportAccess - был ли доступ произведен поддержкой от имени пользователя. Флаг отсутствует, если значение false Только для чтения
• source - Тип изменения Только для чтения
• moment - Дата изменения Только для чтения
• objectCount - количество измененных объектов Только для чтения
• eventType - действие Событий (поле присутствует, только если оно одинаково у всех Событий в рамках данного Контекста) Только для чтения
• entityType - название сущности (поле присутствует, только если оно одинаково у всех Событий в рамках данного Контекста) Только для чтения
• objectType - тип сущностей, с которыми связанно данное изменение. Поле присутствует только для entityType = entitysettings или statesettings или templatesettings
• info - Краткое описание, выводится не для всех типов изменений Только для чтения
• events - Список Событий аудита в формате Метаданных Только для чтения

Возможные значение параметра source преставлены ниже:

Значение параметра source	Описание
app	Все действия
copy	Копирование
combine	Объединение
import	Импорт
importAlfabank	Импорт из Альфа-Банка
importModulebank	Импорт из Модульбанка
importTochkabank	Импорт из Точка Банка
importTinkoffbank	Импорт из Тинькофф Банка
import1c	Импорт из 1С
restapi	REST API
remap-1.0	JSON API 1.0
remap-1.1	JSON API 1.1
remap-1.2	JSON API 1.2
posapi	POS API
retail	Точка продаж
connectors	Синхронизация с ИМ
evotor	Синхронизация с Эвотор
clearrecyclebin	Автоматическая очистка корзины
loginlogout	Вход или выход из МоегоСклада
emailsend	Отправка сообщения
export	Экспорт
phone-1.0	Phone API

Возможные значение параметров eventType и entityType приведены в разделе Фильтры

Получить Контексты

Запрос всех изменений. Результат: Объект JSON, включающий в себя поля:

• meta - Метаданные о контексте
• context - Метаданные о сотруднике, выполнившем запрос
• rows - Массив JSON сущностей, представляющих собой изменения

Параметры

Параметр	Описание
limit	number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset	number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
filter	string (optional) Example: source=jsonapi Подробное описание параметра в разделе Фильтрация выборки с помощью параметра filter Атрибуты фильтрации для Контекстов аудита представлены в разделе Фильтры

Получить Контексты

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/audit"
  -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/audit/",
    "type": "audit",
    "mediaType": "application/json",
    "size": 1,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/audit/b912e9d1-3fbe-11e7-8a7f-40d000000000",
        "type": "audit",
        "mediaType": "application/json"
      },
      "id": "b912e9d1-3fbe-11e7-8a7f-40d000000000",
      "uid": "admin@1",
      "source": "loginlogout",
      "moment": "2017-05-23 16:50:03",
      "info": "Вход в МойСклад (127.0.0.1, Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:50.0) Gecko/20100101 Firefox/50.0)"
    }
  ]
}

Получить Контексты c фильтрацией

Параметры

Параметр	Описание
filter	string (optional) Example: filter=entityType=customerorder фильтр по типу сущности

Пример запроса с фильтрацией контекстов по типу "заказ покупателя" https://online.moysklad.ru/api/remap/1.2/audit?filter=entityType=customerorder

Получить Контексты c фильтрацией

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/audit?filter=entityType=customerorder"
  -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/audit?filter=entityType=customerorder",
    "type": "audit",
    "mediaType": "application/json",
    "size": 1,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/audit/83732f4b-792a-11e7-9464-d04800000005",
        "type": "audit",
        "mediaType": "application/json"
      },
      "id": "83732f4b-792a-11e7-9464-d04800000005",
      "uid": "admin@11",
      "source": "app",
      "moment": "2017-08-04 18:35:15",
      "objectCount": 1,
      "eventType": "create",
      "entityType": "customerorder",
      "events": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/audit/83732f4b-792a-11e7-9464-d04800000005/events",
          "type": "auditevent",
          "mediaType": "application/json",
          "size": 1,
          "limit": 25,
          "offset": 0
        }
      }
    }
  ]
}

События

События аудита содержат подробную информацию о произошедших изменениях, например, изменение значения поля.

Типы Событий

События делятся на несколько типов, начиная от аудита создания сущности и заканчивая аудитом печати, и состоят из сведений о времени события и произошедших во время этого события изменениях. Различные типы событий отличаются друг от друга форматом поля diff, подробнее о котором ниже.

• Создание сущности или документа
• Обновление сущности или документа
• Удаление сущности или документа
• Помещение в корзину
• Восстановление из корзины
• Помещение в архив
• Восстановление из архива
• Публикация документов
• Отправка писем
• Смена токена

Атрибуты сущности

• moment - время создания События Только для чтения
• uid - Логин Сотрудника Только для чтения
• supportAccess - был ли доступ произведен поддержкой от имени пользователя. Флаг отсутствует, если значение false Только для чтения
• source - Тип изменения Только для чтения
• eventType - действие События Только для чтения
• entityType - название сущности Только для чтения
• objectType - тип сущностей, с которыми связанно данное изменение. Поле присутствует только для entityType = entitysettings или statesettings или templatesettings
• name - имя сущности Только для чтения
• entity - Ссылка на сущность в формате Метаданных. Не будет выводиться только для товаров, услуг, модификаций, комплектов удаленных до 20.08.2017 Только для чтения
• additionalInfo - дополнительная информация о Событии. Присутствует не во всех типах событий Только для чтения
• diff - изменения, произошедшие в Событии, в специальном формате diff, описанном в разделе Формат поля diff Только для чтения
• audit - Ссылка на контекст в формате Метаданных Только для чтения

Формат поля diff

В данном поле отображены изменения полей сущности, произошедшие в Событии.

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

Ниже приведены возможные форматы поля diff для разных типов Событий. Для событий создания сущности поле diff будет отсутствовать.

События публикации документов

• templateName - название шаблона Только для чтения
• publicationHref - ссылка на публикацию Только для чтения

События отправки писем

• senderEmail - почта отправителя письма Только для чтения
• targetEmail - почта получателя письма Только для чтения
• subjectEmail - тема письма Только для чтения
• text - текст письма Только для чтения

События удаления сущностей

• attributeName - название атрибута сущности Только для чтения
  • oldValue - значение атрибута до удаления Только для чтения

События обновления сущностей, перемещения/восстановления из корзины, перемещение/восстановление из архива

• attributeName - название атрибута сущности Только для чтения
  • oldValue - значение атрибута до обновления Только для чтения
  • newValue - значение атрибута после обновления Только для чтения

Получить События по Контексту

Запрос на получение событий Контекста с указанным id. Результат: Объект JSON, включающий в себя поля:

• context - Метаданные о сотруднике, выполнившем запрос.
• meta Метаданные событий
• rows - Массив JSON сущностей, представляющих собой события

Параметры

Параметр	Описание
id	string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Контекста.

Получить События по Контексту

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/audit/7944ef04-f831-11e5-7a69-971500188b19/events"
  -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/audit/c107864f-3f88-11e7-8a7f-40d000000041/events",
    "type": "auditevent",
    "mediaType": "application/json",
    "size": 1,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "source": "app",
      "eventType": "update",
      "entityType": "product",
      "uid": "admin@1",
      "moment": "2017-05-30 18:47:49",
      "diff": {
        "weighed": {
          "oldValue": false,
          "newValue": true
        }
      },
      "name": "some product",
      "audit": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/audit/7944ef04-f831-11e5-7a69-971500188b19",
          "type": "audit",
          "mediaType": "application/json"
        }
      },
      "entity": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/7944ef04-f831-11e5-7a69-971500188b19",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=7944ef04-f831-11e5-7a69-971500188b19"
        }
      }
    }
  ]
}

Получить События по Сущности

Запрос на получение событий по сущности с указанным id. Результат: Объект JSON, включающий в себя поля:

• context - Метаданные о сотруднике, выполнившем запрос.
• meta Метаданные событий
• rows - Массив JSON сущностей, представляющих собой события

Параметры

Параметр	Описание
type	string (required) Example: product тип сущности.
id	string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id сущности.

Получить События по Сущности

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/entity/product/7944ef04-f831-11e5-7a69-971500188b19/audit"
  -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/entity/product/7944ef04-f831-11e5-7a69-971500188b19/audit",
    "type": "auditevent",
    "mediaType": "application/json",
    "size": 1,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "source": "app",
      "eventType": "update",
      "entityType": "product",
      "uid": "admin@1",
      "moment": "2017-05-30 18:47:49",
      "diff": {
        "weighed": {
          "oldValue": false,
          "newValue": true
        }
      },
      "name": "some product",
      "audit": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/audit/7944ef04-f831-11e5-7a69-971500188b19",
          "type": "audit",
          "mediaType": "application/json"
        }
      },
      "entity": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/7944ef04-f831-11e5-7a69-971500188b19",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json",
          "uuidHref": "https://online.moysklad.ru/app/#good/edit?id=7944ef04-f831-11e5-7a69-971500188b19"
        }
      }
    }
  ]
}

Фильтры

В JSON API сервиса МойСклад предусмотрена возможность фильтрации Контекстов аудита с помощью url параметр filter. Подробнее про данный параметр можно посмотреть в разделе Фильтрация выборки с помощью параметра filter Фильтрация может осуществляться по полям, описанным ниже.

Атрибуты сущности

• moment - Параметр строкового типа. В качестве значения должна быть передана строка в формате дата + время с точностью до секунд.

Допустимые операторы для фильтрации по атрибуту moment : ['>=', '<=']

Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм], Часовой пояс: MSK (Московское время)

• employee - Параметр строкового типа. В качестве значения должен быть передан href сущности сотрудника. В отфильтрованную выборку попадут все сущности аудита, автором изменений которых является данный пользователь.

Формат строки : href

• eventType - Параметр строкового типа. В качестве значения должен быть передан тип События, по которому должны быть отфильтрованы сущности аудита. Список возможных значений параметра:

Значение параметра eventType	Описание
create	Создание сущностей
update	Изменение сущностей
delete	Удаление сущностей
puttorecyclebin	Помещение в корзину
restorefromrecyclebin	Извлечение из корзины
puttoarchive	Помещение в архив
restorefromarchive	Извлечение из архива
print	Печать документа
openpublication	Создание публикации
closepublication	Удаление публикации
sendemailfromentity	Отправка письма
bulkoperation	Массовая операция
replacetoken	Смена токена для Точки продаж

• source - Параметр строкового типа. В качестве значения должен быть передан тип действия, по которому должны быть отфильтрованы сущности аудита. Список возможных значений параметра:

Значение параметра source	Описание
copy	Копирование
combine	Объединение
import	Импорт
restapi	REST API
jsonapi	JSON API
posapi	POS API
retail	Точка продаж
connectors	Синхронизация с ИМ
evotor	Синхронизация с Эвотор
clearrecyclebin	Автоматическая очистка корзины
loginlogout	Вход или выход из МоегоСклада
emailsend	Отправка сообщения
export	Экспорт
phone-1.0	Phone API
scriptor	Работа со сценариями

• uid - Параметр строкового типа. В качестве значения должен быть передан логин сотрудника, по которому должны быть отфильтрованы события аудита.
• entityType - Параметр строкового типа. В качестве значения должно быть передано название сущности, по которой должны быть отфильтрованы сущности аудита. В качестве параметра может быть передано наименование из JSON API сущности/документа (move, enter, customerorder и т.д.) либо одно из значений следующего списка:

Значение параметра entityType	Описание
processingplanfolder	Группа тех.карт
amiroconnectorsettings	Настройка синхронизации (Amiro)
cmlconnectorsettings	Настройка синхронизации (CML)
ecwidconnectorsettings	Настройка синхронизации (Ecwid)
smartwebconnectorsettings	Настройка синхронизации (SmartWeb)
ymlconnectorsettings	Настройка синхронизации (YML)
vkconnectorsettings	Настройка синхронизации (Вконтакте)
yandexconnectorsettings	Настройка синхронизации (Яндекс.Маркет)
evotorsetting	Настройка обмена с Эвотор
usersettings	Настройки пользователя
user	Пользователь
accountrole	Роль
entitysettings	Настройки сущностей
statesettings	Настройки статусов
templatesettings	Настройки шаблонов
scripttemplate	Сценарий
crptdemand	Отгрузка маркированной продукции
crptcancellation	Списание кодов маркировки
crptpackagecreation	Формирование упаковки
crptpackageitemremoval	Изъятие из упаковки
crptpackagedisaggregation	Расформирование упаковки

Также можно отфильтровать контексты аудита по пользовательскому справочнику. Для этого в качестве параметра entityType необходимо передать href пользовательского справочника. Пример: https://online.moysklad.ru/api/remap/1.2/entity/customentity/eaacabaf-2655-11e6-8a84-bae500000045

Получить Фильтры

Запрос всех фильтров аудита, доступных пользователю. Результат: Объект JSON, включающий в себя поля:

• eventType - действия, по которым могут быть отфильтрованы сущности аудита
• source - типы действий, по которым могут быть отфильтрованы сущности аудита
• entityType - названия сущностей, по которым могут быть отфильтрованы сущности аудита

Получить Фильтры

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

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

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

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

{
  "source": [
    "copy",
    "combine",
    "import",
    "restapi",
    "jsonapi",
    "posapi",
    "retail",
    "connectors",
    "evotor",
    "clearrecyclebin",
    "loginlogout",
    "emailsend",
    "export",
    "phone-1.0",
    "scriptor"
  ],
  "entitytype": [
    "organization",
    "employee",
    "store",
    "retailstore",
    "retailshift",
    "retaildemand",
    "retailsalesreturn",
    "retaildrawercashin",
    "retaildrawercashout",
    "purchaseorder",
    "invoicein",
    "supply",
    "purchasereturn",
    "facturein",
    "customerorder",
    "invoiceout",
    "demand",
    "commissionreportin",
    "commissionreportout",
    "salesreturn",
    "factureout",
    "pricelist",
    "loss",
    "enter",
    "move",
    "inventory",
    "processing",
    "processingplan",
    "processingplanfolder",
    "processingorder",
    "internalorder",
    "cashin",
    "paymentin",
    "cashout",
    "paymentout",
    "service",
    "product",
    "bundle",
    "productfolder",
    "variant",
    "counterparty",
    "currency",
    "project",
    "contract",
    "amiroconnectorsettings",
    "cmlconnectorsettings",
    "ecwidconnectorsettings",
    "smartwebconnectorsettings",
    "ymlconnectorsettings",
    "vkconnectorsettings",
    "yandexconnectorsettings",
    "usersettings",
    "group",
    "user",
    "accountrole",
    "specialpricediscount",
    "personaldiscount",
    "accumulationdiscount",
    "roundoffdiscount",
    "bonusprogram",
    "loyaltydiscount",
    "bonustransaction",
    "country",
    "uom",
    "purpose",
    "notificationsubscription",
    "entitysettings",
    "statesettings",
    "templatesettings",
    "phonecall",
    "receipttemplate",
    "prepayment",
    "prepaymentreturn",
    "enrollorder",
    "retireorder",
    "remarkingorder",
    "emissionorder",
    "crptdemand",
    "scripttemplate",
    "cashboxadjustment",
    "accountadjustment",
    "counterpartyadjustment",
    "crptcancellation",
    "crptpackagecreation",
    "crptpackageitemremoval",
    "crptpackagedisaggregation",
    "evotorsetting",
    "https://online.moysklad.ru/api/remap/1.2/entity/customentity/eaacabaf-2655-11e6-8a84-bae500000045"
  ],
  "eventtype": [
    "create",
    "update",
    "delete",
    "puttorecyclebin",
    "restorefromrecyclebin",
    "puttoarchive",
    "restorefromarchive",
    "print",
    "openpublication",
    "closepublication",
    "sendemailfromentity",
    "bulkoperation",
    "replacetoken"
  ]
}

Уведомления

Лента уведомлений

Общие атрибуты уведомлений

• meta - Метаданные объекта. Содержит тип конкретного уведомления
• id - ID Уведомления в формате UUID Только для чтения
• accountId - ID учетной записи Только для чтения
• created - Дата и время формирования Уведомления Только для чтения
• read - Признак того, было ли Уведомление прочитано
• title - Краткий текст уведомления Только для чтения
• description - Описание уведомления Только для чтения Только для чтения

Получить ленту Уведомлений

Запрос на получение ленты Уведомлений. Результат: Объект 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/notification"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification",
    "type": "notification",
    "mediaType": "application/json",
    "size": 3,
    "limit": 1000,
    "offset": 0
  },
  "rows": [
    {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/notification/32f118d3-5b8f-11e9-9bea-3ff700000070",
      "type": "NotificationGoodCountTooLow",
      "mediaType": "application/json"
    },
    "id": "32f118d3-5b8f-11e9-9bea-3ff700000070",
    "accountId": "45b76d0a-5aa2-11e9-727d-307300000002",
    "created": "2019-04-10 15:50:20.271",
    "read": true,
    "title": "Заканчивается товар Картофель (да)",
    "description": "Остаток ниже 1",
    "good": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/0daf8e9a-5b7a-11e9-727d-307300000007",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "id": "0daf8e9a-5b7a-11e9-727d-307300000007",
      "name": "Картофель (да)"
    },
    "actualBalance": 0,
    "minimumBalance": 1
    },
    {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/notification/0f423542-5b7a-11e9-9bea-3ff70000000f",
      "type": "NotificationImportCompleted",
      "mediaType": "application/json"
    },
    "id": "0f423542-5b7a-11e9-9bea-3ff70000000f",
    "accountId": "45b76d0a-5aa2-11e9-727d-307300000002",
    "created": "2019-04-10 13:19:01.123",
    "read": true,
    "title": "Импорт завершен",
    "description": "Товары и остатки (Excel). Оприходование 00002 создано. Обработано 7 строк, создано 7 элементов, обновлено 0 элементов",
    "message": "Обработано 7 строк, создано 7 элементов, обновлено 0 элементов",
    "taskType": "importer_good",
    "taskState": "completed",
    "createdDocumentName": "00002"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.2/notification/a805beb5-5adf-11e9-9bea-3ff700000025",
        "type": "NotificationTaskChanged",
        "mediaType": "application/json"
      },
      "id": "a805beb5-5adf-11e9-9bea-3ff700000025",
      "accountId": "45b76d0a-5aa2-11e9-727d-307300000002",
      "created": "2019-04-09 18:53:45.314",
      "read": true,
      "title": "Задача изменена: Новое описание задачи",
      "description": "admin изменил задачу",
      "performedBy": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/188cb787-5aa5-11e9-727d-30730000009c",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        },
        "id": "188cb787-5aa5-11e9-727d-30730000009c",
        "name": "admin"
      },
      "task": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/14ac66b6-5add-11e9-727d-30730000002f",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
          "type": "task",
          "mediaType": "application/json"
        },
        "id": "14ac66b6-5add-11e9-727d-30730000002f",
        "name": "Новое описание задачи",
        "deadline": "2019-04-02 18:53:00.000"
      },
      "diff": {
        "description": {
          "oldValue": "Старое описание задачи",
          "newValue": "Новое описание задачи"
        },
        "deadline": {
          "newValue": "2019-04-02 18:53:00.000"
        }
      }
    }
  ]
}

Уведомление

Получить Уведомление

Параметры

Параметр	Описание
id	string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

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

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/bcd815b9-56ca-11e9-c0a8-100b00000001",
    "type": "NotificationTaskAssigned",
    "mediaType": "application/json"
  },
  "id": "bcd815b9-56ca-11e9-c0a8-100b00000001",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 14:13:56.000",
  "read": false,
  "title": "Новая задача: Задача",
  "description": "Администратор назначил вам задачу Задача",
  "performedBy": {
    "id": "c461170f-5640-11e9-c0a8-100a00000003",
    "name": "Администратор"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/8413bfc3-56ca-11e9-c0a8-100a00000000",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "8413bfc3-56ca-11e9-c0a8-100a00000000",
    "name": "Задача"
  }
}

Удалить Уведомление

Запрос на удаление Уведомления. Возможно удаление только Уведомлений текущего пользователя.

Параметры

Параметр	Описание
id	string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Уведомления.

Запрос на удаление Уведомления с указанным id.

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

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

Response 200 (application/json) Успешное удаление Уведомления.

Отметить Уведомление как прочитанное

Отметить конкретное уведомление, как прочитанное. Можно отмечать только Уведомления текущего пользователя.

Параметры

Параметр	Описание
id	string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Уведомления.

Отметить конкретное уведомление, как прочитанное.

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

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

Response 200 (application/json) Успешное проставление признака "прочитано".

Отметить все Уведомления как прочитанные

Отметить все Уведомления текущего пользователя как прочитанные.

Отметить все Уведомления текущего пользователя как прочитанные

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

curl -X PUT
  "https://online.moysklad.ru/api/remap/1.2/notification/markasreadall"
  -H "Authorization: Basic <Credentials>"

Response 200 (application/json) Успешное проставление признака "прочитано" всем непрочитанным Уведомлениям.

Типы уведомлений

Форматы полей

Формат измененного поля

Формат измененного поля содержит в себе старое и новое значение: + oldValue - Старое значение + newValue - Новое значение

Формат oldValue и newValue совпадает с форматом поля, изменение которого отображается. Одно из полей может быть не заполнено.

Возможные значения типа экспорта

• export_csv_good
• export_csv_agent
• export_ms_xml
• export_1c_v2_xml
• export_unisender
• export_1c_v3_xml
• export_subscribepro
• export_1c_client_bank
• export_alfa_payments
• export_tochka_payments
• export_modulbank_payments
• export_1c_enterprise_data
• export_tinkoff_payments
• export_good
• export_custom_entity

Возможные значения типа импорта

• importer_csv
• importer_yml
• importer_csv_agent
• importer_csv_customerorder
• importer_csv_purchaseorder
• importer_csv_pricelist
• importer_ms_xml
• importer_1c_client_bank
• import_alfa_payments
• import_alfa_payments_request
• import_alfa_payments_save
• import_tochka_payments
• import_modulbank_payments
• import_tochka_payments_save
• import_modulbank_payments_save
• import_tinkoff_payments
• import_tinkoff_payments_save
• importer_good
• importer_good_in_doc
• import_edo_supply
• import_union_company
• import_sberbank_payments_request
• import_sberbank_payments_save
• import_update_vat_to_20_percents
• import_custom_entity

Сводная таблица типов уведомлений

Тип уведомления	Группа	О чем уведомление
NotificationOrderNew	Заказ покупателя	Новый заказа покупателя
NotificationOrderOverdue	Заказ покупателя	Просрочен заказ
NotificationInvoiceOutOverdue	Счет	Просрочен счёт, который не оплатил или не полностью оплатил покупатель
NotificationGoodCountTooLow	Остатки	Снижение количества товара до неснижаемого остатка
NotificationTaskAssigned	Задача	Задача назначена
NotificationTaskUnassigned	Задача	Задача снята
NotificationTaskOverdue	Задача	Задача просрочена
NotificationTaskCompleted	Задача	Задача выполнена
NotificationTaskReopened	Задача	Задача переоткрыта
NotificationTaskNewComment	Задача	У задачи появился новый комментарий
NotificationTaskChanged	Задача	Задача поменялась
NotificationTaskDeleted	Задача	Задача удалена
NotificationTaskCommentDeleted	Задача	Комментарий у задачи был удален
NotificationTaskCommentChanged	Задача	Комментарий у задачи был изменен
NotificationImportCompleted	Обмен данными	Импорт выполнен
NotificationExportCompleted	Обмен данными	Экспорт выполнен
NotificationSubscribeExpired	Биллинг	Окончание подписки
NotificationSubscribeTermsExpired	Биллинг	Истекают условия подписки
NotificationRetailShiftOpened	Розничная торговля	Открыта смена
NotificationRetailShiftClosed	Розничная торговля	Закрыта смена

Подробное описание типов уведомлений

Завершение экспорта

Тип уведомления

NotificationExportCompleted - завершение экспорта

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• message - Сообщение о завершении экспорта
• errorMessage - Сообщение об ошибке
• createdDocumentName - Имя экспортированного документа
• taskType - Тип экспорта Необходимое
• taskState - Статус завершения Необходимое. Может принимать значения completed, interrupted, interrupted_by_user, interrupted_by_timeout, interrupted_by_system

Параметры

Параметр	Описание
id	string (required) Example: 02950e3c-35f2-11e9-9ff4-34e8000799c0 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/02950e3c-35f2-11e9-9ff4-34e8000799c0"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/02950e3c-35f2-11e9-9ff4-34e8000799c0",
    "type": "NotificationExportCompleted",
    "mediaType": "application/json"
  },
  "id": "02950e3c-35f2-11e9-9ff4-34e8000799c0",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-02-21 19:01:55.277",
  "read": true,
  "title": "Экспорт завершен",
  "description": "Экспорт товаров (Excel). Экспортировано 43465 товаров и 2080 модификаций",
  "message": "Экспортировано 43465 товаров и 2080 модификаций",
  "taskType": "export_good",
  "taskState": "completed"
}

Завершение импорта

Тип уведомления

NotificationImportCompleted - завершение импорта

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• message - Сообщение о завершении импорта
• errorMessage - Сообщение об ошибке
• createdDocumentName - Имя документа
• taskType - Тип импорта Необходимое
• taskState - Статус завершения Необходимое. Может принимать значения completed, interrupted, interrupted_by_user, interrupted_by_timeout, interrupted_by_system

Параметры

Параметр	Описание
id	string (required) Example: 02950e31-35f2-11e9-9ff4-34e8000799c0 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/02950e31-35f2-11e9-9ff4-34e8000799c0"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/02950e31-35f2-11e9-9ff4-34e8000799c0",
    "type": "NotificationImportCompleted",
    "mediaType": "application/json"
  },
  "id": "02950e31-35f2-11e9-9ff4-34e8000799c0",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-02-21 19:01:55.277",
  "read": true,
  "title": "Импорт завершен",
  "description": "Импорт контрагентов (Excel). Обработано 3 строки, создано 0 контрагентов, обновлено 0 контрагентов.",
  "message": "Обработано 3 строки, создано 0 контрагентов, обновлено 0 контрагентов.",
  "taskType": "importer_csv_agent",
  "taskState": "completed"
}

Снижение остатка товара ниже неснижаемого

Тип уведомления

NotificationGoodCountTooLow - снижение остатка товара ниже неснижаемого

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• actualBalance - Остаток товара Необходимое
• minimumBalance - Неснижаемый остаток товара Необходимое
• good - Ссылка на товар в формате Метаданных Необходимое

Параметры

Параметр	Описание
id	string (required) Example: 9338c8bd-56e5-11e9-c0a8-100b00000023 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/9338c8bd-56e5-11e9-c0a8-100b00000023"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/9338c8bd-56e5-11e9-c0a8-100b00000023",
    "type": "NotificationGoodCountTooLow",
    "mediaType": "application/json"
  },
  "id": "9338c8bd-56e5-11e9-c0a8-100b00000023",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 17:26:02.000",
  "read": false,
  "title": "Заканчивается товар 1",
  "description": "Остаток ниже 200",
  "good": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/product/bdca925e-56e1-11e9-c0a8-100a00000016",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/product/metadata",
      "type": "product",
      "mediaType": "application/json"
    },
    "id": "bdca925e-56e1-11e9-c0a8-100a00000016",
    "name": "1"
  },
  "actualBalance": 180.0,
  "minimumBalance": 200.0
}

Просрочен счет покупателя

Тип уведомления

NotificationInvoiceOutOverdue - просрочен счет покупателя

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• invoice - Ссылка на счет в формате Метаданных Необходимое
  • paymentPlannedMoment - Запланированная дата оплаты
  • sum - Сумма счета
  • agentName - Имя контрагента

Параметры

Параметр	Описание
id	string (required) Example: 572d1dd9-56fc-11e9-c0a8-100b00000006 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/572d1dd9-56fc-11e9-c0a8-100b00000006"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/572d1dd9-56fc-11e9-c0a8-100b00000006",
    "type": "NotificationInvoiceOutOverdue",
    "mediaType": "application/json"
  },
  "id": "572d1dd9-56fc-11e9-c0a8-100b00000006",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 20:09:00.000",
  "read": false,
  "title": "Счет покупателю №00003 просрочен",
  "description": "Дата оплаты: 01.04.2019 20:08. Сумма: 500,00. Покупатель: Розничный покупатель.",
  "invoice": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/invoiceout/571b1ac4-56fc-11e9-c0a8-100e0000002b",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/invoiceout/metadata",
      "type": "invoiceout",
      "mediaType": "application/json"
    },
    "id": "571b1ac4-56fc-11e9-c0a8-100e0000002b",
    "name": "00003",
    "paymentPlannedMoment": "2019-04-01 20:08:00.000",
    "sum": 50000,
    "customerName": "Розничный покупатель"
  }
}

Новый заказ

Тип уведомления

NotificationOrderNew - новый заказ

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• order - Ссылка на заказ в формате Метаданных Необходимое
  • deliveryPlannedMoment - Планируемое время отгрузки
  • sum - Сумма заказа
  • agentName - Имя контрагента

Параметры

Параметр	Описание
id	string (required) Example: c6082a9e-56e1-11e9-c0a8-100b00000011 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/c6082a9e-56e1-11e9-c0a8-100b00000011"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/c6082a9e-56e1-11e9-c0a8-100b00000011",
    "type": "NotificationOrderNew",
    "mediaType": "application/json"
  },
  "id": "c6082a9e-56e1-11e9-c0a8-100b00000011",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 16:58:50.000",
  "read": false,
  "title": "Новый заказ покупателя № 00001",
  "description": "Сумма: 499.99. Покупатель: Розничный покупатель.",
  "order": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/customerorder/c5ab5d93-56e1-11e9-c0a8-100a0000001d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/customerorder/metadata",
      "type": "customerorder",
      "mediaType": "application/json"
    },
    "id": "c5ab5d93-56e1-11e9-c0a8-100a0000001d",
    "name": "00001",
    "sum": 49999,
    "agentName": "Розничный покупатель"
  }
}

Просроченный заказ

Тип уведомления

NotificationOrderOverdue - просроченный заказ

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• order - Ссылка на заказ в формате Метаданных Необходимое
  • deliveryPlannedMoment - Планируемое время отгрузки
  • sum - Сумма заказа
  • agentName - Имя контрагента

Параметры

Параметр	Описание
id	string (required) Example: c6082a9e-56e1-11e9-c0a8-100b00000011 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/c6082a9e-56e1-11e9-c0a8-100b00000011"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/c6082a9e-56e1-11e9-c0a8-100b00000011",
    "type": "NotificationOrderOverdue",
    "mediaType": "application/json"
  },
  "id": "c6082a9e-56e1-11e9-c0a8-100b00000011",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 16:58:50.000",
  "read": false,
  "title": "Просрочен заказ покупателя № 00001",
  "description": "Просрочен заказ покупателя № 00001 Сумма: 300.00. Покупатель: Розничный покупатель.",
  "order": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/customerorder/c5ab5d93-56e1-11e9-c0a8-100a0000001d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/customerorder/metadata",
      "type": "customerorder",
      "mediaType": "application/json"
    },
    "id": "c5ab5d93-56e1-11e9-c0a8-100a0000001d",
    "name": "00001",
    "sum": 30000,
    "agentName": "Розничный покупатель"
  }
}

Окончание подписки

Тип уведомления

NotificationSubscribeExpired - окончание подписки

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое

Параметры

Параметр	Описание
id	string (required) Example: c2582a9e-56e1-11e9-c0a8-100b00000123 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/c2582a9e-56e1-11e9-c0a8-100b00000123"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/c2582a9e-56e1-11e9-c0a8-100b00000123",
    "type": "NotificationOrderOverdue",
    "mediaType": "application/json"
  },
  "id": "c2582a9e-56e1-11e9-c0a8-100b00000123",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 16:58:50.000",
  "read": false,
  "title": "Окончание подписки",
  "description": "Подписка на аккаунте AccountName окончена. Вы по-прежнему можете работать, используя бесплатный тарифный план. Подписка возобновится при пополнении баланса."
}

Условия подписки истекают

Тип уведомления

NotificationSubscribeTermsExpired - условия подписки истекают

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• daysLeft - Количество оставшихся дней подписки Необходимое

Параметры

Параметр	Описание
id	string (required) Example: c2582a9e-56e1-11e9-c0a8-100b00000125 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/c2582a9e-56e1-11e9-c0a8-100b00000125"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/c2582a9e-56e1-11e9-c0a8-100b00000125",
    "type": "NotificationOrderOverdue",
    "mediaType": "application/json"
  },
  "id": "c2582a9e-56e1-11e9-c0a8-100b00000125",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 16:58:50.000",
  "read": false,
  "title": "До окончания подписки 5 дней",
  "description": "До окончания подписки на аккаунте AccountName осталось 3 дней. Рекомендуем заранее пополнить баланс.",
  "daysLeft": 5
}

Задача назначена

Тип уведомления

NotificationTaskAssigned - задача назначена

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи

Параметры

Параметр	Описание
id	string (required) Example: bcd815b9-56ca-11e9-c0a8-100b00000001 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/bcd815b9-56ca-11e9-c0a8-100b00000001"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/bcd815b9-56ca-11e9-c0a8-100b00000001",
    "type": "NotificationTaskAssigned",
    "mediaType": "application/json"
  },
  "id": "bcd815b9-56ca-11e9-c0a8-100b00000001",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 14:13:56.000",
  "read": false,
  "title": "Новая задача: Текст задачи 1",
  "description": "ntest1 назначил вам задачу Текст задачи 1",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Текст задачи 1"
  }
}

Задача снята

Тип уведомления

NotificationTaskUnassigned - задача снята

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи

Параметры

Параметр	Описание
id	string (required) Example: 80c8a58b-56cb-11e9-c0a8-100b00000009 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/80c8a58b-56cb-11e9-c0a8-100b00000009"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/80c8a58b-56cb-11e9-c0a8-100b00000009",
    "type": "NotificationTaskUnassigned",
    "mediaType": "application/json"
  },
  "id": "80c8a58b-56cb-11e9-c0a8-100b00000009",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 14:19:25.000",
  "read": false,
  "title": "Задача снята: Новый текст задачи 1",
  "description": "ntest1 снял с вас задачу",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-27 15:49:00.000"
  }
}

Задача изменена

Тип уведомления

NotificationTaskChanged - задача изменена

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• diff - Измененные поля Необходимое
  • description - Изменение описания задачи в формате изменения поля
  • deadline - Изменение планируемой даты завершения задачи в формате изменения поля
  • agentLink - Изменение контрагента в формате изменения поля
  • documentLink - Изменение связанного документа в формате изменения поля
  • assignee - Изменение исполнителя в формате изменения поля
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи

Параметры

Параметр	Описание
id	string (required) Example: bd0dbccf-56ca-11e9-c0a8-100b00000003 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/bd0dbccf-56ca-11e9-c0a8-100b00000003"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/bd0dbccf-56ca-11e9-c0a8-100b00000003",
    "type": "NotificationTaskChanged",
    "mediaType": "application/json"
  },
  "id": "bd0dbccf-56ca-11e9-c0a8-100b00000003",
  "accountId": "c45c23d5-5640-11e9-c0a8-100a00000001",
  "created": "2019-04-04 14:13:56.000",
  "read": false,
  "title": "Задача изменена: Новый текст задачи 1",
  "description": "ntest1 изменил задачу",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-27 15:49:00.000"
  },
  "diff": {
    "deadline": {
      "oldValue": "2019-05-29 15:47:00.000",
      "newValue": "2019-05-27 15:49:00.000"
    }
  }
}

Задача выполнена

Тип уведомления

NotificationTaskCompleted - задача выполнена

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи

Параметры

Параметр	Описание
id	string (required) Example: 7945a089-56fd-11e9-c0a8-100b00000008 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/7945a089-56fd-11e9-c0a8-100b00000008"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/7945a089-56fd-11e9-c0a8-100b00000008",
    "type": "NotificationTaskCompleted",
    "mediaType": "application/json"
  },
  "id": "7945a089-56fd-11e9-c0a8-100b00000008",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:47:47.000",
  "read": false,
  "title": "Задача выполнена: Новый текст задачи 1",
  "description": "ntest1 выполнил задачу Новый текст задачи 1 Срок: 29.05.2019 15:47",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-29 15:47:00.000"
  }
}

Задача удалена

Тип уведомления

NotificationTaskDeleted - задача удалена

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача с заполненным полем name (без id и meta) Необходимое
  • name - Описание задачи

Параметры

Параметр	Описание
id	string (required) Example: 8d07388c-56cb-11e9-c0a8-100b0000000d id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/8d07388c-56cb-11e9-c0a8-100b0000000d"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/8d07388c-56cb-11e9-c0a8-100b0000000d",
    "type": "NotificationTaskDeleted",
    "mediaType": "application/json"
  },
  "id": "8d07388c-56cb-11e9-c0a8-100b0000000d",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:58:45.000",
  "read": false,
  "title": "Задача удалена: Текст задачи 2",
  "description": "ntest1 удалил задачу Текст задачи 2",
  "task": {
    "name": "Текст задачи 2"
  },
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  }
}

Задача просрочена

Тип уведомления

NotificationTaskOverdue - задача просрочена

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи

Параметры

Параметр	Описание
id	string (required) Example: 51a5b0a3-56e4-11e9-c0a8-100b00000014 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/51a5b0a3-56e4-11e9-c0a8-100b00000014"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/51a5b0a3-56e4-11e9-c0a8-100b00000014",
    "type": "NotificationTaskOverdue",
    "mediaType": "application/json"
  },
  "id": "51a5b0a3-56e4-11e9-c0a8-100b00000014",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:49:01.000",
  "read": false,
  "title": "Просрочена задача: Новый текст задачи 1",
  "description": "Задача просрочена Новый текст задачи 1 Срок: 27.05.2019 15:49",
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-27 15:49:00.000"
  }
}

Задача переоткрыта

Тип уведомления

NotificationTaskReopened - задача переоткрыта

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи

Параметры

Параметр	Описание
id	string (required) Example: df0c3e22-56fd-11e9-c0a8-100b0000000a id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/df0c3e22-56fd-11e9-c0a8-100b0000000a"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/df0c3e22-56fd-11e9-c0a8-100b0000000a",
    "type": "NotificationTaskReopened",
    "mediaType": "application/json"
  },
  "id": "df0c3e22-56fd-11e9-c0a8-100b0000000a",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:48:06.000",
  "read": false,
  "title": "Задача открыта: Новый текст задачи 1",
  "description": "ntest1 открыл задачу Новый текст задачи 1 Срок: 29.05.2019 15:47",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-29 15:47:00.000"
  }
}

Новый комментарий к задаче

Тип уведомления

NotificationTaskNewComment - новый комментарий к задаче

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи
• noteContent - Содержимое комментария Необходимое

Параметры

Параметр	Описание
id	string (required) Example: 240706df-5704-11e9-c0a8-100b00000003 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/240706df-5704-11e9-c0a8-100b00000003"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/240706df-5704-11e9-c0a8-100b00000003",
    "type": "NotificationTaskNewComment",
    "mediaType": "application/json"
  },
  "id": "240706df-5704-11e9-c0a8-100b00000003",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:50:16.000",
  "read": false,
  "title": "Новый комментарий: Новый текст задачи 1",
  "description": "ntest1 добавил комментарий Комментарий 1",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-27 15:49:00.000"
  },
  "noteContent": "Комментарий 1"
}

Изменен комментарий к задаче

Тип уведомления

NotificationTaskCommentChanged - изменен комментарий к задаче

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи
• diff - Изменения комментария в формате изменения поля Необходимое

Параметры

Параметр	Описание
id	string (required) Example: 3d3423ee-5704-11e9-c0a8-100b00000007 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/3d3423ee-5704-11e9-c0a8-100b00000007"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/3d3423ee-5704-11e9-c0a8-100b00000007",
    "type": "NotificationTaskCommentChanged",
    "mediaType": "application/json"
  },
  "id": "3d3423ee-5704-11e9-c0a8-100b00000007",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:50:53.000",
  "read": false,
  "title": "Комментарий изменен: Новый текст задачи 1",
  "description": "ntest1 изменил комментарий Новый текст комментария 1, Комментарий 1",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-27 15:49:00.000"
  },
  "diff": {
    "noteContent": {
      "oldValue": "Комментарий 1",
      "newValue": "Новый текст комментария 1"
    }
  }
}

Удален комментарий к задаче

Тип уведомления

NotificationTaskCommentDeleted - удален комментарий к задаче

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• performedBy - Сотрудник, выполнивший изменение Необходимое
  • meta - Метаданные сотрудника
  • id - Идентификатор сотрудника
  • name - Имя сотрудника
• task - Задача Необходимое
  • meta - Метаданные задачи
  • id - Идентификатор Задачи
  • name - Описание задачи
  • deadline - Планируемая дата завершения задачи
• noteContent - Содержимое удаленного комментария Необходимое

Параметры

Параметр	Описание
id	string (required) Example: 3d2abf0f-5704-11e9-c0a8-100b00000005 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/3d2abf0f-5704-11e9-c0a8-100b00000005"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/3d2abf0f-5704-11e9-c0a8-100b00000005",
    "type": "NotificationTaskCommentDeleted",
    "mediaType": "application/json"
  },
  "id": "3d2abf0f-5704-11e9-c0a8-100b00000005",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-05-27 15:51:09.000",
  "read": false,
  "title": "Комментарий удален: Новый текст задачи 1",
  "description": "ntest1 удалил комментарий Новый текст комментария 1",
  "performedBy": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/c4e1397b-807c-11e9-9ff4-31500025d4ed",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "c4e1397b-807c-11e9-9ff4-31500025d4ed",
    "name": "ntest1"
  },
  "task": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/task/91d6e8a5-807d-11e9-9109-f8fc0024968d",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/task/metadata",
      "type": "task",
      "mediaType": "application/json"
    },
    "id": "91d6e8a5-807d-11e9-9109-f8fc0024968d",
    "name": "Новый текст задачи 1",
    "deadline": "2019-05-27 15:49:00.000"
  },
  "noteContent": "Новый текст комментария 1"
}

Смена открыта

Тип уведомления

NotificationRetailShiftOpened - смена открыта

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• user - Ссылка на сотрудника, отрывшего смену Необходимое
• retailStore - Ссылка на точку продаж Необходимое
• retailShift - Описание смены Необходимое
  • meta - Метаданные
  • id - Идентификатор смены
  • name - Название смены
  • open - Дата открытия
  • proceed - Сумма внесения

Параметры

Параметр	Описание
id	string (required) Example: 8002409b-351d-11e9-9ff4-34e80002a126 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/8002409b-351d-11e9-9ff4-34e80002a126"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/8002409b-351d-11e9-9ff4-34e80002a126",
    "type": "NotificationRetailShiftOpened",
    "mediaType": "application/json"
  },
  "id": "8002409b-351d-11e9-9ff4-34e80002a126",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-02-20 17:40:42.000",
  "read": true,
  "title": "Открыта смена в Точка продаж",
  "description": "Кассир: Кассир Кладкин",
  "user": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/4d4ba195-0e7b-11e2-480d-3c4a92f3a0a7",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "4d4ba195-0e7b-11e2-480d-3c4a92f3a0a7",
    "name": "Кассир Кладкин"
  },
  "retailStore": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/retailstore/ffa5bbf4-351b-11e9-9ff4-34e800131be8",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/retailstore/metadata",
      "type": "retailstore",
      "mediaType": "application/json"
    },
    "id": "ffa5bbf4-351b-11e9-9ff4-34e800131be8",
    "name": "Точка продаж"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/retailshift/7e41bd3c-351c-11e9-9ff4-34e80012cfc1",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/retailshift/metadata",
      "type": "retailshift",
      "mediaType": "application/json"
    },
    "id": "7e41bd3c-351c-11e9-9ff4-34e80012cfc1",
    "name": "00002",
    "open": "2019-02-20 17:33:00.000",
    "proceed": 3000000
  }
}

Смена закрыта

Тип уведомления

NotificationRetailShiftClosed - смена закрыта

Атрибуты уведомления

• meta - Метаданные объекта Необходимое
• id - ID Уведомления в формате UUID Необходимое
• accountId - ID учетной записи Необходимое
• created - Дата и время формирования Уведомления Необходимое
• read - Признак того, было ли Уведомление прочитано Необходимое
• title - Краткий текст уведомления Необходимое
• description - Описание уведомления Необходимое
• user - Ссылка на сотрудника, отрывшего смену Необходимое
• retailStore - Ссылка на точку продаж Необходимое
• retailShift - Описание смены Необходимое
  • meta - Метаданные
  • id - Идентификатор смены
  • name - Название смены
  • open - Дата открытия
  • closed - Дата закрытия
  • proceed - Сумма выручки
• sales - Количество продаж Необходимое
• returns - Количество возвратов Необходимое

Параметры

Параметр	Описание
id	string (required) Example: 3929d717-351c-11e9-9ff4-34e800029ad4 id Уведомления.

Запрос на получение Уведомления с указанным id.

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

curl -X GET
  "https://online.moysklad.ru/api/remap/1.2/notification/3929d717-351c-11e9-9ff4-34e800029ad4"
  -H "Authorization: Basic <Credentials>"

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

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

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.2/notification/3929d717-351c-11e9-9ff4-34e800029ad4",
    "type": "NotificationRetailShiftClosed",
    "mediaType": "application/json"
  },
  "id": "3929d717-351c-11e9-9ff4-34e800029ad4",
  "accountId": "45eb22e0-0e7b-11e2-1c31-3c4a92f3a0a7",
  "created": "2019-02-20 17:31:34.000",
  "read": true,
  "title": "Закрыта смена в Точка продаж",
  "description": "Кассир: Кассир Кладкин. Длительность: 1 мин. Продаж: 2. Возвратов: 0. Выручка: 40000.00",
  "user": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/employee/4d4ba195-0e7b-11e2-480d-3c4a92f3a0a7",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    },
    "id": "4d4ba195-0e7b-11e2-480d-3c4a92f3a0a7",
    "name": "Кассир Кладкин"
  },
  "retailStore": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/retailstore/ffa5bbf4-351b-11e9-9ff4-34e800131be8",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/retailstore/metadata",
      "type": "retailstore",
      "mediaType": "application/json"
    },
    "id": "ffa5bbf4-351b-11e9-9ff4-34e800131be8",
    "name": "Точка продаж"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.2/entity/retailshift/08fd47a8-351c-11e9-9109-f8fc0013f6cd",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.2/entity/retailshift/metadata",
      "type": "retailshift",
      "mediaType": "application/json"
    },
    "id": "08fd47a8-351c-11e9-9109-f8fc0013f6cd",
    "name": "00001",
    "open": "2019-02-20 17:30:00.000",
    "close": "2019-02-20 17:31:11.000",
    "proceed": 4000000
  },
  "sales": 2,
  "returns": 0
}

Настройки уведомлений

Атрибуты сущности

• groups - Подписка на уведомления по группам
  • groupName - Код группы уведомлений
  • enabled: (boolean, required) - Признак "активна" для подписки на уведомления данной группы
  • channels: (array[string], required) - Массив каналов. Содержит значения из списка: email (Email-уведомления), push (уведомления на мобильных устройствах)

Значения кода группы уведомлений.

Код группы уведомлений	Описание
customer_order	Заказы покупателей
invoice	Счета покупателей
stock	Складские остатки
retail	Розничная торговля
task	Задачи
data_exchange	Обмен данными

Получить настройки уведомлений

Запрос настроек Уведомлений текущего пользователя.

Запрос настроек Уведомлений текущего пользователя.

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

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

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

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

{
  "groups" : {
    "customer_order" : {
      "enabled" : true,
      "channels" : [ "email", "push" ]
    },
    "invoice" : {
      "enabled" : true,
      "channels" : [ "email", "push" ]
    },
    "stock" : {
      "enabled" : true,
      "channels" : [ "email", "push" ]
    },
    "retail" : {
      "enabled" : true,
      "channels" : [ "email", "push" ]
    },
    "task" : {
      "enabled" : true,
      "channels" : [ "email", "push" ]
    },
    "data_exchange" : {
      "enabled" : true,
      "channels" : [ "email", "push" ]
    }
  }
}

Изменить настройки уведомлений

Изменение настроек Уведомлений текущего пользователя.

Изменение настроек Уведомлений текущего пользователя.

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

  curl -X PUT
    "https://online.moysklad.ru/api/remap/1.2/notification/subscription"
    -H "Authorization: Basic <Credentials>"
    -H "Content-Type: application/json"
      -d '{
            "groups" : {
              "customer_order" : {
                "enabled" : true,
                "channels" : [ "email", "push" ]
              },
              "invoice" : {
                "enabled" : true,
                "channels" : [ "email", "push" ]
              },
              "stock" : {
                "enabled" : true,
                "channels" : [ "email", "push" ]
              },
              "retail" : {
                "enabled" : true,
                "channels" : [ "email", "push" ]
              },
              "task" : {
                "enabled" : true,
                "channels" : [ "email", "push" ]
              },
              "data_exchange" : {
                "enabled" : true,
                "channels" : [ "email", "push" ]
              }
            }
          }'

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