Данные об ожидаемых списаниях¶
-
GET
https://panel.netangels.ru/api/v1/expected_balance/{date}/
¶ Получить данные по списаниям и ожидаемом балансе за определённую дату (не дальше двух лет).
Пример запроса:
curl -X GET -H "Accept: application/json" -u "uXXXX:password" 'https://panel.netangels.ru/api/v1/expected_balance/2012-06-01/'
Пример результата:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { { "charge_moments": [ { "amount": "16.13", "balance": "453.87", "moment": "2012-05-30T11:01:22", "order": { "comment": "", "end_date": null, "id": 6, "last_charge_date": null, "paid_till": null, "start_date": "2012-05-03T11:01:22", "state": "ORDERED", "tariff": { "amount": "500", "billing_period": [ 1, "MONTHLY" ], "charge_period": [ 1, "DAILY" ], "generic_type": "hosting", "id": 102, "independent": true, "name": "Тариф \"Профи\"", "short_name": "профи", "type": "pro" } }, "positive": true }], "date": "2012-06-09T00:00:00", "edd": null, "error": null, "expected_balance": "-10.00" } }
Status Codes: - 200 OK – Удачный исход.
- 404 Not Found – Нет таких данные или они недоступны.
Описание полей возвращаемых значений¶
Общая информация
date: | дата, по состоянию на которую посчитаны ожидаемые списания |
---|---|
edd: | ожидаемая дата отключения (expected disconnect date). Возвращает null, если edd > date |
error: | сообщение об ошибке, в случае ошибки |
expected_balance: | |
ожидаемый баланс по состоянию на date |
Объекты charge_moments (моменты списаний)
amount: | cумма списания |
---|---|
balance: | баланс после списания |
moment: | момент времени списания (в формате YYYY-mm-ddTHH:MM:SS) |
positive: | true, если баланс положительный (balance > 0) |
order.id: | уникальный id заказа |
order.comment: | комментарий к заказу |
order.last_charge_date: | |
момент времени, в который последний раз выполнялось списание по данному заказу | |
order.paid_till: | |
момент времени, по состоянию на который уже выполнены списания | |
order.start_date: | |
дата начала заказа | |
order.state: | состояние заказа. Может принимать значения “AWAITING”, “ORDERED”, “SUSPENDED”, “COMPLETED”, “REJECTED” |
order.tariff.amount: | |
стоимость тарифа | |
order.tariff.billing_period: | |
пара значений, определяющих период, за который расчитывается стоимость тарифа | |
order.tariff.charge_period: | |
пара значений, определяющих периодичность выполнения списаний | |
order.tariff.generic_type: | |
наиболее общий тип тарифа (возможны варианты “hosting”, “dedicated”, null) | |
order.tariff.id: | |
уникальный id тарифа | |
order.tariff.independent: | |
true, если тариф является основным (независимым) | |
order.tariff.name: | |
имя тарифа | |
order.tariff.short_name: | |
краткое имя тарифа | |
order.tariff.type: | |
тип тарифа (“std”, “pro”, и т.д.) |