Logo

Getting Started

  • Installation
    • Requirements
    • Install from PyPI
      • Optional extras
    • Installing Tesseract (optional)
  • Quickstart
    • Process a single receipt
    • Process an image file
    • Batch processing
    • Web UI
    • Command-line interface
  • Configuration
    • Environment variables
    • .env file example
    • Programmatic configuration
    • Using a different model

API Reference

  • API Reference
    • Agent
      • finamt.agents.agent
        • finamt.agents.agent
        • FinanceAgent
      • finamt.agents.config
        • finamt.agents.config
        • Config
        • ModelConfig
        • AgentsConfig
        • AgentModelConfig
      • finamt.agents.pipeline
        • finamt.agents.pipeline
        • run_pipeline()
      • finamt.agents.prompts
        • finamt.agents.prompts
        • build_agent1_prompt()
        • build_agent2_prompt()
        • build_agent3_prompt()
        • build_agent4_prompt()
      • finamt.agents.llm_caller
        • finamt.agents.llm_caller
        • call_llm()
    • Models
      • finamt.models
        • Key design decisions
      • PostingDirection
      • PostingType
      • Posting
        • Posting.receipt_id
        • Posting.posting_type
        • Posting.direction
        • Posting.amount
        • Posting.description
        • Posting.to_dict()
      • ReceiptCategory
        • ReceiptCategory.VALID
        • ReceiptCategory.other()
      • ReceiptType
        • ReceiptType.purchase()
        • ReceiptType.sale()
      • Address
        • Address.street_and_number
        • Address.address_supplement
        • Address.postcode
        • Address.city
        • Address.state
        • Address.country
        • Address.to_dict()
        • Address.from_dict()
        • Address.empty()
      • Counterparty
        • Counterparty.id
        • Counterparty.name
        • Counterparty.address
        • Counterparty.tax_number
        • Counterparty.vat_id
        • Counterparty.verified
        • Counterparty.to_dict()
      • ReceiptItem
        • ReceiptItem.description
        • ReceiptItem.position
        • ReceiptItem.quantity
        • ReceiptItem.unit_price
        • ReceiptItem.total_price
        • ReceiptItem.vat_rate
        • ReceiptItem.vat_amount
        • ReceiptItem.category
        • ReceiptItem.to_dict()
      • ReceiptData
        • ReceiptData.raw_text
        • ReceiptData.id
        • ReceiptData.receipt_type
        • ReceiptData.counterparty
        • ReceiptData.receipt_number
        • ReceiptData.receipt_date
        • ReceiptData.total_amount
        • ReceiptData.vat_percentage
        • ReceiptData.vat_amount
        • ReceiptData.currency
        • ReceiptData.category
        • ReceiptData.subcategory
        • ReceiptData.description
        • ReceiptData.items
        • ReceiptData.vat_splits
        • ReceiptData.validation_warnings
        • ReceiptData.private_use_share
        • ReceiptData.einfuhr_vat
        • ReceiptData.vendor
        • ReceiptData.net_amount
        • ReceiptData.is_purchase
        • ReceiptData.is_sale
        • ReceiptData.generate_postings()
        • ReceiptData.business_net
        • ReceiptData.business_vat
        • ReceiptData.validate()
        • ReceiptData.to_dict()
        • ReceiptData.to_json()
      • ExtractionResult
        • ExtractionResult.success
        • ExtractionResult.data
        • ExtractionResult.error_message
        • ExtractionResult.processing_time
        • ExtractionResult.duplicate
        • ExtractionResult.existing_id
        • ExtractionResult.to_dict()
    • Exceptions
      • finamt.exceptions
      • FinanceAgentError
      • OCRProcessingError
      • LLMExtractionError
      • InvalidReceiptError
      • DuplicateReceiptError
        • DuplicateReceiptError.existing_id
    • Storage
      • finamt.storage.base
        • finamt.storage.base
        • ReceiptRepository
      • finamt.storage.sqlite
        • finamt.storage.sqlite
        • SQLiteRepository
      • finamt.storage.project
        • finamt.storage.project
        • ProjectLayout
        • resolve_project()
        • layout_from_db_path()
        • validate_project_name()
        • list_projects()
    • CLI
      • finamt.cli
        • Usage examples
      • FinamtCLI
        • FinamtCLI.print_version()
        • FinamtCLI.process_receipt()
        • FinamtCLI.batch_process()
        • FinamtCLI.ingest_receipts()
        • FinamtCLI.run_ustva()
      • callback()
      • cmd_process()
      • cmd_batch()
      • cmd_ustva()
      • cmd_serve()
      • main()
    • Utilities
      • finamt.utils
      • DataExtractor
        • DataExtractor.extract_company_name()
        • DataExtractor.extract_date()
        • DataExtractor.extract_amounts()
        • DataExtractor.extract_vat_info()
        • DataExtractor.extract_items()
      • clean_json_response()
      • parse_decimal()
      • parse_date()

