Получение ссылки для скачивания отчета по транзакциям

Метод используется для получения ссылки для скачивания отчета по транзакциям по балансу аккаунта, к которому есть доступ у текущего пользователя:

Отчет содержит список транзакций с учетом заданных фильтров, отсортированный по ID транзакций.
Состав отчета
- ID транзакции
- Итого — сумма транзакции
- Баланс — свободные средства на балансе аккаунта после завершения транзакции
- Валюта
- Описание
- Дата создания (ДД.ММ.ГГГГ)
Имя файла отчета формируется по шаблону: Balance_statement_<ID аккаунта>_<текущая дата ГГГГ-ММ-ДД>.
Формат файла отчета — .XLSX.

GET {reseller_domain}/internal_api/accounts/{account_id}/balance_transactions/export

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого запрашивается список транзакций
format	query	string	Обязательный	Формат файла отчета. Укажите xlsx
filter[total]	query	number	Опциональный	Предназначен для фильтрации списка по сумме транзакции. Для указания диапазона используются следующие фильтры: filter[total][gt] — сумма больше, чем указанная. filter[total][lt] — сумма меньше, чем указанная.

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

Название		Тип данных	Описание
data		object	Данные ответа
	url_for_download	string	Ссылка для скачивания отчета
meta		object	Дополнительная информация
	server_current_time	string	Текущие дата и время сервера

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

Bash

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

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

JSON

{
    "data": {
            "url_for_download": "https://test.activeplatform.com/private/Balance_statement_1234_20230630.xsls?expires=1683372277&hash=R80QFP&filename=Balance_statement_1234_20230630.xsls"
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}