Lexware
Manage Lexware contacts, articles, vouchers, invoices, quotations, documents, and event subscriptions
Connect Lexware when a project needs accounting and sales-document data from an existing Lexware organisation. Swarmz keeps the organisation's API key in a shared project connection. The AI can request that connection while it builds, and a linked published app can call the same supported operations through the connector gateway.
A Swarmz administrator must make Lexware visible before workspaces can connect it. Lexware doesn't need an OAuth application in Swarmz. Each workspace enters a private API key created by its own Lexware user.
Before you connect
Create a private API key from Lexware's Public API page. The key can access the Lexware organisation available to that user, so treat it like a password. Keep it out of chat, project files, browser code, and client-side environment variables.
Lexware exposes its current API at https://api.lexware.io. See the Lexware API documentation for provider fields, document rules, paging, optimistic locking, and event types.
Available operations
| Area | Read operations | Write operations | Limit per minute |
|---|---|---|---|
| Organisation | get_profile | None | 30 |
| Contacts | list_contacts, get_contact | create_contact, update_contact | 30 read, 10 write |
| Articles | list_articles, get_article | create_article, update_article | 30 read, 10 write |
| Vouchers | list_vouchers, get_voucher | create_voucher, update_voucher | 30 read, 10 write |
| Invoices | get_invoice, render_invoice, download_invoice | create_invoice | 30 read, 10 write |
| Quotations | get_quotation, render_quotation, download_quotation | create_quotation | 30 read, 10 write |
| Event subscriptions | list_event_subscriptions | create_event_subscription, delete_event_subscription | 30 read, 10 write |
List operations accept bounded Lexware query fields. Swarmz limits query objects to 24 fields, request bodies to 128 KB, JSON responses to 2 MB, and downloaded documents to 5 MB. Lexware currently documents a provider-wide limit of two API requests per second; Swarmz also applies the per-operation limits shown above.
Invoice and quotation creation accepts Lexware's document body plus an optional finalize value. Render operations prepare a document. Download operations return the generated file as base64 data and include its content type. Event callbacks must use HTTPS.
Connect Lexware
- In Settings > Integrations, select Lexware, then select Connect new.
- Enter a name that identifies the organisation or environment.
- Enter the private API key in the secure form.
- Link the connection to the project when the AI requests it.
Swarmz validates the key by reading the Lexware profile. An authentication error means the key is invalid, revoked, or belongs to a user without access to the expected organisation.
Build with Lexware
Describe both the workflow and whether it may change accounting data. These prompts map to supported operations:
- “Use Lexware to build a customer directory that searches contacts and lets an approved user update their details.”
- “Build a product-and-service catalogue from Lexware articles, with a form for creating and updating an article.”
- “Create an invoice workspace that drafts an invoice, finalises it only after confirmation, and downloads the rendered PDF.”
- “Build a quotation tracker that opens a quotation and prepares its document for download.”
- “Create an event-subscription screen for an HTTPS webhook and show the active subscriptions.”
The AI requests a Lexware connection before it adds the first provider operation. Write operations require approval during the build. Lexware still validates every document body and revision number.
Test Lexware
Use a test organisation or disposable records for write checks.
- Read the profile and confirm the organisation name.
- List one contact and one article, then open both records in Lexware.
- Create a disposable contact, update it using the latest returned version, and confirm the change.
- Create a draft article and update its price or description.
- Create a draft invoice without finalising it. Inspect the result before testing finalisation on data you can retain.
- Render the invoice, download its file, and confirm that the returned content opens as the expected document.
- Repeat the document check with a quotation.
- Create an event subscription for an HTTPS test endpoint, trigger the matching event, then delete the subscription.
If reads work and an update fails, retrieve the record again and use its latest version because Lexware uses optimistic locking. If a key may have leaked, revoke it in Lexware first, create a replacement, then reconnect Lexware in Swarmz.