Параметр;Тип;Обязательный;Описание

phone;string;да;Номер мобильного телефона пользователя в любом формате (валидны варианты: 9111234567 79111234567, +79111234567, 89111234567, +89111234567 плюс все тоже самое с любым количеством пробелов, скобок, точек, тире и т.п. Таким образом +7 (911) 123-45-67 – тоже валидный номер, который будет корректно обработан) first_name;string;да;Имя пользователя last_name;string;да;Фамилия пользователя middle_name;string;нет;Отчество пользователя region;int;нет;Код региона пользователя, соответствующий оригинальному коду региона в ГИБДД. Например: 77 – Москва 78 – Санкт-Петербург 50 – Московская область 01 - Республика Адыгея 23 - Краснодарский край birthday;string;нет;Дата рождения пользователя. Валидны форматы: 1985-12-31 и 31.12.1985 gender;int;нет;Пол пользователя: 1 – мужской, 2 - женский email;string;нет;Валидный email адрес пользователя comment;string;нет;Комментарий к пользователю. Если комментарий передан, то он будет добавлен в качестве комментария к пользователю, который будут виден в его профиле (и логах). Допустим базовый HTML код. referer_id;string;нет;ID пользователя (реферера), пригласившего регистрируемого пользователя (для учета в партнерской программе) timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса message;string;нет;Возвращается только если запрос выполнен успешно. Содержит в себе текст с результатом выполнения запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки data;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив с некоторыми данными зарегистрированного пользователя

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 403;Пользователь с таким номером телефона уже зарегистрирован 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters; array; нет; Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) user_id – идентификатор пользователя 2) role_id – идентификатор роли пользователя 3) phone – номер телефона пользователя, допускается частичный ввод номера (например – 911), в таком случае будут возвращены все пользователи, номер которых содержит переданное значение 4) balance – фильтр пользователей с определенным типом баланса. Принимаемые значения параметра: 1) POSITIVE – список пользователей с балансом больше нуля. 2) NULL – список пользователей с нулевым балансом 3) NEGATIVE – список пользователей с балансом меньше нуля. timestamp; int; да; UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки users_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком пользователей, может быть null count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество пользователей, попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество пользователей

Параметр;Описание

user_id;ID пользователя referer_id;ID реферера manager_id;ID менеджера status;Статус пользователя: 0 - забанен 1 - активен 5 - активен, но выплаты запрещены last_name;Фамилия first_name;Имя middle_name;Отчество region;Регион birthday;Дата рождения gender;Пол: null — неизвестно 1 — мужчина 2 — женщина 9 — неприменимо phone;Номер телефона email;E-mail last_trip_date;Дата последней поездки пользователя trips_total;Количество поездок у пользователя trips_success;Количество успешных поездок trips_errors;Количество незавершенных поездок balance_total;Общий баланс пользователя commissions_total;Доход по комиссиям пользователя за все время cabinets_data;Массив с информацией о кабинетах, в которых добавлен этот пользователь commissions_30_days;Доход по комиссиям пользователя за последние 30 дней created_at;Итоговая минимальная комиссия в руб. role_id;Идентификатор роли пользователя user_role_name;Роль пользователя cabinets_data;Массив с информацией о кабинетах, в которых добавлен этот пользователь

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) users_id – идентификатор пользователя 2) region – код региона 3) cabinet_id – идентификатор кабинета 4) date_start – дата начала поездки (если этот параметр не указан, то вернутся поездки начиная с понедельника текущей недели). 5) time_start – время начала поездки (по умолчанию – 00:00:00) 6) date_end – дата конца поездки (если этот параметр не указан, то возвращаются поездки в период от даты начала поездки до текущей даты) 7) time_end – время конца поездки (по умолчанию – 23:59:59) Промежуток между датой начала поездки и датой конца поездки должен быть меньше 30 дней! 8) car_id – идентификатор автомобиля 9) car_number – номер автомобиля timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки trips_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком поездок, может быть null count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество поездок попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество поездок

