Описание методов API
/
Биллинг
/
Получить детализацию биллинга

Exodrive API (2.0)

Download OpenAPI description
swagger.json
swagger.yaml
Languages
Servers
DEV сервер
https://dev.api.exodrive.ai/

Аварии

Operations

Аномалии

Operations

Биллинг

Operations

Получить биллинг

Request

Возвращает сводную информацию по выбранному типу биллинга запрошенных типов контрактов за выбранный отчетный месяц

Query
contractTypeIdsstring

Идентификаторы типов контрактов

billingTypeinteger(int32)(BillingType)

Тип биллинга (0 - помесячный, 1 - подневный)

Enum01
monthinteger(int32)

Месяц отчетного периода (по умолчанию - предыдущий месяц)

yearinteger(int32)

Год отчетного периода (по умолчанию - текущий год)

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/Billing/vouchers/count?billingType=0&contractTypeIds=string&month=0&year=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body
contractTypeIdsstring or null

Идентификаторы типов контрактов через запятую.

billingTypeinteger(int32)(BillingType)

Тип биллинга: 0 - помесячный,1 - подневный.

Enum01
billingPeriodstring or null

Биллинговый период, в формате YYYY-mm

countnumber(double)

Количество ваучеров, зависит от типа биллинга

isEstimateboolean

Флаг, является ли данное значение оценочным (если запрошен еще не завершившийся период)

Response
No response example

Получить детализацию биллинга

Request

Возвращает детальную информацию по состоянию биллинга ваучеров в отчетном периоде

Query
contractTypeIdsstring

Идентификаторы типов контрактов

monthinteger(int32)

Месяц отчетного периода (по умолчанию - предыдущий месяц)

yearinteger(int32)

Год отчетного периода (по умолчанию - текущий год)

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/Billing/vouchers/details?contractTypeIds=string&month=0&year=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body
contractTypeIdsstring or null

Идентификаторы типов контрактов

billingPeriodstring or null

Биллинговый период, в формате YYYY-mm

activeVoucherCountinteger(int32)

Количество активных ваучеров в отчетном периоде

closedVoucherCountinteger(int32)

Количество закрытых ваучеров в отчетном периоде

totalVoucherCountinteger(int32)

Общее количество ваучеров в отчетном периоде

daysInPeriodinteger(int32)

Количество дней в отчетном периоде

totalActiveDaysnumber(double)

Сумма активных дней для всех ваучеров

activeDaysRationumber(double)

Коэффициент активности ваучеров

dailyEquivalentCountnumber(double)

Эквивалент количества ваучеров, рассчитанный на основе активных дней (подневный биллинг)

isEstimateboolean

Флаг, является ли данное значение оценочным (если запрошен еще не завершившийся период)

activeVouchersArray of objects or null(VoucherDetailsItem)

Список активных ваучеров

closedVouchersArray of objects or null(VoucherDetailsItem)

Список закрытых ваучеров

Response
No response example

Устройства

Operations

Ваучеры

Operations

Справочники

Operations

Скоринг

Operations