Getting Started
Introduction
Get started with the finaX API.
The finaX API takes JSON, XML or PDF as an input and outputs the corresponding data. It generates the latest valid, supported version of the corresponding e-invoice format.
The API is a RESTful web service. It does not hold any state. It's merely a:
- validator for business terms and rules
- converter between different e-invoice formats
- PDF generator for ZUGFeRD invoices
The following diagram illustrates how the API generally works:
sequenceDiagram
participant YourSoftware@{ "type" : "entity" }
participant finaX
YourSoftware->>+finaX: invoice data (JSON)
finaX->>-YourSoftware: e-invoice (XML/PDF)
Note over YourSoftware,finaX: A typical request/response cycle
Looking for the API reference? Check out the finaX API Reference for detailed information on endpoints, request/response formats, and usage examples.
API mandatory fields
We created a todo list pdf that contains all mandatory fields for creating valid XRechnung (UBL/CII) and ZUGFeRD invoices using the finaX API. You can download it here.
The list contains the formally mandatory fields as per the specifications. Depending on the use case, additional fields may be required to ensure compliance with specific regulations or business rules.