Параметр;Описание

aggregator;Агрегатор region;Регион trip_id;ID поездки в системе aggregator_trip_id;ID поездки у агрегатора cabinet_id;ID кабинета в системе user_id;ID пользователя в системе aggregator_user_id;ID пользователя у агрегатора car_id;ID автомобиля, совершившего поездку car_number;Номер авто, выполнявшего поездку date;Дата поездки booked;Дата и время, на которое поездка была заказана created;Дата и время создания поездки accepted;Дата и время принятия заказа водителем arrived;Дата и время прибытия водителя на место начала поездки started;Дата и время фактического начала поездки с пассажиром ended;Дата и время фактического окончания поездки с пассажиром duration;Общее время поездки с пассажиром в секундах distance;Общее расстояние поездки с пассажиром в метрах address_from;Начальный адрес поездки address_to;Конечный адрес поездки tariff;Фактический тариф поездки без вычета комиссии агрегатора paid;Фактическая сумма оплаченная за поездку (вся оплата) aggregator_commission;Комиссия агрегатора partner_commission;Комиссия партнера toll;Компенсации за сборы и платные дороги bonus;Бонусные начисления tips;Чаевые по поездке income;Доход водителя за поездку cash;Сумма полученная наличными balance;Итоговая сумма к зачислению на баланс за эту поездку status;Статус поездки category;Категория заказа is_changed;Метка обозначающая что как минимум одна из транзакций к поездке была изменена fraud_check_dateTime;Время и время последней проверки поездки на фрод fraud_score;Фродовый балл fraud_signs;Информация по примененным признакам фрода и их итоговым баллам fraud_status;Итого проверки на фрод: 0 - НЕ фрод (автомат), 1 - фрод (автомат), 2 - фрод подтвержден (ручной), 3 - помечена как не фрод (ручной), 8 - вне даты обработки антифродом, 9 - антифрод отключен

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) users_id – идентификатор пользователя 2) date_start – дата, после которой необходимо получить выплаты (если этот параметр не указан, то вернутся выплаты за последние 30 дней) 3) time_start – время, после которого необходимо получить выплаты (по умолчанию – 00:00:00) 4) date_end – дата, до которой необходимо получить выплаты (если этот параметр не указан, то возвращаются выплаты в период от даты начала до текущей даты) 5) time_end – время, до которого необходимо получить выплаты (по умолчанию – 23:59:59) Промежуток между начальной и конечной датой должен быть меньше 30 дней! timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки payout_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком выплат, может быть null count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество выплат, попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество выплат

Параметр;Описание

