V1Order (Square 6.3.0.20200826 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
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.

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()`
`V1Order.Builder`	`toBuilder()` Builds a new `V1Order.Builder` object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, 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 -
    
    id -
    
    buyerEmail -
    
    recipientName -
    
    recipientPhoneNumber -
    
    state -
    
    shippingAddress -
    
    subtotalMoney -
    
    totalShippingMoney -
    
    totalTaxMoney -
    
    totalPriceMoney -
    
    totalDiscountMoney -
    
    createdAt -
    
    updatedAt -
    
    expiresAt -
    
    paymentId -
    
    buyerNote -
    
    completedNote -
    
    refundedNote -
    
    canceledNote -
    
    tender -
    
    orderHistory -
    
    promoCode -
    
    btcReceiveAddress -
    
    btcPriceSatoshi -
- Method Detail
  - getContext
```
public HttpContext getContext()
```
  - getErrors
```
public List<Error> getErrors()
```
    Getter for Errors. Any errors that occurred during the request.
  - getId
```
public String getId()
```
    Getter for Id. The order's unique identifier.
  - getBuyerEmail
```
public String getBuyerEmail()
```
    Getter for BuyerEmail. The email address of the order's buyer.
  - getRecipientName
```
public String getRecipientName()
```
    Getter for RecipientName. The name of the order's buyer.
  - getRecipientPhoneNumber
```
public String getRecipientPhoneNumber()
```
    Getter for RecipientPhoneNumber. The phone number to use for the order's delivery.
  - getState
```
public String getState()
```
    Getter for State.
  - getShippingAddress
```
public Address getShippingAddress()
```
    Getter for ShippingAddress. Represents a physical address.
  - getSubtotalMoney
```
public V1Money getSubtotalMoney()
```
    Getter for SubtotalMoney.
  - getTotalShippingMoney
```
public V1Money getTotalShippingMoney()
```
    Getter for TotalShippingMoney.
  - getTotalTaxMoney
```
public V1Money getTotalTaxMoney()
```
    Getter for TotalTaxMoney.
  - getTotalPriceMoney
```
public V1Money getTotalPriceMoney()
```
    Getter for TotalPriceMoney.
  - getTotalDiscountMoney
```
public V1Money getTotalDiscountMoney()
```
    Getter for TotalDiscountMoney.
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The time when the order was created, in ISO 8601 format.
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The time when the order was last modified, in ISO 8601 format.
  - getExpiresAt
```
public String getExpiresAt()
```
    Getter for ExpiresAt. The time when the order expires if no action is taken, in ISO 8601 format.
  - getPaymentId
```
public String getPaymentId()
```
    Getter for PaymentId. The unique identifier of the payment associated with the order.
  - getBuyerNote
```
public String getBuyerNote()
```
    Getter for BuyerNote. A note provided by the buyer when the order was created, if any.
  - getCompletedNote
```
public String getCompletedNote()
```
    Getter for CompletedNote. A note provided by the merchant when the order's state was set to COMPLETED, if any
  - getRefundedNote
```
public String getRefundedNote()
```
    Getter for RefundedNote. A note provided by the merchant when the order's state was set to REFUNDED, if any.
  - getCanceledNote
```
public String getCanceledNote()
```
    Getter for CanceledNote. A note provided by the merchant when the order's state was set to CANCELED, if any.
  - 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.
  - getOrderHistory
```
public List<V1OrderHistoryEntry> getOrderHistory()
```
    Getter for OrderHistory. The history of actions associated with the order.
  - getPromoCode
```
public String getPromoCode()
```
    Getter for PromoCode. The promo code provided by the buyer, if any.
  - getBtcReceiveAddress
```
public String getBtcReceiveAddress()
```
    Getter for BtcReceiveAddress. For Bitcoin transactions, the address that the buyer sent Bitcoin to.
  - 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).
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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

Method Detail

getContext

getErrors

getId

getBuyerEmail

getRecipientName

getRecipientPhoneNumber

getState

getShippingAddress

getSubtotalMoney

getTotalShippingMoney

getTotalTaxMoney

getTotalPriceMoney

getTotalDiscountMoney

getCreatedAt

getUpdatedAt

getExpiresAt

getPaymentId

getBuyerNote

getCompletedNote

getRefundedNote

getCanceledNote

getTender

getOrderHistory

getPromoCode

getBtcReceiveAddress

getBtcPriceSatoshi

hashCode

equals

toBuilder