Billomat4J

Java Software Development Kit for the Billomat API.

✋ Due to the unversioned Billomat API, the regular breaking changes, the lack of a changelog, ongoing documentation errors and the ignorant support team, the active development and maintenance of this project has been stopped. Pull requests with proper test cases might still be accepted.

Requirements

• Java 11
• Apache Commons Lang
• Jackson JSON Processor
• SLF4J

Example

This example fetches all paid invoices for the last 30 days and prints them out. This file is also part of this project - see Example.java

BillomatConfiguration billomatConfiguration = new BillomatConfiguration();
billomatConfiguration.setBillomatId("<billomatId>");
billomatConfiguration.setApiKey("<apiKey>");

InvoiceService invoiceService = new InvoiceServiceImpl(billomatConfiguration);

System.out.println("Paid invoices for the last 30 days:");

InvoiceFilter invoiceFilter = new InvoiceFilter()
    .byFrom(LocalDate.now().minusDays(30))
    .byTo(LocalDate.now())
    .byStatus(InvoiceStatus.PAID);

for (Invoice invoice : invoiceService.findInvoices(invoiceFilter)) {
    System.out.println("Invoice " + invoice.getInvoiceNumber() + ": " + invoice.getTotalNet());
}

Testing

WARNING: Do not run the integration tests with your regular Billomat account. The tests will wipe out all your invoices, clients and so on. Ask the Billomat-Team for a dedicated Test-User!

Create a file src/integrationTest/resources/billomat.properties with this content:

billomatId = <your-billomat-id>
billomatApiKey = <your-billomat-api-key>
billomatAppId = <your-billomat-app-id>          # OPTIONAL
billomatAppSecret = <your-billomat-app-secret>  # OPTIONAL
email = <your-email-address>

The email address is required for sending test documents (like invoices).

Run the integration test suite by invoking:

./gradlew integrationTest