payout_id;ID выплаты в системе user_id;ID пользователя в системе к которому относится выплата date;Дата фактической выплаты dateTime;Дата и время фактической выплаты payout_date;Дата выплаты согласно периодичности amount;Итоговая сумма выплаты period;Периодичность period_commission;Комиссия за периодичность выплаты в % period_commission_fixed;Фиксированная комиссия периода выплаты за каждую выплату period_commission_minimum;Минимальная комиссия периода выплаты за каждую выплату method;Метод выплаты method_commission;Комиссия за способ выплаты в % method_commission_fixed;Фиксированная комиссия способа выплаты за каждую выплату method_commission_minimum;Минимальная комиссия способа выплаты за каждую выплату total_commission_amount;Итоговая комиссия за выплату в рублях total_commission_percent;Итоговая комиссия в % total_commission_fixed;Итоговая фиксированная комиссия в руб total_commission_minimum;Итоговая минимальная комиссия в руб accounts;Детализация выплаты по счетам accounts_payouts;ID транзакций выплат по счетам card_id;ID банковской карты внутри системы status; 0 - ожидает подтверждения, 1 - подтверждена, больше не может изменяться, ожидает обработки, 2 - подтверждена, возникла ошибка при обработке (обработана не полностью), 3 - подтверждена, обработана, ожидает формирования оплаты, 4 - подтверждена, обработана, отправлено в банк, 5 - подтверждена, обработана, ошибка оплаты (недостаточный баланс или нет доступного способа для выплаты), 6 - ошибка при выполнении платежа, 7 - подтверждена, обработана системой, выплачена confirmed_by;ID пользователя подтвердившего выплату errors;Метка наличия ошибок error_message;Текст ошибки, если есть payments_service;Массив с информацией о сервисе, через который была совершена выплата

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) cabinet_id – идентификатор кабинета в системе, `no_cabinet`, если нужны выплаты без кабинета, 2) user_id – идентификатор пользователя, 3) transactions_type – тип транзакции: “Прочее”, “Аренда авто”, “Перевод между счетами”, 4) transactions_direction – направление транзакции: 1 – приход, 2 - расход, 5) date_start – дата, после которой необходимо получить транзакции (если этот параметр не указан, то вернутся транзакции за последние 30 дней), 6) time_start – время, после которого необходимо получить транзакции (по умолчанию – 00:00:00), 7) date_end – дата, до которой необходимо получить транзакции (если этот параметр не указан, то возвращаются транзакции в период от даты начала до текущей даты), 8) time_end – время, до которого необходимо получить транзакции (по умолчанию – 23:59:59). Промежуток между начальной и конечной датой должен быть меньше 30 дней! timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки transactions_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком транзакций, может быть null count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество транзакций, попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество транзакций

Параметр;Описание

transaction_id;ID транзакции в системе cabinet_id;ID кабинета в системе user_id;ID пользователя в системе к которому относится транзакция aggregator_user_id;ID пользователя в кабинете агрегатора transactions_list;Модуль в котором находится ресурс инициатора транзакции creator_item_id;ID ресурса инициатора транзакции region;Регион date;Дата транзакции dateTime;Дата и время транзакции direction;Направление транзакции: 1 - приход, 2 - расход account;Счёт транзакции amount;Сумма транзакции is_changed;Метка обозначающая, что транзакция была изменена total_balance_after;Сумма на ОБЩЕМ балансе пользователя, после учёта этой транзакции type;Тип транзакции description;Описание транзакции antifraud_block;Блокировка транзакции антифродом: 0 - нет блокировки, 1 - блокировака активна, 2 - блок подтвержден, не учитывается на балансе status;Статус транзакции

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) car_id – идентификатор автомобиля, 2) transactions_account – идентификатор счёта транзакции, 3) transactions_type – тип транзакции: “Прочее”, “Аренда авто”, “Перевод между счетами”, 4) date_start – дата, после которой необходимо получить транзакции (если этот параметр не указан, то вернутся выплаты за последние 30 дней) 5) time_start – время, после которого необходимо получить транзакции (по умолчанию – 00:00:00) 6) date_end – дата, до которой необходимо получить транзакции (если этот параметр не указан, то возвращаются транзакции в период от даты начала до текущей даты) 7) time_end – время, до которого необходимо получить транзакции (по умолчанию – 23:59:59) Промежуток между начальной и конечной датой должен быть меньше 30 дней! timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки transactions_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком транзакций, может быть null count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество транзакций, попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество транзакций

Параметр;Описание

transaction_id;ID транзакции для машины в системе car_id;ID машины в системе к которому относится транзакция date;Дата транзакции dateTime;Дата и время транзакции direction;Направление транзакции: 1 - приход, 2 - расход account;ID счёта транзакции amount;Сумма транзакции is_changed;Метка обозначающая, что транзакция была изменена total_balance_after;Сумма на ОБЩЕМ балансе автомобиля, после учёта этой транзакции type;ID типа транзакции description;Описание транзакции

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

