Перейти к содержанию

Модели данных

Все модели данных используют Pydantic для валидации и сериализации.


Чеки и операции

ServiceCheck

Позиция в чеке (услуга или товар).

Bases: BaseModel

Пример использования:

from nalogovich.models.operations import ServiceCheck

service = ServiceCheck(
    name="Разработка сайта",
    amount=30000.00,
    quantity=1
)

Operation

Информация о зарегистрированной операции (чеке).

Bases: BaseModel


OperationResponse

Ответ API со списком операций (чеков).

Bases: BaseModel

Пример:

response = await client.get_checks()

print(f"Всего чеков: {len(response.content)}")
print(f"Есть ещё: {response.has_more}")
print(f"Смещение: {response.current_offset}")
print(f"Лимит: {response.current_limit}")

Income

Информация о созданном доходе (чеке).

Bases: BaseModel


IncomeInfo

Подробная информация о доходе.

Bases: BaseModel


Счета

Invoice

Информация о счёте.

Bases: BaseModel

Ключевые поля:

  • invoice_id — уникальный ID счёта
  • payment_url — ссылка для оплаты
  • status — статус счёта
  • total_amount — общая сумма
  • client_name — имя клиента

InvoiceResponse

Ответ API со списком счетов.

Bases: BaseModel


PaymentTypeInfo

Информация о реквизитах для получения оплаты.

Bases: BaseModel

Реквизиты для получения оплаты

Пример:

from nalogovich.enums import InvoicePaymentType

payment_types = await client.get_payment_types(
    payment_type=InvoicePaymentType.PHONE
)

for pt in payment_types:
    print(f"{pt.phone} - {pt.bank_name}")