Получение списка категорий транзакций

HTTP-запрос

POST https://fleet-api.taxi.yandex.net/v2/parks/transactions/categories/list

Заголовки запроса

Accept-Language *	string Предпочитаемый язык ответа
X-Client-ID *	string Идентификатор клиента
X-API-Key *	string API-ключ

* Обязательный параметр

Тело запроса

{
  "query": {
    "category": {
      "is_affecting_driver_balance": true,
      "is_creatable": false,
      "is_editable": false,
      "is_enabled": true
    },
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
    }
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

query *	object
query.category	object
query.category.is_affecting_driver_balance	boolean Влияет ли транзакция в категории на баланс водителя
query.category.is_creatable	boolean Доступно ли создание транзакции в категории
query.category.is_editable	boolean Доступно ли редактирование категории транзакции true для партнёрских категорий
query.category.is_enabled	boolean Включена ли категория транзакции false бывает только для партнёрских категорий
query.park *	object
query.park.id *	string Идентификатор партнёра

* Обязательный параметр

Ответы

Код 200

Список категорий транзакций

{
  "categories": [
    {
      "group_id": "partner_other",
      "group_name": "Прочие платежи партнёра",
      "id": "partner_service_recurring_payment",
      "is_affecting_driver_balance": true,
      "is_creatable": false,
      "is_editable": false,
      "is_enabled": true,
      "name": "Платежи по расписанию"
    }
  ]
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

categories[] *	array
categories[].group_id *	string Группа категории транзакции. Допустимые значения: `cash_collected` - наличные; `platform_card` - оплата по карте; `platform_corporate` - корпоративная оплата; `platform_promotion` - промоакции; `platform_bonus` - бонус; `platform_tip` - чаевые; `platform_fees` - комиссии платформы; `partner_fees` - комиссии партнёра; `partner_other` - прочие платежи партнёра; `platform_other` - прочие платежи платформы; `partner_rides` - платежи по поездкам партнера. Список также доступен через API /v2/parks/transactions/categories/list.
categories[].group_name *	string Локализованное название группы категории транзакции
categories[].id *	string Категория транзакции. Примеры значений: `bank_payment` - выплата на расчетный счёт партнера; `bonus` - бонус; `card` - оплата по карте; `cash_collected` - оплата наличными (не меняет баланс водителя); `compensation` - компенсация; `corporate` - корпоративная оплата; `partner_bonus_fee` - комиссия партнера за бонус; `partner_ride_card` - оплата по карте за партнёрский заказ; `partner_ride_cash_collected` - оплата наличными за партнёрский заказ (не меняет баланс водителя); `partner_ride_fee` - комиссия партнера за партнёрский заказ; `partner_service_financial_statement` - финансовая ведомость; `partner_service_manual` - ручной платёж; `partner_service_other` - прочее; `partner_service_recurrent_payment` - списание по условиям работы; `partner_service_recurring_payment` - платежи по расписанию; `partner_subscription_fee` - комиссия партнера за смену; `platform_bonus_fee` - комиссия платформы за бонус; `platform_callcenter_fee` - сервисный сбор за обработку заказа колл-центром; `platform_other_carwash` - прочее, оплата мойки; `platform_other_gas` - оплата на АЗС; `platform_other_gas_cashback` - оплата на АЗС, кэшбэк; `platform_other_gas_fleet_fee` - оплата на АЗС, комиссия партнера; `platform_other_gas_tip` - оплата на АЗС, чаевые; `platform_other_rent_childseat` - аренда детского кресла; `platform_other_rent_childseat_vat` - аренда детского кресла, НДС; `platform_other_referral` - реферальный платёж; `platform_other_scout` - платёж скауту; `platform_ride_fee` - комиссия платформы за заказ; `platform_ride_vat` - комиссия платформы за заказ, НДС; `promotion_discount` - компенсация скидки клиента; `promotion_promocode` - компенсация промокода клиента; `subscription` - покупка смены водителем; `subscription_vat` - покупка смены водителем, НДС; `tip` - чаевые. Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list.
categories[].is_affecting_driver_balance *	boolean Влияет ли транзакция в категории на баланс водителя
categories[].is_creatable *	boolean Доступно ли создание транзакции в категории
categories[].is_editable *	boolean Доступно ли редактирование категории транзакции true для партнёрских категорий
categories[].is_enabled *	boolean Включена ли категория транзакции false бывает только для партнёрских категорий
categories[].name *	string Локализованное название категории транзакции

* Обязательный параметр

Код 400

Некорректные параметры запроса

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 401

Отсутствуют параметры авторизации запроса

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 403

Недостаточно прав для выполнения запроса

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 429

Превышено допустимое число запросов

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 500

Внутренняя ошибка сервера

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Пример

Request:

curl -X POST "https://fleet-api.taxi.yandex.net/v2/parks/transactions/categories/list" \
-H "Accept-Language: ru" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-d '{
  "query": {
    "category": {
      "is_affecting_driver_balance": true,
      "is_creatable": false,
      "is_editable": false,
      "is_enabled": true
    },
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
    }
  }
}'
Скопировано

Responses:

{
  "categories": [
    {
      "group_id": "partner_other",
      "group_name": "Прочие платежи партнёра",
      "id": "partner_service_recurring_payment",
      "is_affecting_driver_balance": true,
      "is_creatable": false,
      "is_editable": false,
      "is_enabled": true,
      "name": "Платежи по расписанию"
    }
  ]
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано