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

Финансы

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

Для получения данных счета необходимо вызвать GET /billing-api/companies/current/account, передавая данные авторизации в заголовке.

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

curl -X GET "https://api.devino.online/billing-api/companiecurrent/account" \
-H "Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ=="

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

Параметр Тип данных Описание
account Account Данные счета.
validPacketChannels string

Доступные каналы.

Возможные значения: EMAIL, FLASHCALL, HLR, PUSH, PUSH_WALLET, SMS, VIBER, VK, VOICE, WHATSAPP.

Account

Параметр Тип данных Описание
companyId integer ID компании.
accountType string

Типы счета.

Возможные значения:
PREPAID - предоплатный.
POSTPAID - постоплатный.

addPercent integer Добавочный процент валютного счета.
balance number Баланс счета.
credit number Сумма овердрафта.
reserve number Общая сумма резерва.
reserveSms number Сумма резерва абонентской платы по услугам SMS.
reserveViber number Сумма резерва абонентской платы по услугам Viber.
currencyId integer ID валюты счета.
isBlocked boolean

Статус финансовой блокировки компании.

Возможные значения:
false - не заблокирован.
true - заблокирован.

recalcBillRate boolean

Необходимость валютного пересчета.

Возможные значения:
false - пересчет не нужен.
true - пересчет нужен.

disableThreshold number Порог баланса для финансовой блокировки компании.
notifyThreshold number Порог баланса для уведомления пользователя.

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

{
  "result": {
    "account": {
      "accountType": "POSTPAID",
      "addPercent": 0,
      "balance": 1000.8,
      "companyId": 111,
      "credit": 0,
      "currencyId": 1,
      "disableThreshold": 0,
      "isBlocked": false,
      "notifyThreshold": 0,
      "recalcBillRate": true,
      "reserve": 0,
      "reserveSms": 0,
      "reserveViber": 0
    },
    "validPacketChannels": [
      "EMAIL"
    ]
  }
}

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

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

Параметры запроса

Параметр Тип данных Описание
channel string

Канал рассылки.

Возможные значения: EMAIL, FLASHCALL, HLR, PUSH, PUSH_WALLET, SMS, VIBER, VK, VOICE, WHATSAPP.

countryId integer ID страны.
currencyId integer ID валюты счета.
mogId integer ID группы мобильных операторов.
onlyNullSourceAddress boolean

Фильтрация тарифных позиций по полю sourceAddress.

Возможные значения:
true - отображение тарифных позиций только с "sourceAddress": null.
false - отображение всех тарифных позиций.

.

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

curl -X GET "https://api.devino.online/billing-api/companiecurrent/plan-records/current?channel=EMAIL&currencyId=1&onlyNullSourceAddress=true" \
-H "Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ==" 

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

Параметр Тип данных Описание
planRecord object Данные тарифной позиции.
quantity integer Текущее значения счетчика по данной тарифной позиции.

PlanRecord

Параметр Тип данных Описание
planRecordId integer ID тарифной позиции.
channel string

Канал рассылки.

Возможные значения: EMAIL, FLASHCALL, HLR, PUSH, PUSH_WALLET, SMS, VIBER, VK, VOICE, WHATSAPP.

traffic string

Тип трафика.

Возможные значения:
ADVERTISING - рекламный трафик.
AUTHORIZATION - авторизационный трафик.
INCOMING - входящий трафик.
SERVICE - сервисный трафик.
TRANSACTIONAL - транзакционный трафик.

Для канала WHATSAPP:
REFERRAL_CONVERSATION - нетарифицируемая сессия, если пользователь использует кнопки в сообщениях от бизнес-аккаунта.
SESSION - сессия начата пользователем.
SESSION_BUSINESS_INITIATED - сессия начата бизнес-аккаунтом.
UNIQUE_PHONE_NUMBERS - уникальные абоненты.

startDate datetime Дата начала действия тарифной позиции.
endDate datetime Дата окончания действия тарифной позиции.
deliveryRule string

Правило расчета.

Возможные значения:
DELIVERED - по доставленным сообщениям.
SENT - по отправленным сообщениям.

sourceAddress string Адрес отправителя.
sourceAddressType string

Тип адреса отправителя.

Возможные значения:
MS - мультиподпись.
IS - индивидуальная подпись.
ILS - международная подпись.
ONEWAY - односторонняя отправка.
TWOWAY - сессионная отправка.
FN - федеральный номер.
SN - короткий номер.
SNP - короткий номер с префиксом.

countryId integer ID страны.
countryName string Название страны.
currencyId integer ID валюты счета.
mogId integer ID группы мобильных операторов.
mogNameRus string Российское название группы мобильных операторов.
mogNameInt string Международное название группы мобильных операторов.
steps array[Step] Параметры степа - расчета стоимости в зависимости от количества отправленных сообщений.
Step
Параметр Тип данных Описание
startStep integer Количество сообщений, необходимое для начала расчета.
endStep integer Количество сообщений, необходимое для окончания расчета.
price number Цена расчета.

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

{
  "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
    }
  ]
}