Invoice (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.Invoice

```
public class Invoice
extends Object
```
This is a model class for Invoice type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Invoice.Builder
Class to build instances of Invoice.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Invoice.Builder` Class to build instances of `Invoice`.

Constructor Summary

Constructors
Constructor and Description
Invoice(String id, Integer version, String locationId, String orderId, InvoiceRecipient primaryRecipient, List<InvoicePaymentRequest> paymentRequests, String deliveryMethod, String invoiceNumber, String title, String description, String scheduledAt, String publicUrl, Money nextPaymentAmountMoney, String status, String timezone, String createdAt, String updatedAt, InvoiceAcceptedPaymentMethods acceptedPaymentMethods, List<InvoiceCustomField> customFields, String subscriptionId, String saleOrServiceDate, String paymentConditions) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`InvoiceAcceptedPaymentMethods`	`getAcceptedPaymentMethods()` Getter for AcceptedPaymentMethods.
`String`	`getCreatedAt()` Getter for CreatedAt.
`List<InvoiceCustomField>`	`getCustomFields()` Getter for CustomFields.
`String`	`getDeliveryMethod()` Getter for DeliveryMethod.
`String`	`getDescription()` Getter for Description.
`String`	`getId()` Getter for Id.
`String`	`getInvoiceNumber()` Getter for InvoiceNumber.
`String`	`getLocationId()` Getter for LocationId.
`Money`	`getNextPaymentAmountMoney()` Getter for NextPaymentAmountMoney.
`String`	`getOrderId()` Getter for OrderId.
`String`	`getPaymentConditions()` Getter for PaymentConditions.
`List<InvoicePaymentRequest>`	`getPaymentRequests()` Getter for PaymentRequests.
`InvoiceRecipient`	`getPrimaryRecipient()` Getter for PrimaryRecipient.
`String`	`getPublicUrl()` Getter for PublicUrl.
`String`	`getSaleOrServiceDate()` Getter for SaleOrServiceDate.
`String`	`getScheduledAt()` Getter for ScheduledAt.
`String`	`getStatus()` Getter for Status.
`String`	`getSubscriptionId()` Getter for SubscriptionId.
`String`	`getTimezone()` Getter for Timezone.
`String`	`getTitle()` Getter for Title.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`Integer`	`getVersion()` Getter for Version.
`int`	`hashCode()`
`Invoice.Builder`	`toBuilder()` Builds a new `Invoice.Builder` object.
`String`	`toString()` Converts this Invoice into string format.

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

- Constructor Detail
  - Invoice
```
public Invoice(String id,
               Integer version,
               String locationId,
               String orderId,
               InvoiceRecipient primaryRecipient,
               List<InvoicePaymentRequest> paymentRequests,
               String deliveryMethod,
               String invoiceNumber,
               String title,
               String description,
               String scheduledAt,
               String publicUrl,
               Money nextPaymentAmountMoney,
               String status,
               String timezone,
               String createdAt,
               String updatedAt,
               InvoiceAcceptedPaymentMethods acceptedPaymentMethods,
               List<InvoiceCustomField> customFields,
               String subscriptionId,
               String saleOrServiceDate,
               String paymentConditions)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    version - Integer value for version.
    
    locationId - String value for locationId.
    
    orderId - String value for orderId.
    
    primaryRecipient - InvoiceRecipient value for primaryRecipient.
    
    paymentRequests - List of InvoicePaymentRequest value for paymentRequests.
    
    deliveryMethod - String value for deliveryMethod.
    
    invoiceNumber - String value for invoiceNumber.
    
    title - String value for title.
    
    description - String value for description.
    
    scheduledAt - String value for scheduledAt.
    
    publicUrl - String value for publicUrl.
    
    nextPaymentAmountMoney - Money value for nextPaymentAmountMoney.
    
    status - String value for status.
    
    timezone - String value for timezone.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    acceptedPaymentMethods - InvoiceAcceptedPaymentMethods value for acceptedPaymentMethods.
    
    customFields - List of InvoiceCustomField value for customFields.
    
    subscriptionId - String value for subscriptionId.
    
    saleOrServiceDate - String value for saleOrServiceDate.
    
    paymentConditions - String value for paymentConditions.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The Square-assigned ID of the invoice.
    
    Returns:
    
    Returns the String
  - getVersion
```
public Integer getVersion()
```
    Getter for Version. The Square-assigned version number, which is incremented each time an update is committed to the invoice.
    
    Returns:
    
    Returns the Integer
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The ID of the location that this invoice is associated with. If specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.
    
    Returns:
    
    Returns the String
  - getOrderId
```
public String getOrderId()
```
    Getter for OrderId. The ID of the [order]($m/Order) for which the invoice is created. This field is required when creating an invoice, and the order must be in the `OPEN` state. To view the line items and other information for the associated order, call the [RetrieveOrder]($e/Orders/RetrieveOrder) endpoint using the order ID.
    
    Returns:
    
    Returns the String
  - getPrimaryRecipient
```
public InvoiceRecipient getPrimaryRecipient()
```
    Getter for PrimaryRecipient. Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice and that Square uses to deliver the invoice. When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates the remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. Square updates the customer ID in response to a merge operation, but does not update other fields.
    
    Returns:
    
    Returns the InvoiceRecipient
  - getPaymentRequests
```
public List<InvoicePaymentRequest> getPaymentRequests()
```
    Getter for PaymentRequests. The payment schedule for the invoice, represented by one or more payment requests that define payment settings, such as amount due and due date. An invoice supports the following payment request combinations: - One balance - One deposit with one balance - 2–12 installments - One deposit with 2–12 installments This field is required when creating an invoice. It must contain at least one payment request. All payment requests for the invoice must equal the total order amount. For more information, see [Payment requests](https://developer.squareup.com/docs/invoices-api/overview#payment-requests). Adding `INSTALLMENT` payment requests to an invoice requires an [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).
    
    Returns:
    
    Returns the List of InvoicePaymentRequest
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Getter for DeliveryMethod. Indicates how Square delivers the [invoice]($m/Invoice) to the customer.
    
    Returns:
    
    Returns the String
  - getInvoiceNumber
```
public String getInvoiceNumber()
```
    Getter for InvoiceNumber. A user-friendly invoice number that is displayed on the invoice. The value is unique within a location. If not provided when creating an invoice, Square assigns a value. It increments from 1 and is padded with zeros making it 7 characters long (for example, 0000001 and 0000002).
    
    Returns:
    
    Returns the String
  - getTitle
```
public String getTitle()
```
    Getter for Title. The title of the invoice, which is displayed on the invoice.
    
    Returns:
    
    Returns the String
  - getDescription
```
public String getDescription()
```
    Getter for Description. The description of the invoice, which is displayed on the invoice.
    
    Returns:
    
    Returns the String
  - getScheduledAt
```
public String getScheduledAt()
```
    Getter for ScheduledAt. The timestamp when the invoice is scheduled for processing, in RFC 3339 format. After the invoice is published, Square processes the invoice on the specified date, according to the delivery method and payment request settings. If the field is not set, Square processes the invoice immediately after it is published.
    
    Returns:
    
    Returns the String
  - getPublicUrl
```
public String getPublicUrl()
```
    Getter for PublicUrl. The URL of the Square-hosted invoice page. After you publish the invoice using the `PublishInvoice` endpoint, Square hosts the invoice page and returns the page URL in the response.
    
    Returns:
    
    Returns the String
  - getNextPaymentAmountMoney
```
public Money getNextPaymentAmountMoney()
```
    Getter for NextPaymentAmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getStatus
```
public String getStatus()
```
    Getter for Status. Indicates the status of an invoice.
    
    Returns:
    
    Returns the String
  - getTimezone
```
public String getTimezone()
```
    Getter for Timezone. The time zone used to interpret calendar dates on the invoice, such as `due_date`. When an invoice is created, this field is set to the `timezone` specified for the seller location. The value cannot be changed. For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\_Angeles becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
    
    Returns:
    
    Returns the String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The timestamp when the invoice was created, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The timestamp when the invoice was last updated, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - getAcceptedPaymentMethods
```
public InvoiceAcceptedPaymentMethods getAcceptedPaymentMethods()
```
    Getter for AcceptedPaymentMethods. The payment methods that customers can use to pay an invoice on the Square-hosted invoice page.
    
    Returns:
    
    Returns the InvoiceAcceptedPaymentMethods
  - getCustomFields
```
public List<InvoiceCustomField> getCustomFields()
```
    Getter for CustomFields. Additional seller-defined fields that are displayed on the invoice. For more information, see [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). Adding custom fields to an invoice requires an [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). Max: 2 custom fields
    
    Returns:
    
    Returns the List of InvoiceCustomField
  - getSubscriptionId
```
public String getSubscriptionId()
```
    Getter for SubscriptionId. The ID of the [subscription]($m/Subscription) associated with the invoice. This field is present only on subscription billing invoices.
    
    Returns:
    
    Returns the String
  - getSaleOrServiceDate
```
public String getSaleOrServiceDate()
```
    Getter for SaleOrServiceDate. The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format. This field can be used to specify a past or future date which is displayed on the invoice.
    
    Returns:
    
    Returns the String
  - getPaymentConditions
```
public String getPaymentConditions()
```
    Getter for PaymentConditions. **France only.** The payment terms and conditions that are displayed on the invoice. For more information, see [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions). For countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and "Payment conditions are not supported for this location's country" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.
    
    Returns:
    
    Returns the 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 Invoice into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Invoice.Builder toBuilder()
```
    Builds a new Invoice.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Invoice.Builder object

Class Invoice

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Invoice

Method Detail

getId

getVersion

getLocationId

getOrderId

getPrimaryRecipient

getPaymentRequests

getDeliveryMethod

getInvoiceNumber

getTitle

getDescription

getScheduledAt

getPublicUrl

getNextPaymentAmountMoney

getStatus

getTimezone

getCreatedAt

getUpdatedAt

getAcceptedPaymentMethods

getCustomFields

getSubscriptionId

getSaleOrServiceDate

getPaymentConditions

hashCode

equals

toString

toBuilder