Navbar

Аудит

Аудит

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

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

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

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

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

Контексты

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

Атрибуты сущности
Название Тип Описание
entityType Enum Название сущности (поле присутствует, только если оно одинаково у всех Событий в рамках данного Контекста)
Обязательное при ответе Только для чтения
eventType Enum Действие Событий (поле присутствует, только если оно одинаково у всех Событий в рамках данного Контекста)
Обязательное при ответе Только для чтения
events Array(Object) Список методанных Событий аудита
Обязательное при ответе Только для чтения
id UUID ID Контекста
Обязательное при ответе Только для чтения
info String(255) Краткое описание
Только для чтения
meta Meta Метаданные сущности Контекста
Обязательное при ответе Только для чтения
moment DateTime Дата изменения
Обязательное при ответе Только для чтения
objectCount Int количество измененных объектов
Обязательное при ответе Только для чтения
objectType Enum Тип сущностей, с которыми связанно данное изменение. Поле присутствует только для entityType = entitysettings или statesettings или templatesettings
Обязательное при ответе
source Enum Тип изменения
Обязательное при ответе Только для чтения
supportAccess Boolean Был ли доступ произведен поддержкой от имени пользователя. Флаг отсутствует, если значение false
Обязательное при ответе Только для чтения
uid String(255) Логин Сотрудника
Обязательное при ответе Только для чтения

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

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

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

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

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

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой изменения.

Параметры

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

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

Параметры

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

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

События

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

Типы Событий

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

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

Название Тип Описание
additionalInfo String(4096) Дополнительная информация о Событии
Только для чтения
audit Enum Метаданные контекста
Обязательное при ответе Только для чтения
diff Object Изменения, произошедшие в Событии, в специальном формате diff, описанном в разделе Формат поля diff
Обязательное при ответе Только для чтения
entity Meta Метаданные сущности. Не будет выводиться только для товаров, услуг, модификаций, комплектов удаленных до 20.08.2017
Только для чтения
entityType Enum Название сущности
Обязательное при ответе Только для чтения
eventType Enum Действие События
Обязательное при ответе Только для чтения
moment DateTime Время создания события
Обязательное при ответе Только для чтения
name String(255) Имя сущности
Обязательное при ответе Только для чтения
objectCount Int количество измененных объектов
Обязательное при ответе Только для чтения
objectType Enum Тип сущностей, с которыми связанно данное изменение. Поле присутствует только для entityType = entitysettings или statesettings или templatesettings
Обязательное при ответе
source Enum Тип изменения
Обязательное при ответе Только для чтения
supportAccess Boolean Был ли доступ произведен поддержкой от имени пользователя. Флаг отсутствует, если значение false
Обязательное при ответе Только для чтения
uid String(255) Логин Сотрудника
Обязательное при ответе Только для чтения

Формат поля diff

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

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

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

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

Название Тип Описание
templateName String(255) Название шаблона
Обязательное при ответе Только для чтения
publicationHref URL Ссылка на публикацию
Обязательное при ответе Только для чтения

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

Название Тип Описание
senderEmail String(255) Почта отправителя письма
Обязательное при ответе Только для чтения
targetEmail String(255) Почта получателя письма
Обязательное при ответе Только для чтения
subjectEmail String(255) Тема письма
Обязательное при ответе Только для чтения
text String(255) Текст письма
Обязательное при ответе Только для чтения

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

Название Тип Описание
attributeName String(255) Название атрибута сущности
Обязательное при ответе Только для чтения
oldValue Boolean Значение атрибута до удаления
Обязательное при ответе Только для чтения

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

Название Тип Описание
attributeName String(255) Название атрибута сущности
Обязательное при ответе Только для чтения
oldValue Boolean Значение атрибута до удаления
Обязательное при ответе Только для чтения
newValue Boolean Значение атрибута после обновления
Обязательное при ответе Только для чтения

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

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

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой события.

Параметры

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

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

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

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой события.

Параметры

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

Фильтры

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

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

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

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

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