user_id;string;да;ID пользователя внутри системы taxiCRM timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса balance;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе информацию о текущем балансе пользователя error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) users_id – идентификатор пользователя 2) car_id – идентификатор авто 3) date_start – дата начала смены (если этот параметр не указан, то вернутся смены начиная с понедельника текущей недели). 4) time_start – время начала смены (по умолчанию – 00:00:00) 5) date_end – дата конца смены (если этот параметр не указан, то возвращаются смены в период от даты начала до текущей даты) 6) time_end – время конца смены (по умолчанию – 23:59:59) Промежуток между датой начала поездки и датой конца поездки должен быть меньше 30 дней! timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да; Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки shifts_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком смен, может быть null count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество поездок, попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество поездок

Параметр;Описание

id;Номер смены shift_id;ID смены внутри taxiCRM user_id;ID водителя смены car_id;ID авто смены opened_by;ID пользователя, открывшего смену closed_by;ID пользователя, закрывшего смену start;Дата и время начала смены end;Дата и время окончания смены (если есть) trips_total;Всего поездок за смену trips_success;Всего успешных поездок за смену trips_errors;Всего отмененных поездок за смену trips_cash;Всего поездок за наличные за смену tariff;Наименование тарифа смены paid;Оплачено aggregator_commission;Комиссия агрегатора partner_commission;Комиссия парка toll;Компенсации за сборы и платные дороги во время смены bonus;Бонусы tips;Чаевые income;Доход водителя за поездки во время смены cash;Сумма полученная наличными во время смены user_income;Чистый доход водителя со смены (за вычетом всех комиссий) park_income;Чистый доход парка со смены (учитывая комиссию агрегатора и все компенсации) status_last_update;Дата и время последнего успешного обновления статистики по смене status;Статус смены (1 – активна, 0 – закрыта) user;Полное ФИО водителя car;Полное название авто opned_by_user;Полное ФИО пользователя, открывшего смену closed_by_user;Полное ФИО пользователя, закрывшего смену

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

shift_id;UUID;да;ID смены внутри taxiCRM timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки shift;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив с детальной информацией по смене

Параметр;Описание

shift_id;UUID смены id;Номер смены opened;Дата открытия смены сar_id;ID авто смены opened_by;ID пользователя, открывшего смену opened_by_user;Полное ФИО пользователя, открывшего смену closed;Дата и время окончания смены (если есть) closed_by;ID пользователя, закрывшего смену closed_by_user;Полное ФИО пользователя, закрывшего смену user_id;ID водителя смены user;Полное ФИО водителя car_id;ID авто смены car;Полное название авто tariff;Наименование тарифа смены park_commission;Тип комиссии парка согласно тарифу park_commission_value;Значение комиссии парка согласно тарифу park_commission_type;Условие комиссии парка согласно тарифу park_commission_min;Минимальная комиссия парка согласно тарифу (₽) park_commission_ignore_bonus;Не брать комиссию с бонусов (%) park_commission_ignore_subsidy;Не брать комиссию с субсидий (%) park_commission_ignore_compensation;Не брать комиссию с компенсаций (%) park_commission_ignore_tips;Не брать комиссию с чаевых (%) aggregator_commission_compensation;Компенсация комиссии агрегатора (%) fueling_compensation;Компенсация заправок (%) shift_buy_compensation;Компенсация покупок смен (%) additional_park_commission;Дополнительная комиссия парка shift_duration;Продолжительность смены (час) time_in_trips;Время в поездках (%) time_out_trips;Время вне поездок (%) mileage_in_trips;Пробег в поездках (км) mileage_by_odometer;Пробег по одометру (км) mileage_empty;Порожний пробег (км) trips_success;Поездок успешно trips_canceled;Поездок отменено trips_tariff;Тариф поездок (₽) payed;Оплачено (₽) non_cash;Безнал (₽) cash;Наличные (₽) cash_handed_over;Сдано наличных в парк (₽) cash_non_handed_over;Не сдано наличных в парк (₽) bonuses;Бонусы (₽) subsidy;Субсидии (₽) compensation;Компенсации (₽) tips;Чаевые (₽) partner_commission;Комиссия партнера (₽) partner_subscription_fee;Абон. плата партнера (₽) aggregator_commission;Комиссия агрегатора (₽) aggregator_commission_compensation_value;Компенсация комиссии агрегатора (₽) fueling;Заправки (₽) fueling_compensation_value;Компенсация заправок (₽) shift_buy;Покупка смены (₽) shift_buy_compensation_value;Компенсация покупок смен (₽) others;Прочее (₽) user_dirty_amount;«Грязный» доход водителя (накат) (₽) user_income;«Чистый» доход водителя (₽) park_dirty_amount;«Грязный» доход парка (₽) park_income;«Чистый» доход парка (₽) tariff_trips_per_hour;Тариф поездок/час user_income_per_hour;Чистый доход водителя/час park_income_per_hour;Чистый доход парка/час tariff_trips_per_km;Тариф поездок/км user_income_per_km;Чистый доход водителя/км park_income_per_km;Чистый доход парка/км stats_last_update;Дата и время последнего обновления статистики смены

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

