Lexware Java SDK

This project is an unofficial Java SDK for the Lexware Office Public API.

Use 3.x to access the api via https://api.lexware.io (formerly https://api.lexoffice.io).

Requirements

lexware-java-sdk	Java	Spring Boot
3.5	21	4.0.x
3.2	21	3.5.x
3.0	21	3.4.x
2.1	21	3.4.x
2.x	21	3.3.x
1.x	17	3.1.x
0.x	17	2.7.x

Usage

Include Lexware java-sdk to your project:

Maven

<dependency>
    <groupId>de.octalog.lexware</groupId>
    <artifactId>java-sdk</artifactId>
    <version>...</version>
</dependency>

Gradle (Kotlin DSL)

dependencies {
    implementation("de.octalog.lexware:java-sdk:...")
}

Gradle (Groovy DSL)

dependencies {
    implementation 'de.octalog.lexware:java-sdk:...'
}

String apiToken = "";
LexwareApi lexwareApi = new LexwareApiBuilder().apiToken(apiToken).build();

See FAQ Get an API key to generate an API key.

Implementation Status

The following Endpoints are implemented based on Lexware developer documentation change-log of 16.08.2022.

• Contacts Endpoint
• Countries Endpoint
• Credit Notes Endpoint
• Delivery Notes Endpoint
• Dunnings Endpoint
• Down Payment Invoices Endpoint
• Event Subscriptions Endpoint
• Files Endpoint
• Invoices Endpoint
• Order Confirmations Endpoint
• Payments Endpoint
• Payment Conditions Endpoint
• Posting Categories Endpoint
• Profile Endpoint
• Quotations
• Recurring Templates Endpoint
• Voucherlist Endpoint
• Vouchers Endpoint

Reference documentation

See Lexware API Documentation.

License

Lexware Java SDK is Open Source software released under the MIT license.

Credits

This project is a fork of focus-shift/lexoffice-java-sdk which is based on the work of rocketbase-io/lexoffice-api