Получение информации об акте

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

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}

Аргументы

Название

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

Тип данных

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

Описание

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 акта, о котором запрашивается информация
includequerystringОпциональный

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

ОбъектЗначение параметра
Подпискиsubscriptions
Платежиpayments
Списанияcharges
Корректировкиcorrections
Налогиtaxes

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

Название

Тип данных

Описание

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


id

integer

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

Модель оплаты акта. Возможные значения:

  • prepayПредоплата.
  • postpayПостоплата.

relationshipsobjectСписок включенных в акт подписок, платежей, списаний и корректировок


subscriptionsobjectСписок подписок, включенных в акт



dataarray




idintegerID подписки




typestringТип данных


paymentsobjectСписок платежей, включенных в акт



dataarray




idintegerID платежа




typestringТип данных


chargesobjectСписок списаний, включенных в акт



dataarray




idintegerID списания




typestringТип данных


correctionsarrayСписок корректировок, включенных в акт (см. Создание корректировки)



dataarray




idintegerID корректировки




typestringТип данных
includedarrayПодробная информация о включенных в акт подписках, платежах, корректировках, списаниях


idintegerID подписки


typestringТип данных


attributesarrayИнформация о подписке



created_at

date

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



updated_at

date

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



auto_renewalboolean



billing_fromdateНачало платного периода подписки



expiration_datedateДата истечения подписки



name

string

Название подписки



renew_point_days
Точка автоматического продления подписки (см. Просмотр и обновление информации о подписке



start_date

date

Дата активации подписки



status

string

Статус подписки (список статусов см. в Просмотр списка подписок)




payment_model

string

Модель оплаты подписки. Возможные значения:

  • prepayПредоплата.
  • postpayПостоплата.



payment_model_parameters

objectПараметры модели оплаты подписки




credit_limit

floatВеличина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay




current_debt

floatВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay


idintegerID платежа


typestringТип данных


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



created_at

date

Дата и время создания платежа



updated_at

date

Дата и время последнего изменения платежа



account_idintegerID клиента



discount_amountfloatВеличина скидки



totalfloatОбщая сумма платежа



commentstringДополнительная информация о платеже



statusstringСтатус платежа (см. Типы платежей)



document_idstringНомер платежа (см. Просмотр списка платежей)



expiration_datedateДата истечения платежа



payment_method_idintegerID способа оплаты (см. Просмотр списка способов оплаты)



requester_ip

stringIP-адрес плательщика



payment_method_namestringНазвание способа оплаты



closed_at

dateДата и время завершения платежа. Если платеж еще не оплачен, то возвращается null


relationships

objectИнформация об объектах, связанных с платежом



orders

objectСписок оплачиваемых заказов




data

array





id

integerID заказа





type

stringТип данных



invoices

objectСписок актов




dataarray





idintegerID акта





typestringТип данных



reseller

objectИнформация о реселлере




dataobject





idintegerID реселлера





typestringТип данных



account

objectИнформация о клиенте




dataobject





idintegerID клиента





typestringТип данных



payment_method

objectИнформация о методе оплаты




dataobject





idintegerID метода оплаты





typestringТип данных


idintegerID списания


typestringТип данных


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



created_at

date

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



updated_at

date

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



subscription_idintegerID подписки



subscription_resource_idintegerID ресурса в подписке клиента



quantityintegerКоличество заказанных единиц услуги или ресурса



operate_fromdateДата начала периода, оплаченного списанием



durationfloatПериод списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24



descriptionstringПодробная информация о списании



unit_pricefloatСтоимость единицы ресурса или услуги у выбранного реселлера



amountfloatОбщая сумма списания



statusstringСтатус списания (см. Атрибуты списаний)



typestringТип списания (список типов см. в Атрибуты списаний)



net_costfloatСебестоимость списания для выбранного реселлера



taxes_amountfloat

Суммарная величина налога для списания (см. Добавление налогов для списаний в модели Постоплата)




subscription_resource_namestringИмя ресурса в подписке



plan_resource_idintegerID ресурса в тарифном плане



resource_idintegerID ресурса в шаблоне услуги



order_idintegerID заказа, по которому произведено списание



operate_todateДата окончания периода, оплаченного списанием



close_datedate

Дата, когда списание должно быть закрыто.

Для списаний в статусе Закрыто — дата закрытия списания




discountfloatВеличина скидки


relationshipsarrayСписок налогов для списания (см. Добавление налогов для списаний в модели Постоплата)



taxesarray




dataarray





idintegerID налога





typestringТип данных


idintegerID налога


typestringТип данных


attributesarrayПодробная информация о налоге



created_at

date

Дата и время создания налога



updated_at

date

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



charge_idintegerID списания, для которого добавлен налог



namestringНазвание налога



descriptionstringОписание и дополнительная информация о налоге



valuefloatВеличина налога с точностью до сотых


idintegerID корректировки (см. Управление корректировками)


typestringТип данных


attributesarrayПодробная информация о корректировке



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



updated_atdateДата и время обновления корректировки



account_idintegerID клиента



statusstringСтатус корректировки



totalfloatСумма корректировки



commentstringДополнительная информация о корректировке



period_fromdateНачало и конец периода, за который производилась корректировка



period_todate



approved_atdateДата и время подтверждения корректировки



subscription_idintegerID подписки, для которой была создана корректировка

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

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
                }
            }
        }
    ]
}