user_id;UUID;да;ID пользователя внутри taxiCRM ignore_aggregator_limit;boolean;нет;Метка “Игнорировать лимит агрегаторов” daily_payout_limit_value;float;нет;Новое значение для дневного лимита на выплаты daily_payout_limit_date;dateTime;нет;Дата, с которой начнет действовать новое значение дневного лимита на выплаты (если не передано, но передано значение лимита, то значение ставится на текущие дату/время) personal_limit_value;float;нет;Новое значение для лимита по счетам агрегаторов personal_limit_date;dateTime;нет;Дата, с которой начнет действовать новое значение лимита по счетам агрегаторов (если не передано, но передано значение лимита, то значение ставится на текущие дату/время) timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки data;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив с информацией о приименных изменениях

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) creator_user_id – идентификатор пользователя, создавшего чат 2) target_user_id – идентификатор пользователя, для которого создан чат 3) responsible_user_id - идентификатор пользователя, ответственного за чат 4) date_start – дата начала списка (если этот параметр не указан, то вернется список начиная с сегодня). 5) time_start – время начала списка (по умолчанию – 00:00:00) 6) date_end – дата конца списка (если этот параметр не указан, то возвращается список в период от даты начала до текущей даты) 7) time_end – время конца списка (по умолчанию – 23:59:59) 8) status – статус чата: 0 – новый, 1 – активный, 5 – информативный (без ответа), 6 – завершен timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки chats_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком

Параметр;Описание

chat_id;UUID чата title;Тема чата creator_user_id;ID создателя чата target_user_id;ID пользователя, для которого создан чат responsible_user_id;ID пользователя, ответственного за чат dateTime;Дата и время создания чата message_dateTime;Дата и время последнего сообщения в чате status;Статус чата: 0 – новый, 1 – активный, 5 – информативный (без ответа), 6 – завершен answered;Метка, обозначающая, что на сообщение в чате ответили creator_user_id_user;ФИО создателя чата target_user_id_user;ФИО пользователя, для которого создан чат responsible_user_id_user;ФИО пользователя, ответственного за чат

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

chat_id;UUID;да;ID чата внутри taxiCRM timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки data;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком сообщений

Параметр;Описание

message_id;Id сообщения внутри taxiCRM user_id;Id создателя сообщения user_name;Отправитель text;Содержимое сообщения text_without_html;Содержимое сообщения без html тэгов dateTime;Дата и время создания сообщения editing_dateTime;Дата и время редактирования сообщения status;Статус сообщения: 0 – неактуальное, 1 – актуальное, 3 – автоматическое, 5 – системное, 6 - удалено

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

