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

Request

POST

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

Headers

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

Body

application/json

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

Name	Description
query*	Type: ParksTransactionsCategoriesListQuery

ParksTransactionsCategoriesListQuery

Name	Description
park*	Type: ParksTransactionsCategoriesListQueryPark
category	Type: ParksTransactionsCategoriesListQueryCategory

ParksTransactionsCategoriesListQueryPark

Name

Description

id*

Type: string

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Min length: 1

Max length: 100

ParksTransactionsCategoriesListQueryCategory

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

Responses

200 OK

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

Body

application/json

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

Name	Description
categories*	Type: TransactionCategory[]

TransactionCategory

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

400 Bad Request

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

401 Unauthorized

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

403 Forbidden

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

429 Too Many Requests

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

500 Internal Server Error

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

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

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

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