Skip to main content
New to Corsair? See API access, authentication, and error handling.

Contacts

create

contacts.create Create a new customer or vendor contact in Lexoffice Risk: write
Input New contacts are created with version 0 when omitted and must have exactly one of person or company plus at least one role. Only one entry per address/contact list and one company contact person can be written. XRechnung contacts require both buyerReference and vendorNumberAtCustomer. Personal contact fields are never included in plugin event logs or propagated provider error details.
Output

get

contacts.get Retrieve a Lexoffice contact by ID Risk: read
Input Output

list

contacts.list List and filter Lexoffice contacts with pagination Risk: read
Input Output

update

contacts.update Update an existing contact in Lexoffice Risk: write
Input Updates require the current contact version. Personal contact fields are never included in plugin event logs or propagated provider error details. The same write rules as contacts.create apply: exactly one of person or company, and at least one role.
Output

Credit Notes

create

creditNotes.create Create a credit note, optionally finalizing or pursuing it Risk: destructive
Input Credit notes can be finalized or pursued from an existing sales voucher; finalize and precedingSalesVoucherId are query parameters. A finalized credit note related to an invoice is immediately paid off and reduces the invoice’s open amount. Credit notes do not support payment conditions, shipping conditions, or per-line discounts. For custom, material, and service lines, name, quantity, unitName, and unitPrice are required; material/service lines also require id.
Output

download

creditNotes.download Download a credit note document as base64-encoded binary data Risk: read
Input Returns the file bytes in base64 form. Lexware supports /, application/pdf, and application/xml for sales credit notes. For an XRechnung credit note, application/pdf returns only a preview; request application/xml for the e-invoice. Output

get

creditNotes.get Retrieve credit note details by ID Risk: read
Input Output

list

creditNotes.list List credit notes with pagination Risk: read
Input Output

render

creditNotes.render Use the deprecated credit-note document endpoint to retrieve a file ID Risk: read
Input Lexware marks this document-ID route deprecated. Prefer creditNotes.download. Finalizing a credit note pursued from an invoice immediately reduces that invoice’s open amount. Output

Down Payment Invoices

download

downPaymentInvoices.download Download a down-payment invoice document as base64 data Risk: read
Input Returns document bytes as base64. Draft down-payment invoices do not have a downloadable document. For an XRechnung down-payment invoice, application/pdf returns only a preview; request application/xml for the e-invoice. Output

get

downPaymentInvoices.get Retrieve a down-payment invoice by ID Risk: read
Input Down-payment invoices are read-only through this API. Their list metadata is available through voucherlist.list using voucherType=downpaymentinvoice. Output

Files

download

files.download Download a bookkeeping file as base64-encoded binary data Risk: read
Input Returns binary bytes as base64. This generic endpoint is intended for bookkeeping voucher files; use the sales-document file routes for invoices, credit notes, and down-payment invoices. Output

upload

files.upload Upload a voucher file, which creates a bookkeeping voucher Risk: destructive
Input Uses multipart form data with a file part and type=voucher. PDF, JPG, PNG, and XML are documented formats, with a 5 MB maximum. Upload creates a voucher whose OCR processing completes asynchronously. The official reference links to files/{id}/status but does not publish that route’s contract, so status polling is excluded as undocumented. Output

Invoices

create

invoices.create Create an invoice in draft or finalized state Risk: destructive
Input The operation can finalize a new invoice or pursue a preceding sales voucher; finalize and precedingSalesVoucherId are query parameters. Finalized invoices cannot be edited or deleted via the API. For custom, material, and service lines, name, quantity, unitName, and unitPrice are required; material/service lines also require id. Text lines accept only name and/or description. Net tax conditions require netAmount; gross tax conditions require grossAmount. Shipping conditions and their required dates are validated before sending. service and delivery need shippingDate; serviceperiod and deliveryperiod need both shippingDate and shippingEndDate; none takes neither.
Output

download

invoices.download Download an invoice document as base64-encoded binary data Risk: read
Input Returns the file bytes in base64 form. Lexware supports /, application/pdf, and application/xml for sales invoices; XRechnung PDF output is a preview only. Output

get

invoices.get Retrieve invoice details by ID Risk: read
Input Output

list

invoices.list List outgoing invoices with pagination Risk: read
Input Output

render

invoices.render Use the deprecated invoice document endpoint to retrieve a file ID Risk: read
Input Lexware marks this document-ID route deprecated. Prefer invoices.download, which returns the document bytes directly. Draft invoices have no downloadable document. Output

Payments

get

payments.get Retrieve payment status and payment entries for a voucher Risk: read
Input Retrieves payment status for a voucher ID; the API documents this operation as read-only. Output

Posting Categories

list

postingCategories.list List the available bookkeeping posting categories Risk: read
Input: empty object Output: object[]

Profile

get

profile.get Retrieve organization and account profile details Risk: read
Input: empty object The response includes organization/account profile details and may include the account user’s email as returned by the provider. The plugin does not log the response. Output

Voucherlist

list

voucherlist.list Search all documented Lexware voucher types with paging Risk: read
Input voucherType and voucherStatus are required; use any or documented comma-separated values. Pagination is zero-based with a maximum size of 250. Invoice, credit-note, and down-payment invoice list operations use this route. overdue must be used on its own; it cannot be combined with other statuses. Output

Vouchers

attachFile

vouchers.attachFile Upload a bookkeeping document to an existing voucher Risk: destructive
Input Uploads a file to an existing voucher. This request has no type form field; use files.upload to create a voucher from an uploaded receipt. Output

create

vouchers.create Create a new bookkeeping voucher Risk: destructive
Input For an open voucher, supply voucherNumber, totalGrossAmount, totalTaxAmount, each item’s taxAmount, and either contactId or useCollectiveContact: true. If both contact fields are supplied, Lexware ignores contactId when useCollectiveContact is true. The purchase example uses the documented “Reisen (für Selbständige)” expense category; select an appropriate outgo category from postingCategories.list for the actual expense. Version is omitted unless explicitly provided because the provider’s create documentation conflicts about its initial value. Leaving out voucherStatus creates an open voucher, which also needs voucherDate and at least one entry in voucherItems.
Output

get

vouchers.get Retrieve voucher details by ID Risk: read
Input Output: object

list

vouchers.list List bookkeeping vouchers with optional voucher number filter Risk: read
Input This convenience operation filters bookkeeping voucher types and voucherStatus=any through the current /voucherlist route. Lexware’s older /vouchers?voucherNumber filter is deprecated. Output

update

vouchers.update Update a bookkeeping voucher including its assigned files Risk: destructive
Input Updates require the latest version and the existing files array. Lexware warns that omitting existing file IDs permanently deletes those files. voucherStatus can only be changed from unchecked to open; this operation is classified destructive. voucherDate is written as YYYY-MM-DD: take the date part of the timestamp vouchers.get returns (for example 2026-11-21 from 2026-11-21T00:00:00.000+01:00) without converting it to UTC. Read the voucher first and pass its version and every file ID in files.
Output