At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key from
LEXOFFICE_API_KEYis sent as theBearerprefixedAuthorizationheader. - Docs: https://developers.lexware.io/docs/
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
LEXOFFICE_API_KEY | Yes | Lexware Office (lexoffice) Public API key, created in the Lexware Office app under Add-ons > Public API Docs. |
Setup
- Create a Lexware Office account: Sign up at https://www.lexware.de (Lexware Office, formerly lexoffice). A regular trial account is sufficient for testing the Public API; there is no separate sandbox environment.
- Generate an API key: Log in to the Lexware Office app and open https://app.lexware.de/addons/public-api to create your Public API key. Only account administrators can create keys.
- Store the key: Set the key as LEXOFFICE_API_KEY. It is sent as a Bearer token in the Authorization header on every request.
- Since the rebranding from lexoffice to Lexware, the canonical API gateway is https://api.lexware.io (changed 26 May 2025). The legacy gateway api.lexoffice.io was only kept available until December 2025, so all tools use the new domain.
- The API is rate limited to 2 requests per second per client; HTTP 429 is returned when exceeded.
- POST /v1/files is a multipart/form-data upload: the binary file goes in the ‘file’ part and the upload type (‘voucher’) in the ‘type’ part.
- Invoices created via the API are drafts by default; pass finalize=true to create them with status open. Finalized invoices can no longer be edited freely.
- voucherType and voucherStatus are mandatory on the voucherlist endpoint; use ‘any’ to avoid filtering.
Tools
| Tool | Access | Description |
|---|---|---|
| List Vouchers | Read | List and filter bookkeeping vouchers (sales and purchase invoices, credit notes) via the voucherlist, e.g. to find open or overdue invoices |
| Get Invoice | Read | Retrieve a single invoice with line items, totals, tax conditions, and payment status |
| Create Invoice | Write | Create a sales invoice. Created as an editable draft by default; set finalize=true to immediately open it |
| List Contacts | Read | List and filter customers and vendors, e.g. to find the contactId for an invoice |
| Create Contact | Write | Create a customer or vendor contact for use on invoices and vouchers |
| Upload Voucher File | Write | Upload a receipt image or invoice file (pdf, jpg, png, xml; max 5 MB) for bookkeeping; returns the file id and the id of the voucher created for it |
| Download File | Read | Download an uploaded bookkeeping voucher file (receipt/invoice image) as binary data by its file id; Content-Type and Content-Disposition response headers carry the MIME type and suggested filename. For sales voucher documents prefer the document render flow. |
| Get Invoice Document | Read | Trigger PDF rendering for an invoice and return its documentFileId, which can then be downloaded via Download File. Required for invoices created through the API with status open; draft invoices have no document file and are rejected with 406. |
| Get Payments | Read | Get the payment status of an invoice or voucher: open amount, paid date, and payment items - the reliable way to check who actually paid |
Example prompts
- List my open and overdue invoices in Lexware Office and summarize the outstanding amounts.
- Create a draft invoice in Lexware Office for a customer; ask me for the line items first.
- Upload this receipt to Lexware Office as a bookkeeping voucher.