InvoicesApi (cybersource-rest-client-java 0.0.76 API)

java.lang.Object
- Api.InvoicesApi

```
public class InvoicesApi
extends Object
```

Constructor Summary

Constructors
Constructor and Description

InvoicesApi()

InvoicesApi(ApiClient apiClient)

Constructors
Constructor and Description
`InvoicesApi()`
`InvoicesApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InvoicingV2InvoicesPost201Response`	`createInvoice(CreateInvoiceRequest createInvoiceRequest)` Create a New Invoice The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device.
`okhttp3.Call`	`createInvoiceAsync(CreateInvoiceRequest createInvoiceRequest, ApiCallback<InvoicingV2InvoicesPost201Response> callback)` Create a New Invoice (asynchronously) The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device.
`okhttp3.Call`	`createInvoiceCall(CreateInvoiceRequest createInvoiceRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createInvoice
`ApiResponse<InvoicingV2InvoicesPost201Response>`	`createInvoiceWithHttpInfo(CreateInvoiceRequest createInvoiceRequest)` Create a New Invoice The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device.
`InvoicingV2InvoicesAllGet200Response`	`getAllInvoices(Integer offset, Integer limit, String status)` Get a List of Invoices Provides a (filtered) list of invoices that have been created in your account.
`okhttp3.Call`	`getAllInvoicesAsync(Integer offset, Integer limit, String status, ApiCallback<InvoicingV2InvoicesAllGet200Response> callback)` Get a List of Invoices (asynchronously) Provides a (filtered) list of invoices that have been created in your account.
`okhttp3.Call`	`getAllInvoicesCall(Integer offset, Integer limit, String status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getAllInvoices
`ApiResponse<InvoicingV2InvoicesAllGet200Response>`	`getAllInvoicesWithHttpInfo(Integer offset, Integer limit, String status)` Get a List of Invoices Provides a (filtered) list of invoices that have been created in your account.
`ApiClient`	`getApiClient()`
`InvoicingV2InvoicesGet200Response`	`getInvoice(String id)` Get Invoice Details You can retrieve details of a specific invoice.
`okhttp3.Call`	`getInvoiceAsync(String id, ApiCallback<InvoicingV2InvoicesGet200Response> callback)` Get Invoice Details (asynchronously) You can retrieve details of a specific invoice.
`okhttp3.Call`	`getInvoiceCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getInvoice
`ApiResponse<InvoicingV2InvoicesGet200Response>`	`getInvoiceWithHttpInfo(String id)` Get Invoice Details You can retrieve details of a specific invoice.
`InvoicingV2InvoicesCancel200Response`	`performCancelAction(String id)` Cancel an Invoice You can cancel an invoice if no payment is made to it.
`okhttp3.Call`	`performCancelActionAsync(String id, ApiCallback<InvoicingV2InvoicesCancel200Response> callback)` Cancel an Invoice (asynchronously) You can cancel an invoice if no payment is made to it.
`okhttp3.Call`	`performCancelActionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for performCancelAction
`ApiResponse<InvoicingV2InvoicesCancel200Response>`	`performCancelActionWithHttpInfo(String id)` Cancel an Invoice You can cancel an invoice if no payment is made to it.
`InvoicingV2InvoicesSend200Response`	`performSendAction(String id)` Send an Invoice You can send an invoice in draft or created state or resend a sent or partially paid invoice.
`okhttp3.Call`	`performSendActionAsync(String id, ApiCallback<InvoicingV2InvoicesSend200Response> callback)` Send an Invoice (asynchronously) You can send an invoice in draft or created state or resend a sent or partially paid invoice.
`okhttp3.Call`	`performSendActionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for performSendAction
`ApiResponse<InvoicingV2InvoicesSend200Response>`	`performSendActionWithHttpInfo(String id)` Send an Invoice You can send an invoice in draft or created state or resend a sent or partially paid invoice.
`void`	`setApiClient(ApiClient apiClient)`
`InvoicingV2InvoicesPut200Response`	`updateInvoice(String id, UpdateInvoiceRequest updateInvoiceRequest)` Update an Invoice You can update all information except the invoice number till any payment is received for an invoice.
`okhttp3.Call`	`updateInvoiceAsync(String id, UpdateInvoiceRequest updateInvoiceRequest, ApiCallback<InvoicingV2InvoicesPut200Response> callback)` Update an Invoice (asynchronously) You can update all information except the invoice number till any payment is received for an invoice.
`okhttp3.Call`	`updateInvoiceCall(String id, UpdateInvoiceRequest updateInvoiceRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateInvoice
`ApiResponse<InvoicingV2InvoicesPut200Response>`	`updateInvoiceWithHttpInfo(String id, UpdateInvoiceRequest updateInvoiceRequest)` Update an Invoice You can update all information except the invoice number till any payment is received for an invoice.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - InvoicesApi
```
public InvoicesApi()
```
  - InvoicesApi
```
public InvoicesApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - createInvoiceCall
```
public okhttp3.Call createInvoiceCall(CreateInvoiceRequest createInvoiceRequest,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException
```
    Build call for createInvoice
    
    Parameters:
    
    createInvoiceRequest - (required)
    
    progressListener - Progress listener
    
    progressRequestListener - Progress request listener
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - createInvoice
```
public InvoicingV2InvoicesPost201Response createInvoice(CreateInvoiceRequest createInvoiceRequest)
                                                 throws ApiException
```
    Create a New Invoice The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device. You can either use the system generated email or use the invoice payment link in your own communication. You can add discounts and taxes for the entire invoice or for each line item. To customize the invoice to match your brand see [Invoice Settings](https://developer.cybersource.com/api-reference-assets/index.html#invoicing_invoice-settings_update-invoice-settings). The invoice payment page uses Unified Checkout to process the payments. The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
    
    Parameters:
    
    createInvoiceRequest - (required)
    
    Returns:
    
    InvoicingV2InvoicesPost201Response
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - createInvoiceWithHttpInfo
```
public ApiResponse<InvoicingV2InvoicesPost201Response> createInvoiceWithHttpInfo(CreateInvoiceRequest createInvoiceRequest)
                                                                          throws ApiException
```
    Create a New Invoice The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device. You can either use the system generated email or use the invoice payment link in your own communication. You can add discounts and taxes for the entire invoice or for each line item. To customize the invoice to match your brand see [Invoice Settings](https://developer.cybersource.com/api-reference-assets/index.html#invoicing_invoice-settings_update-invoice-settings). The invoice payment page uses Unified Checkout to process the payments. The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
    
    Parameters:
    
    createInvoiceRequest - (required)
    
    Returns:
    
    ApiResponse<InvoicingV2InvoicesPost201Response>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - createInvoiceAsync
```
public okhttp3.Call createInvoiceAsync(CreateInvoiceRequest createInvoiceRequest,
                                       ApiCallback<InvoicingV2InvoicesPost201Response> callback)
                                throws ApiException
```
    Create a New Invoice (asynchronously) The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device. You can either use the system generated email or use the invoice payment link in your own communication. You can add discounts and taxes for the entire invoice or for each line item. To customize the invoice to match your brand see [Invoice Settings](https://developer.cybersource.com/api-reference-assets/index.html#invoicing_invoice-settings_update-invoice-settings). The invoice payment page uses Unified Checkout to process the payments. The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
    
    Parameters:
    
    createInvoiceRequest - (required)
    
    callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - getAllInvoicesCall
```
public okhttp3.Call getAllInvoicesCall(Integer offset,
                                       Integer limit,
                                       String status,
                                       ProgressResponseBody.ProgressListener progressListener,
                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                throws ApiException
```
    Build call for getAllInvoices
    
    Parameters:
    
    offset - Page offset number. (required)
    
    limit - Maximum number of items you would like returned. (required)
    
    status - The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED (optional)
    
    progressListener - Progress listener
    
    progressRequestListener - Progress request listener
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getAllInvoices
```
public InvoicingV2InvoicesAllGet200Response getAllInvoices(Integer offset,
                                                           Integer limit,
                                                           String status)
                                                    throws ApiException
```
    Get a List of Invoices Provides a (filtered) list of invoices that have been created in your account. You can filter the list based on Invoice Status by setting the status query parameter to one of DRAFT, CREATED, SENT, PARTIAL, PAID or CANCELED.
    
    Parameters:
    
    offset - Page offset number. (required)
    
    limit - Maximum number of items you would like returned. (required)
    
    status - The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED (optional)
    
    Returns:
    
    InvoicingV2InvoicesAllGet200Response
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getAllInvoicesWithHttpInfo
```
public ApiResponse<InvoicingV2InvoicesAllGet200Response> getAllInvoicesWithHttpInfo(Integer offset,
                                                                                    Integer limit,
                                                                                    String status)
                                                                             throws ApiException
```
    Get a List of Invoices Provides a (filtered) list of invoices that have been created in your account. You can filter the list based on Invoice Status by setting the status query parameter to one of DRAFT, CREATED, SENT, PARTIAL, PAID or CANCELED.
    
    Parameters:
    
    offset - Page offset number. (required)
    
    limit - Maximum number of items you would like returned. (required)
    
    status - The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED (optional)
    
    Returns:
    
    ApiResponse<InvoicingV2InvoicesAllGet200Response>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getAllInvoicesAsync
```
public okhttp3.Call getAllInvoicesAsync(Integer offset,
                                        Integer limit,
                                        String status,
                                        ApiCallback<InvoicingV2InvoicesAllGet200Response> callback)
                                 throws ApiException
```
    Get a List of Invoices (asynchronously) Provides a (filtered) list of invoices that have been created in your account. You can filter the list based on Invoice Status by setting the status query parameter to one of DRAFT, CREATED, SENT, PARTIAL, PAID or CANCELED.
    
    Parameters:
    
    offset - Page offset number. (required)
    
    limit - Maximum number of items you would like returned. (required)
    
    status - The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED (optional)
    
    callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - getInvoiceCall
```
public okhttp3.Call getInvoiceCall(String id,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException
```
    Build call for getInvoice
    
    Parameters:
    
    id - The invoice number. (required)
    
    progressListener - Progress listener
    
    progressRequestListener - Progress request listener
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getInvoice
```
public InvoicingV2InvoicesGet200Response getInvoice(String id)
                                             throws ApiException
```
    Get Invoice Details You can retrieve details of a specific invoice. This can be used to check the Invoice status and get a list of invoice payments in the invoice history section of the response. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.
    
    Parameters:
    
    id - The invoice number. (required)
    
    Returns:
    
    InvoicingV2InvoicesGet200Response
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getInvoiceWithHttpInfo
```
public ApiResponse<InvoicingV2InvoicesGet200Response> getInvoiceWithHttpInfo(String id)
                                                                      throws ApiException
```
    Get Invoice Details You can retrieve details of a specific invoice. This can be used to check the Invoice status and get a list of invoice payments in the invoice history section of the response. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.
    
    Parameters:
    
    id - The invoice number. (required)
    
    Returns:
    
    ApiResponse<InvoicingV2InvoicesGet200Response>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getInvoiceAsync
```
public okhttp3.Call getInvoiceAsync(String id,
                                    ApiCallback<InvoicingV2InvoicesGet200Response> callback)
                             throws ApiException
```
    Get Invoice Details (asynchronously) You can retrieve details of a specific invoice. This can be used to check the Invoice status and get a list of invoice payments in the invoice history section of the response. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.
    
    Parameters:
    
    id - The invoice number. (required)
    
    callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - performCancelActionCall
```
public okhttp3.Call performCancelActionCall(String id,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException
```
    Build call for performCancelAction
    
    Parameters:
    
    id - The invoice number. (required)
    
    progressListener - Progress listener
    
    progressRequestListener - Progress request listener
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - performCancelAction
```
public InvoicingV2InvoicesCancel200Response performCancelAction(String id)
                                                         throws ApiException
```
    Cancel an Invoice You can cancel an invoice if no payment is made to it. You cannot cancel partially or fully paid invoices.
    
    Parameters:
    
    id - The invoice number. (required)
    
    Returns:
    
    InvoicingV2InvoicesCancel200Response
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - performCancelActionWithHttpInfo
```
public ApiResponse<InvoicingV2InvoicesCancel200Response> performCancelActionWithHttpInfo(String id)
                                                                                  throws ApiException
```
    Cancel an Invoice You can cancel an invoice if no payment is made to it. You cannot cancel partially or fully paid invoices.
    
    Parameters:
    
    id - The invoice number. (required)
    
    Returns:
    
    ApiResponse<InvoicingV2InvoicesCancel200Response>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - performCancelActionAsync
```
public okhttp3.Call performCancelActionAsync(String id,
                                             ApiCallback<InvoicingV2InvoicesCancel200Response> callback)
                                      throws ApiException
```
    Cancel an Invoice (asynchronously) You can cancel an invoice if no payment is made to it. You cannot cancel partially or fully paid invoices.
    
    Parameters:
    
    id - The invoice number. (required)
    
    callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - performSendActionCall
```
public okhttp3.Call performSendActionCall(String id,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException
```
    Build call for performSendAction
    
    Parameters:
    
    id - The invoice number. (required)
    
    progressListener - Progress listener
    
    progressRequestListener - Progress request listener
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - performSendAction
```
public InvoicingV2InvoicesSend200Response performSendAction(String id)
                                                     throws ApiException
```
    Send an Invoice You can send an invoice in draft or created state or resend a sent or partially paid invoice. Fully paid or canceled invoices cannot be resent.
    
    Parameters:
    
    id - The invoice number. (required)
    
    Returns:
    
    InvoicingV2InvoicesSend200Response
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - performSendActionWithHttpInfo
```
public ApiResponse<InvoicingV2InvoicesSend200Response> performSendActionWithHttpInfo(String id)
                                                                              throws ApiException
```
    Send an Invoice You can send an invoice in draft or created state or resend a sent or partially paid invoice. Fully paid or canceled invoices cannot be resent.
    
    Parameters:
    
    id - The invoice number. (required)
    
    Returns:
    
    ApiResponse<InvoicingV2InvoicesSend200Response>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - performSendActionAsync
```
public okhttp3.Call performSendActionAsync(String id,
                                           ApiCallback<InvoicingV2InvoicesSend200Response> callback)
                                    throws ApiException
```
    Send an Invoice (asynchronously) You can send an invoice in draft or created state or resend a sent or partially paid invoice. Fully paid or canceled invoices cannot be resent.
    
    Parameters:
    
    id - The invoice number. (required)
    
    callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - updateInvoiceCall
```
public okhttp3.Call updateInvoiceCall(String id,
                                      UpdateInvoiceRequest updateInvoiceRequest,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException
```
    Build call for updateInvoice
    
    Parameters:
    
    id - The invoice number. (required)
    
    updateInvoiceRequest - Updating the invoice does not resend the invoice automatically. You must resend the invoice separately. (required)
    
    progressListener - Progress listener
    
    progressRequestListener - Progress request listener
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - updateInvoice
```
public InvoicingV2InvoicesPut200Response updateInvoice(String id,
                                                       UpdateInvoiceRequest updateInvoiceRequest)
                                                throws ApiException
```
    Update an Invoice You can update all information except the invoice number till any payment is received for an invoice. Invoices that are partially or fully paid or cancelled cannot be updated.
    
    Parameters:
    
    id - The invoice number. (required)
    
    updateInvoiceRequest - Updating the invoice does not resend the invoice automatically. You must resend the invoice separately. (required)
    
    Returns:
    
    InvoicingV2InvoicesPut200Response
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateInvoiceWithHttpInfo
```
public ApiResponse<InvoicingV2InvoicesPut200Response> updateInvoiceWithHttpInfo(String id,
                                                                                UpdateInvoiceRequest updateInvoiceRequest)
                                                                         throws ApiException
```
    Update an Invoice You can update all information except the invoice number till any payment is received for an invoice. Invoices that are partially or fully paid or cancelled cannot be updated.
    
    Parameters:
    
    id - The invoice number. (required)
    
    updateInvoiceRequest - Updating the invoice does not resend the invoice automatically. You must resend the invoice separately. (required)
    
    Returns:
    
    ApiResponse<InvoicingV2InvoicesPut200Response>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateInvoiceAsync
```
public okhttp3.Call updateInvoiceAsync(String id,
                                       UpdateInvoiceRequest updateInvoiceRequest,
                                       ApiCallback<InvoicingV2InvoicesPut200Response> callback)
                                throws ApiException
```
    Update an Invoice (asynchronously) You can update all information except the invoice number till any payment is received for an invoice. Invoices that are partially or fully paid or cancelled cannot be updated.
    
    Parameters:
    
    id - The invoice number. (required)
    
    updateInvoiceRequest - Updating the invoice does not resend the invoice automatically. You must resend the invoice separately. (required)
    
    callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object

Class InvoicesApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InvoicesApi

InvoicesApi

Method Detail

getApiClient

setApiClient

createInvoiceCall

createInvoice

createInvoiceWithHttpInfo

createInvoiceAsync

getAllInvoicesCall

getAllInvoices

getAllInvoicesWithHttpInfo

getAllInvoicesAsync

getInvoiceCall

getInvoice

getInvoiceWithHttpInfo

getInvoiceAsync

performCancelActionCall

performCancelAction

performCancelActionWithHttpInfo

performCancelActionAsync

performSendActionCall

performSendAction

performSendActionWithHttpInfo

performSendActionAsync

updateInvoiceCall

updateInvoice

updateInvoiceWithHttpInfo

updateInvoiceAsync