java.lang.Object
- com.adyen.model.tapi.SaleData

```
public class SaleData
extends Object
```
Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SaleData.CustomerOrderReqEnum
Gets or Sets customerOrderReq

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_CUSTOMER_ORDER_I_D`
`static String`	`JSON_PROPERTY_CUSTOMER_ORDER_REQ`
`static String`	`JSON_PROPERTY_OPERATOR_I_D`
`static String`	`JSON_PROPERTY_OPERATOR_LANGUAGE`
`static String`	`JSON_PROPERTY_SALE_REFERENCE_I_D`
`static String`	`JSON_PROPERTY_SALE_TERMINAL_DATA`
`static String`	`JSON_PROPERTY_SALE_TO_ACQUIRER_DATA`
`static String`	`JSON_PROPERTY_SALE_TO_ISSUER_DATA`
`static String`	`JSON_PROPERTY_SALE_TO_P_O_I_DATA`
`static String`	`JSON_PROPERTY_SALE_TRANSACTION_I_D`
`static String`	`JSON_PROPERTY_SHIFT_NUMBER`
`static String`	`JSON_PROPERTY_TOKEN_REQUESTED_TYPE`

Constructor Summary

Constructors
Constructor Description

SaleData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SaleData`	`addCustomerOrderReqItem(SaleData.CustomerOrderReqEnum customerOrderReqItem)`
`SaleData`	`customerOrderID(String customerOrderID)`	Additional and optional identification of a customer order.
`SaleData`	`customerOrderReq(List<SaleData.CustomerOrderReqEnum> customerOrderReq)`	List of customer order open, closed or both to be sent in the response messages.
`boolean`	`equals(Object o)`	Return true if this SaleData object is equal to o.
`static SaleData`	`fromJson(String jsonString)`	Create an instance of SaleData given an JSON string
`String`	`getCustomerOrderID()`	Additional and optional identification of a customer order.
`List<SaleData.CustomerOrderReqEnum>`	`getCustomerOrderReq()`	List of customer order open, closed or both to be sent in the response messages.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getOperatorID()`	Identification of the Cashier or Operator.
`String`	`getOperatorLanguage()`	Language of the Cashier or Operator.
`String`	`getSaleReferenceID()`	Identification of a Sale global transaction for a sequence of related POI transactions.
`SaleTerminalData`	`getSaleTerminalData()`	Get saleTerminalData
`String`	`getSaleToAcquirerData()`	Sale information intended for the Acquirer.
`SaleToIssuerData`	`getSaleToIssuerData()`	Get saleToIssuerData
`String`	`getSaleToPOIData()`	Sale information intended for the POI.
`TransactionIDType`	`getSaleTransactionID()`	Get saleTransactionID
`String`	`getShiftNumber()`	Shift number.
`TokenRequestedType`	`getTokenRequestedType()`	Get tokenRequestedType
`int`	`hashCode()`
`SaleData`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`SaleData`	`operatorID(String operatorID)`	Identification of the Cashier or Operator.
`SaleData`	`operatorLanguage(String operatorLanguage)`	Language of the Cashier or Operator.
`SaleData`	`saleReferenceID(String saleReferenceID)`	Identification of a Sale global transaction for a sequence of related POI transactions.
`SaleData`	`saleTerminalData(SaleTerminalData saleTerminalData)`	saleTerminalData
`SaleData`	`saleToAcquirerData(String saleToAcquirerData)`	Sale information intended for the Acquirer.
`SaleData`	`saleToIssuerData(SaleToIssuerData saleToIssuerData)`	saleToIssuerData
`SaleData`	`saleToPOIData(String saleToPOIData)`	Sale information intended for the POI.
`SaleData`	`saleTransactionID(TransactionIDType saleTransactionID)`	saleTransactionID
`void`	`setCustomerOrderID(String customerOrderID)`	Additional and optional identification of a customer order.
`void`	`setCustomerOrderReq(List<SaleData.CustomerOrderReqEnum> customerOrderReq)`	List of customer order open, closed or both to be sent in the response messages.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setOperatorID(String operatorID)`	Identification of the Cashier or Operator.
`void`	`setOperatorLanguage(String operatorLanguage)`	Language of the Cashier or Operator.
`void`	`setSaleReferenceID(String saleReferenceID)`	Identification of a Sale global transaction for a sequence of related POI transactions.
`void`	`setSaleTerminalData(SaleTerminalData saleTerminalData)`	saleTerminalData
`void`	`setSaleToAcquirerData(String saleToAcquirerData)`	Sale information intended for the Acquirer.
`void`	`setSaleToIssuerData(SaleToIssuerData saleToIssuerData)`	saleToIssuerData
`void`	`setSaleToPOIData(String saleToPOIData)`	Sale information intended for the POI.
`void`	`setSaleTransactionID(TransactionIDType saleTransactionID)`	saleTransactionID
`void`	`setShiftNumber(String shiftNumber)`	Shift number.
`void`	`setTokenRequestedType(TokenRequestedType tokenRequestedType)`	tokenRequestedType
`SaleData`	`shiftNumber(String shiftNumber)`	Shift number.
`String`	`toJson()`	Convert an instance of SaleData to an JSON string
`SaleData`	`tokenRequestedType(TokenRequestedType tokenRequestedType)`	tokenRequestedType
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_OPERATOR_I_D
```
public static final String JSON_PROPERTY_OPERATOR_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OPERATOR_LANGUAGE
```
public static final String JSON_PROPERTY_OPERATOR_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHIFT_NUMBER
```
public static final String JSON_PROPERTY_SHIFT_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_TRANSACTION_I_D
```
public static final String JSON_PROPERTY_SALE_TRANSACTION_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_REFERENCE_I_D
```
public static final String JSON_PROPERTY_SALE_REFERENCE_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_TERMINAL_DATA
```
public static final String JSON_PROPERTY_SALE_TERMINAL_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOKEN_REQUESTED_TYPE
```
public static final String JSON_PROPERTY_TOKEN_REQUESTED_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CUSTOMER_ORDER_I_D
```
public static final String JSON_PROPERTY_CUSTOMER_ORDER_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CUSTOMER_ORDER_REQ
```
public static final String JSON_PROPERTY_CUSTOMER_ORDER_REQ
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_TO_P_O_I_DATA
```
public static final String JSON_PROPERTY_SALE_TO_P_O_I_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_TO_ACQUIRER_DATA
```
public static final String JSON_PROPERTY_SALE_TO_ACQUIRER_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_TO_ISSUER_DATA
```
public static final String JSON_PROPERTY_SALE_TO_ISSUER_DATA
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SaleData
```
public SaleData()
```
- Method Detail
  - operatorID
