Getting list of transaction categories

Request

POST

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

Headers

Name	Description
Accept-Language*	Type: string Preferred language of the response Example: `ru` Min length: `2`
X-API-Key*	Type: string API-key Example: `<API key>` Min length: `1`
X-Client-ID*	Type: string Client ID Example: `<Client ID>` 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

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Min length: 1

Max length: 100

ParksTransactionsCategoriesListQueryCategory

Name	Description
is_affecting_driver_balance	Type: boolean Whether the transaction in the category impacts the driver's account balance
is_creatable	Type: boolean Whether a new transaction can be created in the category
is_editable	Type: boolean Whether the transaction category is editable true for partners category
is_enabled	Type: boolean Whether the transaction category is enabled false only for partners categories

Responses

200 OK

List of transaction categories

Body

application/json

{
    "categories": [
        {
            "id": "partner_service_manual",
            "name": "Recurring payments",
            "group_id": "partner_other",
            "group_name": "Other payments of the partner",
            "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 Group of transaction category. Possible values: `cash_collected` — cash; `platform_card` — card payment; `platform_corporate` — corporate payment; `platform_promotion` — promo campaings; `platform_bonus` — bonus; `platform_tip` — tip; `platform_fees` — platform's fees; `partner_fees` — partner's fee; `partner_other` — other payments of the partner; `platform_other` — other payments of the platform; `partner_rides` — payments for partner's rides. The list is also available via the API /v2/parks/transactions/categories/list. Example: `partner_other` Min length: `1` Max length: `100`
group_name*	Type: string Localized name of the transaction category group Example: `Other payments of the partner` Min length: `1` Max length: `100`
id*	Type: string Transaction category. Possible values can be obtained through the API /v2/parks/transactions/categories/list. Example: `partner_service_manual` Min length: `1` Max length: `100`
is_affecting_driver_balance*	Type: boolean Whether the transaction in the category impacts the driver's account balance
is_creatable*	Type: boolean Whether a new transaction can be created in the category
is_editable*	Type: boolean Whether the transaction category is editable true for partners category
is_enabled*	Type: boolean Whether the transaction category is enabled false only for partners categories
name*	Type: string Localized name of the transaction category Example: `Recurring payments` Min length: `1` Max length: `100`

400 Bad Request

Invalid request parameters

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

500 Internal Server Error

Internal server error

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Was the article helpful?

Getting list of transactions by orders

Getting list of transactions by park