Getting list of transactions by park

Request

POST

https://fleet-api.taxi.yandex.net/v2/parks/transactions/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",
            "transaction": {
                "event_at": {
                    "from": "2019-08-08T11:58:01+03:00",
                    "to": "2019-08-08T11:58:01+03:00"
                },
                "category_ids": [
                    "partner_service_manual"
                ]
            }
        }
    },
    "limit": 40,
    "cursor": "string"
}

Name	Description
query*	Type: ParksTransactionsListQuery
cursor	Type: string Cursor for obtaining the next data chunk, the value must be taken from the response to the previous request Min length: `1`
limit	Type: integer<int32> Upper limit of the number of transactions per response Default: `40` Example: `40` Min value: `1` Max value: `1000`

ParksTransactionsListQuery

Name	Description
park*	Type: ParksTransactionsListQueryPark

ParksTransactionsListQueryPark

Name

Description

id*

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Min length: 1

Max length: 100

transaction*

Type: ListQueryParkTransaction

ListQueryParkTransaction

Name

Description

event_at*

Type: DateTimeInterval

category_ids

Type: string[]

Array of unique identifiers of transaction categories
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

Min items: 1

Max items: 100

DateTimeInterval

Name

Description

from*

Type: string<date-time>

ISO 8601 with time zone

Example: 2019-08-08T11:58:01+03:00

to*

Type: string<date-time>

ISO 8601 with time zone

Example: 2019-08-08T11:58:01+03:00

Responses

200 OK

List of transactions

Body

application/json

{
    "transactions": [
        {
            "id": "100200400",
            "event_at": "2019-08-08T11:58:01+03:00",
            "category_id": "partner_service_manual",
            "category_name": "Recurring payments",
            "amount": "12345.1434",
            "currency_code": "RUB",
            "description": "Charging #13",
            "created_by": {
                "identity": "dispatcher",
                "passport_uid": "123456789",
                "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
                "dispatcher_name": "John Smith"
            },
            "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
            "order_id": "c8d40acf182b4b32af72f6ad2029031b",
            "event_id": "ee6f33c4562b4e1f8646d157bd70b2c4"
        }
    ],
    "limit": 40,
    "cursor": "string"
}

Name	Description
cursor*	Type: string Cursor for obtaining the next data chunk Example: ``
limit*	Type: integer<int32> Upper limit of the number of transactions per response Default: `40` Example: `40` Min value: `1` Max value: `1000`
transactions*	Type: Transaction[]

Transaction

Name	Description
amount*	Type: string Fixed-point sum Example: `12345.1434` Max length: `20`
category_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`
category_name*	Type: string Localized name of the transaction category Example: `Recurring payments` Min length: `1` Max length: `100`
created_by*	Type: TransactionCreatedByDispatcher or TransactionCreatedByTechSupport or TransactionCreatedByFleetAPI or TransactionCreatedByPlatform
currency_code*	Type: string Example: `RUB`
description*	Type: string Example: `Charging #13`
event_at*	Type: string<date-time> ISO 8601 with time zone Example: `2019-08-08T11:58:01+03:00`
id*	Type: string Example: `100200400` Min length: `1` Max length: `100`
driver_profile_id	Type: string Driver ID Example: `33de650c6a1a40bfa78dd981817da866` Min length: `1` Max length: `100`
event_id	Type: string ID of the event that initiates the creation of transactions via the api Example: `ee6f33c4562b4e1f8646d157bd70b2c4` Min length: `1`
order_id	Type: string Order ID Example: `c8d40acf182b4b32af72f6ad2029031b` Min length: `1` Max length: `100`

TransactionCreatedByDispatcher

Name	Description
dispatcher_id*	Type: string Dispatcher ID Example: `3621b3429ea04d989adf5ff4d5515d6a`
dispatcher_name*	Type: string Dispatcher name Example: `John Smith`
identity*	Type: string Example: `dispatcher` Enum: `dispatcher`
passport_uid*	Type: string User passport ID Example: `123456789`

TransactionCreatedByTechSupport

Name

Description

identity*

Type: string

Example: tech-support

Enum: tech-support

TransactionCreatedByFleetAPI

Name	Description
client_id*	Type: string fleet-api client id Example: `taxi/park/abc123`
identity*	Type: string Example: `fleet-api` Enum: `fleet-api`
key_id*	Type: string fleet-api api key id Example: `521`

TransactionCreatedByPlatform

Name

Description

identity*

Type: string

Example: platform

Enum: platform

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 transaction categories