Завершение акта по модели Постоплата для клиента реселлера

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

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

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

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

По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/complete_invoices

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathnumberОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
account_idpathnumberОбязательныйID клиента
document_idformstringОбязательныйНомер счета на оплату, для которого требуется подтвердить платеж
billing_dateformstringОбязательныйДата начала финансового периода, за который выставлен акт, в формате ГГГГ-ММ-ДД (вычисляемое значение, в платформе не хранится)

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

Название

Тип данных

Описание

dataobjectДанные ответа


id

string

ID акта в платформе

typestringТип данных

attributesobjectИнформация об акте


created_at

dateДата и время создания акта


updated_at

dateДата и время последнего обновления акта


document_id

stringНомер акта


status

stringСтатус акта


total

stringОбщая сумма акта


account_id

integerID клиента, которому выставлен акт


from_date

dateДата начала периода, за который выставлен акт


to_date

dateДата окончания периода, за который выставлен акт


payment_model

string

Модель оплаты акта:

  • postpay — Постоплата.

Ошибки

СтатусКод ошибкиТекст ошибкиКомментарий
400INVOICE-0001Required parameters are not providedНеобходимо указать в запросе все обязательные параметры
404INVOICE-0002Invoice for billing date {billing_date} was not found for account id {account_id}
  • У клиента отсутствует акт для указанной даты начала финансового периода.
  • Акт для указанной даты начала финансового периода имеет нулевую сумму. Подтвердить платеж по такому акту невозможно, потому что акт не содержит информацию о подписках, по которым был сгенерирован.
422INVOICE-0004Unable 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": "0.32",
            "account_id": 505,
            "from_date": "2019-04-17",
            "to_date": "2019-05-01",
            "payment_model": "postpay"
        }
    }
}