Получение статистики закрывающих документов

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

GET {reseller_domain}/internal_api/accounts/{account_id}/external_invoice_statistics

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается статистика закрывающих документов

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

Название		Тип данных	Описание
count_by_types		object	Число закрывающих документов каждого типа. Если нет ни одного закрывающего документа какого-либо типа, соответствующий элемент объекта отсутствует
	invoice	integer	Число закрывающих документов типа Счет
	invoice_vat	integer	Число закрывающих документов типа Счет-фактура
	act	integer	Число закрывающих документов типа Акт
count		integer	Общее число закрывающих документов

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1707/external_invoice_statistics' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
    "count_by_types": {
        "invoice": 3
    },
    "count": 3
}