Skip to main content
Lexoffice logo
  • Category: accounting
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 44
  • Triggers: 0
  • Slug: LEXOFFICE
  • Version: 20261101_00

Tools

Slug: LEXOFFICE_CREATE_ARTICLETool to create a new article (product or service) in Lexoffice. Use when you need to add items to the product/service catalog for invoicing or quotations. The leadingPrice field must be uppercase (NET or GROSS).

Input Parameters

string ("PRODUCT" | "SERVICE")
required
Type of article: PRODUCT for physical goods or SERVICE for services.
object
required
Price information including net/gross price, tax rate, and which price is leading.
string
required
The title/name of the article (product or service).
string
required
Unit of measurement for the article (e.g., piece, hour, kg, meter). This field is required by the Lexoffice API.
string
Optional article number for internal identification. If not provided, Lexoffice will auto-generate one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_CONTACTTool to create a new contact (customer or vendor) in Lexoffice. Use when you need to add a new business contact. Either company or person details must be provided, and at least one role (customer/vendor) must be assigned.

Input Parameters

string
Additional notes about the contact (maximum 1000 characters)
object
required
Contact roles - must contain at least one role (customer and/or vendor)
object
Person contact details - mutually exclusive with company.
object
Company contact details - mutually exclusive with person.
integer
Version number (must be 0 for new contacts)
object
Container for billing and shipping addresses.
object
XRechnung-specific fields for electronic invoicing.
object
Phone numbers organized by type.
object
Email addresses organized by type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_CREDIT_NOTETool to create a credit note in Lexoffice. Credit notes are created in draft mode by default; set finalize=true to create with status ‘open’. Use when you need to issue a refund or credit for an invoice. Maximum 300 line items per credit note.

Input Parameters

string
Title of the credit note. Organization default is used if omitted.
string
Additional remarks. Organization default is used if omitted.
object
required
Recipient address information. Either contactId must be provided, or name/street/city/zip/countryCode.
boolean
Whether the credit note should be archived. Defaults to false.
boolean
If true, creates a finalized credit note with status ‘open’. If false or omitted, creates a draft credit note. Note: Status cannot be changed via API after creation.
string
ISO 639-1 language code. Defaults to ‘de’.
array
required
List of line items in the credit note. Maximum 300 items per credit note.
object
required
Total price information with currency specification.
string
required
Date of the credit note in RFC 3339/ISO 8601 format (yyyy-MM-ddTHH:mm:ss.SSSXXX).
string
Introduction text. Organization default is used if omitted. Recommended to include invoice number if related to an invoice.
string
UUID of the print layout to use. Organization default is used if omitted.
object
required
Tax conditions defining tax type and related settings.
number
Absolute discount amount. Maximum 2 decimal places.
number
Percentage discount. Maximum 2 decimal places.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_DELIVERY_NOTECreate a delivery note in lexoffice. Delivery notes are created in draft mode by default (set finalize=true for open status). Use when shipping goods or providing services and need to document what was delivered without prices/payment terms. Maximum 300 line items allowed per delivery note.

Input Parameters

string
Title of the delivery note. Organization default is used if omitted.
string
Additional remarks or notes for the delivery note.
object
required
Customer address. Either provide contactId for existing contact OR (name + countryCode) for one-time address.
boolean
Whether to archive the delivery note immediately after creation. Defaults to false.
boolean
If true, creates a finalized delivery note with status ‘open’. If false (default), creates in draft mode.
string ("de" | "en")
Language for the delivery note.
array
required
List of items in the delivery note. Maximum 300 items allowed.
string
required
Date of the delivery note in ISO format (yyyy-MM-ddTHH:mm:ss.SSSXXX).
string
Introduction text shown at the beginning of the delivery note.
string
Delivery terms and conditions description.
string
UUID of the print layout template to use. Organization default is used if omitted.
object
required
Tax settings for the delivery note.
object
required
Shipping details including date and type. Required for delivery notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_EVENT_SUBSCRIPTIONTool to register a new webhook for Lexoffice events. Use when you need to receive real-time notifications for specific events like invoice creation, contact changes, or payment updates.

