V1Order (Square 37.0.0.20240118 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	V1Order(List<Error> errors, String id, String buyerEmail, String recipientName, String recipientPhoneNumber, String state, Address shippingAddress, V1Money subtotalMoney, V1Money totalShippingMoney, V1Money totalTaxMoney, V1Money totalPriceMoney, V1Money totalDiscountMoney, String createdAt, String updatedAt, String expiresAt, String paymentId, String buyerNote, String completedNote, String refundedNote, String canceledNote, V1Tender tender, List<V1OrderHistoryEntry> orderHistory, String promoCode, String btcReceiveAddress, Double btcPriceSatoshi) Initialization constructor.
`protected`	V1Order(io.apimatic.core.types.OptionalNullable<List<Error>> errors, String id, io.apimatic.core.types.OptionalNullable<String> buyerEmail, io.apimatic.core.types.OptionalNullable<String> recipientName, io.apimatic.core.types.OptionalNullable<String> recipientPhoneNumber, String state, Address shippingAddress, V1Money subtotalMoney, V1Money totalShippingMoney, V1Money totalTaxMoney, V1Money totalPriceMoney, V1Money totalDiscountMoney, String createdAt, String updatedAt, io.apimatic.core.types.OptionalNullable<String> expiresAt, io.apimatic.core.types.OptionalNullable<String> paymentId, io.apimatic.core.types.OptionalNullable<String> buyerNote, io.apimatic.core.types.OptionalNullable<String> completedNote, io.apimatic.core.types.OptionalNullable<String> refundedNote, io.apimatic.core.types.OptionalNullable<String> canceledNote, V1Tender tender, io.apimatic.core.types.OptionalNullable<List<V1OrderHistoryEntry>> orderHistory, io.apimatic.core.types.OptionalNullable<String> promoCode, io.apimatic.core.types.OptionalNullable<String> btcReceiveAddress, io.apimatic.core.types.OptionalNullable<Double> btcPriceSatoshi) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Double`	`getBtcPriceSatoshi()` Getter for BtcPriceSatoshi.
`String`	`getBtcReceiveAddress()` Getter for BtcReceiveAddress.
`String`	`getBuyerEmail()` Getter for BuyerEmail.
`String`	`getBuyerNote()` Getter for BuyerNote.
`String`	`getCanceledNote()` Getter for CanceledNote.
`String`	`getCompletedNote()` Getter for CompletedNote.
`HttpContext`	`getContext()`
`String`	`getCreatedAt()` Getter for CreatedAt.
`List<Error>`	`getErrors()` Getter for Errors.
`String`	`getExpiresAt()` Getter for ExpiresAt.
`String`	`getId()` Getter for Id.
`List<V1OrderHistoryEntry>`	`getOrderHistory()` Getter for OrderHistory.
`String`	`getPaymentId()` Getter for PaymentId.
`String`	`getPromoCode()` Getter for PromoCode.
`String`	`getRecipientName()` Getter for RecipientName.
`String`	`getRecipientPhoneNumber()` Getter for RecipientPhoneNumber.
`String`	`getRefundedNote()` Getter for RefundedNote.
`Address`	`getShippingAddress()` Getter for ShippingAddress.
`String`	`getState()` Getter for State.
`V1Money`	`getSubtotalMoney()` Getter for SubtotalMoney.
`V1Tender`	`getTender()` Getter for Tender.
`V1Money`	`getTotalDiscountMoney()` Getter for TotalDiscountMoney.
`V1Money`	`getTotalPriceMoney()` Getter for TotalPriceMoney.
`V1Money`	`getTotalShippingMoney()` Getter for TotalShippingMoney.
`V1Money`	`getTotalTaxMoney()` Getter for TotalTaxMoney.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<Double>`	`internalGetBtcPriceSatoshi()` Internal Getter for BtcPriceSatoshi.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetBtcReceiveAddress()` Internal Getter for BtcReceiveAddress.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetBuyerEmail()` Internal Getter for BuyerEmail.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetBuyerNote()` Internal Getter for BuyerNote.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCanceledNote()` Internal Getter for CanceledNote.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCompletedNote()` Internal Getter for CompletedNote.
`protected io.apimatic.core.types.OptionalNullable<List<Error>>`	`internalGetErrors()` Internal Getter for Errors.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetExpiresAt()` Internal Getter for ExpiresAt.
`protected io.apimatic.core.types.OptionalNullable<List<V1OrderHistoryEntry>>`	`internalGetOrderHistory()` Internal Getter for OrderHistory.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPaymentId()` Internal Getter for PaymentId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPromoCode()` Internal Getter for PromoCode.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetRecipientName()` Internal Getter for RecipientName.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetRecipientPhoneNumber()` Internal Getter for RecipientPhoneNumber.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetRefundedNote()` Internal Getter for RefundedNote.
`V1Order.Builder`	`toBuilder()` Builds a new `V1Order.Builder` object.
`String`	`toString()` Converts this V1Order into string format.

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

- Constructor Detail
  - V1Order
```
public V1Order(List<Error> errors,
               String id,
               String buyerEmail,
               String recipientName,
               String recipientPhoneNumber,
               String state,
               Address shippingAddress,
               V1Money subtotalMoney,
               V1Money totalShippingMoney,
               V1Money totalTaxMoney,
               V1Money totalPriceMoney,
               V1Money totalDiscountMoney,
               String createdAt,
               String updatedAt,
               String expiresAt,
               String paymentId,
               String buyerNote,
               String completedNote,
               String refundedNote,
               String canceledNote,
               V1Tender tender,
               List<V1OrderHistoryEntry> orderHistory,
               String promoCode,
               String btcReceiveAddress,
               Double btcPriceSatoshi)
```
    Initialization constructor.
    
    Parameters:
    
    errors - List of Error value for errors.
    
    id - String value for id.
    
    buyerEmail - String value for buyerEmail.
    
    recipientName - String value for recipientName.
    
    recipientPhoneNumber - String value for recipientPhoneNumber.
    
    state - String value for state.
    
    shippingAddress - Address value for shippingAddress.
    
    subtotalMoney - V1Money value for subtotalMoney.
    
    totalShippingMoney - V1Money value for totalShippingMoney.
    
    totalTaxMoney - V1Money value for totalTaxMoney.
    
    totalPriceMoney - V1Money value for totalPriceMoney.
    
    totalDiscountMoney - V1Money value for totalDiscountMoney.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    expiresAt - String value for expiresAt.
    
    paymentId - String value for paymentId.
    
    buyerNote - String value for buyerNote.
    
    completedNote - String value for completedNote.
    
    refundedNote - String value for refundedNote.
    
    canceledNote - String value for canceledNote.
    
    tender - V1Tender value for tender.
    
    orderHistory - List of V1OrderHistoryEntry value for orderHistory.
    
    promoCode - String value for promoCode.
    
    btcReceiveAddress - String value for btcReceiveAddress.
    
    btcPriceSatoshi - Double value for btcPriceSatoshi.
  - V1Order
```
protected V1Order(io.apimatic.core.types.OptionalNullable<List<Error>> errors,
                  String id,
                  io.apimatic.core.types.OptionalNullable<String> buyerEmail,
                  io.apimatic.core.types.OptionalNullable<String> recipientName,
                  io.apimatic.core.types.OptionalNullable<String> recipientPhoneNumber,
                  String state,
                  Address shippingAddress,
                  V1Money subtotalMoney,
                  V1Money totalShippingMoney,
                  V1Money totalTaxMoney,
                  V1Money totalPriceMoney,
                  V1Money totalDiscountMoney,
                  String createdAt,
                  String updatedAt,
                  io.apimatic.core.types.OptionalNullable<String> expiresAt,
                  io.apimatic.core.types.OptionalNullable<String> paymentId,
                  io.apimatic.core.types.OptionalNullable<String> buyerNote,
                  io.apimatic.core.types.OptionalNullable<String> completedNote,
                  io.apimatic.core.types.OptionalNullable<String> refundedNote,
                  io.apimatic.core.types.OptionalNullable<String> canceledNote,
                  V1Tender tender,
                  io.apimatic.core.types.OptionalNullable<List<V1OrderHistoryEntry>> orderHistory,
                  io.apimatic.core.types.OptionalNullable<String> promoCode,
                  io.apimatic.core.types.OptionalNullable<String> btcReceiveAddress,
                  io.apimatic.core.types.OptionalNullable<Double> btcPriceSatoshi)
```
    Initialization constructor.
    
    Parameters:
    
    errors - List of Error value for errors.
    
    id - String value for id.
    
    buyerEmail - String value for buyerEmail.
    
    recipientName - String value for recipientName.
    
    recipientPhoneNumber - String value for recipientPhoneNumber.
    
    state - String value for state.
    
    shippingAddress - Address value for shippingAddress.
    
    subtotalMoney - V1Money value for subtotalMoney.
    
    totalShippingMoney - V1Money value for totalShippingMoney.
    
    totalTaxMoney - V1Money value for totalTaxMoney.
    
    totalPriceMoney - V1Money value for totalPriceMoney.
    
    totalDiscountMoney - V1Money value for totalDiscountMoney.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    expiresAt - String value for expiresAt.
    
    paymentId - String value for paymentId.
    
    buyerNote - String value for buyerNote.
    
    completedNote - String value for completedNote.
    
    refundedNote - String value for refundedNote.
    
    canceledNote - String value for canceledNote.
    
    tender - V1Tender value for tender.
    
    orderHistory - List of V1OrderHistoryEntry value for orderHistory.
    
    promoCode - String value for promoCode.
    
    btcReceiveAddress - String value for btcReceiveAddress.
    
    btcPriceSatoshi - Double value for btcPriceSatoshi.
- Method Detail
  - getContext
```
public HttpContext getContext()
```
  - internalGetErrors
```
protected io.apimatic.core.types.OptionalNullable<List<Error>> internalGetErrors()
```
    Internal Getter for Errors. Any errors that occurred during the request.
    
    Returns:
    
    Returns the Internal List of Error
  - getErrors
```
public List<Error> getErrors()
```
    Getter for Errors. Any errors that occurred during the request.
    
    Returns:
    
    Returns the List of Error
  - getId
```
public String getId()
```
    Getter for Id. The order's unique identifier.
    
    Returns:
    
    Returns the String
  - internalGetBuyerEmail
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBuyerEmail()
```
    Internal Getter for BuyerEmail. The email address of the order's buyer.
    
    Returns:
    
    Returns the Internal String
  - getBuyerEmail
```
public String getBuyerEmail()
```
    Getter for BuyerEmail. The email address of the order's buyer.
    
    Returns:
    
    Returns the String
  - internalGetRecipientName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetRecipientName()
```
    Internal Getter for RecipientName. The name of the order's buyer.
    
    Returns:
    
    Returns the Internal String
  - getRecipientName
```
public String getRecipientName()
```
    Getter for RecipientName. The name of the order's buyer.
    
    Returns:
    
    Returns the String
  - internalGetRecipientPhoneNumber
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetRecipientPhoneNumber()
```
    Internal Getter for RecipientPhoneNumber. The phone number to use for the order's delivery.
    
    Returns:
    
    Returns the Internal String
  - getRecipientPhoneNumber
```
public String getRecipientPhoneNumber()
```
    Getter for RecipientPhoneNumber. The phone number to use for the order's delivery.
    
    Returns:
    
    Returns the String
  - getState
```
public String getState()
```
    Getter for State.
    
    Returns:
    
    Returns the String
  - getShippingAddress
```
public Address getShippingAddress()
```
    Getter for ShippingAddress. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the Address
  - getSubtotalMoney
```
public V1Money getSubtotalMoney()
```
    Getter for SubtotalMoney.
    
    Returns:
    
    Returns the V1Money
  - getTotalShippingMoney
```
public V1Money getTotalShippingMoney()
```
    Getter for TotalShippingMoney.
    
    Returns:
    
    Returns the V1Money
  - getTotalTaxMoney
```
public V1Money getTotalTaxMoney()
```
    Getter for TotalTaxMoney.
    
    Returns:
    
    Returns the V1Money
  - getTotalPriceMoney
```
public V1Money getTotalPriceMoney()
```
    Getter for TotalPriceMoney.
    
    Returns:
    
    Returns the V1Money
  - getTotalDiscountMoney
```
public V1Money getTotalDiscountMoney()
```
    Getter for TotalDiscountMoney.
    
    Returns:
    
    Returns the V1Money
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The time when the order was created, in ISO 8601 format.
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The time when the order was last modified, in ISO 8601 format.
    
    Returns:
    
    Returns the String
  - internalGetExpiresAt
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetExpiresAt()
```
    Internal Getter for ExpiresAt. The time when the order expires if no action is taken, in ISO 8601 format.
    
    Returns:
    
    Returns the Internal String
  - getExpiresAt
```
public String getExpiresAt()
```
    Getter for ExpiresAt. The time when the order expires if no action is taken, in ISO 8601 format.
    
    Returns:
    
    Returns the String
  - internalGetPaymentId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPaymentId()
```
    Internal Getter for PaymentId. The unique identifier of the payment associated with the order.
    
    Returns:
    
    Returns the Internal String
  - getPaymentId
```
public String getPaymentId()
```
    Getter for PaymentId. The unique identifier of the payment associated with the order.
    
    Returns:
    
    Returns the String
  - internalGetBuyerNote
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBuyerNote()
```
    Internal Getter for BuyerNote. A note provided by the buyer when the order was created, if any.
    
    Returns:
    
    Returns the Internal String
  - getBuyerNote
```
public String getBuyerNote()
```
    Getter for BuyerNote. A note provided by the buyer when the order was created, if any.
    
    Returns:
    
    Returns the String
  - internalGetCompletedNote
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCompletedNote()
```
    Internal Getter for CompletedNote. A note provided by the merchant when the order's state was set to COMPLETED, if any
    
    Returns:
    
    Returns the Internal String
  - getCompletedNote
```
public String getCompletedNote()
```
    Getter for CompletedNote. A note provided by the merchant when the order's state was set to COMPLETED, if any
    
    Returns:
    
    Returns the String
  - internalGetRefundedNote
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetRefundedNote()
```
    Internal Getter for RefundedNote. A note provided by the merchant when the order's state was set to REFUNDED, if any.
    
    Returns:
    
    Returns the Internal String
  - getRefundedNote
```
public String getRefundedNote()
```
    Getter for RefundedNote. A note provided by the merchant when the order's state was set to REFUNDED, if any.
    
    Returns:
    
    Returns the String
  - internalGetCanceledNote
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCanceledNote()
```
    Internal Getter for CanceledNote. A note provided by the merchant when the order's state was set to CANCELED, if any.
    
    Returns:
    
    Returns the Internal String
  - getCanceledNote
```
public String getCanceledNote()
```
    Getter for CanceledNote. A note provided by the merchant when the order's state was set to CANCELED, if any.
    
    Returns:
    
    Returns the String
  - getTender
```
public V1Tender getTender()
```
    Getter for Tender. A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment.
    
    Returns:
    
    Returns the V1Tender
  - internalGetOrderHistory
```
protected io.apimatic.core.types.OptionalNullable<List<V1OrderHistoryEntry>> internalGetOrderHistory()
```
    Internal Getter for OrderHistory. The history of actions associated with the order.
    
    Returns:
    
    Returns the Internal List of V1OrderHistoryEntry
  - getOrderHistory
```
public List<V1OrderHistoryEntry> getOrderHistory()
```
    Getter for OrderHistory. The history of actions associated with the order.
    
    Returns:
    
    Returns the List of V1OrderHistoryEntry
  - internalGetPromoCode
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPromoCode()
```
    Internal Getter for PromoCode. The promo code provided by the buyer, if any.
    
    Returns:
    
    Returns the Internal String
  - getPromoCode
```
public String getPromoCode()
```
    Getter for PromoCode. The promo code provided by the buyer, if any.
    
    Returns:
    
    Returns the String
  - internalGetBtcReceiveAddress
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBtcReceiveAddress()
```
    Internal Getter for BtcReceiveAddress. For Bitcoin transactions, the address that the buyer sent Bitcoin to.
    
    Returns:
    
    Returns the Internal String
  - getBtcReceiveAddress
```
public String getBtcReceiveAddress()
```
    Getter for BtcReceiveAddress. For Bitcoin transactions, the address that the buyer sent Bitcoin to.
    
    Returns:
    
    Returns the String
  - internalGetBtcPriceSatoshi
```
protected io.apimatic.core.types.OptionalNullable<Double> internalGetBtcPriceSatoshi()
```
    Internal Getter for BtcPriceSatoshi. For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).
    
    Returns:
    
    Returns the Internal Double
  - getBtcPriceSatoshi
