Integración de la API de Lexware Office: buenas prácticas e información clave

Lexware Office es una de las herramientas de contabilidad más utilizadas en Alemania por pequeñas empresas y autónomos. Lanzada originalmente como lexoffice y renombrada como Lexware Office en 2024, gestiona la contabilidad de cientos de miles de pymes en la región DACH. Si tu software sirve a mercados de habla alemana y tus clientes usan Lexware, acceder a sus datos contables no es algo opcional. Es una necesidad competitiva.

En esta guía, explicamos cómo funciona la API de Lexware Office, cómo configurarla, las buenas prácticas que debes conocer y cómo Chift acelera todo el proceso.

¿Qué es la API de Lexware Office?

Lexware Office expone una única API REST pública en https://api.lexware.io/v1. La API usa JSON en todos los casos, excepto en los endpoints de archivos, que devuelven respuestas binarias o PDF. Todos los identificadores de recursos son UUIDs.

La API estaba originalmente alojada en api.lexoffice.io y el antiguo nombre de dominio sigue funcionando tras el rebranding de 2024, pero api.lexware.io es ahora la URL base oficial.

Los principales recursos disponibles a través de la API son:

• Contactos (clientes y proveedores)
• Facturas, abonos y facturas de anticipo (documentos de venta salientes)
• Justificantes (facturas de compra, gastos, asientos contables)
• Pagos y transacciones bancarias
• Archivos adjuntos (solo PDF)

No existe una v2 ni un endpoint alternativo. La API es estable en v1, que es la versión que utiliza Chift.

Cómo configurar la integración con Lexware Office

Conectarse a la API de Lexware requiere unos pocos pasos sencillos:

1. El usuario final crea o accede a su cuenta de Lexware Office en lexware.de o lexoffice.de. Se necesita una suscripción de pago para acceder a la API pública.
2. El usuario genera una clave API desde el portal de API pública de Lexware: accede a app.lexware.de y ve a Einstellungen > Öffentliche API.
3. La clave API tiene una vida útil infinita y está limitada a una sola organización. No hay flujo de renovación. Revocarla consiste simplemente en eliminarla desde el portal.
4. Un detalle importante: Lexware requiere aprobación antes de emitir claves API. Cuenta con aproximadamente un mes de plazo antes de que tus usuarios puedan activar la integración.
5. Cada solicitud a la API incluye el token en el encabezado Authorization con el prefijo Bearer, junto con Accept: application/json.

Chift gestiona automáticamente el almacenamiento del token y la autenticación de las solicitudes, de modo que tu equipo no tiene que ocuparse de ello por cada cliente.

{{CTA-1}}

¿Qué puedes construir con una integración de Lexware Office?

Conectar Lexware Office a través de Chift abre un amplio abanico de casos de uso prácticos para los proveedores de software que se dirigen a los mercados DACH.

Automatizar asientos contables desde herramientas de precontabilidad

Las plataformas de gestión de gastos o facturación pueden enviar datos financieros estructurados directamente a Lexware Office como justificantes o facturas, eliminando la reintroducción manual y manteniendo la contabilidad al día sin trabajo adicional para el usuario final.

Sincronizar datos de clientes y proveedores

Mantén los registros de contactos alineados entre tu CRM o ERP y Lexware Office. Cualquier actualización realizada en tu producto puede reflejarse automáticamente en Lexware, reduciendo duplicados y la degradación de los datos.

Alimentar previsiones de tesorería con datos AP/AR reales

Las herramientas de gestión de tesorería pueden extraer cuentas por cobrar y por pagar de Lexware Office para construir proyecciones precisas. Datos en tiempo real significa mejores decisiones para las pymes a las que sirves.

Facilitar el crédito digital con datos financieros actualizados

Las plataformas de préstamo pueden recuperar la antigüedad de facturas, el historial de pagos y los saldos de cuenta desde Lexware Office a través de la API Unificada de Contabilidad de Chift, para evaluar el riesgo y automatizar decisiones de crédito, sin pedir a los clientes que exporten hojas de cálculo manualmente.

