> ## 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.

# Глоссарий: Модель данных

> Справочник моделей и полей интеграции с сервисом автоштрафов — автомобили, водители, штрафы ПДД, уведомления и журнал синхронизации.

Справочник к странице [«Сервис автоштрафов: модель данных»](/ru/logic/auto-penalties/models).

## Понятия

| Понятие                                      | Значение                                                                                                                                                  |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Автомобиль сервиса автоштрафов               | Автомобиль, известный сервису автоштрафов, по которому подтягиваются штрафы; дедупликация по внешнему ID (уникальному идентификатору во внешнем сервисе). |
| Водитель сервиса автоштрафов                 | Водитель-нарушитель, связанный со штрафом; дедупликация по внешнему ID.                                                                                   |
| Компания сервиса автоштрафов                 | Компания-нарушитель (владелец авто), связанная со штрафом; дедупликация по внешнему ID.                                                                   |
| Кастомный статус штрафа                      | Пользовательский статус штрафа, задаваемый вручную на уровне компании.                                                                                    |
| Штраф                                        | Штраф ПДД со всеми реквизитами оплаты, документами и связями с авто, водителем и компанией.                                                               |
| Привязка авто компании к сервису автоштрафов | Связь автомобиля компании (единицы инвентаря) с автомобилем сервиса автоштрафов.                                                                          |
| Уведомление о штрафе                         | Запись об отправленном клиенту WhatsApp-уведомлении о штрафе.                                                                                             |
| Лог синхронизации                            | Журнал операций синхронизации с сервисом автоштрафов (выгрузка, приём уведомлений, авторизация).                                                          |

## Модели и поля

### Автомобиль сервиса автоштрафов

*Автомобиль, известный сервису автоштрафов, по которому подтягиваются штрафы.*

**Идентификация**

| Поле              | Тип   | Описание                                          |
| ----------------- | ----- | ------------------------------------------------- |
| Внешний ID        | число | Уникальный идентификатор авто во внешнем сервисе. |
| Номер автомобиля  | текст | Госномер автомобиля.                              |
| Номер техпаспорта | текст | Номер технического паспорта авто.                 |

**Состояние**

| Поле           | Тип        | Описание                                         |
| -------------- | ---------- | ------------------------------------------------ |
| Дата активации | дата/время | Когда авто было активировано для синхронизации.  |
| Активен        | флаг       | Включена ли синхронизация штрафов по этому авто. |

**Служебное**

| Поле            | Тип        | Описание                            |
| --------------- | ---------- | ----------------------------------- |
| Дата создания   | дата/время | Момент появления записи в системе.  |
| Дата обновления | дата/время | Момент последнего изменения записи. |

### Водитель сервиса автоштрафов

*Водитель-нарушитель, связанный со штрафом. Дедупликация по внешнему ID.*

| Поле                      | Тип   | Описание                                              |
| ------------------------- | ----- | ----------------------------------------------------- |
| Внешний ID                | число | Уникальный идентификатор водителя во внешнем сервисе. |
| ИИН                       | текст | Индивидуальный идентификационный номер водителя.      |
| Номер удостоверения       | текст | Номер водительского удостоверения.                    |
| Дата выдачи удостоверения | дата  | Дата выдачи водительского удостоверения.              |
| Имя                       | текст | —                                                     |
| Фамилия                   | текст | —                                                     |
| Отчество                  | текст | —                                                     |

### Компания сервиса автоштрафов

*Компания-нарушитель (владелец авто), связанная со штрафом. Дедупликация по внешнему ID.*

| Поле              | Тип   | Описание                                              |
| ----------------- | ----- | ----------------------------------------------------- |
| Внешний ID        | число | Уникальный идентификатор компании во внешнем сервисе. |
| БИН               | текст | Бизнес-идентификационный номер компании.              |
| Название компании | текст | —                                                     |

### Кастомный статус штрафа

*Пользовательский статус штрафа, задаваемый на уровне компании. Привязан к компании, задаётся вручную.*