text;string;д;Текст сообщения chat_id;UUID;нет;ID чата внутри taxiCRM chat_title;string;да, если не передан chat_id;Если не передан chat_id, то создаст новый чат с таким названием target_user_id;UUID;да, если не передан chat_id;Пользователь, для которого создается чат. Если не передан chat_id, то создаст чат для этого пользователя с названием chat_title creator_user_id;UUID;нет;Пользователь, от лица которого отправляются сообщения в чат (если не передан, то отправитель – таксопарк) timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки data;array;нет;Информация и созданном сообщении

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters;array;нет;Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) filter_manager_id– идентификатор пользователя, ответственного за авто 2) filter_brands – бренд авто 3) filter_models – модель авто 4) filter_owner_id – идентификатор пользователя, владелец авто 5) filter_renter_id – идентификатор пользователя, которому авто сдается в аренду timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки cars_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком

Параметр;Описание

id;Номер авто в базе car_id;ID авто в системе owner_id;ID пользователя владельца авто manager_id;ID ответственного за авто status;Статус авто в системе: 9 - Не работает.1 - Не определен. 2 - На техосмотре. 3 - В ремонте. 6 - В угоне. 7 - Работает. 8 - В гараже number;Регистрационный номер авто brand;Марка авто model;Модель авто color;Цвет авто year;Год выпуска авто transmission;Вид КПП авто sts;Номер СТС авто sts_valid;Метка валидности указанного номера СТС. Если null - проверка еще не выполнялась sts_date_start;Дата выдачи СТС sts_date_end;Дата окончания действия СТС pts;Номер ПТС авто vin;VIN номер авто osago;Номер ОСАГО авто transportation_license;Номер лицензии на перевозку odometer;Пробег авто рассчитанный автоматически odometer_manual;Пробег авто указанный вручную odometer_last_update;Дата и время последнего автоматического обновления данных по пробегу odometer_last_manual_update;Дата и время последнего ручного обновления данных по пробегу через профиль trips;Количество поездок которые выполнены на этом авто count_users;Количество пользователей, использующих это авто в данный момент avatar;Имя файла аватара автомобиля osago_file;Имя файла фото ОСАГО авто sts_file;Имя файла фото СТС авто sts_file_back;Имя файла фото СТС авто, обратная сторона pts_file;Имя файла фото ПТС авто pts_file_back;Имя файла фото ПТС авто, обратная сторона transportation_license_file_name;Имя файла фото номера лицензии на перевозку rentable;Метка возможности сдать авто в аренду check_penalties;Метка необходимости проверить штрафы check_penalties_count;Количество проверок штрафов last_penalty_update;Дата и время последнего успешного обновления информации по штрафам actual_penalties;Количество актуальных штрафов owner_rent_transfer;Метка нужно ли переводить сумму аренды авто на баланс собственника или нет: 0 - нет. 1 - да owner_rent_percent;Процент от суммы аренды, который будет начисляться собственнику автомобиля(0-100) owner_rent_max_daily_amount;Максимальная сумма от аренды авто для перевода собственнику автомобиля за календарные сутки gps_service;Название сервиса GPS мониторинга авто, если он есть gps_object_id;ID маяка в сервисе GPS мониторинга авто, если он известен check_move_not_on_shifts;Метка необходимости проверить перемещение авто вне смен и активных договоров аренды last_gps_track_date;Последняя дата за которую были загружены данные GPS треков авто last_gps_track_update;Дата и время последнего обновления данных GPS треков авто events;Метка о наличии активных событий для авто shift_available;Метка о доступности на сменах авто shift_user_available;Метка о возможности водителей выбирать данный автомобиль для смены vervex_card_number;Номер топливной карты в системе Vervex shell_card_number;Номер топливной карты в системе Shell block_engine_status;Метка о блокировке двигателя(1-заблокирован, 2-разблокирован) balance;Баланс автомобиля balance_last_update;Дата и время последнего успешного ПОЛНОГО обновления баланса автомобиля last_photo_control_date;Дата последнего пройденного фотоконтроля

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки data;array;нет;Содержит в себе два массива: 1. methods – список способов выплат 2. periods – список периодичностей выплат

Параметр;Описание

