Подтверждение акта по модели Постоплата по ID
Метод Approve postpaid invoice by ID используется для подтверждения акта по модели Постоплата по указанному ID с помощью счета на оплату, выставленного клиенту реселлера сторонней ERP-системой (см. Управление актами по модели Постоплата сторонней ERP-системой). Этот метод используется, если у клиента есть несколько актов за один финансовый период и нужно указать ID конкретного акта. Если у клиента только один акт за финансовый период, можно также использовать другой метод без указания ID акта — см. Подтверждение акта по модели Постоплата для клиента реселлера.
В результате:
- Сторонняя ERP-система опционально может указать сумму и валюту счета на оплату. При этом:
- Сумма и валюта акта и связанного платежа в платформе остаются без изменений.
- В Панели управления Клиента для платежа отображается сообщение с указанными суммой и валютой счета.
- Если указанные сумма и валюта счета отличаются от суммы подтверждаемого акта и валюты реселлера в платформе, клиент не сможет оплатить счет с баланса. Доступны только другие способы оплаты, в том числе на основе коннекторов платежных шлюзов (см. Управление коннекторами платежных шлюзов). При переходе на страницу выбранного способа оплаты (см. Способы оплаты) клиенту к оплате выставляются указанная сумма и валюта счета. Сумма платежа в платформе не изменяется, в том числе после оплаты.
- Если указанные сумма и валюта счета не отличаются от суммы подтверждаемого акта и валюты реселлера в платформе, клиент может оплатить счет с баланса или другим способом оплаты.
- Сумму и валюту счета, указанные при вызове метода, затем можно получить по API из платежа, связанного с актом (см. Получение информации о платеже реселлера).
- Сторонняя ERP-система опционально может прикрепить к платежу в платформе файл счета на оплату или ссылку на него.
- Для платежа в платформе будет установлена дата отсрочки согласно правилу обслуживания клиента.
- Срабатывает событие уведомлений Счет был подтвержден (см. Создание события уведомлений).
После получения оплаты по выставленному счету необходимо подтвердить платеж в платформе с помощью метода Завершение акта по модели Постоплата по ID.
В Панели управления Оператора опционально доступно подтверждение акта вручную, а также подтверждение или отмена платежа вручную:
- Подтверждение акта вручную с выставлением счета сторонней ERP-системой
- Обработка платежа с выставлением счета сторонней ERP-системой
Платформа проверяет соответствие счета на оплату и акта по дате начала финансового периода, к которому относится акт (billing_date
).
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/approve
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | |
---|---|---|---|---|---|
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 | Обязательный | Номер счета на оплату, для которого требуется подтвердить акт | |
billing_date | form | string | Обязательный | Финансовый день (ГГГГ-ММ-ДД) — дата начала финансового периода, с которым связан акт | |
amount | form | object | Опциональный | Сведения о сумме счета на оплату, сформированном в сторонней ERP-системе. Указывается, если сумма или валюта счета на оплату отличаются от суммы акта и валюты реселлера в платформе (см. total в Получение информации об акте и currency в Получение информации о реселлере) | |
total | form | string | Опциональный | Сумма счета на оплату, для которого требуется подтвердить акт. Сумма счета должна быть больше 0. Обязательный при наличии amount | |
currency | form | string | Опциональный | ISO-код валюты счета на оплату, для которого требуется подтвердить акт. Можно указать код любой валюты в платформе (см. Получение списка курсов валют реселлера). Обязательный при наличии amount | |
attachment | form | object | Опциональный | Сведения о счете на оплату, сформированном в сторонней ERP-системе. Указывается, если требуется прикрепить счет на оплату к платежу в платформе | |
type | form | string | Опциональный | Тип вложения. Доступные значения:
Обязательный при наличии | |
data | form | string | Опциональный | Сведения о файле счета на оплату, сформированного в сторонней ERP-системе:
Обязательный при наличии | |
name | form | string | Опциональный | Имя файла счета на оплату для отображения в уведомлении клиенту. Обязательный при наличии Имя файла не может содержать символ |
Модель ответа
Название | Тип данных | Описание | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object | Данные ответа | |||||||||||||
id | string | ID акта в платформе | |||||||||||||
type | string | Тип данных | |||||||||||||
attributes | object | Информация об акте | |||||||||||||
created_at | string | Дата и время создания акта | |||||||||||||
updated_at | string | Дата и время последнего обновления акта | |||||||||||||
document_id | string | Номер акта | |||||||||||||
status | string | Статус акта | |||||||||||||
total | string | Общая сумма акта в валюте реселлера в платформе Сумма акта и связанного платежа не учитывают сумму и валюту счета, указанные при вызове метода в параметре Сумму и валюту счета, указанные при вызове метода в параметре | |||||||||||||
account_id | integer | ID клиента, которому выставлен акт | |||||||||||||
from_date | string | Дата начала периода, за который выставлен акт, в формате ГГГГ-ММ-ДД | |||||||||||||
to_date | string | Дата окончания периода, за который выставлен акт, в формате ГГГГ-ММ-ДД | |||||||||||||
payment_model | string | Модель оплаты акта:
| |||||||||||||
relationships | object | Перечень объектов, связанных с актом | |||||||||||||
subscriptions | object | Информация о подписках | |||||||||||||
data | array of objects | Информация о связанном объекте:
| |||||||||||||
payments | object | Информация о платеже | |||||||||||||
data | array of objects | Информация о связанном объекте:
| |||||||||||||
charges | object | Информация о списаниях | |||||||||||||
data | array of objects | Информация о связанном объекте:
| |||||||||||||
corrections | object | Информация о корректировках | |||||||||||||
data | array of objects | Информация о связанном объекте:
|
Ошибки
Статус | Код ошибки | Текст ошибки | Комментарий |
---|---|---|---|
400 | INVOICE-0001 | Required parameters are not provided | Необходимо указать в запросе все обязательные параметры |
INVOICE-0005 | Неверно указан финансовый день для счета | Указанный финансовый день billing_date не соответствует указанному акту | |
INVOICE-0007 | Только счет с моделью оплаты Постоплата может быть подтвержден | Указанный акт не относится к модели Постоплата и поэтому не может быть подтвержден (см. Получение информации об акте) | |
INVOICE-0008 | Только счет в статусе Закрыт может быть подтвержден | Статус указанного акта отличается от Закрыт, и поэтому он не может быть подтвержден (см. Получение информации об акте) | |
INVOICE-0009 | Только ненулевой счет может быть подтвержден | Сумма указанного акта равна нулю, и поэтому он не может быть подтвержден (см. Получение информации об акте) | |
INVOICE-0013 | Значение параметра "total" не может быть меньше 0 либо равное 0 | Указана нулевая или отрицательная сумма счета на оплату total , и поэтому акт не может быть подтвержден | |
INVOICE-0014 | Параметр "currency" содержит валюту, не поддерживаемую реселлером | Указанный код валюты currency не найден для реселлера. Доступные коды валют см. в Получение списка курсов валют реселлера | |
INVOICE-0015 | Параметр "type" содержит неподдерживаемое значение | Проверьте указанный тип вложения type | |
INVOICE-0016 | Платеж, связанный с данным актом, был отменен. Подтверждение акта невозможно | Менеджер вручную отменил связанный платеж (см. Обработка платежа с выставлением счета сторонней ERP-системой). Акт теперь нельзя ни подтвердить, ни завершить | |
INVOICE-0018 | Параметр «data» содержит неподдерживаемый формат файла. Поддерживаемые форматы файлов .PDF, .DOC, .DOCX, .XLS, .XLSX. | Проверьте формат указанного файла счета на оплату data | |
422 | INVOICE-0003 | Unable to approve Invoice one more time | Указанный акт уже подтвержден |
Пример запроса
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",
"amount": {
"total": "123.45",
"currency": "USD"
},
"attachment": {
"type": "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": "987.65",
"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": []
}
}
}
}