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

Request

POST

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

Headers

Name	Description
Accept-Language	Type: string Предпочитаемый язык ответа Min length: `2` Example: `ru`
X-API-Key	Type: string API-ключ Min length: `1` Example: `<API-ключ>`
X-Client-ID	Type: string Идентификатор клиента Min length: `1` Example: `<Идентификатор клиента>`

Body

application/json

{
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
    },
    "category": {
      "is_enabled": true,
      "is_editable": true,
      "is_creatable": true,
      "is_affecting_driver_balance": true
    }
  }
}

Name	Description
query	Type: ParksTransactionsCategoriesListQuery Example `{ "park": { "id": "ee6f33c4562b4e1f8646d157bd70b2c4" }, "category": { "is_enabled": true, "is_editable": true, "is_creatable": true, "is_affecting_driver_balance": true } }`

ParkId

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

Type: string

Min length: 1

Max length: 100

Example: ee6f33c4562b4e1f8646d157bd70b2c4

ParksTransactionsCategoriesListQueryPark

Name

Description

Type: ParkId

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

Min length: 1

Max length: 100

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Example

{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
}

TransactionCategoryIsEnabled

Включена ли категория транзакции false бывает только для партнёрских категорий

Type: boolean

TransactionCategoryIsEditable

Доступно ли редактирование категории транзакции true для партнёрских категорий

Type: boolean

TransactionCategoryIsCreatable

Доступно ли создание транзакции в категории

Type: boolean

TransactionCategoryIsAffectingDriverBalance

Влияет ли транзакция в категории на баланс водителя

Type: boolean

ParksTransactionsCategoriesListQueryCategory

Name	Description
is_affecting_driver_balance	Type: TransactionCategoryIsAffectingDriverBalance Влияет ли транзакция в категории на баланс водителя Example: `true`
is_creatable	Type: TransactionCategoryIsCreatable Доступно ли создание транзакции в категории Example: `true`
is_editable	Type: TransactionCategoryIsEditable Доступно ли редактирование категории транзакции true для партнёрских категорий Example: `true`
is_enabled	Type: TransactionCategoryIsEnabled Включена ли категория транзакции false бывает только для партнёрских категорий Example: `true`

Example

{
  "is_enabled": true,
  "is_editable": true,
  "is_creatable": true,
  "is_affecting_driver_balance": true
}

ParksTransactionsCategoriesListQuery

Name	Description
park	Type: ParksTransactionsCategoriesListQueryPark Example `{ "id": "ee6f33c4562b4e1f8646d157bd70b2c4" }`
category	Type: ParksTransactionsCategoriesListQueryCategory Example `{ "is_enabled": true, "is_editable": true, "is_creatable": true, "is_affecting_driver_balance": true }`

Example

{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
  },
  "category": {
    "is_enabled": true,
    "is_editable": true,
    "is_creatable": true,
    "is_affecting_driver_balance": true
  }
}

Responses

200 OK

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

Body

application/json

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

Name

Description

categories

Type: TransactionCategories

Example

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

TransactionCategoryId

Категория транзакции. Допустимые значения можно получить через API /v2/parks/transactions/categories/list.

Type: string

Min length: 1

Max length: 100

Example: partner_service_manual

TransactionCategoryName

Локализованное название категории транзакции

Type: string

Min length: 1

Max length: 100

Example: Платежи по расписанию

TransactionCategoryGroupId

Группа категории транзакции. Допустимые значения:

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.

Type: string

Min length: 1

Max length: 100

Example: partner_other

TransactionCategoryGroupName

Локализованное название группы категории транзакции

Type: string

Min length: 1

Max length: 100

Example: Прочие платежи партнёра

TransactionCategory

Name	Description
group_id	Type: TransactionCategoryGroupId Группа категории транзакции. Допустимые значения: `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. Min length: `1` Max length: `100` Example: `partner_other`
group_name	Type: TransactionCategoryGroupName Локализованное название группы категории транзакции Min length: `1` Max length: `100` Example: `Прочие платежи партнёра`
id	Type: TransactionCategoryId Категория транзакции. Допустимые значения можно получить через API /v2/parks/transactions/categories/list. Min length: `1` Max length: `100` Example: `partner_service_manual`
is_affecting_driver_balance	Type: TransactionCategoryIsAffectingDriverBalance Влияет ли транзакция в категории на баланс водителя Example: `true`
is_creatable	Type: TransactionCategoryIsCreatable Доступно ли создание транзакции в категории Example: `true`
is_editable	Type: TransactionCategoryIsEditable Доступно ли редактирование категории транзакции true для партнёрских категорий Example: `true`
is_enabled	Type: TransactionCategoryIsEnabled Включена ли категория транзакции false бывает только для партнёрских категорий Example: `true`
name	Type: TransactionCategoryName Локализованное название категории транзакции Min length: `1` Max length: `100` Example: `Платежи по расписанию`

Example

{
  "id": "partner_service_manual",
  "name": "Платежи по расписанию",
  "group_id": "partner_other",
  "group_name": "Прочие платежи партнёра",
  "is_enabled": true,
  "is_editable": true,
  "is_creatable": true,
  "is_affecting_driver_balance": true
}

TransactionCategories

Type: TransactionCategory[]

Example

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

400 Bad Request

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

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

401 Unauthorized

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

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

403 Forbidden

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

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

429 Too Many Requests

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

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

500 Internal Server Error

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

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

Была ли статья полезна?

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

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