Lexware Office

Deletes the article with id value {id}. Returns 204 on success, or 404 if the id does not exist. via DELETE /v1/articles/{id}

Deletes an event subscription with the id {subscriptionId}. On success, you will receive a status code 204 (No Content). via DELETE /v1/event-subscriptions/{subscriptionId}

Returns the articles that fulfill the criteria given by filters filter_1 to filter_n using a paging mechanism. If more than one filter is given, the logical connector is AND. Filters that are not set are ignored. To check the maximum page size for this endpoint, see Paging of Resources. via GET /v1/articles

Returns the article with id value {id}. via GET /v1/articles/{id}

Returns the contacts that fulfill the criteria given by filters filter_1 to filter_n using a paging mechanism. If more than one filter is given, the logical connector is AND. Filters that are not set are ignored. To check the maximum page size for this endpoint, see Paging of Resources. via GET /v1/contacts

Returns the contact with id value {id}. via GET /v1/contacts/{id}

Retrieve list of currently known countries. via GET /v1/countries

Returns the credit note with id value {id}. via GET /v1/credit-notes/{id}

To download the PDF file of a credit note document, you need its documentFileId. This id is usually returned by the credit note resource. However, PDF document file rendering must be triggered separately via this endpoint for credit notes created through the API with the status open. via GET /v1/credit-notes/{id}/document

Returns the delivery note with id value {id}. via GET /v1/delivery-notes/{id}

To download the PDF file of a delivery note document, you need its documentFileId. This id is usually returned by the delivery note resource. However, PDF document file rendering must be triggered separately via this endpoint for delivery notes created through the API with the status open. via GET /v1/delivery-notes/{id}/document

Returns the down payment invoice with id value {id}. via GET /v1/down-payment-invoices/{id}

Returns the dunning with id value {id}. via GET /v1/dunnings/{id}

To download the PDF file of a dunning document, you need its documentFileId. This id is usually returned by the dunning resource. However, PDF document file rendering must be triggered separately via this endpoint for dunnings created through the API. via GET /v1/dunnings/{id}/document

Returns all your event subscriptions. via GET /v1/event-subscriptions

Returns the event subscription with the id {subscriptionId}. via GET /v1/event-subscriptions/{subscriptionId}

Returns the invoice with id value {id}. via GET /v1/invoices/{id}

To download the PDF file of an invoice document, you need its documentFileId. This id is usually returned by the invoice resource. However, PDF document file rendering must be triggered separately via this endpoint for invoices created through the API with the status open. via GET /v1/invoices/{id}/document

Returns the order confirmation with id value {id}. via GET /v1/order-confirmations/{id}

To download the PDF file of an order confirmation document, you need its documentFileId. This id is usually returned by the order confirmation resource. However, PDF document file rendering must be triggered separately via this endpoint for order confirmations created through the API with the status open. via GET /v1/order-confirmations/{id}/document

Retrieve list of currently configured payment conditions. via GET /v1/payment-conditions

Retrieve payment information of a voucher. via GET /v1/payments/{voucherId}

Retrieve list of currently known posting categories. via GET /v1/posting-categories

Retrieve the list of print layouts. Lexware accepts ANY sales-voucher read scope for this call; the connection is checked for invoices.read here. via GET /v1/print-layouts

Retrieve your basic profile information. via GET /v1/profile

Returns the quotation with id value {id}. via GET /v1/quotations/{id}

To download the PDF file of a quotation document, you need its documentFileId. This id is usually returned by the quotation resource. However, PDF document file rendering must be triggered separately via this endpoint for quotations created through the API with the status open. via GET /v1/quotations/{id}/document

Retrieve a collection of recurring templates. The result returns only part of the most relevant data which are the referenced contact (only id and name), total price, payment conditions and the complete recurring templates settings. The naming of objects and properties are the same, though. via GET /v1/recurring-templates

Returns the recurring template with id value {id}. via GET /v1/recurring-templates/{id}

To check the maximum page size for this endpoint, see Paging of Resources. via GET /v1/voucherlist

Returns the voucher with id value {id}. via GET /v1/vouchers/{id}

The contents of the article are expected in the request’s body as an application/json. via POST /v1/articles

The contents of the contact are expected in the request’s body as an application/json. via POST /v1/contacts

Credit notes transmitted via the API are created in draft mode per default. To create a finalized credit note with status open the optional query parameter finalize has to be set. The status of a credit note cannot be changed via the api. The created credit note will be shown in the main voucher list in Lexware: https://app.lexware-sandbox.de/vouchers. To provide your customers access to the created credit note please use our deeplink function. via POST /v1/credit-notes

Delivery notes transmitted via the API are created in draft mode per default. To create a finalized delivery note with status open the optional query parameter finalize has to be set. The status of a delivery note cannot be changed via the api. The created delivery note will be shown in the main voucher list in Lexware: https://app.lexware-sandbox.de/vouchers. To provide your customers access to the created delivery note please use our deeplink function. via POST /v1/delivery-notes

The created dunning will not be shown in the main voucher list in Lexware, but will be attached to an invoice and will be visible there. To provide your customers access to the created dunning please use our deeplink function. The contents of the dunning are expected in the request's body as an application/json and must not contain read-only fields. via POST /v1/dunnings

To subscribe to an event, provide the event type and the webhook callback url in the request body. The endpoint returns an action result (HTTP status code 201 Created) on success. Additionally, the Location header returns the resource url. via POST /v1/event-subscriptions

Invoices transmitted via the API are created in draft mode per default. To create a finalized invoice with status open the optional query parameter finalize has to be set. The status of an invoice cannot be changed via the api. The created invoice will be shown in the main voucher list in Lexware: https://app.lexware-sandbox.de/vouchers. To provide your end-users access to the created invoice please use our deeplink function. via POST /v1/invoices

Order confirmations transmitted via the API are created in draft mode per default. To create a finalized order confirmation with status open the optional query parameter finalize has to be set. The contents of the order confirmation are expected in the request's body as an application/json and must not contain read-only fields. via POST /v1/order-confirmations

Quotations transmitted via the API are created in draft mode per default. To create a finalized quotation with status open the optional query parameter finalize has to be set. The status of a quotation cannot be changed via the api. The created quotation will be shown in the main voucher list in Lexware: https://app.lexware-sandbox.de/vouchers. To provide your end-users access to the created quotation please use our deeplink function. via POST /v1/quotations

The contents of the voucher are expected in the request's body as an application/json. The contents of the voucher must not contain read-only fields. The created voucher will be shown in the main voucher list in Lexware: https://app.lexware-sandbox.de/vouchers. via POST /v1/vouchers

Update an existing article with id {id} with the data given in the payload as JSON. Returns an action result on success. For information about required fields please see Create an article. via PUT /v1/articles/{id}

Update an existing contact with id {id} with the data given in the payload as JSON. Returns an action result on success. For information about required fields please see Create a contact. via PUT /v1/contacts/{id}

When you have retrieved a voucher via GET that is identified by {id}, it's possible to update or merge it with the latest information of the requesting system, so that e. g. read-only fields will be filled with the latest Lexware information - e.g. id, organizationId and version. Although the voucherStatus attribute reflects the voucher's current (billing) status, it is not possible to change that state using the API, except for the finalization of a voucher from unchecked to open. Apart from that, a voucher with state unchecked may be not updated. via PUT /v1/vouchers/{id}