Значение параметра eventType Описание
bulkoperation Массовая операция
closepublication Удаление публикации
create Создание сущностей
delete Удаление сущностей
openpublication Создание публикации
print Печать документа
puttoarchive Помещение в архив
puttorecyclebin Помещение в корзину
replacetoken Смена токена для Точки продаж
restorefromarchive Извлечение из архива
restorefromrecyclebin Извлечение из корзины
sendemailfromentity Отправка письма
update Изменение сущностей
Значение параметра source Описание
clearrecyclebin Автоматическая очистка корзины
combine Объединение
connectors Синхронизация с ИМ
copy Копирование
emailsend Отправка сообщения
evotor Синхронизация с Эвотор
export Экспорт
exportediclient1c Экспорт в 1С Клиент ЭДО
import Импорт
importediclient1c Импорт в 1С Клиент ЭДО
jsonapi JSON API
loginlogout Вход или выход из МоегоСклада
phone-1.0 Phone API
posapi POS API
restapi REST API
retail Точка продаж
scriptor Работа со сценариями
Значение параметра entityType Описание
accountrole Роль
amiroconnectorsettings Настройка синхронизации (Amiro)
cmlconnectorsettings Настройка синхронизации (CML)
crptcancellation Списание кодов маркировки
crptdemand Отгрузка маркированной продукции
crptpackagecreation Формирование упаковки
crptpackagedisaggregation Расформирование упаковки
crptpackageitemremoval Изъятие из упаковки
ecwidconnectorsettings Настройка синхронизации (Ecwid)
entitysettings Настройки сущностей
evotorsetting Настройка обмена с Эвотор
processingplanfolder Группа тех.карт
scripttemplate Сценарий
smartwebconnectorsettings Настройка синхронизации (SmartWeb)
statesettings Настройки статусов
templatesettings Настройки шаблонов
user Пользователь
usersettings Настройки пользователя
vkconnectorsettings Настройка синхронизации (Вконтакте)
yandexconnectorsettings Настройка синхронизации (Яндекс.Маркет)
ymlconnectorsettings Настройка синхронизации (YML)

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

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

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

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

Уведомления

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

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

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

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

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

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Уведомления.

Параметры

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

Уведомление

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

Параметры

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

Формат измененного поля содержит в себе старое и новое значение:

Название Тип Описание
oldValue String(255) Значение атрибута до удаления
Обязательное при ответе Только для чтения
newValue String(255) Значение атрибута после обновления
Обязательное при ответе Только для чтения

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
actualBalance Int Остаток товара
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
good Meta Метаданные товара
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
minimumBalance Int Неснижаемый остаток товара
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
*agentName String(255) Имя контрагента
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
invoice Meta Метаданные счета
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
paymentPlannedMoment DateTime Запланированная дата оплаты
Обязательное при ответе
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
sum Int Сумма счета
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

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

Новый заказ

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
*agentName String(255) Имя контрагента
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
deliveryPlannedMoment DateTime Планируемое время отгрузки
Обязательное при ответе
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
order Meta Метаданные заказа
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
sum Int Сумма счета
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
*agentName String(255) Имя контрагента
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
deliveryPlannedMoment DateTime Планируемое время отгрузки
Обязательное при ответе
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
order Meta Метаданные заказа
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
sum Int Сумма счета
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

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

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

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

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

Атрибуты

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
daysLeft Int Количество оставшихся дней подписки
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

Задача снята

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
diff Object Измененные поля Подробнее тут
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Измененные поля
Название Тип Описание
description String(255) Изменение описания задачи в формате изменения поля
Обязательное при ответе
deadline String(255) Изменение планируемой даты завершения задачи в формате изменения поля
Обязательное при ответе
agentLink String(255) Изменение контрагента в формате изменения поля
Обязательное при ответе
documentLink String(255) Изменение связанного документа в формате изменения поля
Обязательное при ответе
assignee String(255) Изменение исполнителя в формате изменения поля
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

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

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
noteContent String(4096) Содержимое комментария
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
diff String(255) Изменения комментария в формате изменения поля
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
noteContent String(4096) Содержимое комментария
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
noteContent String(4096) Содержимое комментария
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

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

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
retailShift Object Описание смены
Обязательное при ответе Необходимо при создании
retailStore Object Точка продаж
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании
user Object Сотрудник
Обязательное при ответе Необходимо при создании

Параметры

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

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

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

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

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
retailShift Object Описание смены
Обязательное при ответе Необходимо при создании
retailStore Object Точка продаж
Обязательное при ответе Необходимо при создании
returns Int Количество возвратов
Обязательное при ответе Необходимо при создании
sales Int Количество продаж
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании
user Object Сотрудник
Обязательное при ответе Необходимо при создании

Параметры

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

Уведомление из сценария

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

NotificationScript - уведомление из сценария

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Только для чтения
description String(255) Описание уведомления
Обязательное при ответе Только для чтения
entity Объект Ссылка на объект сценария
Обязательное при ответе Только для чтения
eventType Событие Тип события сценария
Обязательное при ответе Только для чтения
id UUID ID Уведомления
Обязательное при ответе Только для чтения
meta Meta Метаданные объекта
Обязательное при ответе Только для чтения
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Только для чтения
title String(255) Краткий текст уведомления
Обязательное при ответе Только для чтения

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

Событие

Тип события сценария. Возможные значения:

Объект

Объект, на который сработал сценарий.

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

Допустимые значения для meta.type:

Параметры

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

Предупреждение о скором окончании действия доступа к аккаунту Facebook

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

FacebookTokenExpirationNotification - предупреждение о скором окончании действия доступа к аккаунту Facebook

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

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
connectorName String(4096) Название коннектора "Instagram and Facebook"
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
daysLeftToExpiration Int Количество дней, оставшихся до окончания действия доступа к аккаунту Facebook
Обязательное при ответе
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 9596251d-da73-11eb-ac12-000c00000015 id Уведомления.

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

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

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

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

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

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

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

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

Отключение уведомлений из сценариев недопустимо. Параметр enabled игнорируется.

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