setting_id;Id настройки payment_method;Метод выплаты payment_method_service;Содержит в себе два массива: 1. methods – список способов выплат 2. periods – список периодичностей выплат commission;Комиссия метода выплаты commission_fixed;Фиксированная комиссия метода выплаты за каждую выплату commission_minimum;Минимальная комиссия метода выплаты за каждую выплату tinkoff_card_commission;Комиссия метода выплаты на карты Тинькофф tinkoff_card_commission_fixed;Фиксированная комиссия метода выплаты за каждую выплату на карты Тинькофф tinkoff_card_commission_minimum;Минимальная комиссия метода выплаты за каждую выплату на карты Тинькофф maximum_daily_amount;Размер максимальной суммы выплаты этим способом в течении календарных суток. 0 (ноль) - без ограничений roles;Массив с id Ролей, на которых распространена настройка (если Null, то доступно всем) sms_inform;Метка о необходимости отправить смс сообщение о выплате: 0 - не отправлять, 1 - отправлять users_use;Количество пользователей, использующих этот метод

Параметр;Описание

setting_id;Id настройки payment_period;Периодичность days;День недели, месяца или количество дней заморозки hours;Минимальное количество часов, которое должны отлежаться транзакции прежде чем они попадут в выплаты time;Время commission;Комиссия периодичности выплаты commission_fixed;Фиксированная комиссия периодичности выплаты за каждую выплату commission_minimum;Минимальная комиссия периодичности выплаты за каждую выплату no_confirmation;Метка разрешающая или запрещающая формирования выплат без подтверждения администратором (автооплату): 0 - запрещено; 1 - разрешено; roles;Массив с id Ролей, на которых распространена настройка (если Null, то доступно всем) users_use;Количество пользователей, использующих этот метод

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки roles_list;array;нет;Содержит в себе два массива: 1. methods – список способов выплат 2. periods – список периодичностей выплат count;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе количество ролей, попадающих под фильтры total;int;нет;Возвращается только если запрос выполнен успешно. Содержит в себе общее количество ролей

Параметр;Описание

role_id;Id роли name;Название роли в системе users_use;Количество пользователей, использующих эту роль

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

timestamp;int;да;UNIX время формирования запроса user_id;uuid;да;ID редактируемого пользователя внутри системы legal_status;int;нет;Юридический статус. Возможные значения: 1 – Физическое лицо 2 – Самозанятый 3 – ИП 4 - ООО last_name;string;нет;Фамилия first_name;string;нет;Имя middle_name;string;нет;Отчество, передать Null, чтобы удалить gender;Int?;нет;Пол. Возможные значения: Null - не указан 1 - мужской 2 - женский birthday;date;нет;Дата рождения формата Y-m-d, передать Null, чтобы удалить email;string;нет;Электронная почта, передать Null, чтобы удалить region;int;нет;Числовой номер региона (например, передать 95 – Чеченская республика), 0 – не указан status;int;нет;Статус. Возможные значения: 0 - заблокирован 1 – активен 5 – выплаты заблокированы kis_art_id;string;нет;KIS АРТ ID, передать Null, чтобы удалить passport;string;нет;Серия и номер паспорта, передать Null, чтобы удалить passport_issue;date;нет;Дата выдачи паспорта формата Y-m-d, передать Null, чтобы удалить passport_department_code;string;нет;Код подразделения, передать Null, чтобы удалить passport_issued_by;string;нет;Кем выдан паспорт, передать Null, чтобы удалить reg_place;string;нет;Место регистрации, передать Null, чтобы удалить birth_place;string;нет;Место рождения, передать Null, чтобы удалить address;string;нет;Адрес проживания , передать Null, чтобы удалить driver_license;string;нет;Номер ВУ, передать Null, чтобы удалить driver_license_issue;date;нет;Дата выдачи ВУ, передать Null, чтобы удалить manager_id;uuid;нет;ID ответственного менеджера внутри системы , передать Null, чтобы удалить role_id;uuid;нет;ID роли в системе, НЕЛЬЗЯ УКАЗЫВАТЬ РОЛЬ АДМИНИСТРАТОР И СЛУЖБА ПОДДЕРЖКИ!

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

