Перейти к содержанию

Финансы

Получение данных счета

Для получения данных счета выполните запрос GET /billing-api/companies/current/account

curl -X GET "https://api.devino.online/billing-api/companies/current/account" \
-H "Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
{
  "result": {
    "account": {
      "companyId": 111,
      "accountType": "PREPAID",
      "balance": 1000.8,
      "credit": 0,
      "reserveSms": 0,
      "reserveViber": 0,
      "reserve": 0,
      "currencyId": 1,
      "isBlocked": false,
      "disableThreshold": 0,
      "notifyThreshold": 0
    }
  }
}
Параметр Тип данных Описание и Допустимые значения
account object Данные счета
companyId integer Идентификатор компании
accountType string Тип счета. Возможные значения:
PREPAID - предоплатный,
POSTPAID - постоплатный
balance bigDecimal Сумма баланса
credit bigDecimal Сумма овердрафта
reserveSms bigDecimal Сумма резерва абонентской платы по именам отправителя SMS
reserveViber bigDecimal Сумма резерва абонентской платы по именам отправителя VIBER
reserve bigDecimal Общая сумма резерва
currencyId integer Идентификатор валюты счета
isBlocked boolean Статус финансовой блокировки компании. Возможные значения:
0 - не заблокирован,
1 - заблокирован
disableThreshold bigDecimal Порог баланса для финансовой блокировки компании
notifyThreshold intbigDecimaleger Порог баланса для отсылки уведомления

Тарифные позиции

Для получения тарифных позиций необходимо вызвать GET /billing-api/companies/current/plan-records/current

curl -X GET "https://api.devino.online/billing-api/companies/current/plan-records/current?channel=SMS" \
-H "Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ==" 
Параметр Тип данных Описание и Допустимые значения
channel string Канал рассылки. Возможные значения: SMS, EMAIL, VIBER, PUSH, WHATSAPP
{
  "result": [
    {
      "planRecord": {
          "planRecordId": 59260,
          "channel": "SMS",
          "traffic": "SERVICE",
          "sourceAddressType": "IS",
          "countryId": 240,
          "countryName": "Russia",        
          "mogId": 1,
          "mogNameInt": "MOTIV",
          "mogNameRus": "Екатеринбург-2000 (МОТИВ)",              
          "startDate": "2020-12-01",
          "deliveryRule": "SENT",
          "steps": [
            {
              "startStep": 1,
              "endStep": 5000,
              "price": 1.9400
            },
            {
              "startStep": 5001,
              "endStep": 10000,
              "price": 1.9100
            },
            {
              "startStep": 10001,
              "price": 1.3700
            }
          ]
        },
      "quantity": 10538
    }
  ]
}
Параметр Тип данных Описание и Допустимые значения
planRecord object Данные тарифной позиции
planRecordId integer Идентификатор тарифной позиции
channel string Канал рассылки. Возможные значения: SMS, EMAIL, VIBER, PUSH, WHATSAPP
traffic string Тип трафика. Возможные значения:
ADVERTISING - рекламный,
SERVICE - сервисный,
TRANSACTIONAL - транзакционный,
UNIQUE_PHONE_NUMBERS - уникальные абоненты (для канала WHATSAPP)
startDate datetime Дата начала действия тарифной позиции
endDate datetime Дата окончания действия тарифной позиции
deliveryRule string Правило расчета. Возможные значения:
DELIVERED - по доставленным,
SENT - по отправленным
sourceAddress string Адрес отправителя
sourceAddressType string Тип адреса отправителя. Возможные значения:
MS - мультиподпись,
IS - индивидуальная,
ILS - международная,
ONEWAY - One Way,
TWOWAY - Two Way,
FN - федеральный номер,
SN - короткий номер
countryId integer Идентификатор страны
countryName string Название страны
mogId integer Идентификатор группы мобильных операторов
mogNameInt string Международное название группы мобильных операторов
mogNameRus string Название группы мобильных операторов
steps array[object] Список объектов Step
quantity integer Текущее значения счётчика по данной тарифной позиции

Step

Параметр Тип данных Описание и Допустимые значения
startStep integer количество сообщений начала расчета
endStep integer количество сообщений окончания расчета
price number цена расчета