Получение списка платежей реселлера

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

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

По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-Token header string Обязательный API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)

Content-Type header string Обязательный Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json

Accept header string Обязательный Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json

base_url path string Обязательный URL ActivePlatform

reseller_id path integer Обязательный ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

page[size] query integer Опциональный Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number] query integer Опциональный Параметр постраничной навигации. Номер страницы ответа

sort

query

integer

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

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

sort={parameter} — сортировка по возрастанию.
sort={-parameter} — сортировка по убыванию.

В качестве {parameter} можно указать любое поле

filter[created_at]

query

string

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

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

filter[created_at][gt] — дата и время более, чем указанные.
filter[created_at][lt] — дата и время менее, чем указанные.

filter[updated_at]

query

string

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

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

filter[updated_at][gt] — дата и время более, чем указанные.
filter[updated_at][lt] — дата и время менее, чем указанные.

filter[closed_at]

query

string

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

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

filter[closed_at][gt] — дата и время более, чем указанные.
filter[closed_at][lt] — дата и время менее, чем указанные.

filter[account_id]

query

string

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

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

filter[payment_method_id]

query

string

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

Предназначен для фильтрации платежей по ID способа оплаты, который был использован при оплате (см. Просмотр списка способов оплаты)

filter[document_id]

query

string

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

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

filters[status]

query

string

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

Фильтрация списка по статусу платежа (список статусов см. в Типы платежей)

include

query

string

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

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

Объект	Значение параметра
Акты	`invoices`
Заказы	`orders`
Клиент	`account`
Способ оплаты	`payment_method`
Реселлер	`reseller`
Списания	`charges`

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

Название

Тип данных

Описание

data

array

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

id

string

ID платежа

type

string

Тип данных

attributes

object

Информация о платеже

created_at

string

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

updated_at

string

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

account_id

integer

ID клиента

discount_amount

string

Размер скидки по платежу

total

string

Общая сумма платежа

comment

string

Комментарий к платежу

status

string

Статус платежа (список статусов см. в Типы платежей)

document_id

string

Номер платежа, указываемый в платежном документе клиента

expiration_date

string

Дата истечения платежа для автоматически создаваемых платежей для подписок по модели Постоплата. Если отсутствует, то возвращается null

payment_method_id

integer

ID способа оплаты платежа, которым платеж был завершен (см. Просмотр списка способов оплаты). Если отсутствует, то возвращается null

requester_ip

string

IP-адрес плательщика. Если отсутствует, то возвращается null

manager_id

integer

ID менеджера, ответственного за обработку платежа. Если отсутствует, то возвращается null

purpose

string

Назначение платежа для пополнения баланса клиента. Отображается в форме счета на оплату (см. Ручное создание платежа)

external_total

string

Сумма счета на оплату в сторонней ERP-системе. Только для платежа, связанного с актом по модели Постоплата с внешним управлением (см. Подтверждение акта по модели Постоплата для клиента реселлера). Если отсутствует, то возвращается null

external_currency

string

ISO-код валюты счета на оплату в сторонней ERP-системе. Только для платежа, связанного с актом по модели Постоплата с внешним управлением (см. Подтверждение акта по модели Постоплата для клиента реселлера). Если отсутствует, то возвращается null

payment_method_name

string

Наименование способа оплаты, которым платеж был завершен. Если отсутствует, то возвращается null

closed_at

string

Дата и время завершения платежа

relationships

object

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

orders

object

Список оплачиваемых заказов

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

invoices

object

Список актов

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

charges

object

Список списаний

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

reseller

object

Информация о реселлере

data

object

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

account

object

Информация о клиенте

data

object

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

payment_method

object

Информация о способе оплаты, которым платеж был завершен

data

object

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

included

array

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

Название	Тип данных	Описание
id	string	ID объекта
type	string	Тип данных
attributes	object	Атрибуты (состав данных см. ниже)

Для акта состав данных см. в Получение информации об акте.
Для клиента состав данных см. в Получение информации о клиенте реселлера по ID.
Для реселлера состав данных см. в Получение информации о реселлере.
Для списания состав данных см. в Получение информации о списании конечного клиента реселлера по ID.

Для заказа:

