Получение баланса и заблокированного баланса водителя

Request

GET

https://fleet-api.taxi.yandex.net/v1/parks/contractors/blocked-balance

Query parameters

Name

Description

contractor_id

Type: string

Идентификатор профиля водителя

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

Headers

Name

Description

X-API-Key

Type: string

API-ключ

Min length: 1

Example: <API-ключ>

X-Park-ID

Type: string

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Responses

200 OK

Заблокированный баланс водителя

Body

application/json

{
  "balance": "example",
  "blocked_balance": null,
  "details": {
    "blocked_tips": null,
    "blocked_cashless": null,
    "blocked_bonuses": null,
    "blocked_financial_statements": null,
    "blocked_closing_documents": null
  }
}

Name	Description
balance	Type: Decimal4 Баланс водителя Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_balance	Type: Decimal4 Заблокированный баланс водителя Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
details	Type: BalanceDetails Детали заблокированного баланса водителя Example `{ "blocked_tips": "example", "blocked_cashless": null, "blocked_bonuses": null, "blocked_financial_statements": null, "blocked_closing_documents": null }`

Decimal4

Type: string

Pattern: ^-?[0-9]+(\.[0-9]{1,4})?$

Example: example

BalanceDetails

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

Name	Description
blocked_bonuses	Type: Decimal4 Заблокированные бонусы Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_cashless	Type: Decimal4 Заблокированные деньги за поездки Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_closing_documents	Type: Decimal4 Заблокированные деньги за закрывающие документы Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_financial_statements	Type: Decimal4 Заблокированные деньги за финансовые отчеты Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_tips	Type: Decimal4 Заблокированные чаевые Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`

Example

{
  "blocked_tips": "example",
  "blocked_cashless": null,
  "blocked_bonuses": null,
  "blocked_financial_statements": null,
  "blocked_closing_documents": null
}

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

404 Not Found

Запрашиваемый ресурс не найден

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

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

Получение времени водителя на линии

Получение списка условий работы