NAV Navbar
cURL

Аудит

Аудит

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

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

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

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

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

Контексты

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

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

Возможные значение параметра 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
exportediclient1c Экспорт в 1С Клиент ЭДО
importediclient1c Импорт в 1С Клиент ЭДО

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

События

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

Типы Событий

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

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

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

Формат поля 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 Контекста.

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

Фильтры

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

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

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

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

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

Значение параметра eventType Описание
create Создание сущностей
update Изменение сущностей
delete Удаление сущностей
puttorecyclebin Помещение в корзину
restorefromrecyclebin Извлечение из корзины
puttoarchive Помещение в архив
restorefromarchive Извлечение из архива
print Печать документа
openpublication Создание публикации
closepublication Удаление публикации
sendemailfromentity Отправка письма
bulkoperation Массовая операция
replacetoken Смена токена для Точки продаж
Значение параметра 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 Работа со сценариями
exportediclient1c Экспорт в 1С Клиент ЭДО
importediclient1c Импорт в 1С Клиент ЭДО
Значение параметра 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 названия сущностей, по которым могут быть отфильтрованы сущности аудита

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

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

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

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

Уведомления

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

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

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

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

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

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

Параметры

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

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

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

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

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

Уведомление

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

Параметры

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

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

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

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

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

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

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

Параметры

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

Запрос на удаление Уведомления с указанным 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 совпадает с форматом поля, изменение которого отображается. Одно из полей может быть не заполнено.

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

Новый заказ

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

Атрибуты

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

Задача снята

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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