```
public Double getBtcPriceSatoshi()
```
    Getter for BtcPriceSatoshi. For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).
    
    Returns:
    
    Returns the Double
  - 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 V1Order into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public V1Order.Builder toBuilder()
```
    Builds a new V1Order.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new V1Order.Builder object

Class V1Order

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

V1Order

V1Order

Method Detail

getContext

internalGetErrors

getErrors

getId

internalGetBuyerEmail

getBuyerEmail

internalGetRecipientName

getRecipientName

internalGetRecipientPhoneNumber

getRecipientPhoneNumber

getState

getShippingAddress

getSubtotalMoney

getTotalShippingMoney

getTotalTaxMoney

getTotalPriceMoney

getTotalDiscountMoney

getCreatedAt

getUpdatedAt

internalGetExpiresAt

getExpiresAt

internalGetPaymentId

getPaymentId

internalGetBuyerNote

getBuyerNote

internalGetCompletedNote

getCompletedNote

internalGetRefundedNote

getRefundedNote

internalGetCanceledNote

getCanceledNote

getTender

internalGetOrderHistory

getOrderHistory

internalGetPromoCode

getPromoCode

internalGetBtcReceiveAddress

getBtcReceiveAddress

internalGetBtcPriceSatoshi

getBtcPriceSatoshi

hashCode

equals

toString

toBuilder