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

Метод 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

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

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

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


approvedbool

Признак подтвержденного акта по модели Постоплата с внешним управлением (см. Акты с внешним управлением):

  • true — акт по модели Постоплата с внешним управлением, и сторонняя ERP-система его подтвердила.
  • false — в остальных случаях:
    • Акт по модели Постоплата с внешним управлением, и сторонняя ERP-система его не подтвердила.
    • Акт по модели Постоплата, управляемый платформой.
    • Акт по модели Предоплата.

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


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



dataarray

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

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


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



dataarray

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

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


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



dataarray

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

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


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



dataarray

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

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


taxesobjectСписок налогов для списаний, включенных в акт



dataarray

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

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

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных
attributesobjectАтрибуты (состав данных см. ниже)
НазваниеТип данныхОписание
idstringID подписки
typestringТип данных
attributesobjectИнформация о подписке

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

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

auto_renewalbool

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

  • true — автоматическое продление включено.
  • false — автоматическое продление отключено.

billing_fromstringДата начала генерации списаний по подписке в формате ГГГГ-ММ-ДД

expiration_datestringДата истечения срока действия подписки в формате ГГГГ-ММ-ДД

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

auto_renew_point_daysintegerТочка автоматического продления подписки (в днях)

start_datestringДата активации подписки в формате ГГГГ-ММ-ДД

statusstring

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


payment_modelstring

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

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

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


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


current_debtnumberВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay
  • Для корректировки:
НазваниеТип данныхОписание
idstringID корректировки
typestringТип данных
attributesobjectИнформация о корректировке

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

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

account_idintegerID клиента

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

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

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

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

period_tostringКонец периода, за который производилась корректировка

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

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

  • Для налогов — о каждом налоге, использованном при создании списания:

    НазваниеТип данныхОписание
    idstringID налога
    typestringТип данных
    attributesobjectИнформация о налоге

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

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

    		charge_idintegerID списания, для которого рассчитан налог

    		origin_idintegerID налога в налоговом модуле

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

    		codestringКод налога

    		ratenumberРазмер налога в процентах

    		amountstringСумма налога, рассчитанная для net_amount списания

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

GET /api/v3/resellers/1/invoices/3973?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": "3973",
        "type": "invoices",
        "attributes": {
            "created_at": "2021-03-02T01:12:58.186820+0300",
            "updated_at": "2021-03-02T01:12:58.380559+0300",
            "document_id": "003661",
            "status": "closed",
            "total": "220.0",
            "account_id": 906,
            "from_date": "2021-02-01",
            "to_date": "2021-03-01",
            "payment_model": "prepay",
            "approved": "false"
        },
        "relationships": {
            "subscriptions": {
                "data": [
                    {
                        "id": "3007572",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3007576",
                        "type": "subscriptions"
                    }
                ]
            },
            "payments": {
                "data": []
            },
            "charges": {
                "data": [
                    {
                        "id": "85176",
                        "type": "charges"
                    },
                    {
                        "id": "85229",
                        "type": "charges"
                    }
                ]
            },
            "corrections": {
                "data": []
            },
            "taxes": {
                "data": []
            }
        }
    },
    "included": [
        {
            "id": "3007572",
            "type": "subscriptions",
            "attributes": {
                ...
            }
        },
        {
            "id": "3007576",
            "type": "subscriptions",
            "attributes": {
                ...
            }
        },
        {
            "id": "85176",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "85229",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        }
    ]
}