Configuration
Connection page
Section titled “Connection page”| Field | Meaning |
|---|---|
| Mode | Test uses the test API key, Live the live key. Lexware Office has no sandbox: use a second (trial) account for tests |
| API key | Created in Lexware Office (Settings > Public API). Stored encrypted, never shown again; leave the field empty to keep the saved key. A new key removes the event subscriptions of the old one: register them again |
| Event subscriptions | Registers invoice.status.changed, payment.changed and credit-note.status.changed with the address of this store. Lexware Office signs every call with an RSA signature that the add-on verifies |
Settings
Section titled “Settings”| Setting | Default | Meaning |
|---|---|---|
| Enable | on | Off = no new work starts; jobs under way finish |
| Marketplace owner mode | on | Multi-Vendor. On: every order is invoiced in the owner’s Lexware Office account and vendors only look. Off: each vendor connects their own account with their own API key |
| Create the invoice when the order status becomes | Paid | Empty = invoices only by hand (“Create invoice now” on the order). Declined, failed and canceled orders never get an invoice |
| Finalize the invoice | on | On: status open, number and PDF at once. Off: a draft that you finalize in Lexware Office (the API cannot finalize it later; a draft has no PDF and no credit note) |
| Create the credit note when the order status becomes | Canceled | Credits everything that is left on the invoice. Empty = off |
| Credit note for completed RMA returns | on | A completed return with refund credits the returned items |
| Set the order status when the invoice is paid in Lexware Office | none | An order that is still Open or Backordered moves to this status when Lexware Office shows the invoice as paid. Other orders never move |
| Create a contact for consumers | off | Off: consumers get a one-time address on the invoice. Companies, vat-free sales and EU company sales always use a contact |
| Language of the documents | German | Lexware Office prints German or English invoices. Automatic = German for orders in a German language, otherwise English |
| EU sale to a company with a VAT ID, no VAT charged | intra-community supply | Tax type of those invoices: intra-community supply or external service (section 13b) |
| Payment term in days | 0 | 0 = the payment conditions of your Lexware Office account |
| Introduction text of the invoice | empty | Empty = the default text of your Lexware Office account. Placeholders {order_id} and {date} |
| Invoice download for customers | on | Download button on the order page of signed-in customers |
| Do not sync orders before | empty | Keeps old orders out of the books; also limits “Queue past orders” |
| Debug log, Log retention | off, 90 days | The debug log stores masked requests and responses; switch it off when done |
Tax rates
Section titled “Tax rates”Orders > Lexware Office documents > Tax rates. By default each product line gets the percentage of the CS-Cart tax in the order. Enter a percentage per tax to send another one. Lexware Office accepts 0, 7 and 19 for domestic sales; other rates only for EU distance sales when the organization uses the DESTINATION principle (shown on the Connection page). An order with a rate Lexware Office does not accept stops with a clear message instead of creating a wrong invoice. The shipping line takes the rate of the shipping tax in the order, or the rate you enter here, or the highest product rate.
How the tax type is chosen (delivery country of the order):
| Case | Tax type |
|---|---|
| Germany | net or gross prices, the same as in your store |
| Another EU country, company with a VAT ID, no VAT charged | intra-community supply (or section 13b, see settings); needs a contact |
| Another EU country, consumer, VAT charged, DESTINATION principle | standard voucher with taxSubType distanceSales and the destination rate |
| Third country, no VAT charged | export delivery; needs a contact |
| Small business account (Kleinunternehmer) | vat-free |
The VAT ID is read from the EU VAT Validation add-on when it is installed, otherwise from a customer profile field whose name contains VAT, USt, Umsatzsteuer or tax id.
The queue (invoices, credit notes, payment checks, events) is processed by cron. Use either of these every minute:
- Command line:
php /path/to/store/admin.php --dispatch=kv_lexware_office.cron - Web address (shown in the settings):
.../index.php?dispatch=kv_lexware_office.cron&key=<secret>
Lexware Office allows 2 requests per second; the add-on spaces its calls by about half a second across all processes and retries a rejected call, so a large queue simply takes longer.
Multi-Vendor
Section titled “Multi-Vendor”- Owner mode on: the marketplace owner’s key is used for all orders. Vendors see the documents of their own orders and download the files, but cannot create, retry or credit documents.
- Owner mode off: every vendor opens Vendor panel > Orders > Lexware Office documents > Connection and enters their own API key. Their orders are invoiced in their own Lexware Office account. A vendor sees only their own orders, documents, jobs and log.
- Running the whole queue, queuing past orders and the cron are for the marketplace administrator only.