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

# Глоссарий: Инвойсы и платежи

> Справочник моделей, полей, сигналов и статусов биллинга компании: счёт на оплату подписки через FreedomPay и провижининг лимитов при подтверждении.

Справочник к странице [«Инвойсы: счёт, оплата и провижининг»](/ru/logic/company-billing/invoices).

## Понятия

| Понятие                                | Значение                                                                                                                                                                                                                                                |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Сопоставление тип позиции → тип лимита | Словарь, связывающий типы позиций счёта (места/точки/инвентарь) с типами лимитов плана для их провижининга. Только «лимитные» позиции; модули и интеграции не входят.                                                                                   |
| Сигнал провижининга при оплате         | Обработчик по инвойсу: при статусе «Подтверждён» создаёт/обновляет лимиты плана, пополняет SMS-баланс и подключает интеграции. Ничего не делает, если статус не «Подтверждён»; SMS-пакет пересчитывается в деньги по цене одного SMS для этой компании. |
| Сигнал выдачи пакета документов        | Обработчик по инвойсу: при подтверждении создаёт пакет документов для оплаченных позиций тарифа интеграции подписи. Пропускает уже созданные пакеты.                                                                                                    |
| Задача рекуррентного выставления счёта | Периодическая задача: для карт с автосписанием и истекающими интеграциями создаёт инвойс и выполняет прямое списание через FreedomPay. Отбирает подключения с окончанием в течение суток; списывает по сохранённому токену карты.                       |
| Расчёт позиций и суммы счёта           | Функция расчёта цен позиций: тарифы интеграций/модулей продлеваются от текущего конца подключения, лимиты тарифицируются по превышению бесплатного базиса. Возвращает итоговую сумму и обогащённые позиции (цена, начало и конец периода).              |
| Формирование фискального чека          | Строит список позиций чека (наименование, количество, цена) для передачи в FreedomPay.                                                                                                                                                                  |
| Вебхук результата оплаты (FreedomPay)  | Публичный endpoint без авторизации, принимающий callback FreedomPay и отвечающий подписанным XML; меняет статус инвойса на «Подтверждён»/«Отклонён». Подтверждён / отклонён (+ошибка) / не завершён; подпись MD5 с секретом мерчанта.                   |
| Вью списка и создания инвойсов         | Список счетов компании (подтверждённые/отклонённые/возвращённые и свежие за 3 дня) и создание нового счёта с инициализацией оплаты.                                                                                                                     |
| Вью расчёта суммы счёта                | Предварительный расчёт позиций и итоговой суммы без создания инвойса.                                                                                                                                                                                   |
| Вью детали инвойса                     | Получение, обновление (синхронизация статуса) и удаление конкретного счёта компании.                                                                                                                                                                    |
| Вью ручной оплаты инвойса              | Повторная инициализация оплаты существующего счёта (формирование ссылки на оплату) без автосписания с карты. Запрещает оплату уже подтверждённого/возвращённого счёта.                                                                                  |

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

### Инвойс (счёт на оплату)

*Счёт компании на оплату подписки/модулей/лимитов, оплачиваемый через шлюз FreedomPay. Подтверждение запускает провижининг лимитов, SMS-баланса и интеграций.*

**Связи**

| Поле            | Тип   | Описание                                                          |
| --------------- | ----- | ----------------------------------------------------------------- |
| Компания        | связь | Владелец счёта (защищённое удаление)                              |
| Платёжная карта | связь | Сохранённая карта для автосписания; обнуляется при удалении карты |

**Деньги**

| Поле            | Тип             | Описание                                       |
| --------------- | --------------- | ---------------------------------------------- |
| Валюта          | текст           | По умолчанию KZT (тенге)                       |
| Сумма к оплате  | число (2 знака) | Итоговая сумма счёта                           |
| Списанная сумма | число (2 знака) | Фактически захваченная сумма при подтверждении |
| Сумма возврата  | число (2 знака) | Возвращённая сумма                             |

**Оплата**

| Поле             | Тип              | Описание                                                                                                                                                                                                                                                                      |
| ---------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Платёжный шлюз   | текст            | Провайдер оплаты; сейчас только FreedomPay                                                                                                                                                                                                                                    |
| Статус платежа   | текст            | В ожидании / Подтверждён / Отклонён / Возвращён                                                                                                                                                                                                                               |
| ID транзакции    | текст            | Идентификатор платежа во FreedomPay                                                                                                                                                                                                                                           |
| Ссылка на оплату | текст            | URL страницы оплаты FreedomPay                                                                                                                                                                                                                                                |
| Данные платежа   | структура (JSON) | Для оплаты через шлюз — телефон, данные карты (номер, срок, владелец, бренд) и способ оплаты из вебхука; для оплаты, зарегистрированной вручную, — признак ручной оплаты, источник, автор и комментарий (см. [глоссарий расчёта](/ru/logic/company-billing/pricing-glossary)) |
| Способ оплаты    | вычисляется      | Готовое к показу описание оплаты (платёжная система и маскированная карта либо пометка ручной регистрации); отдаётся по подтверждённому счёту                                                                                                                                 |

**Сроки**

| Поле            | Тип        | Описание                            |
| --------------- | ---------- | ----------------------------------- |
| Дата списания   | дата/время | Момент подтверждения оплаты         |
| Начало периода  | дата/время | Начало оплаченного периода подписки |
| Конец периода   | дата/время | Конец оплаченного периода подписки  |
| Дата создания   | дата/время | —                                   |
| Дата обновления | дата/время | —                                   |

### Позиция инвойса

*Отдельная строка счёта: тариф на модуль/интеграцию или объём лимита (места, точки, единицы инвентаря). Уникальна по паре (тип, инвойс, период интеграции).*

| Поле                       | Тип                            | Описание                                                                                 |
| -------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------- |
| Тип позиции                | текст                          | Что оплачивается: места, точки, инвентарь, модуль или интеграция                         |
| Инвойс                     | связь                          | Счёт, к которому относится позиция                                                       |
| Тарифный период интеграции | связь                          | Выбранный тариф/период для модуля или интеграции                                         |
| Начало периода             | дата/время                     | Начало действия позиции                                                                  |
| Конец периода              | дата/время (может быть пустым) | Конец действия позиции; пусто для количественных тарифов, которые не истекают по времени |
| Количество                 | число                          | Число оплачиваемых единиц                                                                |
| Цена                       | число (2 знака)                | Стоимость позиции                                                                        |
| Сумма                      | число (2 знака)                | Итог по позиции (дублирует цену)                                                         |

### Ошибка оплаты инвойса

*Запись об отклонённом платеже с кодом и описанием причины от FreedomPay. Создаётся при отклонении в вебхуке.*

| Поле            | Тип        | Описание                           |
| --------------- | ---------- | ---------------------------------- |
| Инвойс          | связь      | Счёт, по которому произошла ошибка |
| Код ошибки      | текст      | Код отказа от FreedomPay           |
| Описание ошибки | текст      | Описание отказа от FreedomPay      |
| Дата создания   | дата/время | —                                  |

## Статусы и справочники

### Платёжный шлюз

* FreedomPay

### Статус платежа

* В ожидании
* Подтверждён
* Отклонён
* Возвращён

### Тип позиции счёта

* Пользовательские места
* Точки аренды
* Автомобили
* Самокаты
* Мотоциклы
* Модуль
* Интеграция
