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

  1. HTTP-запрос
  2. Заголовки запроса
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 400
      1. Представление
      2. Поля
    3. Код 401
      1. Представление
      2. Поля
    4. Код 403
      1. Представление
      2. Поля
    5. Код 429
      1. Представление
      2. Поля
    6. Код 500
      1. Представление
      2. Поля
  5. Пример

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

HTTP-запрос

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

Заголовки запроса

Accept-Language *

string

Предпочитаемый язык ответа

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

Accept-Language *

string

Предпочитаемый язык ответа

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

Тело запроса

{
  "cursor": "string",
  "limit": 40,
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "transaction": {
        "category_ids": [
          "partner_service_recurring_payment"
        ],
        "event_at": {
          "from": "2019-08-08T11:58:01+03:00",
          "to": "2019-08-08T11:58:01+03:00"
        }
      }
    }
  }
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

cursor

string

Курсор для получения следующий порции данных,
значение должно быть взято из ответа на предыдущий запрос

limit

integer

Ограничение сверху на число транзакций в ответе

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 40.

query *

object

query.park *

object

query.park.id *

string

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

query.park.transaction *

object

query.park.transaction.category_ids[]

array

Массив неповторяющихся идентификаторов категорий транзакций

query.park.transaction.event_at *

object

query.park.transaction.event_at.from *

string

ISO 8601 с временной зоной

query.park.transaction.event_at.to *

string

ISO 8601 с временной зоной

cursor

string

Курсор для получения следующий порции данных,
значение должно быть взято из ответа на предыдущий запрос

limit

integer

Ограничение сверху на число транзакций в ответе

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 40.

query *

object

query.park *

object

query.park.id *

string

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

query.park.transaction *

object

query.park.transaction.category_ids[]

array

Массив неповторяющихся идентификаторов категорий транзакций

query.park.transaction.event_at *

object

query.park.transaction.event_at.from *

string

ISO 8601 с временной зоной

query.park.transaction.event_at.to *

string

ISO 8601 с временной зоной

Ответы

Код 200

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

