com.squareup.square.models

Class UpdateInvoiceRequest

java.lang.Object

com.squareup.square.models.UpdateInvoiceRequest

public class UpdateInvoiceRequest
extends Object

This is a model class for UpdateInvoiceRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateInvoiceRequest.Builder Class to build instances of UpdateInvoiceRequest.

Constructor Summary

Constructors

Constructor and Description
UpdateInvoiceRequest(Invoice invoice, String idempotencyKey, List<String> fieldsToClear) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getFieldsToClear() Getter for FieldsToClear.
String	getIdempotencyKey() Getter for IdempotencyKey.
Invoice	getInvoice() Getter for Invoice.
int	hashCode()
UpdateInvoiceRequest.Builder	toBuilder() Builds a new UpdateInvoiceRequest.Builder object.
String	toString() Converts this UpdateInvoiceRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateInvoiceRequest

public UpdateInvoiceRequest(Invoice invoice,
                            String idempotencyKey,
                            List<String> fieldsToClear)

Initialization constructor.

Parameters:

invoice - Invoice value for invoice.

idempotencyKey - String value for idempotencyKey.

fieldsToClear - List of String value for fieldsToClear.

Method Detail

getInvoice

public Invoice getInvoice()

Getter for Invoice. Stores information about an invoice. You use the Invoices API to create and manage invoices. For more information, see [Manage Invoices Using the Invoices API](https://developer.squareup.com/docs/invoices-api/overview).

Returns:

Returns the Invoice

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies the `UpdateInvoice` request. If you do not provide `idempotency_key` (or provide an empty string as the value), the endpoint treats each request as independent. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).

Returns:

Returns the String

getFieldsToClear

public List<String> getFieldsToClear()

Getter for FieldsToClear. The list of fields to clear. For examples, see [Update an invoice](https://developer.squareup.com/docs/invoices-api/overview#update-an-invoice).

Returns:

Returns the List of String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this UpdateInvoiceRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public UpdateInvoiceRequest.Builder toBuilder()

Builds a new UpdateInvoiceRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new UpdateInvoiceRequest.Builder object