```
public SaleData operatorID(String operatorID)
```
    Identification of the Cashier or Operator.
    
    Parameters:
    
    operatorID - Identification of the Cashier or Operator.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getOperatorID
```
public String getOperatorID()
```
    Identification of the Cashier or Operator.
    
    Returns:
    
    operatorID Identification of the Cashier or Operator.
  - setOperatorID
```
public void setOperatorID(String operatorID)
```
    Identification of the Cashier or Operator.
    
    Parameters:
    
    operatorID - Identification of the Cashier or Operator.
  - operatorLanguage
```
public SaleData operatorLanguage(String operatorLanguage)
```
    Language of the Cashier or Operator. If different from the Login.
    
    Parameters:
    
    operatorLanguage - Language of the Cashier or Operator. If different from the Login.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getOperatorLanguage
```
public String getOperatorLanguage()
```
    Language of the Cashier or Operator. If different from the Login.
    
    Returns:
    
    operatorLanguage Language of the Cashier or Operator. If different from the Login.
  - setOperatorLanguage
```
public void setOperatorLanguage(String operatorLanguage)
```
    Language of the Cashier or Operator. If different from the Login.
    
    Parameters:
    
    operatorLanguage - Language of the Cashier or Operator. If different from the Login.
  - shiftNumber
```
public SaleData shiftNumber(String shiftNumber)
```
    Shift number. If different from the Login, see Login SaleData.
    
    Parameters:
    
    shiftNumber - Shift number. If different from the Login, see Login SaleData.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getShiftNumber