Consulta los casos de éxito de Chift para más ejemplos concretos.

Read more on Chift's case studies.

Best practices for the Lexware Office API

The Lexware API has a few specificities worth understanding before you build. Getting these right from the start will save your team a lot of debugging later.

Work within the rate limit

Lexware enforces a hard limit of 2 requests per second per API key. This is among the strictest limits across major accounting APIs. Do not parallelize calls within the same connection. Serialize your requests, and implement automatic retry logic for HTTP 429 responses. Note that Lexware does not include a Retry-After header in 429 responses, so your client needs to back off on its own.

Always read before you write

Every updatable resource in Lexware Office carries a version integer. PUT requests must include the current version number or the server will reject the update with HTTP 409. This is optimistic locking by design. Always fetch the latest state of a resource before attempting to update it.

Understand the two document models

Lexware Office distinguishes clearly between two types of financial documents, and they are not interchangeable:

• /vouchers covers purchase invoices, expense receipts, and bookkeeping entries. You can attach PDF files to vouchers. But Lexware cannot render vouchers as PDFs.
• /invoices, /credit-notes, and /down-payment-invoices are outgoing sales documents with full layout and PDF rendering.

Routing a document to the wrong endpoint will cause errors. Pick the right model for each use case upfront.

Use the draft/open lifecycle correctly

Create documents as drafts first. Draft documents are freely editable. Promote them to open status only when ready, by passing ?finalize=true as a query parameter on the request. Once finalized, invoices and credit notes cannot be edited. Correcting a finalized invoice requires cancelling it and creating a new one.

Handle file uploads in two steps

Attaching a file to a voucher requires a two-step process: first POST the file via /files as a multipart upload to receive a file ID, then reference that file ID when creating or updating the voucher. Only PDFs are supported as attachment types.

Parse errors by i18nKey

Lexware uses HTTP 406 for domain validation errors (not 400 or 422), which can catch developers off guard. Errors return a structured body with an IssueList. Parse the i18nKey field, which is stable and machine-readable, rather than relying on human-readable message fields that may change.

Paginate list endpoints properly

List endpoints use page (zero-indexed) and size (maximum 250 per page). Responses include totalPages and totalElements. Iterate until your page index reaches totalPages - 1.

Connect Lexware Office through Chift

Building and maintaining an integration directly against the Lexware API takes time your team likely wants to spend elsewhere. You need to handle rate limiting, optimistic locking, the two document models, the approval lead time, error parsing, and pagination, before you've written a single line of feature code.

Chift's Unified Accounting API gives you access to Lexware Office and a growing library of accounting connectors through a single integration. We handle API maintenance, authentication, and data mapping so you don't have to. When Lexware updates their API or changes behavior, we adapt our connector. You stay focused on your product.

For software vendors targeting DACH markets, Lexware Office is one of the most important accounting connections you can offer your customers. With Chift, you can activate it in one click once your initial integration is in place.

Book a demo to see how easy it is to get started.

Lexware Office API: frequently asked questions

What authentication method does the Lexware Office API use?

‍Lexware uses a static API key passed as a Bearer token in the Authorization header. Keys have infinite lifetime and are scoped to one organization. There is no OAuth flow or token refresh mechanism.

What is the rate limit for the Lexware API?

‍‍Lexware enforces a hard limit of 2 requests per second per API key. This is the binding constraint. There is no published per-minute or per-hour quota beyond this per-second limit.

How long does it take to get a Lexware API key?

‍‍Lexware requires approval before issuing API keys to integrators. Expect approximately one month of lead time. Plan your project timeline accordingly.

What is the difference between vouchers and invoices in Lexware Office?

‍‍Vouchers are for incoming documents like purchase invoices and expense receipts. Invoices, credit notes, and down payment invoices are outgoing sales documents. They use separate endpoints and are not interchangeable. Only sales documents can be rendered to PDF by Lexware.

Does the Lexware API support multi-tenancy?

‍‍Each API key is scoped to a single organization. To integrate multiple customers, each customer generates their own API key, which is stored and used separately per connection.