What problem does it solve?
Audits XBRL numeric facts in SEC-style filings by comparing the reported (book) value from the instance document against the correct (true) value derived from the filing's calculation linkbase, US-GAAP taxonomy, and XBRL sign conventions. The correct value may be a summation recomputation, a sign correction for directional concepts (expenditures, losses must be positive), or an algebraic derivation. Handles fact extraction, context resolution, period matching, balance-type checking, and writing the final JSON result to results/auditing/.
Core Features & Use Cases
- Audits XBRL numeric facts by validating reported values against computed true values from linkbases and taxonomy.
- Supports period alignment, context resolution, and sign handling for directional concepts.
- Outputs a single JSON audit record via the write_audit.py script for reproducible results.
Quick Start
Audit a filing's numeric fact by computing the true value from the calculation linkbase and taxonomy and compare it to the reported value.