Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Lexware Office (lexoffice)

Scalekit connector
Open markdown

The Lexware Office (lexoffice) connector lets your AI agent act in each user's Lexware Office (lexoffice) account. Each user connects their own Lexware Office (lexoffice) access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 38 tools.

Tools
38
What they doRead · write · destructive
23 · 13 · 223 read13 write2 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Lexware Office (lexoffice) connection

    In AgentKit > Connections, create a Lexware Office (lexoffice) connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'lexoffice'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Lexware Office (lexoffice):', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'lexoffice_articles_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Lexware Office (lexoffice) credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • lexoffice_article_getGet one article by ID, including its current version.Read-only

    Get Article

    Get one article by ID, including its current version. Returns the article object. Get IDs from lexoffice_articles_list.

    Inputs

    article_idstringrequired
    ID (UUID) of the article. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
  • lexoffice_articles_listList articles (products and services) a page at a time, optionally filtered by article number, GTIN or type.Read-only

    List Articles

    List articles (products and services) a page at a time, optionally filtered by article number, GTIN or type. Returns a page with content and paging info. Use lexoffice_article_get for one article.

    Inputs

    article_numberstring
    Only the article with this article number. Example: LXW-BUHA-2024-001.
    gtinstring
    Only articles with this Global Trade Item Number. Example: 9783648170632.
    pageinteger
    Page to retrieve, starting at 0. Example: 0.
    sizeinteger
    Page size: 25 by default, up to 250. Example: 25.
    typestring
    Only articles of this type: PRODUCT or SERVICE. Example: PRODUCT.one of PRODUCTSERVICE
  • lexoffice_contact_getGet one contact by ID with roles, addresses, emails, phone numbers and current version.Read-only

    Get Contact

    Get one contact by ID with roles, addresses, emails, phone numbers and current version. Returns the contact object. Get IDs from lexoffice_contacts_list.

    Inputs

    contact_idstringrequired
    ID (UUID) of the contact. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
  • lexoffice_contacts_listList contacts (customers and vendors) a page at a time, filtered by email, name, contact number or role.Read-only

    List Contacts

    List contacts (customers and vendors) a page at a time, filtered by email, name, contact number or role. Returns a page with content and paging info. Use lexoffice_contact_get for one contact.

    Inputs

    customerboolean
    true for contacts with the customer role, false for those without. Example: true.
    emailstring
    Filter by email (substring, case-insensitive, _ and % wildcards; at least 3 characters). Example: max@example.com.
    namestring
    Filter by name (substring, case-insensitive; at least 3 characters). Example: Mustermann.
    numberinteger
    Customer or vendor number. Example: 10308.
    pageinteger
    Page to retrieve, starting at 0. Example: 0.
    sizeinteger
    Page size: 25 by default, up to 250. Example: 25.
    vendorboolean
    true for contacts with the vendor role, false for those without. Example: false.
  • lexoffice_countries_listList the countries Lexware knows with their country codes and tax classification (DE, intra-community, third party).Read-only

    List Countries

    List the countries Lexware knows with their country codes and tax classification (DE, intra-community, third party). Returns country objects. Use the codes in addresses.

    Inputs

    This tool takes no inputs.

  • lexoffice_credit_note_getGet one credit note by ID with its status, number, address, line items and totals.Read-only

    Get Credit Note

    Get one credit note by ID with its status, number, address, line items and totals. Returns the document object. Find IDs with lexoffice_voucherlist_get.

    Inputs

    credit_note_idstringrequired
    ID (UUID) of the credit note. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
  • lexoffice_delivery_note_getGet one delivery note by ID with its status, number, address, line items and totals.Read-only

    Get Delivery Note

    Get one delivery note by ID with its status, number, address, line items and totals. Returns the document object. Find IDs with lexoffice_voucherlist_get.

    Inputs

    delivery_note_idstringrequired
    ID (UUID) of the delivery note. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
  • lexoffice_down_payment_invoice_getGet one down payment invoice by ID.Read-only

    Get Down Payment Invoice

    Get one down payment invoice by ID. Returns the document object. Find IDs with lexoffice_voucherlist_get (voucherType downpaymentinvoice).

    Inputs

    down_payment_invoice_idstringrequired
    ID (UUID) of the down payment invoice. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.