Завершение акта

Метод Complete invoice используется для подтверждения платежа, связанного с подтвержденным актом по модели Постоплата (см. Подтверждение акта), с помощью счета на оплату, выставленного клиенту реселлера сторонней ERP-системой (см. Управление актами по модели Постоплата сторонней ERP-системой).

Если у клиента несколько актов за один финансовый период, необходимо использовать другой метод и указать ID конкретного акта — см. Завершение акта по ID.

Опционально также доступно подтверждение акта и платежа вручную в Панели управления Оператора:

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

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

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

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

POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/complete_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_id	path	number	Обязательный	ID клиента
document_id	form	string	Обязательный	Номер счета на оплату, для которого требуется подтвердить платеж
billing_date	form	string	Обязательный	Финансовый день (ГГГГ-ММ-ДД) — дата начала финансового периода, с которым связан акт

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

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

Ошибки

Статус	Код ошибки	Текст ошибки	Комментарий
400	INVOICE-0001	Required parameters are not provided	Необходимо указать в запросе все обязательные параметры
400	INVOICE-0017	Платеж, связанный с данным актом, был отменен. Завершение акта невозможно	Менеджер вручную отменил связанный платеж (см. Обработка платежа с выставлением счета сторонней ERP-системой). Акт теперь нельзя ни подтвердить, ни завершить
404	INVOICE-0002	Invoice for billing date {billing_date} was not found for account id {account_id}	У клиента отсутствует акт для указанного финансового дня `billing_date`. Акт для указанного финансового дня `billing_date` имеет нулевую сумму. Подтвердить платеж по такому акту невозможно, потому что акт не содержит информацию о подписках, по которым был сгенерирован.
422	INVOICE-0004	Unable to complete Invoice one more time	Акт уже завершен

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

POST /api/v3/resellers/1/accounts/505/complete_invoices
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": "NS2000015",
            "status": "closed",
            "total": "987.65",
            "account_id": 505,
            "from_date": "2019-04-17",
            "to_date": "2019-05-01",
            "payment_model": "postpay",
            "approved": "true"
        },
        "relationships": {
            "subscriptions": {
                "data": [
                    {
                        "id": "3009839",
                        "type": "subscriptions"
                    }
                ]
            },
            "payments": {
                "data": [
                    {
                        "id": "12201",
                        "type": "payments"
                    }
                ]
            },
            "charges": {
                "data": [
                    {
                        "id": "323740",
                        "type": "charges"
                    }
                ]
            },
            "corrections": {
                "data": []
            }
        }
    }
}