Skip to content

Getting Started

What is xTool?

xTool is a platform for electronic document management and invoice processing. The system provides comprehensive capabilities for:

  • Document conversion between various formats (JSON, XML, ZUGFeRD, IDoc)
  • Validation of electronic invoices according to XRechnung 3, Peppol BIS 3 standards
  • Document exchange through the Peppol network for international B2B interaction
  • PDF generation with embedded XML data (ZUGFeRD)
  • Document management with full audit trails and status tracking

xTool supports both real-time processing (without storage) and persistent storage of documents with full lifecycle management.

API Documentation

For integration with xTool, use our REST API. The main client API version is v1, which is the stable production version. Version v2 is currently in beta.

API v1 (Stable)

The primary client API version for production use:

  • Swagger UI - Interactive API explorer with live examples
  • ReDoc - Alternative API documentation interface
  • Scalar - Modern API documentation viewer

API v2 (Beta)

The second version of the API is currently in beta testing:

  • Swagger UI - Interactive API explorer with live examples
  • ReDoc - Alternative API documentation interface
  • Scalar - Modern API documentation viewer

Additional Resources

Authentication

API access requires an API key:

  1. Create an API key through the xTool web application
  2. Add the x-api-key header to all requests
  3. Keys are scoped to your organization for security

What's in the Documentation?

The xTool documentation includes:

  • Guides - Step-by-step instructions for getting started
  • Concepts - Description of key concepts:
  • Organizations and subsidiaries
  • Users and access rights
  • Documents and their lifecycle
  • Document formats (XRechnung, Peppol, ZUGFeRD)
  • Peppol network and transactions
  • API and tools
  • API Reference - Complete REST API documentation with examples
  • Tags - Tags for navigating the documentation

Contact

If you have questions or need assistance:

Next Steps

  1. Review the API Overview
  2. Explore the API v1 Swagger documentation for interactive examples
  3. Read the Concepts section to understand the system architecture
  4. Create an API key and start integrating