Back to help

Reading Invoices via API

Loading invoice lists and their data in machine-readable format via REST API. Supports pagination and filtering. Responses contain complete invoice data including line items, contacts, and bank details.

Screenshots and a more detailed guide are coming soon.

1
Step 1 / 3

Paginated invoice list

Endpoint GET /api/invoice-isdoc returns a paginated list of invoices. Parameters: 'offset' (page index, default 0), 'limit' (items per page, default 25), 'exclude drafts' (filter out drafts). Response contains: 'items' (array of invoices with complete data), 'hasMore' (whether more records exist), 'totalCount' (total count in database).

2
Step 2 / 3

Response structure

Each invoice in the response contains complete data: invoice number, buyer and supplier details (name, ID, VAT ID, address, email), bank details (IBAN, BIC), invoice items (description, quantity, price, VAT), total amounts in local and foreign currency, dates (issue, due, taxable), symbols (variable, constant, specific), and invoice status.

3
Step 3 / 3

Generating ZUGFeRD via API

Endpoint POST /api/generate-zugferd-invoice accepts a PDF document and invoice data. The system generates ZUGFeRD XML from structured data and embeds it directly into the PDF file. The output is a PDF with embedded machine-readable data according to the European ZUGFeRD standard. Suitable for automated generation of electronic invoices for German and European buyers.