| Поле     | Тип   | Описание                                                  |
| -------- | ----- | --------------------------------------------------------- |
| Компания | связь | Компания, которой принадлежит статус (может быть пустым). |
| Название | текст | Название статуса.                                         |
| Цвет     | текст | Цвет статуса в HEX (по умолчанию #ffffff).                |

### Штраф

*Штраф ПДД со всеми реквизитами оплаты, документами и связями с авто, водителем и компанией. PDF скачивается по ссылке и сохраняется в облачном хранилище — при появлении или смене ссылки либо когда файла ещё нет; неудачная загрузка не затирает уже сохранённый файл.*

**Основные данные**

| Поле                            | Тип             | Описание                                            |
| ------------------------------- | --------------- | --------------------------------------------------- |
| Внешний ID                      | число           | Уникальный идентификатор штрафа во внешнем сервисе. |
| Номер протокола                 | текст           | Номер протокола о нарушении.                        |
| Описание нарушения              | текст           | —                                                   |
| Орган, выявивший правонарушение | текст           | Название органа, зафиксировавшего нарушение.        |
| Основная мера наказания         | текст           | —                                                   |
| Сумма штрафа                    | число (2 знака) | Сумма штрафа в тенге.                               |

**Адрес и время нарушения**

| Поле                   | Тип        | Описание                                                    |
| ---------------------- | ---------- | ----------------------------------------------------------- |
| Адрес нарушения        | текст      | —                                                           |
| Дата нарушения         | дата       | —                                                           |
| Время нарушения        | время      | —                                                           |
| Дата и время нарушения | дата/время | Вычисляется из даты и времени нарушения, только для чтения. |

**Статус оплаты**

| Поле                  | Тип        | Описание                                      |
| --------------------- | ---------- | --------------------------------------------- |
| Оплачен               | флаг       | Оплачен ли штраф.                             |
| Дата оплаты           | дата/время | —                                             |
| Дата истечения скидки | дата/время | До какого момента действует скидка на оплату. |

**Реквизиты оплаты**

| Поле                       | Тип   | Описание                                 |
| -------------------------- | ----- | ---------------------------------------- |
| КНО                        | текст | Код налогового органа (реквизит оплаты). |
| КБК                        | текст | Код бюджетной классификации.             |
| КНП                        | текст | Код назначения платежа.                  |
| Название налогового органа | текст | Получатель платежа.                      |
| IBAN налогового органа     | текст | Банковский счёт получателя.              |
| БИН налогового органа      | текст | БИН получателя платежа.                  |

**Документы**

| Поле                     | Тип    | Описание                                         |
| ------------------------ | ------ | ------------------------------------------------ |
| PDF протокола            | файл   | PDF протокола, сохранённый в облачном хранилище. |
| Ссылки на фото нарушения | список | Список ссылок на фотографии нарушения.           |

**Связи**

| Поле       | Тип   | Описание                               |
| ---------- | ----- | -------------------------------------- |
| Автомобиль | связь | Автомобиль, по которому выписан штраф. |
| Водитель   | связь | Водитель-нарушитель.                   |
| Компания   | связь | Компания-нарушитель (владелец авто).   |

### Привязка авто компании к сервису автоштрафов

*Связь автомобиля компании (единицы инвентаря) с автомобилем сервиса автоштрафов. Уникальна по компании, авто и единице инвентаря.*

| Поле                           | Тип   | Описание                                                      |
| ------------------------------ | ----- | ------------------------------------------------------------- |
| Компания                       | связь | Компания, которой принадлежит привязка.                       |
| Автомобиль сервиса автоштрафов | связь | Связанный автомобиль сервиса автоштрафов (может быть пустым). |
| ID единицы инвентаря           | число | ID автомобиля в инвентаре компании.                           |

**Служебное**

| Поле            | Тип        | Описание                              |
| --------------- | ---------- | ------------------------------------- |
| Дата создания   | дата/время | Момент создания привязки.             |
| Дата обновления | дата/время | Момент последнего изменения привязки. |

### Уведомление о штрафе

*Запись об отправленном клиенту WhatsApp-уведомлении о штрафе. Уникальна по телефону и штрафу; создание ставит фоновую задачу отправки WhatsApp (до трёх повторов с интервалом 5 минут) и системное уведомление.*

| Поле        | Тип   | Описание                                                       |
| ----------- | ----- | -------------------------------------------------------------- |
| Телефон     | текст | Номер телефона получателя уведомления.                         |
| ID клиента  | число | Идентификатор клиента-получателя.                              |
| Компания    | связь | Компания, отправившая уведомление.                             |
| Штраф       | связь | Штраф, о котором уведомляют.                                   |
| Доп. данные | JSON  | Дополнительные данные (имя клиента, название компании и т.п.). |

### Лог синхронизации

*Журнал операций синхронизации с сервисом автоштрафов (выгрузка, приём уведомлений, авторизация). Создаётся в начале синхронизации и обновляется по завершении.*

| Поле              | Тип    | Описание                                                |
| ----------------- | ------ | ------------------------------------------------------- |
| Тип синхронизации | список | Выгрузка данных, получение уведомления или авторизация. |
| Статус            | список | В процессе, успешно или ошибка.                         |

**Итоги**

| Поле               | Тип   | Описание |
| ------------------ | ----- | -------- |
| Обработано записей | число | —        |
| Создано записей    | число | —        |
| Обновлено записей  | число | —        |

| Поле                | Тип          | Описание                                  |
| ------------------- | ------------ | ----------------------------------------- |
| Сообщение об ошибке | текст        | —                                         |
| Время выполнения    | длительность | Продолжительность операции синхронизации. |
