Отправка уведомлений клиентам реселлера о готовности закрывающих документов

Метод Send notifications on closing documents используется для формирования события Закрывающие документы сформированы (см. Создание события уведомлений). Это событие запускает отправку клиентам текущего реселлера или любого из его нижестоящих реселлеров уведомлений о готовности в платформе закрывающих документов в статусе Новый из внешней ERP-системы за указанный период.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/notifications/external_invoices

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	number	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
account_ids	form	array	Обязательный	Список ID клиентов, для которых будут отправлены уведомления. ID в списке указываются через запятую
start_date	form	string	Обязательный	Дата начала финансового периода, за который выставлены закрывающие документы, в формате ГГГГ-ММ-ДД
end_date	form	string	Обязательный	Дата окончания финансового периода, за который выставлены закрывающие документы, в формате ГГГГ-ММ-ДД

Модель ответа

В случае успеха метод возвращает null и статус 200 OK.

Факт отправки уведомлений для события Закрывающие документы сформированы можно проверить с помощью журнала уведомлений (см. Журнал уведомлений).

Если массив account_ids пустой или имеет неверный формат, метод возвращает описание ошибки и статус 422 (Unprocessable Entity). Уведомления отправлены не будут.

{
    "errors": {
        "title": "param is missing or the value is empty: account_ids",
        "status": "422"
    }
}

Пример запроса

POST /api/v3/resellers/1/accounts/505/notifications/external_invoices
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "account_ids": [
        2003421,
        2003565,
        2013289,
        2013459
    ],
    "start_date": "2019-11-01",
    "end_date": "2019-11-30"
}

Пример ответа

Status: 200 OK
Body: null