app.models package

Submodules

Module contents

Import all models so SQLAlchemy can discover them for metadata.create_all().

class app.models.BankStatement(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, Base

Statement-level metadata extracted from a CSV bank statement.

account_holder: Mapped[str | None]
account_number: Mapped[str | None]
bank_name: Mapped[str | None]
closing_balance: Mapped[Decimal | None]
currency: Mapped[str | None]
detected_delimiter: Mapped[str | None]
detected_encoding: Mapped[str | None]
detected_format: Mapped[str | None]
document: Mapped[Document]
document_id: Mapped[UUID]
extracted_at: Mapped[datetime]
id
opening_balance: Mapped[Decimal | None]
processing_job: Mapped[ProcessingJob]
processing_job_id: Mapped[UUID]
raw_headers: Mapped[dict[str, Any] | None]
statement_from: Mapped[date | None]
statement_to: Mapped[date | None]
total_rows_parsed: Mapped[int | None]
total_rows_skipped: Mapped[int | None]
transactions: Mapped[list[BankTransaction]]
updated_at: Mapped[datetime]
class app.models.BankTransaction(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, Base

Individual transaction row from a bank statement CSV.

amount: Mapped[Decimal]
balance_after: Mapped[Decimal | None]
bank_statement: Mapped[BankStatement]
bank_statement_id: Mapped[UUID]
created_at: Mapped[datetime]
currency: Mapped[str | None]
description: Mapped[str | None]
direction: Mapped[str]
id: Mapped[UUID]
parse_warnings: Mapped[list[str] | None]
raw_description: Mapped[str | None]
reference_number: Mapped[str | None]
row_index: Mapped[int]
transaction_date: Mapped[date]
transaction_type: Mapped[TransactionType]
value_date: Mapped[date | None]
class app.models.Base(**kwargs: Any)[source]

Bases: DeclarativeBase

metadata: ClassVar[MetaData] = MetaData()

Refers to the _schema.MetaData collection that will be used for new _schema.Table objects.

See also

orm_declarative_metadata

registry: ClassVar[registry] = <sqlalchemy.orm.decl_api.registry object>

Refers to the _orm.registry in use where new _orm.Mapper objects will be associated.

class app.models.Document(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, TimestampMixin, Base

Immutable record of every uploaded file. Acts as the root entity — everything else hangs off this.

checksum_sha256: Mapped[str]
created_at
deleted_at: Mapped[datetime | None]
document_type: Mapped[DocumentType]
file_size_bytes: Mapped[int]
file_type: Mapped[str]
filename: Mapped[str]
id
is_deleted: Mapped[bool]
original_name: Mapped[str]
processing_jobs: Mapped[list[ProcessingJob]]
storage_path: Mapped[str]
updated_at
uploaded_at: Mapped[datetime]
uploaded_by: Mapped[str]
class app.models.DocumentType(*values)[source]

Bases: str, Enum

BANK_STATEMENT = 'bank_statement'
INVOICE = 'invoice'
class app.models.Invoice(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, Base

Extracted Invoice Data.

confidence: Mapped[Decimal | None]
currency: Mapped[str | None]
discount_amount: Mapped[Decimal | None]
document: Mapped[Document]
document_id: Mapped[UUID]
due_date: Mapped[date | None]
extracted_at: Mapped[datetime]
id
invoice_date: Mapped[date | None]
invoice_index: Mapped[int]
invoice_number: Mapped[str | None]
line_items: Mapped[list[InvoiceLineItem]]
notes: Mapped[str | None]
page_range_end: Mapped[int | None]
page_range_start: Mapped[int | None]
processing_job: Mapped[ProcessingJob]
processing_job_id: Mapped[UUID]
raw_date_text: Mapped[str | None]
raw_total_text: Mapped[str | None]
raw_vendor_name: Mapped[str | None]
subtotal: Mapped[Decimal | None]
tax_amount: Mapped[Decimal | None]
total_amount: Mapped[Decimal | None]
updated_at: Mapped[datetime]
vendor: Mapped[Vendor | None]
vendor_id: Mapped[UUID | None]
class app.models.InvoiceLineItem(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, Base

Individual line items within an invoice.

created_at: Mapped[datetime]
description: Mapped[str | None]
id: Mapped[UUID]
invoice: Mapped[Invoice]
invoice_id: Mapped[UUID]
line_number: Mapped[int]
line_total: Mapped[Decimal | None]
quantity: Mapped[Decimal | None]
sku: Mapped[str | None]
tax_amount: Mapped[Decimal | None]
tax_rate: Mapped[Decimal | None]
unit_of_measure: Mapped[str | None]
unit_price: Mapped[Decimal | None]
class app.models.JobStatus(*values)[source]

Bases: str, Enum

COMPLETED = 'completed'
FAILED = 'failed'
PARTIAL = 'partial'
PENDING = 'pending'
PROCESSING = 'processing'
class app.models.ProcessingJob(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, Base

bank_statement: Mapped[BankStatement | None]
completed_at: Mapped[datetime | None]
created_at: Mapped[datetime]
document: Mapped[Document]
document_id: Mapped[UUID]
error_detail: Mapped[dict[str, Any] | None]
error_message: Mapped[str | None]
id
invoice: Mapped[Invoice | None]
is_reprocess: Mapped[bool]
max_retries: Mapped[int]
ocr_confidence_avg: Mapped[float | None]
ocr_engine: Mapped[str | None]
ocr_used: Mapped[bool]
parser_version: Mapped[str | None]
pdf_encryption_type: Mapped[str | None]
pdf_password_used: Mapped[bool]
retry_count: Mapped[int]
scanned_pages: Mapped[list[int] | None]
started_at: Mapped[datetime | None]
status: Mapped[JobStatus]
updated_at: Mapped[datetime]
warnings: Mapped[list[dict] | None]
class app.models.TransactionType(*values)[source]

Bases: str, Enum

CREDIT = 'credit'
DEBIT = 'debit'
FEE = 'fee'
INTEREST = 'interest'
TRANSFER = 'transfer'
UNKNOWN = 'unknown'
class app.models.Vendor(**kwargs)[source]

Bases: UUIDPrimaryKeyMixin, Base

Normalized vendor registry.

canonical_name: Mapped[str]
country: Mapped[str | None]
created_at: Mapped[datetime]
id: Mapped[UUID]
invoices: Mapped[list[Invoice]]
raw_names: Mapped[list[str]]
tax_id: Mapped[str | None]
updated_at: Mapped[datetime]