Получение Cписка корректировок
Метод Get List of Corrections позволяет получить Список корректировок для определенного Оператора (Реселлера).
GET /api/vendor/v1/corrections.json?api_token={api_token}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
api_token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию |
page | query | integer | Опциональный | Возвращается список корректировок по указанному номеру страницы |
per_page | query | integer | Опциональный | Установка числа элементов на странице |
sorting[field] | query | string | Опциональный | Сортировка списка по указанному полю |
sorting[reversed] | query | boolean | Опциональный | Установка режима обратной сортировки по указанному полю:
|
filters[is_included_in_invoice] | query | boolean | Опциональный | Признак включения Корректировки в будущий Акт:
|
filters[subscription_id] | query | string | Опциональный | Фильтрация списка по ID Подписки, по которой производится Корректировка. Данные доступны если is_included_in_invoice=true |
filters[created_at] | query | date | Опциональный | Фильтрация списка по дате создания Корректировки |
filters[approved_at] | query | date | Опциональный | Фильтрация списка по дате подтверждения Корректировки |
filters[status] | query | string | Опциональный | Фильтрация списка по статусу Корректировки:
|
Модель ответа
Название | Тип данных | Описание |
---|---|---|
id | integer | ID Корректировки |
account_id | integer | ID Клиента, баланс которого был скорректирован |
manager_id | integer | ID сотрудника, который создал Корректировку |
status | string | Текущий статус Корректировки:
|
total | float | Сумма корректировки |
is_included_in_invoice | boolean | Признак включения корректировки в Акт:
|
subscription_id | string | ID Подписки, по которой была произведена Корректировка, если is_included_in_invoice=true |
description | string | Описание Корректировки, которое должно отражается в Акте, если is_included_in_invoice=true |
string | Комментарий Сотрудника к Корректировке | |
created_at | data | Дата и время создания Корректировки |
approved_at | data | Дата и время подтверждения Корректировки |
Пример запроса
GET http://billing.activeplatform.com:80/api/vendor/v1/corrections.json?api_token=654321
Пример ответа
[
{
"id": 22520,
"account_id": 2000177,
"manager_id": 2000199,
"status": "approved",
"total": "-1.1",
"is_included_in_invoice": true,
"subscription_id": 2000133,
"description": "Корректировка Подписки №1218454 ""Microsoft Lync 50 пользователей" с 01.01.2017 по 09.03.2017",
"сomment": null,
"created_at": "2014-12-03T11:56:49.457668+0300",
"approved_at": "2015-08-01T11:09:11.132108+0300"
}
]