Skip to content

README.md

Latest commit

 

History

History
264 lines (198 loc) · 10.4 KB

README.md

File metadata and controls

264 lines (198 loc) · 10.4 KB

Invoices

Overview

Available Operations

  • list - List invoices
  • get - Get invoice

list

Retrieve a list of all your invoices, optionally filtered by year or by invoice reference.

The results are paginated.

Example Usage: list-invoices-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListInvoicesRequest;
import com.mollie.mollie.models.operations.ListInvoicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListInvoicesRequest req = ListInvoicesRequest.builder()
                .reference("2024.10000")
                .year("2024")
                .from("inv_xBEbP9rvAq")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.invoices().list()
                .callAsStream()
                .forEach((ListInvoicesResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-invoices-200-2

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListInvoicesRequest;
import com.mollie.mollie.models.operations.ListInvoicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListInvoicesRequest req = ListInvoicesRequest.builder()
                .reference("2024.10000")
                .year("2024")
                .from("inv_xBEbP9rvAq")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.invoices().list()
                .callAsStream()
                .forEach((ListInvoicesResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-invoices-200-3

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListInvoicesRequest;
import com.mollie.mollie.models.operations.ListInvoicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListInvoicesRequest req = ListInvoicesRequest.builder()
                .reference("2024.10000")
                .year("2024")
                .from("inv_xBEbP9rvAq")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.invoices().list()
                .callAsStream()
                .forEach((ListInvoicesResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-invoices-200-4

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListInvoicesRequest;
import com.mollie.mollie.models.operations.ListInvoicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListInvoicesRequest req = ListInvoicesRequest.builder()
                .reference("2024.10000")
                .year("2024")
                .from("inv_xBEbP9rvAq")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.invoices().list()
                .callAsStream()
                .forEach((ListInvoicesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter Type Required Description
request ListInvoicesRequest ✔️ The request object to use for the request.

Response

ListInvoicesResponse

Errors

Error Type Status Code Content Type
models/errors/ErrorResponse 400, 404 application/hal+json
models/errors/APIException 4XX, 5XX */*

get

Retrieve a single invoice by its ID.

If you want to retrieve the details of an invoice by its invoice number, call the List invoices endpoint with the reference parameter.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.GetInvoiceResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        GetInvoiceResponse res = sdk.invoices().get()
                .invoiceId("inv_aHbjjdrUdm")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

        if (res.entityInvoice().isPresent()) {
            System.out.println(res.entityInvoice().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
invoiceId String ✔️ Provide the ID of the related invoice. inv_aHbjjdrUdm
idempotencyKey Optional<String> ➖ A unique key to ensure idempotent requests. This key should be a UUID v4 string. 123e4567-e89b-12d3-a456-426

Response

GetInvoiceResponse

Errors

Error Type Status Code Content Type
models/errors/ErrorResponse 404 application/hal+json
models/errors/APIException 4XX, 5XX */*
⚡