Получение списка актов

Метод Get list of invoices используется для получения списка актов. Метод позволяет получить список актов для текущего реселлера и любого из его нижестоящих реселлеров.

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

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

filter[created_at]

query

string

Опциональный

Фильтрация списка по дате создания акта в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339)

filter[updated_at]

query

string

Опциональный

Фильтрация списка по дате обновления акта в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339)

filter[status]

query

string

Опциональный

Фильтрация списка по статусу акта (см. Просмотр списка актов)

filter[account_id]

query

string

Опциональный

Фильтрация списка по ID клиента

filter[from_date]querystringОпциональныйФильтрация по дате начала периода, за который выставлен акт (ГГГГ-ММ-ДД)
filter[to_date]querystringОпциональныйФильтрация по дате окончания периода, за который выставлен акт (ГГГГ-ММ-ДД)
filter[payment_model]querystringОпциональныйФильтрация по модели оплаты акта. Возможные значения:
  • prepay — Предоплата.
  • postpay — Постоплата.
filter[charges]queryboolОпциональный

Фильтрация списка актов в статусе Закрыт по наличию списаний (см. relationships.charges):

  • true — список актов в статусе Закрыт, в которых есть хотя бы одно списание.
  • false — список актов в статусе Закрыт, в которых нет списаний.

page[size]

query

integer

Опциональный

Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number]

query

integer

Опциональный

Параметр постраничной навигации. Номер страницы ответа

includequerystringОпциональный

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

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

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

Название

Тип данных

Описание

dataarray of objectsДанные ответа


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 списания
linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу

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

GET /api/v3/resellers/1/invoices?filter[status]=closed&filter[from_date]=2021-02-01&filter[to_date]=2021-03-01&page[size]=2&page[number]=36&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": "3974",
            "type": "invoices",
            "attributes": {
                "created_at": "2021-03-02T01:13:01.886407+0300",
                "updated_at": "2021-03-02T01:13:02.080438+0300",
                "document_id": "003662",
                "status": "closed",
                "total": "30.0",
                "account_id": 893,
                "from_date": "2021-02-01",
                "to_date": "2021-03-01",
                "payment_model": "prepay",
                "approved": "false"
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3007326",
                            "type": "subscriptions"
                        }
                    ]
                },
                "payments": {
                    "data": []
                },
                "charges": {
                    "data": [
                        {
                            "id": "83106",
                            "type": "charges"
                        }
                    ]
                },
                "corrections": {
                    "data": []
                },
                "taxes": {
                    "data": []
                }
            }
        },
        {
            "id": "3975",
            "type": "invoices",
            "attributes": {
                "created_at": "2021-03-02T01:19:12.771065+0300",
                "updated_at": "2021-03-02T01:19:12.992596+0300",
                "document_id": "003663",
                "status": "closed",
                "total": "54.0",
                "account_id": 108,
                "from_date": "2021-02-01",
                "to_date": "2021-03-01",
                "payment_model": "prepay",
                "approved": "false"
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3002769",
                            "type": "subscriptions"
                        },
                        {
                            "id": "3002770",
                            "type": "subscriptions"
                        },
                        {
                            "id": "3002771",
                            "type": "subscriptions"
                        }
                    ]
                },
                "payments": {
                    "data": []
                },
                "charges": {
                    "data": [
                        {
                            "id": "22719",
                            "type": "charges"
                        },
                        {
                            "id": "22840",
                            "type": "charges"
                        },
                        {
                            "id": "22962",
                            "type": "charges"
                        },
                        {
                            "id": "23083",
                            "type": "charges"
                        },
                        {
                            "id": "23204",
                            "type": "charges"
                        },
                        {
                            "id": "23326",
                            "type": "charges"
                        },
                        {
                            "id": "23447",
                            "type": "charges"
                        },
                        {
                            "id": "23568",
                            "type": "charges"
                        },
                        {
                            "id": "23690",
                            "type": "charges"
                        }
                    ]
                },
                "corrections": {
                    "data": []
                },
                "taxes": {
                    "data": []
                }
            }
        }
    ],
    "included": [
        {
            "id": "3007326",
            "type": "subscriptions",
            "attributes": {
                ...
            }
        },
        {
            "id": "83106",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "3002769",
            "type": "subscriptions",
            "attributes": {
                ...
            }
        },
        {
            "id": "3002770",
            "type": "subscriptions",
            "attributes": {
                ...
            }
        },
        {
            "id": "3002771",
            "type": "subscriptions",
            "attributes": {
                ...
            }
        },
        {
            "id": "22719",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "22840",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "22962",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "23083",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "23204",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "23326",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "23447",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "23568",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "23690",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2021-02-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2021-03-01&include=subscriptions%2Cpayments%2Ccharges%2Ccorrections%2Ctaxes&page%5Bnumber%5D=36&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2021-02-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2021-03-01&include=subscriptions%2Cpayments%2Ccharges%2Ccorrections%2Ctaxes&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2021-02-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2021-03-01&include=subscriptions%2Cpayments%2Ccharges%2Ccorrections%2Ctaxes&page%5Bnumber%5D=35&page%5Bsize%5D=2",
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2021-02-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2021-03-01&include=subscriptions%2Cpayments%2Ccharges%2Ccorrections%2Ctaxes&page%5Bnumber%5D=36&page%5Bsize%5D=2"
    }
}