Получение Cписка корректировок

Метод Get List of Corrections позволяет получить Список корректировок для определенного Оператора (Реселлера).

 GET /api/vendor/v1/corrections.json?api_token={api_token}

Аргументы

Название

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

Тип данных

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

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию

page

query

integer

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

Возвращается список корректировок по указанному номеру страницы

per_page

query

integer

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

Установка числа элементов на странице

sorting[field]

query

string

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

Сортировка списка по указанному полю

sorting[reversed]

query

boolean

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

Установка режима обратной сортировки по указанному полю:

  • true — список будет отсортирован по убыванию.
  • false — список будет отсортирован по возрастанию (используется по умолчанию).

filters[is_included_in_invoice]

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

Признак включения Корректировки в будущий Акт:

  • true Корректировка включается в Акт.
  • false Корректировка не включается в Акт.
filters[subscription_id]querystringОпциональныйФильтрация списка по ID Подписки, по которой производится Корректировка. Данные доступны если is_included_in_invoice=true

filters[created_at]

query

date

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

Фильтрация списка по дате создания Корректировки

filters[approved_at]

query

date

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

Фильтрация списка по дате подтверждения Корректировки

filters[status]

query

string

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

Фильтрация списка по статусу Корректировки:

  • approval_requiredКорректировка создана, но не подтверждена.
  • approved Корректировка подтверждена.
  • declinedКорректировка отклонена.

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

Название

Тип данных

Описание

id

integerID Корректировки
account_idintegerID Клиента, баланс которого был скорректирован
manager_idintegerID сотрудника, который создал Корректировку

status

stringТекущий статус Корректировки:
    • approval_requiredКорректировка создана, но не подтверждена.
    • approved Корректировка подтверждена.
    • declinedКорректировка отклонена.

total

floatСумма корректировки
is_included_in_invoiceboolean

Признак включения корректировки в Акт:

  • true — корректировка включается в Акт.
  • false — корректировка не включается в Акт.
subscription_idstringID Подписки, по которой была произведена Корректировка, если 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" 
 }
]