user_id;UUID;да;ID пользователя внутри taxiCRM payment_method;UUID;нет;ID способа выплат для пользователя (можно получить в интерфейсе #15) payment_period;UUID;нет;ID периодичности выплат для пользователя (можно получить в интерфейсе #15)

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

user_id;UUID;да;ID пользователя внутри taxiCRM

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки payouts_methods_list;array;нет;Возвращается только если запрос выполнился успешно, содержит в себе список всех реквизитов пользователя

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

user_id;UUID;да;ID пользователя внутри taxiCRM type;string;да;Тип добавляемого реквизита, возможные значения: bank – банковский счёт, card – банковская карта, qiwi – QIWI кошелек ДАЛЬНЕШИЕ ПАРАМЕТРЫ ПЕРЕДАЮТСЯ В ЗАВИСИМОСТИ ОТ ТИПА РЕКВИЗИТА Банковский счёт payment_bic;string;БИК банка payment_account;string;Номер счёта payment_receiver_inn;string;ИНН payment_receiver;string;Получать перевода Банковская карта card_number;string;Номер карты QIWI кошелек qiwi_number;string;Номер QIWI кошелька

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

requisite_id;UUID;да;ID платежного реквизита пользователя

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

user_id;UUID;да;ID пользователя внутри taxiCRM requisite_id;UUID;да;ID платежного реквизита пользователя, который будет выбран «по умолчанию»

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

filters; array; нет; Список параметров, по которым происходит фильтрация возвращаемых данных. Возможные значения: 1) date_start – дата начала поездки 2) time_start – время начала поездки 3) date_end – дата конца 4) time_end – время конца 5) car_id – Ид авто 6) status – статус штрафа, возможные значения: actual_not_paid – актуальные, неоплаченные; paid – оплаченные; not_actual – не актуальные timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки penalties_list;array;нет;Возвращается только если запрос выполнен успешно. Содержит в себе массив со списком

HTTP код ответа;Причина

car_id;ID авто в системе car_name;Название авто penalty_id;ID штрафа dateTime;Дата и время совершения правонарушения source;Источник штрафа uin;УИН Штрафа ruling;Постановление amount;Сумма штрафа amount_discount;Сумма с учетом скидки description;Описание штрафа status;Статус штрафа status_id;ИД Статуса штрафа discount_till;Дата, до которой действует скидка

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)

Параметр;Тип;Обязательный;Описание

penalty_id;UUID;да;ID Штрафа внутри системы timestamp;int;да;UNIX время формирования запроса

Параметр;Тип;Обязательный;Описание

success;boolean;да;Статус обработки запроса error;string;нет;Возвращается только при возникновении ошибки. Содержит в себе текст ошибки car_id;UUID;нет;ID авто в системе car_name;String;нет;Название авто penalty_id;UUID;нет;ID штрафа dateTime;String;нет;Дата и время совершения правонарушения source;String;нет;Источник штрафа uin;String;нет;УИН Штрафа ruling;String;нет;Постановление amount;Float;нет;Сумма штрафа amount_discount;Float;нет;Сумма с учетом скидки description;String;нет;Описание штрафа status;String;нет;Статус штрафа status_id;Int;нет;ИД Статуса штрафа discount_till;string;нет;Дата, до которой действует скидка photo_url string;нет;Ссылка на фото превышения check_photo;string;нет;Ссылка на фото чека

HTTP код ответа;Причина

200;Запрос выполнен успешно 400;Не передан обязательный параметр 401;Не передана подпись запроса или подпись неверна 402;Модуль системы, необходимый для обработки запроса, отключен или приостановлен 415;Ошибка при валидации переданных параметров 500;Технический сбой при обработке запроса (обратитесь в службу поддержки taxiCRM)