eba-xbridge

Getting Started

  • Quickstart Guide
    • Prerequisites
    • Installation
    • Use Case 1: XBRL-XML to XBRL-CSV Conversion
      • Basic Conversion
      • Output Structure
      • Conversion Options
      • Validate-Convert-Validate Pipeline
      • Batch Processing
    • Use Case 2: Standalone Validation
      • CLI Examples
      • Python API Examples
    • Use Case 3: XBRL-CSV Architecture Conversion
      • When to Use
      • How It Works
    • Next Steps
    • Troubleshooting
    • Getting Help

User Guide

  • Technical notes
    • XML_instances
    • Conversion process
      • Workarounds
    • Load Taxonomy
  • Validation Rules
    • Rule Attributes
    • Input Format Detection
    • 1. XML Instance Rules
      • 1.1 XML Well-formedness and Encoding
      • 1.2 Root Element
      • 1.3 Schema Reference (schemaRef)
      • 1.4 Filing Indicators
      • 1.5 Context Structure
      • 1.6 Fact Structure
      • 1.7 Unit Structure
      • 1.8 Document-level Checks
      • 1.9 Taxonomy Conformance
      • 1.10 Entity Identification
      • 1.11 Decimals Accuracy
      • 1.12 Currency Rules
      • 1.13 Non-monetary Numeric Values
      • 1.14 Additional Checks
      • 1.15 Guidance
    • 2. CSV Report Package Rules
      • 2.1 Report Package Structure
      • 2.2 Metadata File (report.json)
      • 2.3 Parameters File (parameters.csv)
      • 2.4 Filing Indicators File (FilingIndicators.csv)
      • 2.5 Data Table CSV Files
      • 2.6 Fact-level Validation
      • 2.7 Taxonomy Conformance
      • 2.8 Entity Identification
      • 2.9 Decimals Accuracy
      • 2.10 Currency Rules
      • 2.11 Non-monetary Numeric Values
      • 2.12 Decimal Representation
      • 2.13 Additional Checks
      • 2.14 Guidance
    • 3. Submission Package Naming Rules
      • 3.1 Overall File Name Structure
      • 3.2 Report Subject
      • 3.3 Country
      • 3.4 Framework Code and Module Version
      • 3.5 Module
      • 3.6 Reference Date
      • 3.7 Creation Timestamp
      • 3.8 Inner Content Naming
    • Rule Coverage Summary

API Reference

  • API Reference
    • Python API
    • Convert XBRL Instance to CSV
      • convert_instance()
    • Basic Usage
    • Advanced Usage Examples
      • Convert with Custom Options
      • Handle Validation Warnings
      • Batch Conversion
    • Parameters
    • Load an XBRL-XML Instance
      • load_instance()
    • Usage Examples
      • Basic Instance Loading
      • Inspect Instance Details
      • Validate Before Conversion
    • load_instance() Parameters
    • Return Value
  • Validation API
    • Overview
    • Design
      • Orthogonal Parameters
      • Severity Levels
      • Rule Organization
      • Post-conversion Mode
    • Quick Start
    • Public API
      • validate()
        • validate()
    • Usage Examples
      • Basic Validation
      • Enable EBA Rules
      • Validate a CSV Package
      • Post-Conversion Validation
      • Inspect Findings
      • JSON Output Example
    • Parameters
    • Integration with Conversion
    • Architecture
      • Rule Registry
      • Module Structure
      • Rule Selection Logic
      • Rule Implementation Pattern
    • Reference Documents
  • Command-Line Interface
    • Usage
    • Arguments
    • CLI Examples
    • Validate Command
    • Validate Examples
  • Converter
    • Converter
      • Converter.convert()
      • Converter.convert_csv()
      • Converter.convert_xml()
    • Generating variables:
    • Converting tables:
    • Converting filing indicators:
    • Converting parameters:
  • Taxonomy loader
    • Taxonomy class
      • Taxonomy
        • Taxonomy.from_taxonomy()
        • Taxonomy.get_module()
        • Taxonomy.load_modules()
        • Taxonomy.modules
  • Modules
    • Module class
      • Module
        • Module.architecture
        • Module.extract_tables()
        • Module.from_serialized()
        • Module.from_taxonomy()
        • Module.get_module_setup()
        • Module.get_table()
        • Module.is_relative_url()
        • Module.repeated_variables
        • Module.tables
        • Module.to_dict()
        • Module.variables_location
    • Table class
      • Table
        • Table.attributes
        • Table.check_taxonomy_architecture()
        • Table.extract_columns()
        • Table.extract_open_keys()
        • Table.extract_variables()
        • Table.filing_indicator_code
        • Table.from_dict()
        • Table.from_taxonomy()
        • Table.generate_variable_df()
        • Table.get_table_code()
        • Table.open_keys
        • Table.to_dict()
        • Table.variable_columns
        • Table.variable_df
        • Table.variables
    • Variable class
      • Variable
        • Variable.dimensions
        • Variable.extract_allowed_values()
        • Variable.extract_dimensions()
        • Variable.from_dict()
        • Variable.from_taxonomy()
        • Variable.to_dict()
  • XML Instance
    • Instance Class
      • Instance
        • Instance.base_currency
        • Instance.contexts
        • Instance.entity
        • Instance.facts
        • Instance.facts_list_dict
        • Instance.filing_indicators
        • Instance.from_path()
        • Instance.get_contexts()
        • Instance.get_facts()
        • Instance.get_facts_list_dict()
        • Instance.get_filing_indicators()
        • Instance.get_module_code()
        • Instance.get_units()
        • Instance.identifier_prefix
        • Instance.instance_df
        • Instance.module_code
        • Instance.module_ref
        • Instance.namespaces
        • Instance.parse()
        • Instance.period
        • Instance.table_files
        • Instance.temp_dir_path
        • Instance.to_df()
        • Instance.units
        • Instance.validate_entity()
    • Scenario Class
      • Scenario
        • Scenario.get_value()
        • Scenario.parse()
    • Context Class
      • Context
        • Context.entity
        • Context.id
        • Context.parse()
        • Context.period
        • Context.scenario
    • Fact Class
      • Fact
        • Fact.parse()
    • Filing Indicator Class
      • FilingIndicator
        • FilingIndicator.parse()

Additional Resources

  • GitHub Repository
  • Issue Tracker
  • Changelog
  • Contributing
  • Security Policy
eba-xbridge
  • Search

© Copyright 2025-2026 MeaningfulData.

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