Class InvoicesBankApi


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2024-03-02T00:38:41.793663Z[Etc/UTC]")
    public class InvoicesBankApi
    extends Object
    • Constructor Detail

      • InvoicesBankApi

        public InvoicesBankApi()
      • InvoicesBankApi

        @Autowired
        public InvoicesBankApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • cancelInvoice

        public reactor.core.publisher.Mono<InvoiceBankModel> cancelInvoice​(String invoiceGuid)
                                                                    throws org.springframework.web.reactive.function.client.WebClientResponseException
        Cancel Invoice Cancels an invoice. Required scope: **invoices:execute**

        200 - Invoice cancelled

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - Invoice not found

        Parameters:
        invoiceGuid - Identifier for the invoice.
        Returns:
        InvoiceBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • cancelInvoiceWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<InvoiceBankModel>> cancelInvoiceWithHttpInfo​(String invoiceGuid)
                                                                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • createInvoice

        public reactor.core.publisher.Mono<InvoiceBankModel> createInvoice​(PostInvoiceBankModel postInvoiceBankModel)
                                                                    throws org.springframework.web.reactive.function.client.WebClientResponseException
        Create Invoice Creates a invoice. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the invoice details in our private store | | unpaid | The invoice is unpaid. Payment instructions can be generated for an invoice in this state | | cancelling | The invocie is in the process of being cancelled | | cancelled | The invoice has been cancelled | | settling | The invoice has been paid and the funds associated with this invoice are in the process of being settled | | paid | The invoice has been paid and the funds associated with this invoice have been settled | Required scope: **invoices:execute**

        201 - Invoice created

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        Parameters:
        postInvoiceBankModel - The postInvoiceBankModel parameter
        Returns:
        InvoiceBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • createInvoiceWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<InvoiceBankModel>> createInvoiceWithHttpInfo​(PostInvoiceBankModel postInvoiceBankModel)
                                                                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • getInvoice

        public reactor.core.publisher.Mono<InvoiceBankModel> getInvoice​(String invoiceGuid)
                                                                 throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get Invoice Retrieves a invoice. Required scope: **invoices:read**

        200 - invoice found

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - invoice not found

        Parameters:
        invoiceGuid - Identifier for the payment instruction.
        Returns:
        InvoiceBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • getInvoiceWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<InvoiceBankModel>> getInvoiceWithHttpInfo​(String invoiceGuid)
                                                                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • listInvoices

        public reactor.core.publisher.Mono<InvoiceListBankModel> listInvoices​(BigInteger page,
                                                                              BigInteger perPage,
                                                                              String guid,
                                                                              String bankGuid,
                                                                              String customerGuid,
                                                                              String accountGuid,
                                                                              String label)
                                                                       throws org.springframework.web.reactive.function.client.WebClientResponseException
        List Invoices Retrieves a list of invoices. Required scope: **invoices:read**

        200 - get list of invoices

        400 - Invalid requests

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        Parameters:
        page - The page index to retrieve.
        perPage - The number of entities per page to return.
        guid - Comma separated guids to list invoices for.
        bankGuid - Comma separated bank_guids to list invoices for.
        customerGuid - Comma separated customer_guids to list invoices for.
        accountGuid - Comma separated account_guids to list invoices for.
        label - Comma separated labels to list invoices for.
        Returns:
        InvoiceListBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • listInvoicesWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<InvoiceListBankModel>> listInvoicesWithHttpInfo​(BigInteger page,
                                                                                                                                   BigInteger perPage,
                                                                                                                                   String guid,
                                                                                                                                   String bankGuid,
                                                                                                                                   String customerGuid,
                                                                                                                                   String accountGuid,
                                                                                                                                   String label)
                                                                                                                            throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException