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

Метод Get List of Payments позволяет получить список всех Платежей.

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора.
page	query	integer	Опциональный	Возвращается список Платежей по указанному номеру страницы
per_page	query	integer	Опциональный	Установка числа элементов на странице
sorting[field]	query	string	Опциональный	Сортировка списка по указанному полю
sorting[reversed]	query	string	Опциональный	Установка режима обратной сортировки по указанному полю: true — список будет отсортирован по убыванию. false — список будет отсортирован по возрастанию (используется по умолчанию).
filters[created_at]	query	date	Опциональный	Фильтрация списка по дате создания
filters[updated_at]	query	date	Опциональный	Фильтрация списка по дате обновления
filters[account_id]	query	integer	Опциональный	Фильтрация списка по id аккаунта
filters[payment_method_id]	query	integer	Опциональный	Фильтрация списка по id метода оплаты
filters[status]	query	string	Опциональный	Фильтрация списка по статусу

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

Название	Тип данных	Описание
id	integer	ID Платежа
document_id	string	Номер Платежа, указываемый в платежном документе клиента (формируется с маской (формат идентификатора), см. Системные настройки в ActivePlatform. Руководство по Панели управления Оператора)
status		Статус Платежа: waiting for payment — Платеж был добавлен, но не подтвержден. completed — Платеж был успешно обработан (подтвержден). receipt creating — счет на оплату формируется Сотрудником вручную (см. Обработка Платежа с ручным методом выставления Счета). receipt sent — счет на оплату сформирован Сотрудником вручную и отправлен клиенту. cancelled — Платеж был отменен.
account_id	integer	ID клиента, которому принадлежит Платеж
created_at	date	Дата и время создания Платежа
updated_at	date	Дата и время последнего изменения Платежа
total	float	Общая сумма Платежа
comment	string	Комментарий к Платежу
requester IP	string	IP-адрес плательщика
manager_id	integer	ID менеджера, ответственного за обработку Платежа
payment_method_id	integer	ID способа оплаты Платежа
payment_method_name	string	Наименование способа оплаты
orders	array	Список заказов связанных с данным Платежом (см. Получение списка Заказов)

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

GET http://billing.activeplatform.com:80/api/vendor/v1/payments.json?api_token=654321

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

  {
    "id": 2000466,
    "document_id": "P000005",
    "status": "completed",
    "account_id": 2000039,
    "created_at": "2014-12-03T11:56:49.898+03:00",
    "updated_at": "2014-12-03T11:57:09.629+03:00",
    "total": "24.0",
    "comment": "Платеж для заказа 2000231",
    "requester_ip": null,
    "manager_id": null,
    "payment_method_id": 1,
    "payment_method_name": "Check",
    "orders": [
      {
        "id": 2000231,
        "document_id": "RN000001",
        "status": "provisioning",
        "account_id": 2000039,
        "type": "RenewalOrder",
        "created_at": "2014-12-03T11:56:49.313+03:00",
        "updated_at": "2014-12-03T11:57:09.471+03:00",
        "expiration_date": "2014-12-17",
        "total": "24.0",
        "promo_code": "",
        "payment_id": 2000466,
        "items": [
          {
            "id": 4217,
            "target_id": 2000177,
            "target_type": "Subscription",
            "type": "ProvisioningItem::Renew",
            "status": "provisioning",
            "description": "Fanta"
          }
        ],
        "charges": [
          {
            "id": 22521,
            "subscription_id": 2000177,
            "subscription_resource_id": null,
            "subscription_resource_name": null,
            "plan_resource_id": null,
            "resource_id": null,
            "quantity": 1,
            "operate_from": "2014-12-03",
            "operate_to": "2014-12-03",
            "duration": 3,
            "description": "Продление подписки (абонентская плата) #2000177 Fanta",
            "unit_price": "5.0",
            "amount": "15.0",
            "status": "closed",
            "type": "Charge::Recurring",
            "order_id": 2000231,
            "close_date": null,
            "created_at": "2014-12-03T11:56:49.774220+0300",
            "updated_at": "2016-03-28T09:47:19.628221+0300"
          },
          {
            "id": 22520,
            "subscription_id": 2000177,
            "subscription_resource_id": null,
            "subscription_resource_name": null,
            "plan_resource_id": null,
            "resource_id": null,
            "quantity": 1,
            "operate_from": "2014-12-03",
            "operate_to": "2014-12-03",
            "duration": null,
            "description": "translation missing: ru.descriptions.charge.renewal_order.charge/renewal_subscription",
            "unit_price": "9.0",
            "amount": "9.0",
            "status": "closed",
            "type": "Charge::Renewal",
            "order_id": 2000231,
            "close_date": null,
            "created_at": "2014-12-03T11:56:49.457668+0300",
            "updated_at": "2016-03-28T09:47:15.179083+0300"
          }
        ]
      }
    ]
  }