> ## Documentation Index > Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt > Use this file to discover all available pages before exploring further. # Глоссарий: API компании: авто и штрафы > Справочник моделей, фильтров и статусов интеграции сервиса автоштрафов — автомобили, водители, компании и штрафы ПДД, доступные компании через API. Справочник к странице [«API компании: авто и штрафы»](/ru/logic/auto-penalties/company-api). ## Понятия | Понятие | Значение | | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Автомобиль сервиса автоштрафов | Автомобиль, известный сервису автоштрафов, по которому подтягиваются штрафы. | | Водитель сервиса автоштрафов | Водитель-нарушитель, связанный со штрафом; дедупликация по идентификатору во внешнем сервисе. | | Компания сервиса автоштрафов | Компания-нарушитель (владелец авто), связанная со штрафом; дедупликация по идентификатору во внешнем сервисе. | | Штраф | Штраф ПДД со всеми реквизитами оплаты, документами и связями с авто, водителем и компанией. | | Кастомный статус штрафа | Пользовательский статус штрафа, задаваемый на уровне компании вручную. Общие статусы (без компании) видны и доступны на выбор всем, но менять и удалять их компания не может. | | Привязка авто компании к сервису автоштрафов | Связь автомобиля компании (единицы инвентаря) с автомобилем сервиса автоштрафов. | | Фильтр штрафов | Набор фильтров для списка штрафов, ограниченного машинами компании. | | База выборки штрафов | Общая логика: ограничивает штрафы машинами компании и сопоставляет их с арендами и клиентами по времени нарушения. | ## Модели и поля ### Автомобиль сервиса автоштрафов *Автомобиль, известный сервису автоштрафов, по которому подтягиваются штрафы. Идентифицируется уникальным ID во внешнем сервисе.* **Идентификация** | Поле | Тип | Описание | | ------------------------ | ----- | ------------------------------------------------------------ | | ID в сервисе автоштрафов | число | Уникальный идентификатор авто во внешнем сервисе автоштрафов | | Номер автомобиля | текст | Госномер автомобиля | | Номер техпаспорта | текст | Номер технического паспорта авто | **Состояние** | Поле | Тип | Описание | | -------------- | ---------- | ----------------------------------------------- | | Дата активации | дата/время | Когда авто было активировано для синхронизации | | Активен | флаг | Включена ли синхронизация штрафов по этому авто | **Служебное** | Поле | Тип | Описание | | --------------- | ---------- | ----------------------------------- | | Дата создания | дата/время | Момент появления записи в системе. | | Дата обновления | дата/время | Момент последнего изменения записи. | ### Водитель сервиса автоштрафов *Водитель-нарушитель, связанный со штрафом. Дедупликация по идентификатору во внешнем сервисе.* | Поле | Тип | Описание | | ------------------------- | ----- | ---------------------------------------------------- | | ID в сервисе автоштрафов | число | Уникальный идентификатор водителя во внешнем сервисе | | ИИН | текст | Индивидуальный идентификационный номер водителя | | Номер удостоверения | текст | Номер водительского удостоверения | | Дата выдачи удостоверения | дата | Дата выдачи водительского удостоверения | | Имя | текст | — | | Фамилия | текст | — | | Отчество | текст | — | ### Компания сервиса автоштрафов *Компания-нарушитель (владелец авто), связанная со штрафом. Дедупликация по идентификатору во внешнем сервисе.* | Поле | Тип | Описание | | ------------------------ | ----- | ---------------------------------------------------- | | ID в сервисе автоштрафов | число | Уникальный идентификатор компании во внешнем сервисе | | БИН | текст | Бизнес-идентификационный номер компании | | Название компании | текст | — | ### Кастомный статус штрафа *Пользовательский статус штрафа, задаваемый на уровне компании вручную. Присвоить штрафу можно только статус своей компании или общий; изменять и удалять — только статус своей компании.* | Поле | Тип | Описание | | -------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------- | | Компания | связь | Компания, которой принадлежит статус; пустое значение означает общий статус, доступный всем компаниям на выбор, но не на изменение | | Название | текст | Название статуса | | Цвет | текст | Цвет статуса в HEX (по умолчанию #ffffff) | ### Штраф *Штраф ПДД со всеми реквизитами оплаты, документами и связями с авто, водителем и компанией. PDF протокола скачивается по ссылке и сохраняется в облачном хранилище — при появлении или смене ссылки либо когда файла ещё нет.* **Основные данные** | Поле | Тип | Описание | | ------------------------------- | --------------- | -------------------------------------------------- | | ID в сервисе автоштрафов | число | Уникальный идентификатор штрафа во внешнем сервисе | | Номер протокола | текст | Номер протокола о нарушении | | Описание нарушения | текст | — | | Орган, выявивший правонарушение | текст | Название органа, зафиксировавшего нарушение | | Основная мера наказания | текст | — | | Сумма штрафа | число (2 знака) | Сумма штрафа в тенге | **Адрес и время нарушения** | Поле | Тип | Описание | | ---------------------- | ---------- | ---------------------------------------------------------- | | Адрес нарушения | текст | — | | Дата нарушения | дата | — | | Время нарушения | время | — | | Дата и время нарушения | дата/время | Вычисляется из даты и времени нарушения, только для чтения | **Статус оплаты** | Поле | Тип | Описание | | --------------------- | ---------- | -------------------------------------------- | | Оплачен | флаг | Оплачен ли штраф | | Дата оплаты | дата/время | — | | Дата истечения скидки | дата/время | До какого момента действует скидка на оплату | **Реквизиты оплаты** | Поле | Тип | Описание | | -------------------------- | ----- | --------------------------------------- | | КНО | текст | Код налогового органа (реквизит оплаты) | | КБК | текст | Код бюджетной классификации | | КНП | текст | Код назначения платежа | | Название налогового органа | текст | Получатель платежа | | IBAN налогового органа | текст | Банковский счёт получателя | | БИН налогового органа | текст | БИН получателя платежа | **Документы** | Поле | Тип | Описание | | ------------------------ | ------ | ----------------------------------------------- | | PDF протокола | файл | PDF протокола, сохранённый в облачном хранилище | | Ссылки на фото нарушения | список | Список ссылок на фотографии нарушения | **Связи** | Поле | Тип | Описание | | ---------- | ----- | ------------------------------------- | | Автомобиль | связь | Автомобиль, по которому выписан штраф | | Водитель | связь | Водитель-нарушитель | | Компания | связь | Компания-нарушитель (владелец авто) | ### Привязка авто компании к сервису автоштрафов *Связь автомобиля компании (единицы инвентаря) с автомобилем сервиса автоштрафов. Уникальна по паре «компания + авто».* | Поле | Тип | Описание | | ------------------------------ | ----- | ------------------------------------------------------------ | | Компания | связь | Компания, которой принадлежит привязка | | Автомобиль сервиса автоштрафов | связь | Связанный автомобиль сервиса автоштрафов (может быть пустым) | | ID единицы инвентаря | число | ID автомобиля в инвентаре компании | **Служебное** | Поле | Тип | Описание | | --------------- | ---------- | ------------------------------------- | | Дата создания | дата/время | Момент создания привязки. | | Дата обновления | дата/время | Момент последнего изменения привязки. | ### Фильтр штрафов *Набор фильтров для списка штрафов, ограниченного машинами компании. Фильтры по инвентарю, клиенту, аренде и точке проката применяются в выборке, а не в самом наборе фильтров.* **Область** | Поле | Тип | Описание | | -------------------- | ----- | ------------------------------------------------------ | | По единице инвентаря | число | ID инвентаря | | По клиенту | число | ID клиента; аренда сопоставляется по времени нарушения | | По аренде | число | ID заявки/аренды | | По точке проката | число | ID точки | **Атрибуты** | Поле | Тип | Описание | | ---------------------- | ------ | --------------------------------------------------------- | | Тип штрафа | список | Дорожное или прочее — по наличию фото | | С водителем | флаг | Есть водитель или без водителя | | Дата нарушения (от/до) | дата | Диапазон дат нарушения | | Сумма (от/до) | число | Диапазон суммы штрафа | | Оплачен | флаг | — | | Просмотрен | флаг | — | | Кастомный статус | связь | Точное совпадение, список значений или отсутствие статуса | ### Агрегаты по штрафам *Сводка по отфильтрованным штрафам: количество и суммы — всего, оплачено, в ожидании. Только чтение, вычисляется агрегацией.* **Количество** | Поле | Тип | Описание | | ----------------- | ----- | -------- | | Всего штрафов | число | — | | Оплачено (шт.) | число | — | | Не оплачено (шт.) | число | — | **Суммы** | Поле | Тип | Описание | | ------------------ | --------------- | -------- | | Общая сумма | число (2 знака) | — | | Сумма оплаченных | число (2 знака) | — | | Сумма неоплаченных | число (2 знака) | — | ### База выборки штрафов *Общая логика: ограничивает штрафы машинами компании и сопоставляет их с арендами и клиентами по времени нарушения. Наследуется списком, счётчиком и агрегатами штрафов; собственных полей не имеет.* ## Статусы и справочники ### Тип штрафа Тип штрафа для фильтрации определяется по наличию фото нарушения (в модели не хранится): * Дорожное нарушение (с фото) * Прочее (без фото)