com.squareup.square.models

Class OrderReturn

java.lang.Object

com.squareup.square.models.OrderReturn

public class OrderReturn
extends Object

This is a model class for OrderReturn type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OrderReturn(String uid, String sourceOrderId, List<OrderReturnLineItem> returnLineItems, List<OrderReturnServiceCharge> returnServiceCharges, List<OrderReturnTax> returnTaxes, List<OrderReturnDiscount> returnDiscounts, OrderRoundingAdjustment roundingAdjustment, OrderMoneyAmounts returnAmounts) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
OrderMoneyAmounts	getReturnAmounts() Getter for ReturnAmounts.
List<OrderReturnDiscount>	getReturnDiscounts() Getter for ReturnDiscounts.
List<OrderReturnLineItem>	getReturnLineItems() Getter for ReturnLineItems.
List<OrderReturnServiceCharge>	getReturnServiceCharges() Getter for ReturnServiceCharges.
List<OrderReturnTax>	getReturnTaxes() Getter for ReturnTaxes.
OrderRoundingAdjustment	getRoundingAdjustment() Getter for RoundingAdjustment.
String	getSourceOrderId() Getter for SourceOrderId.
String	getUid() Getter for Uid.
int	hashCode()
OrderReturn.Builder	toBuilder() Builds a new OrderReturn.Builder object.
String	toString() Converts this OrderReturn into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderReturn

public OrderReturn(String uid,
                   String sourceOrderId,
                   List<OrderReturnLineItem> returnLineItems,
                   List<OrderReturnServiceCharge> returnServiceCharges,
                   List<OrderReturnTax> returnTaxes,
                   List<OrderReturnDiscount> returnDiscounts,
                   OrderRoundingAdjustment roundingAdjustment,
                   OrderMoneyAmounts returnAmounts)

Initialization constructor.

Parameters:

uid - String value for uid.

sourceOrderId - String value for sourceOrderId.

returnLineItems - List of OrderReturnLineItem value for returnLineItems.

returnServiceCharges - List of OrderReturnServiceCharge value for returnServiceCharges.

returnTaxes - List of OrderReturnTax value for returnTaxes.

returnDiscounts - List of OrderReturnDiscount value for returnDiscounts.

roundingAdjustment - OrderRoundingAdjustment value for roundingAdjustment.

returnAmounts - OrderMoneyAmounts value for returnAmounts.

Method Detail

getUid

public String getUid()

Getter for Uid. A unique ID that identifies the return only within this order.

Returns:

Returns the String

getSourceOrderId

public String getSourceOrderId()

Getter for SourceOrderId. An order that contains the original sale of these return line items. This is unset for unlinked returns.

Returns:

Returns the String

getReturnLineItems

public List<OrderReturnLineItem> getReturnLineItems()

Getter for ReturnLineItems. A collection of line items that are being returned.

Returns:

Returns the List of OrderReturnLineItem

getReturnServiceCharges

public List<OrderReturnServiceCharge> getReturnServiceCharges()

Getter for ReturnServiceCharges. A collection of service charges that are being returned.

Returns:

Returns the List of OrderReturnServiceCharge

getReturnTaxes

public List<OrderReturnTax> getReturnTaxes()

Getter for ReturnTaxes. A collection of references to taxes being returned for an order, including the total applied tax amount to be returned. The taxes must reference a top-level tax ID from the source order.

Returns:

Returns the List of OrderReturnTax

getReturnDiscounts

public List<OrderReturnDiscount> getReturnDiscounts()

Getter for ReturnDiscounts. A collection of references to discounts being returned for an order, including the total applied discount amount to be returned. The discounts must reference a top-level discount ID from the source order.

Returns:

Returns the List of OrderReturnDiscount

getRoundingAdjustment

public OrderRoundingAdjustment getRoundingAdjustment()

Getter for RoundingAdjustment. A rounding adjustment of the money being returned. Commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physical denomination of the currency.

Returns:

Returns the OrderRoundingAdjustment

getReturnAmounts

public OrderMoneyAmounts getReturnAmounts()

Getter for ReturnAmounts. A collection of various money amounts.

Returns:

Returns the OrderMoneyAmounts

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 OrderReturn into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderReturn.Builder toBuilder()

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

Returns:

a new OrderReturn.Builder object