Breadcrumbs

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

Метод используется для получения ссылки для скачивания отчета по платежам (кроме платежей в статусе Отменен), для аккаунта, к которому есть доступ у текущего пользователя:

  • Отчет содержит список платежей с учетом заданных фильтров, отсортированный по ID платежей.

  • Состав отчета

    • Номер платежа

    • Статус

    • Срок оплаты (ДД.ММ.ГГГГ) — дата из параметра due_date (см. Получение списка платежей).

    • Скидка — не заполняется, если у реселлера включена настройка Счета формируются внешней системой (см. )

    • Сумма — если у реселлера включена настройка Счета формируются внешней системой, заполняется значением, полученным от внешней системы

    • Валюта — если у реселлера включена настройка Счета формируются внешней системой, заполняется значением, полученным от внешней системы

    • Номер акта (внешний) — если у реселлера включена настройка Счета формируются внешней системой, заполняется значением, полученным от внешней системы, иначе не заполняется

    • Дата создания (ДД.ММ.ГГГГ)

    • Подписки — через запятую перечисляются ID и название всех подписок, с которыми связан платеж

  • Имя файла отчета формируется по шаблону: Payments_<ID аккаунта>_<текущая дата ГГГГ-ММ-ДД>.

  • Формат файла отчета — .XLSX.

GET {reseller_domain}/internal_api/accounts/{account_id}/payments/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[document_id][like]

query

string

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

Предназначен для фильтрации списка по части номера платежа

filter[payment_status]

query

string

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

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

  • waiting_for_payment — Ожидает оплаты.

  • expired — Просрочен.

  • completed — Завершен.

  • paid_from_balance — Оплачен с баланса.

  • processing — Обрабатывается.

  • invoice_creation — Счет формируется.

  • invoice_sent — Счет отправлен.

filter[created_at]

query

string

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

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

  • filter[created_at][gt] — дата больше, чем указанная.

  • filter[created_at][lt] — дата меньше, чем указанная.

  • filter[created_at][gteq] — дата больше, чем указанная, или равна.

  • filter[created_at][lteq] — дата меньше, чем указанная, или равна.

filter[сlosed_at]

query

string

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

Предназначен для фильтрации списка по дате завершения платежа в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры:

  • filter[сlosed_at][gt] — дата больше, чем указанная.

  • filter[сlosed_at][lt] — дата меньше, чем указанная.

  • filter[сlosed_at][gteq] — дата больше, чем указанная, или равна.

  • filter[сlosed_at][lteq] — дата меньше, чем указанная, или равна.

filter[id]

query

integer

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

Предназначен для фильтрации списка по ID платежа

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

Название

Тип данных

Описание

data

object

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


url_for_download

string

Ссылка для скачивания отчета

meta

object

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


server_current_time

string

Текущие дата и время сервера

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

Bash
curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/95/payments/export?format=xlsx' \
--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/Payments_1234_20230630.xsls?expires=1683372277&hash=R80QFP&filename=Payments_1234_20230630.xsls"
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}