Input Parameters

string ("article.created" | "article.changed" | "article.deleted" | "contact.created" | "contact.changed" | "contact.deleted" | "credit-note.created" | "credit-note.changed" | "credit-note.deleted" | "credit-note.status.changed" | "delivery-note.created" | "delivery-note.changed" | "delivery-note.deleted" | "down-payment-invoice.created" | "down-payment-invoice.changed" | "down-payment-invoice.deleted" | "down-payment-invoice.status.changed" | "dunning.created" | "dunning.changed" | "dunning.deleted" | "invoice.created" | "invoice.changed" | "invoice.deleted" | "invoice.status.changed" | "order-confirmation.created" | "order-confirmation.changed" | "order-confirmation.deleted" | "order-confirmation.status.changed" | "payment.changed" | "quotation.created" | "quotation.changed" | "quotation.deleted" | "quotation.status.changed" | "recurring-template.created" | "recurring-template.changed" | "recurring-template.deleted" | "token.revoked" | "voucher.created" | "voucher.changed" | "voucher.deleted" | "voucher.status.changed")
required
The type of event to subscribe to. When this event occurs, a notification will be sent to the callback URL
string
required
The HTTPS URL where Lexoffice will send webhook notifications when the specified event occurs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_INVOICECreate a Lexware invoice as an editable draft by default, or set finalize=true to irreversibly create it as open and no longer editable; finalization generates its document representation but does not email the invoice.

Input Parameters

string
Optional invoice title; the organization default applies if omitted.
string
Optional formatted closing remark; the organization default applies if omitted.
object
required
Referenced-contact or one-time billing address.
boolean
Set true to create the invoice immediately as open/finalized and no longer editable. Omit it to create an editable draft. Finalization does not email the invoice.
string ("de" | "en")
Invoice language; defaults to German (de).
array
required
Invoice line-item list.
object
Optional XRechnung settings for an XRechnung-enabled referenced contact.
object
required
Invoice currency and optional overall discount; calculated totals are read-only and cannot be supplied.
string
Optional formatted introductory text; the organization default applies if omitted.
string
required
Invoice voucher timestamp in RFC3339 format (yyyy-MM-ddTHH:mm:ss.SSSXXX).
object
required
Tax treatment for the invoice.
string
Optional print-layout ID; the organization default applies if omitted.
object
Optional payment terms; organization or contact defaults apply if omitted.
object
required
Service or delivery timing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_ORDER_CONFIRMATIONCreate a draft order confirmation in Lexoffice with line items, pricing, and shipping details.

Input Parameters

string
Document title/heading
string
Closing remark or additional notes
object
required
Recipient address details
boolean
Whether the order confirmation should be archived immediately after creation
string ("de" | "en")
Document language (de for German, en for English). Defaults to de if not specified.
array
required
List of line items for the order confirmation (maximum 300 items)
object
required
Total price details
string
required
Document date in RFC 3339/ISO 8601 format (yyyy-MM-ddTHH:mm:ss.SSSXXX)
string
Introduction text that appears at the beginning of the document
string
Delivery terms description
string
UUID of custom print template to use
object
required
Tax conditions for the order confirmation
object
required
Shipping conditions for the order confirmation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_QUOTATIONTool to create a quotation in Lexoffice. Quotations are created in draft mode by default. Use the finalize parameter to create a finalized quotation with status ‘open’. Requires address with either contactId or name+countryCode, line items, total pricing, and tax conditions.

Input Parameters

