Аннулирование подтверждения акта по ID

Метод Revoke invoice approval by ID используется для отмены (аннулирования) подтверждения акта по модели Постоплата по указанному ID. Этот метод используется, если нужно исправить выставленный счет. В результате аннулирования подтверждения акт, платеж и связанные подписки возвращаются в исходное состояние, информация о внешнем счете удаляется, а для акта снова становится доступно подтверждение (см. Подтверждение акта по ID).

Опционально также доступно аннулирование подтверждения акта вручную в Панели управления Оператора (см. Аннулирование подтверждения акта по модели Постоплата с выставлением счета сторонней ERP-системой).

Аннулирование подтверждения акта недоступно, если связанный платеж уже завершен или отменен.

Платформа проверяет соответствие счета на оплату и акта по дате начала финансового периода, к которому относится акт (billing_date).

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

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

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

POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/revoke

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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 любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
invoice_id	path	integer	Обязательный	ID акта
document_id	form	string	Обязательный	Номер счета на оплату, указанный ранее при подтверждении акта (см. Подтверждение акта по ID)
billing_date	form	string	Обязательный	Финансовый день (ГГГГ-ММ-ДД) — дата начала финансового периода, с которым связан акт

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

Модель ответа аналогична методу Получение информации об акте.

Ошибки

Статус	Код ошибки	Текст ошибки	Комментарий
400	INVOICE-0001	Required parameters are not provided	Необходимо указать в запросе все обязательные параметры
	INVOICE-0005	Неверно указан финансовый день для счета	Указанный финансовый день `billing_date` не соответствует указанному акту
	INVOICE-0006	Неверно указан document_id для счета	Указанный номер счета на оплату `document_id` не соответствует указанному акту
	INVOICE-0019	Платеж, связанный с данным актом, был завершен. Аннулирование подтверждения акта невозможно	Аннулирование подтверждения акта недоступно, если связанный платеж уже завершен или отменен
	INVOICE-0020	Платеж, связанный с данным актом, был отменен. Аннулирование подтверждения акта невозможно
	INVOICE-0021	Только акт с моделью оплаты Постоплата может быть аннулирован	Возможные причины: Акт относится к модели Предоплата. У реселлера не включено внешнее управление актами по модели Постоплата (см. Управление финансовыми настройками).
	INVOICE-0022	Только подтвержденный акт в статусе Закрыт может быть аннулирован	Акт еще не был подтвержден, поэтому аннулирование подтверждения невозможно

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

POST /api/v3/resellers/1/invoices/2046/revoke
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "document_id": "NS2000015",
    "billing_date": "2020-04-01"
}

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

{
    "data": {
        "id": "2046",
        "type": "invoices",
        "attributes": {
            "created_at": "2019-04-18T09:02:01.257560+0300",
            "updated_at": "2019-05-02T06:12:41.990713+0300",
            "document_id": "003661",
            "status": "closed",
            "total": "987.65",
            "account_id": 505,
            "from_date": "2019-04-17",
            "to_date": "2019-05-01",
            "payment_model": "postpay",
            "approved": "false"
        },
        "relationships": {
            "subscriptions": {
                "data": [
                    {
                        "id": "3009839",
                        "type": "subscriptions"
                    }
                ]
            },
            "payments": {
                "data": [
                    {
                        "id": "12201",
                        "type": "payments"
                    }
                ]
            },
            "charges": {
                "data": [
                    {
                        "id": "323740",
                        "type": "charges"
                    }
                ]
            },
            "corrections": {
                "data": []
            }
        }
    }
}