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

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

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

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

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

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

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

POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/approve_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	Обязательный	Дата начала финансового периода, за который выставлен акт, в формате ГГГГ-ММ-ДД (вычисляемое значение, в платформе не хранится)
file		form	object	Опциональный	Сведения о файле счета на оплату, сформированного в сторонней ERP-системе. Можно указать или сведения о файле, или сведения о ссылке на файл, но не то и другое вместе
	data	form	string	Опциональный	Счет на оплату в кодировке base64. Обязательный, если указываются сведения о файле Максимальный размер прикрепляемого файла зависит от настроек конкретной инсталляции и может быть изменен по обращению в службу технической поддержки.
	name	form	string	Опциональный	Имя файла счета на оплату. Обязательный, если указываются сведения о файле
link		form	object	Опциональный	Сведения о ссылке на файл счета на оплату, сформированного в сторонней ERP-системе. Можно указать или сведения о файле, или сведения о ссылке на файл, но не то и другое вместе
	data	form	string	Опциональный	Ссылка на файл счета на оплату. Обязательный, если указываются сведения о ссылке на файл
	name	form	string	Опциональный	Имя файла счета на оплату по ссылке. Обязательный, если указываются сведения о ссылке на файл

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

Название			Тип данных	Описание
data			object	Данные ответа
	id		string	ID акта в платформе
	type		string	Тип данных
	attributes		object	Информация об акте
		created_at	date	Дата и время создания акта
		updated_at	date	Дата и время последнего обновления акта
		document_id	string	Номер акта
		status	string	Статус акта
		total	string	Общая сумма акта
		account_id	integer	ID клиента, которому выставлен акт
		from_date	date	Дата начала периода, за который выставлен акт
		to_date	date	Дата окончания периода, за который выставлен акт
		payment_model	string	Модель оплаты акта: postpay — Постоплата.

Ошибки

Статус	Код ошибки	Текст ошибки	Комментарий
400	INVOICE-0001	Required parameters are not provided	Необходимо указать в запросе все обязательные параметры
404	INVOICE-0002	Invoice for billing date {billing_date} was not found for account id {account_id}	У клиента отсутствует акт для указанной даты начала финансового периода. Акт для указанной даты начала Финансового периода имеет нулевую сумму. Подтвердить такой акт невозможно, потому что он не содержит информацию о подписках, по которым был сгенерирован.
422	INVOICE-0003	Unable to approve Invoice one more time	Акт уже подвержен
422		Only one attribute can be present: file or link	Можно указать или сведения о файле счета на оплату (параметр `file`), или сведения о ссылке на файл (параметр `link`), но не то и другое вместе

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

POST /api/v3/resellers/1/accounts/505/approve_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",
    "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"
        }
    }
}