string
Quotation title
string
Closing remark for the quotation
object
required
Recipient address details
boolean
Set to true to create a finalized quotation with status ‘open’. If false, quotation is created in draft mode
string ("de" | "en")
Quotation language
array
required
List of line items in the quotation (maximum 300 items)
object
required
Total pricing information
string
required
Quotation date in RFC 3339/ISO 8601 format (e.g., ‘2026-02-13T10:00:00.000+01:00’)
string
Introduction text for the quotation
string
Delivery terms text
string
UUID of the print layout to use
object
required
Tax conditions
string
required
Quotation expiration date in RFC 3339/ISO 8601 format (REQUIRED)
string
Shipping conditions text

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_CREATE_VOUCHERTool to create a bookkeeping voucher in Lexoffice. Use when you need to create expense receipts, sales invoices, purchase invoices, or other accounting vouchers. The voucher requires line items with amounts, tax rates, and posting category IDs.

Input Parameters

string ("salesinvoice" | "salescreditnote" | "purchaseinvoice" | "purchasecreditnote" | "invoice" | "downpaymentinvoice" | "creditnote" | "orderconfirmation" | "quotation" | "deliverynote")
required
Type of voucher to create (e.g., salesinvoice, purchaseinvoice)
string
Additional remarks or notes for the voucher
string
Due date for the voucher in ISO 8601 format (YYYY-MM-DD)
string ("net" | "gross")
required
Tax calculation type - ‘gross’ for amounts including tax, ‘net’ for amounts excluding tax
string
UUID of the contact (customer or vendor) associated with this voucher
string
Date of the voucher in ISO 8601 format (YYYY-MM-DD)
string
Shipping date in ISO 8601 format (YYYY-MM-DD)
array
required
List of line items for the voucher with amounts and tax information (minimum 1 item required)
string
Custom voucher number/reference
string ("unchecked" | "open")
Status of the voucher
number
Total tax amount of the voucher (sum of all item tax amounts)
number
Total gross amount of the voucher (sum of all item amounts if taxType is gross)
boolean
Whether to use a collective contact instead of a specific contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_DELETE_ARTICLETool to permanently delete an article by its ID. Returns success confirmation on 204, or raises error if article not found (404).

Input Parameters

string
required
Unique identifier of the article to delete. Use List Articles or Get Article actions to find valid article IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_DELETE_EVENT_SUBSCRIPTIONTool to delete an event subscription by its ID. Use when you need to remove an existing event subscription from Lexoffice.

Input Parameters

string
required
The unique identifier of the event subscription to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_DOWNLOAD_FILEDownload a file by ID from Lexoffice, with the returned format depending on the requested Accept type. This endpoint is intended for bookkeeping voucher documents and is deprecated for sales voucher documents.

Input Parameters

string ("*/*" | "application/xml" | "application/pdf" | "image/jpeg" | "image/png")
The desired content type for the downloaded file. Use this to specify the format you want to receive.
string
required
The unique identifier of the file to download. This ID is typically obtained from invoice, voucher, or other document endpoints that return file references.
string
Optional filename for the downloaded file. If not provided, defaults to ‘file_{file_id}’ with appropriate extension based on content type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_ARTICLETool to retrieve an article by ID from Lexoffice. Use when you need to fetch details of a specific article including its price, type, and other metadata.

Input Parameters

string
required
The unique identifier of the article to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_CONTACTTool to retrieve a specific contact by its ID. Use when you need to fetch detailed information about a contact.

Input Parameters

string
required
Unique ID of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_CREDIT_NOTETool to retrieve a credit note by its UUID from Lexoffice. Use when you need to fetch details of a specific credit note. Credit notes can be in draft or finalized (open) mode.

Input Parameters

string
required
UUID of the credit note to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_CREDIT_NOTE_DOCUMENTRender a finalized credit note PDF and retrieve its document file ID using the deprecated credit note document endpoint. Draft credit notes cannot be rendered.

Input Parameters

string
required
The unique identifier (UUID) of the credit note. The credit note must be in ‘open’ status (not ‘draft’) for document rendering to work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_DELIVERY_NOTERetrieve a delivery note by ID from Lexoffice, including available address, line item and tax information.

Input Parameters

