📄 Инвойс

Инвойс — это разовая финансовая сущность, предназначенная для приёма средств и последующей их обработки юнитом.

💡 Особенности работы:

• Инвойс служит для разового покрытия платежа: товар, услуга или конкретная операция.

• Инвойс может иметь кошелек только для валюты и сети, указанной при создании.

• Средства с инвойса перенаправляются на кошелек юнита только после достижения полной суммы инвойса.

• В случае, если средства были отправлены повторно по ошибке, их можно вернуть через поддержку или администратора бизнеса.

• В отличие от контрагента, инвойс не может иметь мультивалютные кошельки или субсчета — один инвойс = один кошелек для выбранной валюты/сети.

📘 Основная структура

{
    "id": 639,
    "uuid": "ccd43456-01ce-44f6-9fcd-e30e539d2758",
    "status": "awaiting_payment",
    "title": null,
    "description": null,
    "amount": "1",
    "total_available_amount": "0",
    "total_received_amount": "0",
    "total_fee_paid": "0",
    "unitId": 5,
    "currency": "ETH",
    "network": "ERC20",
    "customerEmail": null,
    "manager": { /* Manager info */ },
    "unit": { /* Unit info */ },
    "wallets": [ /* Wallet objects */ ],
    "transactions": []
}

🧩 Поля сущности

Поле	Тип	Nullable	Описание
id	number	❌	Уникальный идентификатор инвойса.
uuid	string	❌	Уникальный UUID инвойса.
status	string	❌	Статус инвойса: awaiting_payment, partially_paid, overpaid, paid, transferring, settled.
title	string	✅	Название инвойса (опционально).
description	string	✅	Описание инвойса (опционально).
amount	string	❌	Сумма инвойса, которую нужно получить для перевода на юнит.
total_available_amount	string	❌	Сумма средств, доступных для перевода на юнит после полной оплаты.
total_received_amount	string	❌	Сумма средств, фактически полученных на кошелек инвойса.
total_fee_paid	string	❌	Сумма уплаченных комиссий.
unitId	number	❌	Идентификатор юнита, которому принадлежит инвойс.
currency	string	❌	Валюта инвойса.
network	string	❌	Сеть инвойса.
customerEmail	string	✅	Email плательщика (опционально).
manager	object	❌	Информация о менеджере, который создал инвойс.
unit	object	❌	Информация о юните, к которому принадлежит инвойс.
wallets	array<Wallet>	❌	Кошельки, связанные с инвойсом. Один кошелек на валюту/сеть.
transactions	array<Transaction>	✅	Список транзакций по инвойсу.

🔗 Статусы инвойса

Статус	Описание
awaiting_payment	Инвойс создан и ожидает оплату.
partially_paid	Инвойс оплачен частично.
overpaid	Оплата превышает сумму инвойса.
paid	Инвойс полностью оплачен.
transferring	Средства в процессе перевода на юнит.
settled	Средства успешно зачислены на юнит.

🔗 Связанные сущности

Поле	Связь	Сущность	Тип связи
unitId	принадлежит	Unit	Many-to-One
wallets	содержит	Wallet	One-to-Many
transactions	содержит	Transaction	One-to-Many

⚙️ Использование

• Инвойс создаётся для разовой оплаты: товар, услуга или конкретная операция.

• Средства на кошелек инвойса не переводятся на юнит до полной оплаты.

• Инвойс фиксирует сумму, валюту и статус платежа, позволяя отслеживать оплату и автоматизировать переводы.

• Подходит для операций, где не нужен мультикошелек, как у клиента.