Project

  • Changelog
    • Changelog
      • Version 0.21.0 (2026-05-31)
        • Annual Umsatzsteuererklärung (USt 2A) — ELSTER submission via ERiC
      • Version 0.20.0 (2026-05-25)
        • Removed system dependency: Ollama → HuggingFace direct inference
      • Version 0.19.0 (2026-05-25)
        • New features / improvements
      • Version 0.18.0 (2026-05-17)
        • New features / improvements
      • Version 0.17.3 (2026-05-17)
        • Repository / licensing
      • Version 0.17.2 (2026-05-03)
        • Tooling / code quality
      • Version 0.17.1 (2026-04-26)
        • New features / improvements
      • Version 0.17.0 (2026-04-26)
        • New features
      • Version 0.16.2 (2026-04-25)
        • Bug fixes / improvements
      • Version 0.16.1 (2026-04-19)
        • Bug fixes / improvements
      • Version 0.16.0 (2026-04-19)
        • New features / improvements
      • Version 0.15.0 (2026-04-13)
        • New features / improvements
      • Version 0.14.4 (2026-04-08)
        • New features
      • Version 0.14.3 (2026-04-07)
        • New features
      • Version 0.14.2 (2026-04-06)
        • New features
      • Version 0.14.1 (2026-04-06)
        • New features
      • Version 0.14.0 (2026-04-05)
        • New features
        • Bug fixes / improvements
      • Version 0.13.2 (2026-04-05)
        • New features
      • Version 0.13.1 (2026-04-05)
        • New features
        • Bug fixes / improvements
      • Version 0.13.0 (2026-04-04)
        • New features
        • Bug fixes / improvements
      • Version 0.12.6 (2026-04-03)
        • Bug fixes
      • Version 0.12.5 (2026-04-03)
        • Bug fixes
      • Version 0.12.4 (2026-04-03)
        • Bug fixes
      • Version 0.12.3 (2026-04-03)
        • Bug fixes
      • Version 0.12.2 (2026-04-03)
      • Version 0.12.1 (2026-04-03)
      • Version 0.12.0 (2026-04-03)
      • Version 0.11.4 (2026-03-26)
      • Version 0.11.3 (2026-03-26)
      • Version 0.11.1 (2026-03-23)
      • Version 0.11.0 (2026-03-23)
      • Version 0.10.1 (2026-03-21)
      • Version 0.10.0 (2026-03-21)
      • Version 0.9.2 (2026-03-21)
      • Version 0.9.1 (2026-03-21)
      • Version 0.9.0 (2026-03-21)
      • Version 0.8.1 (2026-03-20)
      • Version 0.8.0 (2026-03-20)
      • Version 0.7.5 (2026-03-20)
      • Version 0.7.4 (2026-03-17)
      • Version 0.7.3 (2026-03-17)
      • Version 0.7.2 (2026-03-17)
      • Version 0.7.1 (2026-03-17)
      • Version 0.7.0 (2026-03-17)
      • Version 0.6.0 (2026-03-15)
      • Version 0.5.5 (2026-03-15)
      • Version 0.5.4 (2026-03-14)
      • Version 0.5.3 (2026-03-10)
      • Version 0.5.2 (2026-03-10)
      • Version 0.5.1 (2026-03-07)
      • Version 0.5.0 (2026-03-07)
      • Version 0.4.6 (2026-03-06)
      • Version 0.4.5 (2026-03-06)
      • Version 0.4.4 (2026-03-01)
      • Version 0.4.3 (2026-03-01)
      • Version 0.4.2 (2026-03-01)
      • Version 0.4.1 (2026-03-01)
      • Version 0.4.0 (2026-03-01)
      • Version 0.3.2 (2026-02-25)
      • Version 0.3.1 (2026-02-24)
      • Version 0.3.0 (2026-02-24)
      • Version 0.2.0 (2026-02-23)
      • Version 0.1.5 (2026-02-22)
      • Version 0.1.4 (2026-02-22)
      • Version 0.1.3 (2026-02-21)
      • Version 0.1.2 (2025-07-10)
      • Version 0.1.1 (2025-07-10)
      • Version 0.1.0 (2025-07-10)
finamt
  • Python Module Index

Python Module Index

f
 
f
- finamt
    finamt.agents.agent
    finamt.agents.config
    finamt.agents.llm_caller
    finamt.agents.pipeline
    finamt.agents.prompts
    finamt.cli
    finamt.exceptions
    finamt.models
    finamt.storage.base
    finamt.storage.project
    finamt.storage.sqlite
    finamt.utils

© Copyright 2026, Yauheniya Varabyova.

Built with Sphinx using a theme provided by Read the Docs.