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
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Lexware Office (lexoffice) connection
In AgentKit > Connections, create a Lexware Office (lexoffice) connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'lexoffice'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'lexoffice_articles_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "lexoffice"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Lexware Office (lexoffice):", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="lexoffice_articles_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toollexoffice_article_getGet one article by ID, including its current version.Read-onlyGet 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-onlyList 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-onlyGet 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-onlyList 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-onlyList 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-onlyGet 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-onlyGet 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-onlyGet 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.
lexoffice_dunning_getGet one dunning by ID with its status, number, address, line items and totals.Read-onlyGet Dunning
Get one dunning by ID with its status, number, address, line items and totals. Returns the document object. Find IDs with lexoffice_voucherlist_get.
Inputs
dunning_idstringrequired- ID (UUID) of the dunning. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_event_subscription_getGet one event subscription by ID.Read-onlyGet Event Subscription
Get one event subscription by ID. Returns the subscription.
Inputs
subscription_idstringrequired- ID of the event subscription. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_event_subscriptions_listList the webhook event subscriptions of this API key.Read-onlyList Event Subscriptions
List the webhook event subscriptions of this API key. Returns subscriptions with event type and callback URL.
Inputs
This tool takes no inputs.
lexoffice_invoice_getGet one invoice by ID with its status, number, address, line items and totals.Read-onlyGet Invoice
Get one invoice by ID with its status, number, address, line items and totals. Returns the document object. Find IDs with lexoffice_voucherlist_get.
Inputs
invoice_idstringrequired- ID (UUID) of the invoice. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_order_confirmation_getGet one order confirmation by ID with its status, number, address, line items and totals.Read-onlyGet Order Confirmation
Get one order confirmation by ID with its status, number, address, line items and totals. Returns the document object. Find IDs with lexoffice_voucherlist_get.
Inputs
order_confirmation_idstringrequired- ID (UUID) of the order confirmation. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_payment_conditions_listList the organization's payment condition templates.Read-onlyList Payment Conditions
List the organization's payment condition templates. Returns payment terms with labels, durations and discounts to use in paymentConditions.
Inputs
This tool takes no inputs.
lexoffice_payments_getGet the payment status of a voucher (invoice, credit note, bookkeeping voucher...): open amount, payment status and the payment items.Read-onlyGet Payment Information
Get the payment status of a voucher (invoice, credit note, bookkeeping voucher...): open amount, payment status and the payment items. Returns the payment information. Find voucher IDs with lexoffice_voucherlist_get.
Inputs
voucher_idstringrequired- ID of the voucher. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_posting_categories_listList the posting categories for bookkeeping vouchers.Read-onlyList Posting Categories
List the posting categories for bookkeeping vouchers. Returns category IDs, names and types to use as categoryId in voucher items.
Inputs
This tool takes no inputs.
lexoffice_print_layouts_listList the organization's print layouts.Read-onlyList Print Layouts
List the organization's print layouts. Returns layout IDs and names to use as printLayoutId on sales documents.
Inputs
This tool takes no inputs.
lexoffice_profile_getGet the connected organization's profile: company name, organization ID, user, tax type and business features.Read-onlyGet Profile
Get the connected organization's profile: company name, organization ID, user, tax type and business features. Returns the profile. Use it to test the connection.
Inputs
This tool takes no inputs.
lexoffice_quotation_getGet one quotation by ID with its status, number, address, line items and totals.Read-onlyGet Quotation
Get one quotation by ID with its status, number, address, line items and totals. Returns the document object. Find IDs with lexoffice_voucherlist_get.
Inputs
quotation_idstringrequired- ID (UUID) of the quotation. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_recurring_template_getGet one recurring invoice template by ID with its full invoice data and schedule.Read-onlyGet Recurring Template
Get one recurring invoice template by ID with its full invoice data and schedule. Returns the template.
Inputs
recurring_template_idstringrequired- ID (UUID) of the recurring template. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_recurring_templates_listList recurring invoice templates a page at a time, sortable by created, updated, last or next execution date.Read-onlyList Recurring Templates
List recurring invoice templates a page at a time, sortable by created, updated, last or next execution date. Returns templates with contact, total and schedule. Use lexoffice_recurring_template_get for one.
Inputs
pageinteger- Page to retrieve, starting at 0. Example: 0.
sizeinteger- Page size: 25 by default, up to 250. Example: 25.
sortstring- Sort field and direction: createdDate, updatedDate, lastExecutionDate or nextExecutionDate, then ASC or DESC, for example nextExecutionDate,ASC. Example: updatedDate,DESC.
lexoffice_voucher_getGet one bookkeeping voucher by ID with items, totals, files and version.Read-onlyGet Bookkeeping Voucher
Get one bookkeeping voucher by ID with items, totals, files and version. Returns the voucher. Find IDs with lexoffice_voucherlist_get.
Inputs
voucher_idstringrequired- ID (UUID) of the voucher. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_voucherlist_getList vouchers of any kind (invoices, credit notes, quotations, order confirmations, delivery notes, dunnings, bookkeeping vouchers) filtered by type, status, contact, dates or number.Read-onlyList Vouchers (Voucherlist)
List vouchers of any kind (invoices, credit notes, quotations, order confirmations, delivery notes, dunnings, bookkeeping vouchers) filtered by type, status, contact, dates or number. Returns a page of voucher metadata with IDs, numbers, dates, amounts and status. Use the type-specific get tools for details.
Inputs
voucher_statusstringrequired- Comma-separated statuses, or any: draft, open, paid, paidoff, voided, transferred, sepadebit, overdue, accepted, rejected, unchecked. Example: open.
voucher_typestringrequired- Comma-separated voucher types, or any: salesinvoice, salescreditnote, purchaseinvoice, purchasecreditnote, invoice, downpaymentinvoice, creditnote, orderconfirmation, quotation, deliverynote, dunning. Example: invoice.
archivedboolean- true for archived vouchers only, false for unarchived. Example: false.
contact_idstring- Only vouchers for this contact. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
created_date_fromstring- Only vouchers created on or after this day (yyyy-MM-dd). Example: 2026-01-01.
created_date_tostring- Only vouchers created on or before this day (yyyy-MM-dd). Example: 2026-01-31.
pageinteger- Page to retrieve, starting at 0. Example: 0.
sizeinteger- Page size: 25 by default, up to 250. Example: 25.
sortstring- Sort field and direction, for example voucherDate,DESC. Example: updatedDate,DESC.
updated_date_fromstring- Only vouchers changed on or after this day (yyyy-MM-dd). Example: 2026-01-01.
updated_date_tostring- Only vouchers changed on or before this day (yyyy-MM-dd). Example: 2026-01-31.
voucher_date_fromstring- Only vouchers dated on or after this day (yyyy-MM-dd, CET). Example: 2026-01-01.
voucher_date_tostring- Only vouchers dated on or before this day (yyyy-MM-dd, CET). Example: 2026-01-31.
voucher_numberstring- Only the voucher with this number. Example: RE1234.
lexoffice_article_createCreate an article (product or service) with title, type, unit name and price.WriteCreate Article
Create an article (product or service) with title, type, unit name and price. Returns the new article's id and version.
Inputs
priceobjectrequired- Price object: netPrice or grossPrice, leadingPrice (NET or GROSS) and taxRate. Example: {"netPrice": 61.90, "leadingPrice": "NET", "taxRate": 19}
titlestringrequired- Title of the article. Example: Rechnung.
typestringrequired- PRODUCT or SERVICE. Example: PRODUCT.one of
PRODUCTSERVICE unit_namestringrequired- Unit name, for example Piece or Hour. Example: Piece.
article_numberstring- Your article number. Example: LXW-BUHA-2024-001.
descriptionstring- Description of the article. For this property, text formatting is supported. For details, see Text Formatting . Example: Monthly subscription, multi-user bookkeeping.
gtinstring- Global Trade Item Number; validated if given. Example: 9783648170632.
notestring- Internal note. Example: Internal note.
lexoffice_article_updateReplace an article's data.WriteUpdate Article
Replace an article's data. Send the current version from lexoffice_article_get (optimistic locking). Returns the id and new version.
- Idempotent
Inputs
article_idstringrequired- ID (UUID) of the record. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
priceobjectrequired- Price object: netPrice or grossPrice, leadingPrice (NET or GROSS) and taxRate. Example: {"netPrice": 61.90, "leadingPrice": "NET", "taxRate": 19}
titlestringrequired- Title of the article. Example: Rechnung.
typestringrequired- PRODUCT or SERVICE. Example: PRODUCT.one of
PRODUCTSERVICE unit_namestringrequired- Unit name, for example Piece or Hour. Example: Piece.
versionintegerrequired- Version of the record for optimistic locking: 0 when creating, the current version from the matching get tool when updating. Example: 2.
article_numberstring- Your article number. Example: LXW-BUHA-2024-001.
descriptionstring- Description of the article. For this property, text formatting is supported. For details, see Text Formatting . Example: Monthly subscription, multi-user bookkeeping.
gtinstring- Global Trade Item Number; validated if given. Example: 9783648170632.
notestring- Internal note. Example: Internal note.
lexoffice_contact_createCreate a contact (a company or a person) with its roles (customer and/or vendor), addresses, email addresses and phone numbers.WriteCreate Contact
Create a contact (a company or a person) with its roles (customer and/or vendor), addresses, email addresses and phone numbers. Returns the new contact's id and version.
Inputs
rolesobjectrequired- Roles of the contact as an object with customer and/or vendor keys, for example {"customer": {}}. Example: {"customer": {}}
versionintegerrequired- Version of the record for optimistic locking: 0 when creating, the current version from the matching get tool when updating. Example: 0.
addressesobject- Addresses as lists under billing and shipping, each with street, zip, city and countryCode. Example: {"billing": [{"street": "Musterstraße 1", "zip": "10115", "city": "Berlin", "countryCode": "DE"}]}
companyobject- Company details (name, taxNumber, vatRegistrationId, contactPersons). Send company or person. Example: {"name": "Musterfirma GmbH", "taxNumber": "12345/12345", "vatRegistrationId": "DE123456789"}
email_addressesobject- Email addresses as lists under business, office, private and other. Example: {"business": ["inge@example.com"]}
notestring- Note about the contact (max 1000 characters). Example: Internal note.
personobject- Person details (salutation, firstName, lastName). Send company or person. Example: {"salutation": "Frau", "firstName": "Inge", "lastName": "Musterfrau"}
phone_numbersobject- Phone numbers as lists under business, office, mobile, private, fax and other. Example: {"business": ["+49 30 1234567"]}
x_rechnungobject- XRechnung data, for example the buyerReference (Leitweg-ID) for public-sector recipients. Example: {"buyerReference": "04011000-1234512345-35"}
lexoffice_contact_updateReplace a contact's data.WriteUpdate Contact
Replace a contact's data. Send the current version from lexoffice_contact_get. Contacts with more than one entry in any address, email, phone or contact-person list cannot be updated through the API. Returns the id and new version.
- Idempotent
Inputs
contact_idstringrequired- ID (UUID) of the record. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
rolesobjectrequired- Roles of the contact as an object with customer and/or vendor keys. Example: {"customer": {}}
versionintegerrequired- Version of the record for optimistic locking: 0 when creating, the current version from the matching get tool when updating. Example: 2.
addressesobject- Addresses as lists under billing and shipping. Example: {"billing": [{"street": "Musterstraße 1", "zip": "10115", "city": "Berlin", "countryCode": "DE"}]}
companyobject- Company details. Send company or person. Example: {"name": "Musterfirma GmbH", "taxNumber": "12345/12345", "vatRegistrationId": "DE123456789"}
email_addressesobject- Email addresses as lists under business, office, private and other. Example: {"business": ["inge@example.com"]}
notestring- Note about the contact. Example: Internal note.
personobject- Person details. Send company or person. Example: {"salutation": "Frau", "firstName": "Inge", "lastName": "Musterfrau"}
phone_numbersobject- Phone numbers as lists by type. Example: {"business": ["+49 30 1234567"]}
x_rechnungobject- XRechnung data, for example the buyerReference (Leitweg-ID) for public-sector recipients. Example: {"buyerReference": "04011000-1234512345-35"}
lexoffice_credit_note_createCreate a credit note with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true.WriteCreate Credit Note
Create a credit note with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true. Pass precedingSalesVoucherId to pursue from an invoice. Returns the new document's id and version. Get contact IDs from lexoffice_contacts_list.
Inputs
addressobjectrequired- Recipient: {"contactId": ""} for an existing contact, or an address with name, street, zip, city and countryCode. Example: {"contactId": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8"}
line_itemsarrayrequired- Line items: each has a type (custom, material, service or text), name, quantity, unitName and unitPrice (currency, netAmount or grossAmount, taxRatePercentage); material and service items reference an article id. Example: [{"type": "custom", "name": "Consulting", "quantity": 2, "unitName": "Hour", "unitPrice": {"currency": "EUR", "netAmount": 100.0, "taxRatePercentage": 19}}]
tax_conditionsobjectrequired- Tax conditions: taxType (net, gross, vatfree, intraCommunitySupply, constructionService13b, externalService13b, thirdPartyCountryService, thirdPartyCountryDelivery), plus taxTypeNote where needed. Example: {"taxType": "net"}
total_priceobjectrequired- Total price object; send {"currency": "EUR"} and Lexware calculates the amounts. Example: {"currency": "EUR"}
voucher_datestringrequired- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15T00:00:00.000+01:00.
finalizeboolean- true creates the document finalized (status open, no longer editable); false or empty creates a draft. Example: false.
introductionstring- Introductory text above the line items. Example: Thank you for your order.
languagestring- Language of the document: de or en. Example: de.
preceding_sales_voucher_idstring- ID of the preceding sales voucher to pursue from (for example the quotation or invoice this document follows); Lexware links them and copies its data. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
print_layout_idstring- ID of the print layout to use. Get IDs from lexoffice_print_layouts_list. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
titlestring- Title of the document. Defaults to the organization's setting. Example: Rechnung.
lexoffice_delivery_note_createCreate a delivery note with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true.WriteCreate Delivery Note
Create a delivery note with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true. Pass precedingSalesVoucherId to pursue from an invoice or order confirmation. Returns the new document's id and version. Get contact IDs from lexoffice_contacts_list.
Inputs
addressobjectrequired- Recipient: {"contactId": ""} for an existing contact, or an address with name, street, zip, city and countryCode. Example: {"contactId": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8"}
line_itemsarrayrequired- Line items: each has a type (custom, material, service or text), name, quantity, unitName and unitPrice (currency, netAmount or grossAmount, taxRatePercentage); material and service items reference an article id. Example: [{"type": "custom", "name": "Consulting", "quantity": 2, "unitName": "Hour", "unitPrice": {"currency": "EUR", "netAmount": 100.0, "taxRatePercentage": 19}}]
shipping_conditionsobjectrequired- Shipping conditions: shippingType (service, delivery, serviceperiod, deliveryperiod or none) and shippingDate, plus shippingEndDate for periods. Example: {"shippingType": "delivery", "shippingDate": "2026-01-15T00:00:00.000+01:00"}
tax_conditionsobjectrequired- Tax conditions: taxType (net, gross, vatfree, intraCommunitySupply, constructionService13b, externalService13b, thirdPartyCountryService, thirdPartyCountryDelivery), plus taxTypeNote where needed. Example: {"taxType": "net"}
voucher_datestringrequired- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15T00:00:00.000+01:00.
delivery_termsstring- (Optional) Describes the terms for delivery. The organization's (or contact-specific) default is used if no value was sent. Example: Delivery within 3 days.
finalizeboolean- true creates the document finalized (status open, no longer editable); false or empty creates a draft. Example: false.
introductionstring- Introductory text above the line items. Example: Thank you for your order.
languagestring- Language of the document: de or en. Example: de.
preceding_sales_voucher_idstring- ID of the preceding sales voucher to pursue from (for example the quotation or invoice this document follows); Lexware links them and copies its data. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
print_layout_idstring- ID of the print layout to use. Get IDs from lexoffice_print_layouts_list. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
titlestring- Title of the document. Defaults to the organization's setting. Example: Rechnung.
lexoffice_dunning_createCreate a dunning (payment reminder) for an invoice with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true.WriteCreate Dunning
Create a dunning (payment reminder) for an invoice with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true. precedingSalesVoucherId (the invoice) is required. Returns the new document's id and version. Get contact IDs from lexoffice_contacts_list.
Inputs
addressobjectrequired- Recipient: {"contactId": ""} for an existing contact, or an address with name, street, zip, city and countryCode. Example: {"contactId": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8"}
line_itemsarrayrequired- Line items: each has a type (custom, material, service or text), name, quantity, unitName and unitPrice (currency, netAmount or grossAmount, taxRatePercentage); material and service items reference an article id. Example: [{"type": "custom", "name": "Consulting", "quantity": 2, "unitName": "Hour", "unitPrice": {"currency": "EUR", "netAmount": 100.0, "taxRatePercentage": 19}}]
preceding_sales_voucher_idstringrequired- ID of the preceding sales voucher to pursue from (for example the quotation or invoice this document follows); Lexware links them and copies its data. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
shipping_conditionsobjectrequired- Shipping conditions: shippingType (service, delivery, serviceperiod, deliveryperiod or none) and shippingDate, plus shippingEndDate for periods. Example: {"shippingType": "delivery", "shippingDate": "2026-01-15T00:00:00.000+01:00"}
tax_conditionsobjectrequired- Tax conditions: taxType (net, gross, vatfree, intraCommunitySupply, constructionService13b, externalService13b, thirdPartyCountryService, thirdPartyCountryDelivery), plus taxTypeNote where needed. Example: {"taxType": "net"}
total_priceobjectrequired- Total price object; send {"currency": "EUR"} and Lexware calculates the amounts. Example: {"currency": "EUR"}
voucher_datestringrequired- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15T00:00:00.000+01:00.
introductionstring- Introductory text above the line items. Example: Thank you for your order.
languagestring- Language of the document: de or en. Example: de.
print_layout_idstring- ID of the print layout to use. Get IDs from lexoffice_print_layouts_list. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
titlestring- Title of the document. Defaults to the organization's setting. Example: Rechnung.
lexoffice_event_subscription_createSubscribe a callback URL to a Lexware event, such as invoice.created or contact.changed; Lexware then POSTs a signed notification to the URL.WriteCreate Event Subscription
Subscribe a callback URL to a Lexware event, such as invoice.created or contact.changed; Lexware then POSTs a signed notification to the URL. Returns the subscription ID. Use lexoffice_event_subscriptions_list to see existing ones.
Inputs
callback_urlstringrequired- HTTPS URL Lexware notifies when the event happens. Example: https://example.com/webhooks/lexware.
event_typestringrequired- Event to subscribe to, as resource.event, for example invoice.created, invoice.status.changed or contact.changed. Example: invoice.created.
lexoffice_invoice_createCreate an invoice with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true.WriteCreate Invoice
Create an invoice with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true. Pass precedingSalesVoucherId to pursue from a quotation or order confirmation. Returns the new document's id and version. Get contact IDs from lexoffice_contacts_list.
Inputs
addressobjectrequired- Recipient: {"contactId": ""} for an existing contact, or an address with name, street, zip, city and countryCode. Example: {"contactId": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8"}
line_itemsarrayrequired- Line items: each has a type (custom, material, service or text), name, quantity, unitName and unitPrice (currency, netAmount or grossAmount, taxRatePercentage); material and service items reference an article id. Example: [{"type": "custom", "name": "Consulting", "quantity": 2, "unitName": "Hour", "unitPrice": {"currency": "EUR", "netAmount": 100.0, "taxRatePercentage": 19}}]
shipping_conditionsobjectrequired- Shipping conditions: shippingType (service, delivery, serviceperiod, deliveryperiod or none) and shippingDate, plus shippingEndDate for periods. Example: {"shippingType": "delivery", "shippingDate": "2026-01-15T00:00:00.000+01:00"}
tax_conditionsobjectrequired- Tax conditions: taxType (net, gross, vatfree, intraCommunitySupply, constructionService13b, externalService13b, thirdPartyCountryService, thirdPartyCountryDelivery), plus taxTypeNote where needed. Example: {"taxType": "net"}
total_priceobjectrequired- Total price object; send {"currency": "EUR"} and Lexware calculates the amounts. Example: {"currency": "EUR"}
voucher_datestringrequired- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15T00:00:00.000+01:00.
finalizeboolean- true creates the document finalized (status open, no longer editable); false or empty creates a draft. Example: false.
introductionstring- Introductory text above the line items. Example: Thank you for your order.
languagestring- Language of the document: de or en. Example: de.
payment_conditionsobject- Payment terms: paymentTermLabel, paymentTermDuration (days) and optional paymentDiscountConditions. Defaults to the organization's or contact's terms. Example: {"paymentTermLabel": "10 Tage - 3 %, 30 Tage netto", "paymentTermDuration": 30}
preceding_sales_voucher_idstring- ID of the preceding sales voucher to pursue from (for example the quotation or invoice this document follows); Lexware links them and copies its data. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
print_layout_idstring- ID of the print layout to use. Get IDs from lexoffice_print_layouts_list. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
recurring_template_idstring- The id of the recurring template, if this is a recurring invoice deduced from a template. Null otherwise. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
titlestring- Title of the document. Defaults to the organization's setting. Example: Rechnung.
x_rechnungobject- XRechnung data, for example the buyerReference (Leitweg-ID) for public-sector recipients. Example: {"buyerReference": "04011000-1234512345-35"}
lexoffice_order_confirmation_createCreate an order confirmation with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true.WriteCreate Order Confirmation
Create an order confirmation with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true. Pass precedingSalesVoucherId to pursue from a quotation. Returns the new document's id and version. Get contact IDs from lexoffice_contacts_list.
Inputs
addressobjectrequired- Recipient: {"contactId": ""} for an existing contact, or an address with name, street, zip, city and countryCode. Example: {"contactId": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8"}
line_itemsarrayrequired- Line items: each has a type (custom, material, service or text), name, quantity, unitName and unitPrice (currency, netAmount or grossAmount, taxRatePercentage); material and service items reference an article id. Example: [{"type": "custom", "name": "Consulting", "quantity": 2, "unitName": "Hour", "unitPrice": {"currency": "EUR", "netAmount": 100.0, "taxRatePercentage": 19}}]
shipping_conditionsobjectrequired- Shipping conditions: shippingType (service, delivery, serviceperiod, deliveryperiod or none) and shippingDate, plus shippingEndDate for periods. Example: {"shippingType": "delivery", "shippingDate": "2026-01-15T00:00:00.000+01:00"}
tax_conditionsobjectrequired- Tax conditions: taxType (net, gross, vatfree, intraCommunitySupply, constructionService13b, externalService13b, thirdPartyCountryService, thirdPartyCountryDelivery), plus taxTypeNote where needed. Example: {"taxType": "net"}
total_priceobjectrequired- Total price object; send {"currency": "EUR"} and Lexware calculates the amounts. Example: {"currency": "EUR"}
voucher_datestringrequired- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15T00:00:00.000+01:00.
delivery_termsstring- (Optional) Describes the terms for delivery. The organization's (or contact-specific) default is used if no value was sent. For this property, text formatting is supported. For details, see Text Formatting . Example: Delivery within 3 days.
finalizeboolean- true creates the document finalized (status open, no longer editable); false or empty creates a draft. Example: false.
introductionstring- Introductory text above the line items. Example: Thank you for your order.
languagestring- Language of the document: de or en. Example: de.
payment_conditionsobject- Payment terms: paymentTermLabel, paymentTermDuration (days) and optional paymentDiscountConditions. Defaults to the organization's or contact's terms. Example: {"paymentTermLabel": "10 Tage - 3 %, 30 Tage netto", "paymentTermDuration": 30}
preceding_sales_voucher_idstring- ID of the preceding sales voucher to pursue from (for example the quotation or invoice this document follows); Lexware links them and copies its data. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
print_layout_idstring- ID of the print layout to use. Get IDs from lexoffice_print_layouts_list. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
titlestring- Title of the document. Defaults to the organization's setting. Example: Rechnung.
lexoffice_quotation_createCreate a quotation (offer) with an expiration date with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true.WriteCreate Quotation
Create a quotation (offer) with an expiration date with recipient address, line items, tax, payment and shipping conditions; it is a draft unless finalize is true. Returns the new document's id and version. Get contact IDs from lexoffice_contacts_list.
Inputs
addressobjectrequired- Recipient: {"contactId": ""} for an existing contact, or an address with name, street, zip, city and countryCode. Example: {"contactId": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8"}
expiration_datestringrequired- The instant of time when the quotation will expire. Value in format yyyy-MM-ddTHH:mm:ss.SSSXXX as described in RFC 3339/ISO 8601 (e.g. 2023-02-21T00:00:00.000+01:00 ). Example: 2026-02-15T00:00:00.000+01:00.
line_itemsarrayrequired- Line items: each has a type (custom, material, service or text), name, quantity, unitName and unitPrice (currency, netAmount or grossAmount, taxRatePercentage); material and service items reference an article id. Example: [{"type": "custom", "name": "Consulting", "quantity": 2, "unitName": "Hour", "unitPrice": {"currency": "EUR", "netAmount": 100.0, "taxRatePercentage": 19}}]
tax_conditionsobjectrequired- Tax conditions: taxType (net, gross, vatfree, intraCommunitySupply, constructionService13b, externalService13b, thirdPartyCountryService, thirdPartyCountryDelivery), plus taxTypeNote where needed. Example: {"taxType": "net"}
total_priceobjectrequired- Total price object; send {"currency": "EUR"} and Lexware calculates the amounts. Example: {"currency": "EUR"}
voucher_datestringrequired- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15T00:00:00.000+01:00.
finalizeboolean- true creates the document finalized (status open, no longer editable); false or empty creates a draft. Example: false.
introductionstring- Introductory text above the line items. Example: Thank you for your order.
languagestring- Language of the document: de or en. Example: de.
payment_conditionsobject- Payment terms: paymentTermLabel, paymentTermDuration (days) and optional paymentDiscountConditions. Defaults to the organization's or contact's terms. Example: {"paymentTermLabel": "10 Tage - 3 %, 30 Tage netto", "paymentTermDuration": 30}
print_layout_idstring- ID of the print layout to use. Get IDs from lexoffice_print_layouts_list. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
titlestring- Title of the document. Defaults to the organization's setting. Example: Rechnung.
lexoffice_voucher_createCreate a bookkeeping voucher (a sales or purchase invoice or credit note recorded for accounting, not a document Lexware renders) with totals, tax type and voucher items.WriteCreate Bookkeeping Voucher
Create a bookkeeping voucher (a sales or purchase invoice or credit note recorded for accounting, not a document Lexware renders) with totals, tax type and voucher items. Returns the id and version. Get posting category IDs from lexoffice_posting_categories_list.
Inputs
tax_typestringrequired- net or gross. Example: net.
typestringrequired- Voucher type: salesinvoice, salescreditnote, purchaseinvoice or purchasecreditnote. Example: salesinvoice.
contact_idstring- ID of an existing contact. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
contact_namestring- Name shown when the collective contact is used. Example: Musterfirma GmbH.
due_datestring- Payment due date (yyyy-MM-dd). Example: 2026-02-14.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
shipping_datestring- Delivery date (yyyy-MM-dd). Example: 2026-01-15.
total_gross_amountnumber- Total gross amount (sum of the items plus tax). Example: 119.5.
total_tax_amountnumber- Total tax amount. Example: 19.5.
use_collective_contactboolean- true books against the collective customer/vendor instead of contactId. Example: false.
versioninteger- 0 when creating. Example: 0.
voucher_datestring- Date of the voucher (yyyy-MM-dd). Example: 2026-01-15.
voucher_itemsarray- Items grouped by tax rate: amount, taxAmount, taxRatePercent and categoryId (posting category). Example: [{"amount": 100.0, "taxAmount": 19.0, "taxRatePercent": 19, "categoryId": "8f8664a8-fd86-11e1-a21f-0800200c9a66"}]
voucher_numberstring- Your reference number of the voucher. Example: RE1234.
voucher_statusstring- Billing state, for example open or unchecked. Example: open.
lexoffice_voucher_updateReplace a bookkeeping voucher's data, sending the current version from lexoffice_voucher_get.WriteUpdate Bookkeeping Voucher
Replace a bookkeeping voucher's data, sending the current version from lexoffice_voucher_get. Returns the id and new version.
- Idempotent
Inputs
tax_typestringrequired- net or gross. Example: net.
typestringrequired- Voucher type: salesinvoice, salescreditnote, purchaseinvoice or purchasecreditnote. Example: salesinvoice.
versionintegerrequired- Current version from lexoffice_voucher_get. Example: 3.
voucher_idstringrequired- ID (UUID) of the record. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
contact_idstring- If not using the collective contact option, an existing contact id must be provided. This must exist within Lexware before and can be created via the Contacts endpoint. If a contact is assigned to a voucher, its role must either be Customer , or both Customer and Vendor . Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
contact_namestring- Name of the recipient or invoicing party if the collective contact is used. Please note that if you change the contact name, the voucher will have an individual contact name but is still assigned to the collective contact. Also, changing the contact name does not result in the name of the collective contact being changed. Example: Musterfirma GmbH.
due_datestring- Date when the voucher's payment has to be settled. Format must be yyyy-MM-dd (e.g. 2023-06-28 ). Example: 2026-02-14.
remarkstring- Closing text below the line items. Example: We look forward to working with you again.
shipping_datestring- Date when the purchased item/service has to be shipped/supplied. If it is a period of time, the end date must be given. Format must be yyyy-MM-dd (e.g. 2023-07-02 ). Please note: ShippingDate can only be specified for voucher types salesinvoice and salescreditnote . Example: 2026-01-15.
total_gross_amountnumber- Total gross amount of the voucher. Must match the sum of all positions with added/calculated tax amounts. Format must be ##.00 (119.00) . Example: 119.5.
total_tax_amountnumber- Total tax amount of the voucher. Must match the sum of all positions' tax amounts. Format must be ##.00 (19.00) . Example: 19.5.
use_collective_contactboolean- Set to true if the Collective Contact (customer/vendor) within Lexware should be used. If used, the optional contactId will be ignored. Example: false.
voucher_datestring- Date of the document (RFC 3339), for example 2026-01-15T00:00:00.000+01:00. Example: 2026-01-15.
voucher_itemsarray- Items grouped by tax rate: amount, taxAmount, taxRatePercent and categoryId. Example: [{"amount": 100.0, "taxAmount": 19.0, "taxRatePercent": 19, "categoryId": "8f8664a8-fd86-11e1-a21f-0800200c9a66"}]
voucher_numberstring- Number of the voucher. Should be the order's identification/reference number. Example: RE1234.
voucher_statusstring- Billing state of the voucher. Possible values are blank , open , paid , paidoff , voided , transferred , sepadebit , or unchecked . Only open and unchecked are writeable leveraging the Lexware API. Vouchers with status blank are read-only and to be ignored until unchecked or open. Example: open.
lexoffice_article_deleteDelete an article.DestructiveDelete Article
Delete an article. Returns an empty response. Get IDs from lexoffice_articles_list.
- Idempotent
Inputs
article_idstringrequired- ID (UUID) of the article. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
lexoffice_event_subscription_deleteDelete an event subscription so Lexware stops calling its URL.DestructiveDelete Event Subscription
Delete an event subscription so Lexware stops calling its URL. Returns an empty response.
- Idempotent
Inputs
subscription_idstringrequired- ID of the event subscription. Example: e9066f04-8cc7-4616-93f8-ac9ecc8479c8.
No tools match.