string
required
The unique identifier (UUID) of the delivery note to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_DELIVERY_NOTE_DOCUMENTRender a finalized delivery note PDF and retrieve its file ID using the deprecated delivery note document endpoint. Draft delivery notes cannot be rendered.

Input Parameters

string
required
Unique identifier (UUID format) of the delivery note to render. The delivery note must be finalized (not in draft status) for the document endpoint to work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_DUNNINGTool to retrieve a dunning document by its ID. Use when you need to fetch details of a specific dunning from Lexoffice.

Input Parameters

string
required
The unique identifier of the dunning to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_DUNNING_DOCUMENTRender a dunning PDF by ID and retrieve its document file reference for downloading. The document-rendering endpoint is deprecated.

Input Parameters

string
required
The unique identifier of the dunning for which to render the document. Must be a valid UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_EVENT_SUBSCRIPTIONTool to retrieve a specific event subscription by its ID. Use when you need to get details about an existing event subscription.

Input Parameters

string
required
The unique identifier of the event subscription to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_INVOICETool to retrieve a specific invoice by its UUID. Use when you need to fetch detailed information about an invoice including line items, pricing, and payment terms.

Input Parameters

string
required
UUID of the invoice to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_INVOICE_DOCUMENTRender an invoice PDF by invoice ID and retrieve its document file reference for downloading. The document-rendering endpoint is deprecated and does not support draft invoices.

Input Parameters

string
required
The unique identifier (UUID) of the invoice to render as PDF. This triggers the PDF document file rendering for invoices in ‘open’ status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_ORDER_CONFIRMATIONRetrieve an order confirmation by ID, including line items, pricing, recipient address, and payment terms.

Input Parameters

string
required
The unique identifier (UUID) of the order confirmation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_ORDER_CONFIRMATION_DOCUMENTRender an order confirmation PDF by ID and return its document file reference for downloading. The document-rendering endpoint is deprecated and does not support draft order confirmations.

Input Parameters

string
required
The unique identifier (UUID) of the order confirmation for which to render the PDF document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_PAYMENTTool to retrieve payment information for a specific voucher (invoice or credit note) from Lexoffice. Use when you need to check payment status, outstanding amounts, or view payment transaction details for bookkeeping or sales vouchers.

Input Parameters

string
required
Unique identifier of the voucher (invoice or credit note) to retrieve payment information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_PROFILERetrieves the user and company profile information from Lexoffice. Use this action to get account details, enabled features, subscription status, and company information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_QUOTATIONTool to retrieve a quotation by its ID. Use when you need to fetch details of a specific quotation including line items, pricing, and payment terms.

Input Parameters

string
required
UUID of the quotation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_QUOTATION_DOCUMENTTool to render a quotation document as a PDF file. Triggers the PDF document file rendering for newly created quotations in status open. Returns a document file ID that can be used to download the PDF.

Input Parameters

string
required
The unique identifier (UUID) of the quotation for which to render the PDF document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_GET_VOUCHERRetrieve a bookkeeping voucher by UUID, including its financial and item details. This covers bookkeeping sales and purchase invoices and credit notes.

Input Parameters

string
required
UUID of the voucher to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_ARTICLESTool to list articles from Lexoffice using filters and pagination. Use when you need to retrieve articles filtered by articleNumber, gtin, or type (PRODUCT/SERVICE). Supports pagination with page and size parameters.

Input Parameters

string
Filter by Global Trade Item Number (GTIN) of the article.
integer
Specify the page number for pagination (zero-indexed). Default is 0.
integer
Specify the number of articles per page. Maximum is 25.
string
Specify the sort order for results. Format: ‘property,direction’ (e.g., ‘title,asc’ or ‘createdDate,desc’).
string ("PRODUCT" | "SERVICE")
Article type enumeration.
string
Filter by article number as given by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_CONTACTSList a page of Lexoffice contacts with optional filters for number, email, name, vendor status, or customer status. Use pagination to retrieve additional pages.

Input Parameters