{
  "cursor": "",
  "limit": 40,
  "transactions": [
    {
      "amount": "12345.1434",
      "category_id": "partner_service_recurring_payment",
      "category_name": "Платежи по расписанию",
      "created_by": {
        "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
        "dispatcher_name": "Вася Пупкин",
        "identity": "dispatcher",
        "passport_uid": "123456789"
      },
      "currency_code": "RUB",
      "description": "Списание №13",
      "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
      "event_at": "2019-08-08T11:58:01+03:00",
      "id": "100200400",
      "order_id": "c8d40acf182b4b32af72f6ad2029031b"
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

cursor *

string

Курсор для получения следующий порции данных

limit *

integer

Ограничение сверху на число транзакций в ответе

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 40.

transactions[] *

array

transactions[].amount *

string

Сумма с фиксированной точностью

transactions[].category_id *

string

Категория транзакции. Примеры значений:

  • bank_payment - выплата на расчетный счёт партнера;
  • bonus - бонус;
  • card - оплата по карте;
  • cash_collected - оплата наличными (не меняет баланс водителя);
  • compensation - компенсация;
  • corporate - корпоративная оплата;
  • partner_bonus_fee - комиссия партнера за бонус;
  • partner_ride_card - оплата по карте за партнёрский заказ;
  • partner_ride_cash_collected - оплата наличными за партнёрский заказ (не меняет баланс водителя);
  • partner_ride_fee - комиссия партнера за партнёрский заказ;
  • partner_service_financial_statement - финансовая ведомость;
  • partner_service_manual - ручной платёж;
  • partner_service_other - прочее;
  • partner_service_recurrent_payment - списание по условиям работы;
  • partner_service_recurring_payment - платежи по расписанию;
  • partner_subscription_fee - комиссия партнера за смену;
  • platform_bonus_fee - комиссия платформы за бонус;
  • platform_callcenter_fee - сервисный сбор за обработку заказа колл-центром;
  • platform_other_carwash - прочее, оплата мойки;
  • platform_other_gas - оплата на АЗС;
  • platform_other_gas_cashback - оплата на АЗС, кэшбэк;
  • platform_other_gas_fleet_fee - оплата на АЗС, комиссия партнера;
  • platform_other_gas_tip - оплата на АЗС, чаевые;
  • platform_other_rent_childseat - аренда детского кресла;
  • platform_other_rent_childseat_vat - аренда детского кресла, НДС;
  • platform_other_referral - реферальный платёж;
  • platform_other_scout - платёж скауту;
  • platform_ride_fee - комиссия платформы за заказ;
  • platform_ride_vat - комиссия платформы за заказ, НДС;
  • promotion_discount - компенсация скидки клиента;
  • promotion_promocode - компенсация промокода клиента;
  • subscription - покупка смены водителем;
  • subscription_vat - покупка смены водителем, НДС;
  • tip - чаевые.

Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list.

transactions[].category_name *

string

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

transactions[].created_by *

object

transactions[].created_by.dispatcher_id *

string

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

transactions[].created_by.dispatcher_name *

string

Имя диспетчера

transactions[].created_by.identity *

string

Возможные значения
  1. dispatcher

transactions[].created_by.passport_uid *

string

Паспортный идентификатор пользователя

transactions[].created_by.identity *

string

Возможные значения
  1. tech-support

transactions[].created_by.client_id *

string

fleet-api client id

transactions[].created_by.identity *

string

Возможные значения
  1. fleet-api

transactions[].created_by.key_id *

string

fleet-api api key id

transactions[].created_by.identity *

string

Возможные значения
  1. platform

transactions[].currency_code *

string

transactions[].description *

string

transactions[].driver_profile_id

string

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

transactions[].event_at *

string

ISO 8601 с временной зоной

transactions[].id *

string

transactions[].order_id

string

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

cursor *

string

Курсор для получения следующий порции данных

limit *

integer

Ограничение сверху на число транзакций в ответе

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 40.

transactions[] *

array

transactions[].amount *

string

Сумма с фиксированной точностью

transactions[].category_id *

string

Категория транзакции. Примеры значений:

  • bank_payment - выплата на расчетный счёт партнера;
  • bonus - бонус;
  • card - оплата по карте;
  • cash_collected - оплата наличными (не меняет баланс водителя);
  • compensation - компенсация;
  • corporate - корпоративная оплата;
  • partner_bonus_fee - комиссия партнера за бонус;
  • partner_ride_card - оплата по карте за партнёрский заказ;
  • partner_ride_cash_collected - оплата наличными за партнёрский заказ (не меняет баланс водителя);
  • partner_ride_fee - комиссия партнера за партнёрский заказ;
  • partner_service_financial_statement - финансовая ведомость;
  • partner_service_manual - ручной платёж;
  • partner_service_other - прочее;
  • partner_service_recurrent_payment - списание по условиям работы;
  • partner_service_recurring_payment - платежи по расписанию;
  • partner_subscription_fee - комиссия партнера за смену;
  • platform_bonus_fee - комиссия платформы за бонус;
  • platform_callcenter_fee - сервисный сбор за обработку заказа колл-центром;
  • platform_other_carwash - прочее, оплата мойки;
  • platform_other_gas - оплата на АЗС;
  • platform_other_gas_cashback - оплата на АЗС, кэшбэк;
  • platform_other_gas_fleet_fee - оплата на АЗС, комиссия партнера;
  • platform_other_gas_tip - оплата на АЗС, чаевые;
  • platform_other_rent_childseat - аренда детского кресла;
  • platform_other_rent_childseat_vat - аренда детского кресла, НДС;
  • platform_other_referral - реферальный платёж;
  • platform_other_scout - платёж скауту;
  • platform_ride_fee - комиссия платформы за заказ;
  • platform_ride_vat - комиссия платформы за заказ, НДС;
  • promotion_discount - компенсация скидки клиента;
  • promotion_promocode - компенсация промокода клиента;
  • subscription - покупка смены водителем;
  • subscription_vat - покупка смены водителем, НДС;
  • tip - чаевые.

Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list.

transactions[].category_name *

string

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

transactions[].created_by *

object

transactions[].created_by.dispatcher_id *

string

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

transactions[].created_by.dispatcher_name *

string

Имя диспетчера

transactions[].created_by.identity *

string

Возможные значения
  1. dispatcher

transactions[].created_by.passport_uid *

string

Паспортный идентификатор пользователя

transactions[].created_by.identity *

string

Возможные значения
  1. tech-support

transactions[].created_by.client_id *

string

fleet-api client id

transactions[].created_by.identity *

string

Возможные значения
  1. fleet-api

transactions[].created_by.key_id *

string

fleet-api api key id

transactions[].created_by.identity *

string

Возможные значения
  1. platform

transactions[].currency_code *

string

transactions[].description *

string

transactions[].driver_profile_id

string

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

transactions[].event_at *

string

ISO 8601 с временной зоной

transactions[].id *

string

transactions[].order_id

string

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

Код 400

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 401

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 403

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 429

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 500

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Пример

Request:

curl -X POST "https://fleet-api.taxi.yandex.net/v2/parks/transactions/list" \
-H "Accept-Language: ru" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-d '{
  "limit": 40,
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "transaction": {
        "category_ids": [
          "partner_service_recurring_payment"
        ],
        "event_at": {
          "from": "2019-08-08T11:58:01+03:00",
          "to": "2019-08-08T11:58:01+03:00"
        }
      }
    }
  }
}'
Скопировано

Responses:

{
  "cursor": "",
  "limit": 40,
  "transactions": [
    {
      "amount": "12345.1434",
      "category_id": "partner_service_recurring_payment",
      "category_name": "Платежи по расписанию",
      "created_by": {
        "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
        "dispatcher_name": "Вася Пупкин",
        "identity": "dispatcher",
        "passport_uid": "123456789"
      },
      "currency_code": "RUB",
      "description": "Списание №13",
      "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
      "event_at": "2019-08-08T11:58:01+03:00",
      "id": "100200400",
      "order_id": "c8d40acf182b4b32af72f6ad2029031b"
    }
  ]
}
Скопировано