Название	Тип данных	Описание
created_at	string	Дата и время создания заказа
updated_at	string	Дата и время последнего изменения заказа
account_id	integer	ID клиента
total	string	Общая сумма заказа
payment_id	integer	ID способа оплаты (см. Просмотр списка способов оплаты)
status	string	Статус заказа (список статусов см. в Просмотр информации о заказе)
type	string	Тип заказа (список типов см. в Просмотр информации о заказе)
expiration_date	string	Дата, до которой заказ должен быть оплачен (см. Создание правила обслуживания)
owner_id	integer	ID Владельца клиента
promo_code	string	Промо-код, использованный для получения скидки
document_id	string	Номер заказа
requester_ip	string	IP-адрес заказчика
manager_id	integer	ID менеджера клиента
custom_price	bool	Признак заказа по индивидуальным ценам: true — Заказ подписки по индивидуальным ценам. false — Заказ подписки по ценам, указанным в тарифном плане.
net_cost	string	Себестоимость подписки в заказе
discount_amount	string	Размер скидки по заказу
payment_model	string	Модель оплаты: prepay — Предоплата. postpay — Постоплата.
closed_at	string	Дата завершения заказа
provisioning_date	string	Дата предоставления заказа

Для способа оплаты:

Название	Тип данных	Описание
created_at	string	Дата и время создания способа оплаты
updated_at	string	Дата и время последнего изменения способа оплаты
name	string	Название способа оплаты
description	string	Описание способа оплаты
enabled	bool	Статус способа оплаты: true — доступен в Панели управления Клиента и Панели управления Оператора. false — недоступен для проведения оплаты.
plugin_id	string	Название платежного модуля (см. Просмотр списка модулей), который используется для проведения оплаты

links

object

Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

self

string

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

first

string

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

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

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

last

string

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

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

GET /api/v3/resellers/1/payments?page[size]=2&page[number]=7&filter[created_at][gt]=2022-03-22&include=invoices,orders,account,payment_method,reseller,charges
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "9714",
            "type": "payments",
            "attributes": {
                "created_at": "2022-03-22T16:37:21.321874+0300",
                "updated_at": "2022-03-22T16:37:30.163316+0300",
                "account_id": 1349,
                "discount_amount": "0.0",
                "total": "715.76",
                "comment": "Payment for order 14759",
                "status": "completed",
                "document_id": "2007136",
                "expiration_date": null,
                "payment_method_id": 3,
                "requester_ip": "10.20.30.40",
                "manager_id": null,
                "purpose": "",
                "external_total": null,
                "external_currency": null,
                "payment_method_name": "Bank Transfer",
                "closed_at": "2022-03-22T16:37:30.163316+0300"
            },
            "relationships": {
                "orders": {
                    "data": [
                        {
                            "id": "14759",
                            "type": "prolong_orders"
                        }
                    ]
                },
                "invoices": {
                    "data": []
                },
                "charges": {
                    "data": [
                        {
                            "id": "94591",
                            "type": "charges"
                        }
                    ]
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "1349",
                        "type": "accounts"
                    }
                },
                "payment_method": {
                    "data": {
                        "id": "3",
                        "type": "payment_methods"
                    }
                }
            }
        },
        {
            "id": "9715",
            "type": "payments",
            "attributes": {
                "created_at": "2022-03-22T16:51:34.290462+0300",
                "updated_at": "2022-03-22T16:53:35.452802+0300",
                "account_id": 1349,
                "discount_amount": "0.0",
                "total": "511.26",
                "comment": "Payment for order 14760",
                "status": "completed",
                "document_id": "2007137",
                "expiration_date": null,
                "payment_method_id": 3,
                "requester_ip": "10.20.30.40",
                "manager_id": null,
                "purpose": "",
                "external_total": null,
                "external_currency": null,
                "payment_method_name": "Bank Transfer",
                "closed_at": "2022-03-22T16:53:35.452802+0300"
            },
            "relationships": {
                "orders": {
                    "data": [
                        {
                            "id": "14760",
                            "type": "renewal_orders"
                        }
                    ]
                },
                "invoices": {
                    "data": []
                },
                "charges": {
                    "data": [
                        {
                            "id": "94592",
                            "type": "charges"
                        },
                        {
                            "id": "94593",
                            "type": "charges"
                        }
                    ]
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "1349",
                        "type": "accounts"
                    }
                },
                "payment_method": {
                    "data": {
                        "id": "3",
                        "type": "payment_methods"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "14759",
            "type": "prolong_orders",
            "attributes": {
                ...
            }
        },
        {
            "id": "94591",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "1",
            "type": "resellers",
            "attributes": {
                ...
            }
        },
        {
            "id": "1349",
            "type": "accounts",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "3",
            "type": "payment_methods",
            "attributes": {
                ...
            }
        },
        {
            "id": "14760",
            "type": "renewal_orders",
            "attributes": {
                ...
            }
        },
        {
            "id": "94592",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "94593",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=7&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=6&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=8&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=153&page%5Bsize%5D=2"
    }
}