FinParse API Documentation 🏦

Welcome to the FinParse API developer portal! 🚀

FinParse is a production-grade, highly-extensible parsing engine built with FastAPI to process financial documents (PDF invoices and CSV/Excel bank statements) into clean, structured relational data.

Features at a Glance

• 🔍 Smart Format Recognition: Automatically identifies document types and handles variations across different banks and vendors.

• 🛡️ 3-Stage File Validation: Strict validation checks (Extension → MIME Type → File Content Headers) preventing malicious or invalid file uploads.

• ⚡ Polymorphic Parser Factory: Implemented with the Strategy and Factory design patterns, making it trivial to extend parsing logic to new formats.

• 📊 Reconciliation & Mathematical Audit: Auto-calculates invoice subtotals, taxes, and transaction directions, generating descriptive system warnings on mismatches.

• 💾 Case-Insensitive Vendor Deduplication: Automatically resolves vendor variations (e.g. “Amazon Inc” vs “Amazon”) to a canonical vendor registry.

• ⚙️ Fully Automated CI/CD & Docs: Automatic testing suite runs alongside Sphinx compilation, auto-deploying documentation pages.

🛠️ API Reference:

• Code Reference
  • app package
    • Subpackages
    • Submodules
    • Module contents
  • app.api package
    • Subpackages
    • Module contents
  • app.api.v1 package
    • Subpackages
    • Submodules
    • Module contents
  • app.api.v1.endpoints package
    • Submodules
    • Module contents
  • app.api.v1.endpoints.documents module
  • app.api.v1.router module
  • app.config module
    • Settings
    • get_settings()
  • app.core package
    • Submodules
    • Module contents
  • app.core.exceptions module
    • CSVEncodingError
    • CSVMissingRequiredColumnsError
    • CSVNoDataRowsError
    • CSVParseError
    • DuplicateFileError
    • EmptyFileError
    • FileMimeTypeMismatchError
    • FileTooLargeError
    • FinParseException
    • InvalidExtensionError
    • OCRFailedError
    • PDFCorruptedError
    • PDFPasswordRequiredError
    • PDFTooManyPagesError
    • PDFWrongPasswordError
    • PartialParseError
    • UnsupportedFormatError
    • UploadIncompleteError
  • app.core.logging module
    • get_logger()
    • setup_logging()
  • app.database module
  • app.dependencies module
  • app.main module
  • app.models package
    • Submodules
    • Module contents
  • app.models.bank_statement module
    • BankStatement
    • BankTransaction
  • app.models.base module
    • Base
    • TimestampMixin
    • UUIDPrimaryKeyMixin
  • app.models.custom_types module
    • IntegerArray
    • TextArray
  • app.models.document module
    • Document
  • app.models.enums module
    • DocumentType
    • JobStatus
    • TransactionType
  • app.models.invoice module
    • Invoice
    • InvoiceLineItem
    • Vendor
  • app.models.processing_job module
    • ProcessingJob
  • app.parsers package
    • Submodules
    • Module contents
  • app.parsers.base module
    • BaseParser
  • app.parsers.constants module
  • app.parsers.csv_parser module
    • CSVParser
    • FileReader
    • FormatDetector
    • PostProcessor
    • RowFilter
    • RowParser
  • app.parsers.factory module
  • app.parsers.pdf_parser module
    • PDFParser
  • app.parsers.schemas module
    • ColumnMapping
    • ParsedBankStatement
    • ParsedInvoice
    • ParsedInvoiceLineItem
    • ParsedTransaction
  • app.services package
    • Submodules
    • Module contents
  • app.services.document_service module
  • app.utils package
    • Submodules
    • Module contents
  • app.utils.amount_parser module
    • ParsedAmount
    • parse_amount()
    • parse_split_amounts()
  • app.utils.date_parser module
    • ParsedDate
    • infer_date_format_hint()
    • parse_date()
  • app.validators package
    • Submodules
    • Module contents
  • app.validators.file_validator module

Indices and Tables

• Index

• Module Index

• Search Page