Подтверждение или отклонение корректировки

Метод Update correction status используется для подтверждения или отклонения корректировки. Этот метод может использоваться для автоматизации учета в 1С оплат по платежам, отмененным или оплаченным с баланса клиента (вместе с Создание корректировки). корректировка может быть подтверждена или отклонена для клиента текущего реселлера и любого из его нижестоящих реселлеров. Для подтверждения корректировки может быть настроено событие уведомлений Корректировка баланса подтверждена (см. Создание события уведомлений в Руководство по Панели управления Оператора).

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

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

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

PATCH {base_url}/api/v3/resellers/{reseller_id}/corrections/{correction_id}

{
    "data": {
        "attributes": {
            "status" : "{status}"
        }
    }
}

Аргументы

Название			Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
correction_id			path	integer	Обязательный	ID корректировки. Для подтверждения или отклонения корректировка должна иметь текущий статус Необходимо подтверждение (`approval_required`).
data			form	object	Обязательный	Информация об атрибутах операции
	attributes		form	object	Обязательный	Атрибуты операции
		status	form	string	Обязательный	Целевой статус корректировки: approved — если корректировку необходимо подтвердить. В результате подтверждения корректировки в платформе будут выполнены действия, описанные в статье Подтверждение корректировки. Также Владельцу клиента может быть отправлено уведомление Корректировка баланса подтверждена (см. Создание события уведомлений). declined — если корректировку необходимо отклонить.

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

В случае отсутствия ошибок метод возвращает данные о корректировке (см. модель ответа в Создание корректировки).

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

PATCH /api/v3/resellers/1/corrections/correction/738
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "data": {
        "attributes": {
            "status" : "approved"
        }
    }
}

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

{
    "data": {
        "id": "738",
        "type": "corrections",
        "attributes": {
            "created_at": "2021-08-10T12:18:42.721974+0300",
            "updated_at": "2021-08-10T12:19:36.144666+0300",
            "account_id": 710,
            "manager_id": 225,
            "status": "approved",
            "total": "100.25",
            "included_invoice": true,
            "subscription_id": 3008954,
            "period_from": "2021-12-01",
            "period_to": "2021-12-31",
            "comment": "top-up payment",
            "approved_at": "2021-08-10"
        }
    }
}