Skip to main content

Lexware Office

Read and create Lexware Office invoices, quotations, contacts, articles and vouchers.

Connect it with: API key. Lexware Office's own documentation: https://developers.lexware.io/docs/.

What agents can do​

Connect Lexware Office so the agents working your tasks can reach it. With it connected, they can:

  • Find an invoice, quotation or credit note and report its status, amount and due date.
  • Create draft invoices or quotations from a task's line items for a person to finalize.
  • Look up or add customers and suppliers in the contacts list.
  • List open receivables or vouchers for a period to support bookkeeping.

Before you start​

  • A Lexware Office plan that includes the Public API (Lexware lists it in its XL plan).
  • A Lexware Office user allowed to create API keys (an administrator of the account).
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Lexware Office​

Jaah connects to Lexware Office with an API key, not with a sign-in button.

Connect with an API key​

Find each value first:

  • API key: Sign in to Lexware Office and open https://app.lexware.de/addons/public-api (or the gear icon > Erweiterungen > Weitere Apps > Public API > Verwalten). Select API-Schlüssel erstellen (Create API key), choose the permissions agents need and copy the key: Lexware shows it only once.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Lexware Office card.
  2. Name the secret and choose who can use it.
  3. Fill in API key.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to Lexware Office with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls Lexware Office's API once (GET https://api.lexware.io/v1/profile) with the stored values, and shows who it answered as, or which value Lexware Office refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: api_key.

Tell the agent in your task description which secret to use, for example “use the Lexware Office secret org/lexware”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Lexware Office once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Lexware Office's side too, revoke or delete the key at Lexware Office.

Limitations​

  • Lexware allows 2 requests per second per key; agents that go faster get 429 and slow down.
  • A key lasts at most 24 months, then must be created again.
  • What a key can reach depends on the permissions chosen when it was created and on the contract's features; a key made before an endpoint existed (for example quotations) must be recreated to reach it.
  • Agents can do only what the connected Lexware Office account allows.

Troubleshooting​

Test says Lexware Office rejected the API key (401)

The key expired, was deleted, or was mistyped. Create a new key at https://app.lexware.de/addons/public-api and select Replace.

An agent's call fails with 403

The key was created without the permission that call needs. Create a key with that permission and replace the stored one.

Agents report 429 Too Many Requests

Lexware allows 2 requests per second. Ask the agent to work in smaller batches; the limit clears by itself.

Still stuck? Select Test and read the result: it names the value Lexware Office refused and the status it answered.

FAQ​

I used lexoffice before. Does that key still work?

Yes. lexoffice is now Lexware Office and existing keys keep working on the new address, api.lexware.io.

Does Test change anything?

No. It reads your company profile and nothing else.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Lexware Office account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.