Подтверждение акта по модели Постоплата по ID

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

  • Сторонняя ERP-система опционально может прикрепить к платежу, связанному с актом по модели Постоплата, для которого выполняется подтверждение, файл счета на оплату или ссылку на него.
  • В платформе для платежа будет установлена дата отсрочки согласно правилу обслуживания клиента.

После получения оплаты по выставленному счету необходимо подтвердить платеж в платформе с помощью метода Завершение акта по модели Постоплата по ID. Опционально также доступно подтверждение платежа вручную в Панели управления Оператора (см. Обработка платежа с выставлением счета сторонней ERP-системой).

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

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

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

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

Аргументы

Название

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

Тип данных

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

Описание

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

dataformstringОпциональный

Счет на оплату в кодировке base64. Обязательный, если указываются сведения о файле

Максимальный размер прикрепляемого файла зависит от настроек конкретной инсталляции и может быть изменен по обращению в службу технической поддержки.


nameformstringОпциональныйИмя файла счета на оплату. Обязательный, если указываются сведения о файле
linkformobjectОпциональныйСведения о ссылке на файл счета на оплату, сформированного в сторонней ERP-системе. Можно указать или сведения о файле, или сведения о ссылке на файл, но не то и другое вместе

dataformstringОпциональныйСсылка на файл счета на оплату. Обязательный, если указываются сведения о ссылке на файл

nameformstringОпциональныйИмя файла счета на оплату по ссылке. Обязательный, если указываются сведения о ссылке на файл

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

Название

Тип данных

Описание

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


id

string

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

typestringТип данных

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


created_at

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


updated_at

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


document_id

stringНомер акта


status

stringСтатус акта


total

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


account_id

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


from_date

stringДата начала периода, за который выставлен акт, в формате ГГГГ-ММ-ДД


to_date

stringДата окончания периода, за который выставлен акт, в формате ГГГГ-ММ-ДД


payment_model

string

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

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

relationshipsobjectПеречень объектов, связанных с актом


subscriptionsobjectИнформация о подписках



dataarray of objects

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


paymentsobjectИнформация о платеже



dataarray of objects

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


chargesobjectИнформация о списаниях



dataarray of objects

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


correctionsobjectИнформация о корректировках



dataarray of objects

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных

Ошибки

СтатусКод ошибкиТекст ошибкиКомментарий
400INVOICE-0001Required parameters are not providedНеобходимо указать в запросе все обязательные параметры
INVOICE-0005Неверно указан финансовый день для счетаУказанная дата начала финансового периода billing_date не соответствует указанному акту
INVOICE-0007Только счет с моделью оплаты Постоплата может быть подтвержденУказанный акт не относится к модели Постоплата и поэтому не может быть подтвержден (см. Получение информации об акте)
INVOICE-0008Только счет в статусе Закрыт может быть подтвержденСтатус указанного акта отличается от Закрыт, и поэтому он не может быть подтвержден (см. Получение информации об акте)
INVOICE-0009Только ненулевой счет может быть подтвержденСумма указанного акта равна нулю, и поэтому он не может быть подтвержден (см. Получение информации об акте)
422INVOICE-0003Unable to approve Invoice one more timeАкт уже подвержен

Only one attribute can be present: file or linkМожно указать или сведения о файле счета на оплату (параметр file), или сведения о ссылке на файл (параметр link), но не то и другое вместе

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

POST /api/v3/resellers/1/invoices/2046/approve
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",
    "file": {
        "data": "data:application/pdf;base64,'SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdpbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBpbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29ycmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJlbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUuZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikgVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFydCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9jZXNzLg=='",
        "name": "Invoice NS2000015"
    }
}

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

{
    "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"
        },
        "relationships": {
            "subscriptions": {
                "data": [
                    {
                        "id": "3009839",
                        "type": "subscriptions"
                    }
                ]
            },
            "payments": {
                "data": [
                    {
                        "id": "12201",
                        "type": "payments"
                    }
                ]
            },
            "charges": {
                "data": [
                    {
                        "id": "323740",
                        "type": "charges"
                    }
                ]
            },
            "corrections": {
                "data": []
            }
        }
    }
}