```
public String getShiftNumber()
```
    Shift number. If different from the Login, see Login SaleData.
    
    Returns:
    
    shiftNumber Shift number. If different from the Login, see Login SaleData.
  - setShiftNumber
```
public void setShiftNumber(String shiftNumber)
```
    Shift number. If different from the Login, see Login SaleData.
    
    Parameters:
    
    shiftNumber - Shift number. If different from the Login, see Login SaleData.
  - saleTransactionID
```
public SaleData saleTransactionID(TransactionIDType saleTransactionID)
```
    saleTransactionID
    
    Parameters:
    
    saleTransactionID -
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getSaleTransactionID
```
public TransactionIDType getSaleTransactionID()
```
    Get saleTransactionID
    
    Returns:
    
    saleTransactionID
  - setSaleTransactionID
```
public void setSaleTransactionID(TransactionIDType saleTransactionID)
```
    saleTransactionID
    
    Parameters:
    
    saleTransactionID -
  - saleReferenceID
```
public SaleData saleReferenceID(String saleReferenceID)
```
    Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
    
    Parameters:
    
    saleReferenceID - Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getSaleReferenceID
```
public String getSaleReferenceID()
```
    Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
    
    Returns:
    
    saleReferenceID Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
  - setSaleReferenceID
```
public void setSaleReferenceID(String saleReferenceID)
```
    Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
    
    Parameters:
    
    saleReferenceID - Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
  - saleTerminalData
```
public SaleData saleTerminalData(SaleTerminalData saleTerminalData)
```
    saleTerminalData
    
    Parameters:
    
    saleTerminalData -
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getSaleTerminalData
```
public SaleTerminalData getSaleTerminalData()
```
    Get saleTerminalData
    
    Returns:
    
    saleTerminalData
  - setSaleTerminalData
```
public void setSaleTerminalData(SaleTerminalData saleTerminalData)
```
    saleTerminalData
    
    Parameters:
    
    saleTerminalData -
  - tokenRequestedType
```
public SaleData tokenRequestedType(TokenRequestedType tokenRequestedType)
```
    tokenRequestedType
    
    Parameters:
    
    tokenRequestedType -
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getTokenRequestedType
```
public TokenRequestedType getTokenRequestedType()
```
    Get tokenRequestedType
    
    Returns:
    
    tokenRequestedType
  - setTokenRequestedType
```
public void setTokenRequestedType(TokenRequestedType tokenRequestedType)
```
    tokenRequestedType
    
    Parameters:
    
    tokenRequestedType -
  - customerOrderID
```
public SaleData customerOrderID(String customerOrderID)
```
    Additional and optional identification of a customer order.
    
    Parameters:
    
    customerOrderID - Additional and optional identification of a customer order.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getCustomerOrderID
```
public String getCustomerOrderID()
```
    Additional and optional identification of a customer order.
    
    Returns:
    
    customerOrderID Additional and optional identification of a customer order.
  - setCustomerOrderID
```
public void setCustomerOrderID(String customerOrderID)
```
    Additional and optional identification of a customer order.
    
    Parameters:
    
    customerOrderID - Additional and optional identification of a customer order.
  - customerOrderReq
```
public SaleData customerOrderReq(List<SaleData.CustomerOrderReqEnum> customerOrderReq)
```
    List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
    
    Parameters:
    
    customerOrderReq - List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - addCustomerOrderReqItem
```
public SaleData addCustomerOrderReqItem(SaleData.CustomerOrderReqEnum customerOrderReqItem)
```
  - getCustomerOrderReq
```
public List<SaleData.CustomerOrderReqEnum> getCustomerOrderReq()
```
    List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
    
    Returns:
    
    customerOrderReq List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
  - setCustomerOrderReq
```
public void setCustomerOrderReq(List<SaleData.CustomerOrderReqEnum> customerOrderReq)
```
    List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
    
    Parameters:
    
    customerOrderReq - List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
  - saleToPOIData
