Получение информации об акте
Метод Get invoice используется для получения информации об акте. Метод позволяет получить информацию об актах для текущего реселлера и любого из его нижестоящих реселлеров. Подробнее об актах см. Просмотр списка актов.
Для авторизации требуется API-токен сотрудника. API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 акта, о котором запрашивается информация | ||||||||||||
include | query | string | Опциональный | Предназначен для включения в ответ дополнительной информации о объектах, связанных с актом. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:
|
Модель ответа
Название | Тип данных | Описание | |||||
---|---|---|---|---|---|---|---|
data | object | Данные ответа | |||||
id | integer | 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 | Модель оплаты акта. Возможные значения:
| |||||
relationships | object | Список включенных в акт подписок, платежей, списаний и корректировок | |||||
subscriptions | object | Список подписок, включенных в акт | |||||
data | array | ||||||
id | integer | ID подписки | |||||
type | string | Тип данных | |||||
payments | object | Список платежей, включенных в акт | |||||
data | array | ||||||
id | integer | ID платежа | |||||
type | string | Тип данных | |||||
charges | object | Список списаний, включенных в акт | |||||
data | array | ||||||
id | integer | ID списания | |||||
type | string | Тип данных | |||||
corrections | array | Список корректировок, включенных в акт (см. Создание корректировки) | |||||
data | array | ||||||
id | integer | ID корректировки | |||||
type | string | Тип данных | |||||
included | array | Подробная информация о включенных в акт подписках, платежах, корректировках, списаниях | |||||
id | integer | ID подписки | |||||
type | string | Тип данных | |||||
attributes | array | Информация о подписке | |||||
created_at | date | Дата и время создания подписки | |||||
updated_at | date | Дата и время последнего изменения подписки | |||||
auto_renewal | boolean |
| |||||
billing_from | date | Начало платного периода подписки | |||||
expiration_date | date | Дата истечения подписки | |||||
name | string | Название подписки | |||||
renew_point_days | Точка автоматического продления подписки (см. Просмотр и обновление информации о подписке) | ||||||
start_date | date | Дата активации подписки | |||||
status | string | Статус подписки (список статусов см. в Просмотр списка подписок) | |||||
payment_model | string | Модель оплаты подписки. Возможные значения:
| |||||
payment_model_parameters | object | Параметры модели оплаты подписки | |||||
credit_limit | float | Величина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay | |||||
current_debt | float | Величина текущей задолженности по подписке. Возвращается только для payment_model = postpay | |||||
id | integer | ID платежа | |||||
type | string | Тип данных | |||||
attributes | array | Информация о платеже | |||||
created_at | date | Дата и время создания платежа | |||||
updated_at | date | Дата и время последнего изменения платежа | |||||
account_id | integer | ID клиента | |||||
discount_amount | float | Величина скидки | |||||
total | float | Общая сумма платежа | |||||
comment | string | Дополнительная информация о платеже | |||||
status | string | Статус платежа (см. Типы платежей) | |||||
document_id | string | Номер платежа (см. Просмотр списка платежей) | |||||
expiration_date | date | Дата истечения платежа | |||||
payment_method_id | integer | ID способа оплаты (см. Просмотр списка способов оплаты) | |||||
requester_ip | string | IP-адрес плательщика | |||||
payment_method_name | string | Название способа оплаты | |||||
closed_at | date | Дата и время завершения платежа. Если платеж еще не оплачен, то возвращается null | |||||
relationships | object | Информация об объектах, связанных с платежом | |||||
orders | object | Список оплачиваемых заказов | |||||
data | array | ||||||
id | integer | ID заказа | |||||
type | string | Тип данных | |||||
invoices | object | Список актов | |||||
data | array | ||||||
id | integer | ID акта | |||||
type | string | Тип данных | |||||
reseller | object | Информация о реселлере | |||||
data | object | ||||||
id | integer | ID реселлера | |||||
type | string | Тип данных | |||||
account | object | Информация о клиенте | |||||
data | object | ||||||
id | integer | ID клиента | |||||
type | string | Тип данных | |||||
payment_method | object | Информация о методе оплаты | |||||
data | object | ||||||
id | integer | ID метода оплаты | |||||
type | string | Тип данных | |||||
id | integer | ID списания | |||||
type | string | Тип данных | |||||
attributes | array | Информация о списании | |||||
created_at | date | Дата и время создания списания | |||||
updated_at | date | Дата и время последнего изменения списания | |||||
subscription_id | integer | ID подписки | |||||
subscription_resource_id | integer | ID ресурса в подписке клиента | |||||
quantity | integer | Количество заказанных единиц услуги или ресурса | |||||
operate_from | date | Дата начала периода, оплаченного списанием | |||||
duration | float | Период списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24 | |||||
description | string | Подробная информация о списании | |||||
unit_price | float | Стоимость единицы ресурса или услуги у выбранного реселлера | |||||
amount | float | Общая сумма списания | |||||
status | string | Статус списания (см. Атрибуты списаний) | |||||
type | string | Тип списания (список типов см. в Атрибуты списаний) | |||||
net_cost | float | Себестоимость списания для выбранного реселлера | |||||
taxes_amount | float | Суммарная величина налога для списания (см. Добавление налогов для списаний в модели Постоплата) | |||||
subscription_resource_name | string | Имя ресурса в подписке | |||||
plan_resource_id | integer | ID ресурса в тарифном плане | |||||
resource_id | integer | ID ресурса в шаблоне услуги | |||||
order_id | integer | ID заказа, по которому произведено списание | |||||
operate_to | date | Дата окончания периода, оплаченного списанием | |||||
close_date | date | Дата, когда списание должно быть закрыто. Для списаний в статусе Закрыто — дата закрытия списания | |||||
discount | float | Величина скидки | |||||
relationships | array | Список налогов для списания (см. Добавление налогов для списаний в модели Постоплата) | |||||
taxes | array | ||||||
data | array | ||||||
id | integer | ID налога | |||||
type | string | Тип данных | |||||
id | integer | ID налога | |||||
type | string | Тип данных | |||||
attributes | array | Подробная информация о налоге | |||||
created_at | date | Дата и время создания налога | |||||
updated_at | date | Дата и время последнего изменения налога | |||||
charge_id | integer | ID списания, для которого добавлен налог | |||||
name | string | Название налога | |||||
description | string | Описание и дополнительная информация о налоге | |||||
value | float | Величина налога с точностью до сотых | |||||
id | integer | ID корректировки (см. Управление корректировками) | |||||
type | string | Тип данных | |||||
attributes | array | Подробная информация о корректировке | |||||
created_at | date | Дата и время создания корректировки | |||||
updated_at | date | Дата и время обновления корректировки | |||||
account_id | integer | ID клиента | |||||
status | string | Статус корректировки | |||||
total | float | Сумма корректировки | |||||
comment | string | Дополнительная информация о корректировке | |||||
period_from | date | Начало и конец периода, за который производилась корректировка | |||||
period_to | date | ||||||
approved_at | date | Дата и время подтверждения корректировки | |||||
subscription_id | integer | ID подписки, для которой была создана корректировка |
Пример запроса
GET /api/v3/resellers/1/invoices/2046?include=subscriptions,payments,charges,corrections,taxes
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": {
"id": "2046",
"type": "invoices",
"attributes": {
"created_at": "2019-09-11T09:02:01.257560+0300",
"updated_at": "2019-10-13T06:12:41.990713+0300",
"document_id": "001800",
"status": "closed",
"total": "0.32",
"account_id": 453,
"from_date": "2019-09-10",
"to_date": "2019-10-10",
"payment_model": "postpay"
},
"relationships": {
"subscriptions": {
"data": [
{
"id": "3005665",
"type": "subscriptions"
},
{
"id": "3005201",
"type": "subscriptions"
}
]
},
"payments": {
"data": [
{
"id": "6396",
"type": "payments"
}
]
},
"charges": {
"data": [
{
"id": "73228",
"type": "charges"
}
]
},
"corrections": {
"data": []
}
}
},
"included": [
{
"id": "3005665",
"type": "subscriptions",
"attributes": {
"created_at": "2019-08-30T00:15:43.769169+0300",
"updated_at": "2019-10-11T21:31:07.417465+0300",
"auto_renewal": false,
"billing_from": "2019-09-01",
"expiration_date": "2119-10-20",
"name": "Azure stub",
"renew_point_days": 0,
"start_date": "2019-08-29",
"status": "deleted",
"payment_model": "postpay",
"payment_model_parameters": {
"credit_limit": 100.0,
"current_debt": 0.06
}
}
},
{
"id": "3005201",
"type": "subscriptions",
"attributes": {
"created_at": "2019-11-06T10:54:02.357325+0300",
"updated_at": "2019-11-06T10:59:16.533047+0300",
"auto_renewal": false,
"billing_from": null,
"expiration_date": "2119-10-20",
"name": "Dr Web",
"renew_point_days": 0,
"start_date": null,
"status": "installing",
"payment_model": "postpay",
"payment_model_parameters": {
"credit_limit": 100.0,
"current_debt": 0.0
}
}
},
{
"id": "6396",
"type": "payments",
"attributes": {
"created_at": "2019-10-11T09:00:02.876392+0300",
"updated_at": "2019-10-11T09:00:02.876392+0300",
"account_id": 453,
"discount_amount": "0.0",
"total": "0.32",
"comment": "Платеж для модели Постоплата",
"status": "waiting_for_payment",
"document_id": "2005194",
"expiration_date": "2019-11-10",
"payment_method_id": null,
"requester_ip": null,
"manager_id": null,
"payment_method_name": null,
"closed_at": null
},
"relationships": {
"orders": {
"data": []
},
"invoices": {
"data": [
{
"id": "2046",
"type": "invoices"
}
]
},
"reseller": {
"data": {
"id": "1",
"type": "resellers"
}
},
"account": {
"data": {
"id": "453",
"type": "accounts"
}
},
"payment_method": {
"data": null
}
}
},
{
"id": "73228",
"type": "charges",
"attributes": {
"created_at": "2019-09-11T10:01:45.726138+0300",
"updated_at": "2019-10-10T09:00:03.368862+0300",
"subscription_id": 3005665,
"subscription_resource_id": null,
"quantity": 1.0,
"operate_from": "2019-09-11",
"duration": 0.07911273,
"description": "\"Fee for consumed resources of subscription #3005665 \"Azure stub\"",
"unit_price": "4.0",
"amount": "0.32",
"status": "closed",
"type": "Charge::ExternalResource",
"net_cost": null,
"taxes_amount": 0,
"subscription_resource_name": null,
"plan_resource_id": null,
"resource_id": null,
"order_id": null,
"operate_to": "2019-10-09",
"close_date": "2019-10-09",
"discount": "0.00"
},
"relationships": {
"taxes": {
"data": []
},
"reseller": {
"data": {
"id": "1",
"type": "resellers"
}
},
"account": {
"data": {
"id": "453",
"type": "accounts"
}
},
"subscription": {
"data": {
"id": "3005665",
"type": "subscriptions"
}
},
"plan": {
"data": {
"id": "880",
"type": "plans"
}
},
"discount": {
"data": null
}
}
}
]
}