string
Filter by name
integer
Page number for pagination
integer
Number of records per page
string
Sort field and direction (e.g., ‘name,asc’ or ‘number,desc’)
string
Filter by email address
integer
Filter by contact number
boolean
Filter by vendor status
boolean
Filter by customer status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_COUNTRIESTool to retrieve the list of all available countries with tax classifications from Lexoffice. Use when you need to get country information for invoicing, tax calculations, or address validation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_EVENT_SUBSCRIPTIONSTool to retrieve all event subscriptions for the current access token. Use when you need to inspect configured webhook subscriptions for events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_PAYMENT_CONDITIONSTool to retrieve list of currently configured payment conditions from Lexoffice. Use when you need to view all payment terms and conditions set up in the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_POSTING_CATEGORIESTool to retrieve the list of posting categories for bookkeeping vouchers (revenue or expense) supported in lexoffice. Use when you need to get available posting categories for creating or updating vouchers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_PRINT_LAYOUTSTool to retrieve all print layouts for invoices and other documents. Use when you need to list available print layouts that can be referenced when creating sales vouchers (invoices, delivery notes, credit notes, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_RECURRING_TEMPLATESTool to retrieve all recurring templates from Lexoffice. Use when you need to list recurring invoice templates with pagination and sorting options.

Input Parameters

integer
Page number for pagination (zero-indexed)
integer
Number of records per page
string
Sort field and direction (e.g., ‘title,asc’ or ‘createdDate,desc’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_VOUCHERLISTRetrieve a page of Lexoffice voucher metadata, including bookkeeping vouchers, invoices, credit notes, order confirmations, quotations, and delivery notes. Filter by type, status, archive state, contact, dates, or voucher number, and control sorting and pagination. Pages are zero-indexed and contain up to 250 entries.

Input Parameters

integer
Page number for pagination (zero-indexed). Default is 0.
integer
Number of vouchers per page. Maximum is 250.
string
Sort field and direction (e.g., ‘voucherNumber,DESC’ or ‘voucherDate,ASC’).
boolean
Filter by archived status. Set to true for archived vouchers, false for non-archived.
string
Filter by contact ID (UUID format).
string ("any" | "salesinvoice" | "salescreditnote" | "purchaseinvoice" | "purchasecreditnote" | "invoice" | "creditnote" | "orderconfirmation" | "quotation" | "downpaymentinvoice" | "deliverynote")
Filter by voucher type (salesinvoice, invoice, creditnote, etc.).
string
Filter by created date to (ISO date format: YYYY-MM-DD).
string
Filter by updated date to (ISO date format: YYYY-MM-DD).
string
Filter by voucher date to (ISO date format: YYYY-MM-DD).
string
Filter by specific voucher number.
string ("any" | "draft" | "open" | "overdue" | "paid" | "paidoff" | "voided" | "transferred" | "sepadebit" | "accepted" | "rejected" | "uncheked")
Filter by voucher status (draft, open, paid, etc.).
string
Filter by created date from (ISO date format: YYYY-MM-DD).
string
Filter by updated date from (ISO date format: YYYY-MM-DD).
string
Filter by voucher date from (ISO date format: YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_LIST_VOUCHERSTool to filter vouchers by voucher number from Lexoffice. Use when you need to retrieve vouchers with a specific voucher number.

Input Parameters

integer
Page number for pagination, defaults to 0
integer
Number of items per page
string
required
Filter vouchers by voucher number (REQUIRED)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_UPDATE_ARTICLETool to update an existing article in Lexoffice with new data. Use when you need to modify article details such as price, title, type, or other attributes. Requires the article ID and version number for optimistic locking.

Input Parameters

string
required
The unique identifier (UUID) of the article to update.
string
Global Trade Item Number (GTIN) for the article.
string
Additional notes or description for the article.
string ("PRODUCT" | "SERVICE")
required
Type of the article. Must be either ‘PRODUCT’ for physical goods or ‘SERVICE’ for services.
object
required
Price information including leading price type, gross price, net price, and tax rate.
string
Title or name of the article.
integer
required
Version number of the article for optimistic locking. Must match the current version to prevent conflicts.
string
required
Unit name for the article (e.g., ‘Stunden’ for hours, ‘Stück’ for pieces).
string
Custom article number for identification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_UPDATE_CONTACTTool to update an existing contact in lexoffice. Use when modifying customer or vendor information. Requires the contact ID and current version number for optimistic locking.

Input Parameters

string
required
UUID of the contact to update
string
Notes about the contact
object
required
Contact roles (customer and/or vendor). At least one role is required.
object
Person contact details. Use this for individual contacts (mutually exclusive with company).
object
Company contact details. Use this for business contacts (mutually exclusive with person).
integer
required
Current version number of the contact for optimistic locking. Get this from the contact details before updating.
object
Contact addresses (billing and/or shipping).
object
Phone number information.
object
Email address information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_UPDATE_VOUCHERUpdate a currently open voucher after checking its version, or finalize a currently unchecked voucher by explicitly transitioning it to open. Other current statuses are non-writable. Files are preserved when omitted or null; supplying a full retention list permanently deletes every omitted attachment.

Input Parameters

string ("salesinvoice" | "salescreditnote" | "purchaseinvoice" | "purchasecreditnote")
Replacement voucher type; omit or pass null to preserve the current type.
array
DESTRUCTIVE FULL RETENTION LIST: if supplied, this entire list replaces the voucher’s retained file IDs and every currently attached file omitted from it is permanently deleted. Omit this parameter or pass null to preserve every current file. An explicit empty list removes all attachments.
string
Replacement voucher remark; omit or pass null to preserve it.
string
Replacement due date in YYYY-MM-DD format; omit or pass null to preserve it. Lexware uses voucher_date if absent for a checked voucher.
string ("net" | "gross")
Replacement tax calculation mode; omit or pass null to preserve it.
string
Replacement existing Customer contact ID, required in the merged payload unless collective contact is enabled. Omit or pass null to preserve it.
string
required
ID of the existing voucher to update.
string
Replacement displayed collective-contact name; omit or pass null to preserve it.
string
Replacement voucher date in YYYY-MM-DD format; omit or pass null to preserve it. Required in the merged payload when status is not unchecked.
string
Replacement shipping date in YYYY-MM-DD format; valid only for sales invoices and sales credit notes. Omit or pass null to preserve it.
array
Complete replacement item list; omit or pass null to preserve all current items. Required and non-empty in the merged payload when status is not unchecked.
string
Replacement voucher number; omit or pass null to preserve it. Required in the merged payload when status is not unchecked.
string ("open" | "unchecked")
Requested status. The only allowed change is unchecked to open; omit or pass null to preserve status. An unchecked voucher cannot otherwise be updated.
integer
required
Version the caller last read. The action aborts before updating if Lexware now reports a different version; re-read and reconsider the intended merge instead of blindly retrying.
string
Replacement tax total with two decimal places. It must equal the exact sum of merged item tax amounts and is required when status is not unchecked. Omit or pass null to preserve the current total.
string
Replacement gross total with two decimal places. It must match the merged voucher items and taxes and is required when status is not unchecked. Omit or pass null to preserve the current total.
boolean
Set true to remove the current shipping date from the merged PUT body. Use this explicit clear when changing a sales voucher with a shipping date to a purchase voucher. Omit or set false to preserve the current shipping date. This does not affect attached files.
boolean
Set true to use the collective contact, in which case contact_id is ignored; omit or pass null to preserve the current value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEXOFFICE_UPLOAD_VOUCHER_FILEUpload and assign a PDF, image, or XML file to an existing bookkeeping voucher as a supporting document or receipt. File processing is asynchronous.

Input Parameters

string
required
Unique identifier of the voucher to which the file will be uploaded.
object
required
File (PDF or image) to upload to the voucher. Only PDF and image files are accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not