```
public SaleData saleToPOIData(String saleToPOIData)
```
    Sale information intended for the POI. Stored with the transaction.
    
    Parameters:
    
    saleToPOIData - Sale information intended for the POI. Stored with the transaction.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getSaleToPOIData
```
public String getSaleToPOIData()
```
    Sale information intended for the POI. Stored with the transaction.
    
    Returns:
    
    saleToPOIData Sale information intended for the POI. Stored with the transaction.
  - setSaleToPOIData
```
public void setSaleToPOIData(String saleToPOIData)
```
    Sale information intended for the POI. Stored with the transaction.
    
    Parameters:
    
    saleToPOIData - Sale information intended for the POI. Stored with the transaction.
  - saleToAcquirerData
```
public SaleData saleToAcquirerData(String saleToAcquirerData)
```
    Sale information intended for the Acquirer. Send to the Acquirer if present.
    
    Parameters:
    
    saleToAcquirerData - Sale information intended for the Acquirer. Send to the Acquirer if present.
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getSaleToAcquirerData
```
public String getSaleToAcquirerData()
```
    Sale information intended for the Acquirer. Send to the Acquirer if present.
    
    Returns:
    
    saleToAcquirerData Sale information intended for the Acquirer. Send to the Acquirer if present.
  - setSaleToAcquirerData
```
public void setSaleToAcquirerData(String saleToAcquirerData)
```
    Sale information intended for the Acquirer. Send to the Acquirer if present.
    
    Parameters:
    
    saleToAcquirerData - Sale information intended for the Acquirer. Send to the Acquirer if present.
  - saleToIssuerData
```
public SaleData saleToIssuerData(SaleToIssuerData saleToIssuerData)
```
    saleToIssuerData
    
    Parameters:
    
    saleToIssuerData -
    
    Returns:
    
    the current SaleData instance, allowing for method chaining
  - getSaleToIssuerData
```
public SaleToIssuerData getSaleToIssuerData()
```
    Get saleToIssuerData
    
    Returns:
    
    saleToIssuerData
  - setSaleToIssuerData
```
public void setSaleToIssuerData(SaleToIssuerData saleToIssuerData)
```
    saleToIssuerData
    
    Parameters:
    
    saleToIssuerData -
  - includeNullValues
```
public SaleData includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this SaleData object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static SaleData fromJson(String jsonString)
                         throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of SaleData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SaleData
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to SaleData
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of SaleData to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class SaleData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_OPERATOR_I_D

JSON_PROPERTY_OPERATOR_LANGUAGE

JSON_PROPERTY_SHIFT_NUMBER

JSON_PROPERTY_SALE_TRANSACTION_I_D

JSON_PROPERTY_SALE_REFERENCE_I_D

JSON_PROPERTY_SALE_TERMINAL_DATA

JSON_PROPERTY_TOKEN_REQUESTED_TYPE

JSON_PROPERTY_CUSTOMER_ORDER_I_D

JSON_PROPERTY_CUSTOMER_ORDER_REQ

JSON_PROPERTY_SALE_TO_P_O_I_DATA

JSON_PROPERTY_SALE_TO_ACQUIRER_DATA

JSON_PROPERTY_SALE_TO_ISSUER_DATA

Constructor Detail

SaleData

Method Detail

operatorID

getOperatorID

setOperatorID

operatorLanguage

getOperatorLanguage

setOperatorLanguage

shiftNumber

getShiftNumber

setShiftNumber

saleTransactionID

getSaleTransactionID

setSaleTransactionID

saleReferenceID

getSaleReferenceID

setSaleReferenceID

saleTerminalData

getSaleTerminalData

setSaleTerminalData

tokenRequestedType

getTokenRequestedType

setTokenRequestedType

customerOrderID

getCustomerOrderID

setCustomerOrderID

customerOrderReq

addCustomerOrderReqItem

getCustomerOrderReq

setCustomerOrderReq

saleToPOIData

getSaleToPOIData

setSaleToPOIData

saleToAcquirerData

getSaleToAcquirerData

setSaleToAcquirerData

saleToIssuerData

getSaleToIssuerData

setSaleToIssuerData

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson