CustomerReturn (SAP Cloud SDK - Parent POM 3.22.0 API)

java.lang.Object
- com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
- - com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<CustomerReturn>
  - - com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerreturn.CustomerReturn

```
public class CustomerReturn
extends VdmEntity<CustomerReturn>
```
Customer Return (API)

Original entity name from the Odata EDM: A_CustomerReturnType

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CustomerReturn.CustomerReturnBuilder
Helper class to allow for fluent creation of CustomerReturn instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CustomerReturn.CustomerReturnBuilder` Helper class to allow for fluent creation of CustomerReturn instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static CustomerReturnSelectable`	`ALL_FIELDS` Selector for all available fields of CustomerReturn.
`static CustomerReturnField<String>`	`CREATED_BY_USER` Use with available fluent helpers to apply the CreatedByUser field to query operations.
`static CustomerReturnField<LocalDateTime>`	`CREATION_DATE` Use with available fluent helpers to apply the CreationDate field to query operations.
`static CustomerReturnField<String>`	`CUSTOMER_PAYMENT_TERMS` Use with available fluent helpers to apply the CustomerPaymentTerms field to query operations.
`static CustomerReturnField<LocalDateTime>`	`CUSTOMER_PURCHASE_ORDER_DATE` Use with available fluent helpers to apply the CustomerPurchaseOrderDate field to query operations.
`static CustomerReturnField<String>`	`CUSTOMER_PURCHASE_ORDER_TYPE` Use with available fluent helpers to apply the CustomerPurchaseOrderType field to query operations.
`static CustomerReturnField<String>`	`CUSTOMER_RETURN` Use with available fluent helpers to apply the CustomerReturn field to query operations.
`static CustomerReturnField<LocalDateTime>`	`CUSTOMER_RETURN_DATE` Use with available fluent helpers to apply the CustomerReturnDate field to query operations.
`static CustomerReturnField<String>`	`CUSTOMER_RETURN_TYPE` Use with available fluent helpers to apply the CustomerReturnType field to query operations.
`static CustomerReturnField<String>`	`DELIVERY_BLOCK_REASON` Use with available fluent helpers to apply the DeliveryBlockReason field to query operations.
`static CustomerReturnField<String>`	`DISTRIBUTION_CHANNEL` Use with available fluent helpers to apply the DistributionChannel field to query operations.
`static CustomerReturnField<String>`	`HEADER_BILLING_BLOCK_REASON` Use with available fluent helpers to apply the HeaderBillingBlockReason field to query operations.
`static CustomerReturnField<String>`	`INCOTERMS_CLASSIFICATION` Use with available fluent helpers to apply the IncotermsClassification field to query operations.
`static CustomerReturnField<String>`	`INCOTERMS_LOCATION1` Use with available fluent helpers to apply the IncotermsLocation1 field to query operations.
`static CustomerReturnField<String>`	`INCOTERMS_LOCATION2` Use with available fluent helpers to apply the IncotermsLocation2 field to query operations.
`static CustomerReturnField<String>`	`INCOTERMS_TRANSFER_LOCATION` Use with available fluent helpers to apply the IncotermsTransferLocation field to query operations.
`static CustomerReturnField<String>`	`INCOTERMS_VERSION` Use with available fluent helpers to apply the IncotermsVersion field to query operations.
`static CustomerReturnField<LocalDateTime>`	`LAST_CHANGE_DATE` Use with available fluent helpers to apply the LastChangeDate field to query operations.
`static CustomerReturnField<ZonedDateTime>`	`LAST_CHANGE_DATE_TIME` Use with available fluent helpers to apply the LastChangeDateTime field to query operations.
`static CustomerReturnField<String>`	`ORGANIZATION_DIVISION` Use with available fluent helpers to apply the OrganizationDivision field to query operations.
`static CustomerReturnField<String>`	`OVERALL_SD_DOCUMENT_REJECTION_STS` Use with available fluent helpers to apply the OverallSDDocumentRejectionSts field to query operations.
`static CustomerReturnField<String>`	`OVERALL_SD_PROCESS_STATUS` Use with available fluent helpers to apply the OverallSDProcessStatus field to query operations.
`static CustomerReturnField<String>`	`PAYMENT_METHOD` Use with available fluent helpers to apply the PaymentMethod field to query operations.
`static CustomerReturnField<LocalDateTime>`	`PRICING_DATE` Use with available fluent helpers to apply the PricingDate field to query operations.
`static CustomerReturnField<String>`	`PURCHASE_ORDER_BY_CUSTOMER` Use with available fluent helpers to apply the PurchaseOrderByCustomer field to query operations.
`static CustomerReturnField<String>`	`REFERENCE_SD_DOCUMENT` Use with available fluent helpers to apply the ReferenceSDDocument field to query operations.
`static CustomerReturnField<String>`	`REFERENCE_SD_DOCUMENT_CATEGORY` Use with available fluent helpers to apply the ReferenceSDDocumentCategory field to query operations.
`static CustomerReturnField<LocalDateTime>`	`REQUESTED_DELIVERY_DATE` Use with available fluent helpers to apply the RequestedDeliveryDate field to query operations.
`static CustomerReturnField<String>`	`RETS_MGMT_COMPN_PROCG_STATUS` Use with available fluent helpers to apply the RetsMgmtCompnProcgStatus field to query operations.
`static CustomerReturnField<String>`	`RETS_MGMT_LOG_PROCG_STATUS` Use with available fluent helpers to apply the RetsMgmtLogProcgStatus field to query operations.
`static CustomerReturnField<String>`	`RETS_MGMT_PROCESS` Use with available fluent helpers to apply the RetsMgmtProcess field to query operations.
`static CustomerReturnField<String>`	`RETS_MGMT_PROCESSING_STATUS` Use with available fluent helpers to apply the RetsMgmtProcessingStatus field to query operations.
`static CustomerReturnField<String>`	`SALES_DISTRICT` Use with available fluent helpers to apply the SalesDistrict field to query operations.
`static CustomerReturnField<String>`	`SALES_GROUP` Use with available fluent helpers to apply the SalesGroup field to query operations.
`static CustomerReturnField<String>`	`SALES_OFFICE` Use with available fluent helpers to apply the SalesOffice field to query operations.
`static CustomerReturnField<String>`	`SALES_ORGANIZATION` Use with available fluent helpers to apply the SalesOrganization field to query operations.
`static CustomerReturnField<String>`	`SD_DOCUMENT_REASON` Use with available fluent helpers to apply the SDDocumentReason field to query operations.
`static CustomerReturnField<String>`	`SOLD_TO_PARTY` Use with available fluent helpers to apply the SoldToParty field to query operations.
`static CustomerReturnLink<CustomerReturnItem>`	`TO_ITEM` Use with available fluent helpers to apply the to_Item navigation property to query operations.
`static CustomerReturnLink<CustomerReturnPartner>`	`TO_PARTNER` Use with available fluent helpers to apply the to_Partner navigation property to query operations.
`static CustomerReturnLink<CustomerReturnPrcgElmnt>`	`TO_PRICING_ELEMENT` Use with available fluent helpers to apply the to_PricingElement navigation property to query operations.
`static CustomerReturnField<String>`	`TOTAL_CREDIT_CHECK_STATUS` Use with available fluent helpers to apply the TotalCreditCheckStatus field to query operations.
`static CustomerReturnField<BigDecimal>`	`TOTAL_NET_AMOUNT` Use with available fluent helpers to apply the TotalNetAmount field to query operations.
`static CustomerReturnField<String>`	`TRANSACTION_CURRENCY` Use with available fluent helpers to apply the TransactionCurrency field to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject
changedOriginalFields

Constructor Summary

Constructors
Constructor and Description
`CustomerReturn()`
CustomerReturn(String customerReturn, String customerReturnType, String salesOrganization, String distributionChannel, String organizationDivision, String salesGroup, String salesOffice, String salesDistrict, String soldToParty, LocalDateTime creationDate, String createdByUser, LocalDateTime lastChangeDate, ZonedDateTime lastChangeDateTime, String purchaseOrderByCustomer, String customerPurchaseOrderType, LocalDateTime customerPurchaseOrderDate, LocalDateTime customerReturnDate, BigDecimal totalNetAmount, String transactionCurrency, String sDDocumentReason, LocalDateTime pricingDate, LocalDateTime requestedDeliveryDate, String headerBillingBlockReason, String deliveryBlockReason, String incotermsClassification, String incotermsTransferLocation, String incotermsLocation1, String incotermsLocation2, String incotermsVersion, String customerPaymentTerms, String paymentMethod, String retsMgmtProcess, String referenceSDDocument, String referenceSDDocumentCategory, String retsMgmtLogProcgStatus, String retsMgmtCompnProcgStatus, String retsMgmtProcessingStatus, String overallSDProcessStatus, String totalCreditCheckStatus, String overallSDDocumentRejectionSts, List<CustomerReturnItem> toItem, List<CustomerReturnPartner> toPartner, List<CustomerReturnPrcgElmnt> toPricingElement)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addItem(CustomerReturnItem... entity)` Adds elements to the list of associated CustomerReturnItem entities.
`void`	`addPartner(CustomerReturnPartner... entity)` Adds elements to the list of associated CustomerReturnPartner entities.
`void`	`addPricingElement(CustomerReturnPrcgElmnt... entity)` Adds elements to the list of associated CustomerReturnPrcgElmnt entities.
`void`	`attachToService(String servicePath, HttpDestinationProperties destination)` Sets the service path and destination for the fetch commands of this entity.
`static CustomerReturn.CustomerReturnBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`List<CustomerReturnItem>`	`fetchItem()` Fetches the CustomerReturnItem entities (one to many) associated with this entity.
`List<CustomerReturnPartner>`	`fetchPartner()` Fetches the CustomerReturnPartner entities (one to many) associated with this entity.
`List<CustomerReturnPrcgElmnt>`	`fetchPricingElement()` Fetches the CustomerReturnPrcgElmnt entities (one to many) associated with this entity.
`static <T> CustomerReturnField<T>`	`field(String fieldName, Class<T> fieldType)` Use with available fluent helpers to apply an extension field to query operations.
`static <T,DomainT> CustomerReturnField<T>`	`field(String fieldName, TypeConverter<T,DomainT> typeConverter)` Use with available fluent helpers to apply an extension field to query operations.
`protected void`	`fromMap(Map<String,Object> inputValues)`
`String`	`getCreatedByUser()` Constraints: Not nullable, Maximum length: 12
`LocalDateTime`	`getCreationDate()` Constraints: Not nullable, Precision: 0
`String`	`getCustomerPaymentTerms()` Constraints: Not nullable, Maximum length: 4
`LocalDateTime`	`getCustomerPurchaseOrderDate()` Constraints: Not nullable, Precision: 0
`String`	`getCustomerPurchaseOrderType()` Constraints: Not nullable, Maximum length: 4
`String`	`getCustomerReturn()` (Key Field) Constraints: Not nullable, Maximum length: 10
`LocalDateTime`	`getCustomerReturnDate()` Constraints: Not nullable, Precision: 0
`String`	`getCustomerReturnType()` Constraints: Not nullable, Maximum length: 4
`protected String`	`getDefaultServicePath()` Used by fluent helpers and navigation property methods to construct OData queries.
`String`	`getDeliveryBlockReason()` Constraints: Not nullable, Maximum length: 2
`HttpDestinationProperties`	`getDestinationForFetch()` Convienence field for reusing the same destination with multiple queries (e.g.
`String`	`getDistributionChannel()` Constraints: Not nullable, Maximum length: 2
`protected String`	`getEntityCollection()` Used by fluent helpers and navigation property methods to construct OData queries.
`String`	`getHeaderBillingBlockReason()` Constraints: Not nullable, Maximum length: 2
`String`	`getIncotermsClassification()` Constraints: Not nullable, Maximum length: 3
`String`	`getIncotermsLocation1()` Constraints: Not nullable, Maximum length: 70
`String`	`getIncotermsLocation2()` Constraints: Not nullable, Maximum length: 70
`String`	`getIncotermsTransferLocation()` Constraints: Not nullable, Maximum length: 28
`String`	`getIncotermsVersion()` Constraints: Not nullable, Maximum length: 4
`io.vavr.control.Option<List<CustomerReturnItem>>`	`getItemIfPresent()` Retrieval of associated CustomerReturnItem entities (one to many).
`List<CustomerReturnItem>`	`getItemOrFetch()` Retrieval of associated CustomerReturnItem entities (one to many).
`protected Map<String,Object>`	`getKey()`
`LocalDateTime`	`getLastChangeDate()` Constraints: Not nullable, Precision: 0
`ZonedDateTime`	`getLastChangeDateTime()` Constraints: Not nullable, Precision: 7
`String`	`getOrganizationDivision()` Constraints: Not nullable, Maximum length: 2
`String`	`getOverallSDDocumentRejectionSts()` Constraints: Not nullable, Maximum length: 1
`String`	`getOverallSDProcessStatus()` Constraints: Not nullable, Maximum length: 1
`io.vavr.control.Option<List<CustomerReturnPartner>>`	`getPartnerIfPresent()` Retrieval of associated CustomerReturnPartner entities (one to many).
`List<CustomerReturnPartner>`	`getPartnerOrFetch()` Retrieval of associated CustomerReturnPartner entities (one to many).
`String`	`getPaymentMethod()` Constraints: Not nullable, Maximum length: 1
`LocalDateTime`	`getPricingDate()` Constraints: Not nullable, Precision: 0
`io.vavr.control.Option<List<CustomerReturnPrcgElmnt>>`	`getPricingElementIfPresent()` Retrieval of associated CustomerReturnPrcgElmnt entities (one to many).
`List<CustomerReturnPrcgElmnt>`	`getPricingElementOrFetch()` Retrieval of associated CustomerReturnPrcgElmnt entities (one to many).
`String`	`getPurchaseOrderByCustomer()` Constraints: Not nullable, Maximum length: 35
`String`	`getReferenceSDDocument()` Constraints: Not nullable, Maximum length: 10
`String`	`getReferenceSDDocumentCategory()` Constraints: Not nullable, Maximum length: 4
`LocalDateTime`	`getRequestedDeliveryDate()` Constraints: Not nullable, Precision: 0
`String`	`getRetsMgmtCompnProcgStatus()` Constraints: Not nullable, Maximum length: 1
`String`	`getRetsMgmtLogProcgStatus()` Constraints: Not nullable, Maximum length: 1
`String`	`getRetsMgmtProcess()` Constraints: Not nullable, Maximum length: 10
`String`	`getRetsMgmtProcessingStatus()` Constraints: Not nullable, Maximum length: 1
`String`	`getSalesDistrict()` Constraints: Not nullable, Maximum length: 6
`String`	`getSalesGroup()` Constraints: Not nullable, Maximum length: 3
`String`	`getSalesOffice()` Constraints: Not nullable, Maximum length: 4
`String`	`getSalesOrganization()` Constraints: Not nullable, Maximum length: 4
`String`	`getSDDocumentReason()` Constraints: Not nullable, Maximum length: 3
`String`	`getSoldToParty()` Constraints: Not nullable, Maximum length: 10
`String`	`getTotalCreditCheckStatus()` Constraints: Not nullable, Maximum length: 1
`BigDecimal`	`getTotalNetAmount()` Constraints: Not nullable, Precision: 16, Scale: 3
`String`	`getTransactionCurrency()` Constraints: Not nullable, Maximum length: 5
`Class<CustomerReturn>`	`getType()`
`int`	`hashCode()`
`void`	`setCreatedByUser(String createdByUser)` Constraints: Not nullable, Maximum length: 12
`void`	`setCreationDate(LocalDateTime creationDate)` Constraints: Not nullable, Precision: 0
`void`	`setCustomerPaymentTerms(String customerPaymentTerms)` Constraints: Not nullable, Maximum length: 4
`void`	`setCustomerPurchaseOrderDate(LocalDateTime customerPurchaseOrderDate)` Constraints: Not nullable, Precision: 0
`void`	`setCustomerPurchaseOrderType(String customerPurchaseOrderType)` Constraints: Not nullable, Maximum length: 4
`void`	`setCustomerReturn(String customerReturn)` (Key Field) Constraints: Not nullable, Maximum length: 10
`void`	`setCustomerReturnDate(LocalDateTime customerReturnDate)` Constraints: Not nullable, Precision: 0
`void`	`setCustomerReturnType(String customerReturnType)` Constraints: Not nullable, Maximum length: 4
`void`	`setDeliveryBlockReason(String deliveryBlockReason)` Constraints: Not nullable, Maximum length: 2
`void`	`setDistributionChannel(String distributionChannel)` Constraints: Not nullable, Maximum length: 2
`void`	`setHeaderBillingBlockReason(String headerBillingBlockReason)` Constraints: Not nullable, Maximum length: 2
`void`	`setIncotermsClassification(String incotermsClassification)` Constraints: Not nullable, Maximum length: 3
`void`	`setIncotermsLocation1(String incotermsLocation1)` Constraints: Not nullable, Maximum length: 70
`void`	`setIncotermsLocation2(String incotermsLocation2)` Constraints: Not nullable, Maximum length: 70
`void`	`setIncotermsTransferLocation(String incotermsTransferLocation)` Constraints: Not nullable, Maximum length: 28
`void`	`setIncotermsVersion(String incotermsVersion)` Constraints: Not nullable, Maximum length: 4
`void`	`setItem(List<CustomerReturnItem> value)` Overwrites the list of associated CustomerReturnItem entities for the loaded navigation property to_Item.
`void`	`setLastChangeDate(LocalDateTime lastChangeDate)` Constraints: Not nullable, Precision: 0
`void`	`setLastChangeDateTime(ZonedDateTime lastChangeDateTime)` Constraints: Not nullable, Precision: 7
`void`	`setOrganizationDivision(String organizationDivision)` Constraints: Not nullable, Maximum length: 2
`void`	`setOverallSDDocumentRejectionSts(String overallSDDocumentRejectionSts)` Constraints: Not nullable, Maximum length: 1
`void`	`setOverallSDProcessStatus(String overallSDProcessStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setPartner(List<CustomerReturnPartner> value)` Overwrites the list of associated CustomerReturnPartner entities for the loaded navigation property to_Partner.
`void`	`setPaymentMethod(String paymentMethod)` Constraints: Not nullable, Maximum length: 1
`void`	`setPricingDate(LocalDateTime pricingDate)` Constraints: Not nullable, Precision: 0
`void`	`setPricingElement(List<CustomerReturnPrcgElmnt> value)` Overwrites the list of associated CustomerReturnPrcgElmnt entities for the loaded navigation property to_PricingElement.
`void`	`setPurchaseOrderByCustomer(String purchaseOrderByCustomer)` Constraints: Not nullable, Maximum length: 35
`void`	`setReferenceSDDocument(String referenceSDDocument)` Constraints: Not nullable, Maximum length: 10
`void`	`setReferenceSDDocumentCategory(String referenceSDDocumentCategory)` Constraints: Not nullable, Maximum length: 4
`void`	`setRequestedDeliveryDate(LocalDateTime requestedDeliveryDate)` Constraints: Not nullable, Precision: 0
`void`	`setRetsMgmtCompnProcgStatus(String retsMgmtCompnProcgStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setRetsMgmtLogProcgStatus(String retsMgmtLogProcgStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setRetsMgmtProcess(String retsMgmtProcess)` Constraints: Not nullable, Maximum length: 10
`void`	`setRetsMgmtProcessingStatus(String retsMgmtProcessingStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setSalesDistrict(String salesDistrict)` Constraints: Not nullable, Maximum length: 6
`void`	`setSalesGroup(String salesGroup)` Constraints: Not nullable, Maximum length: 3
`void`	`setSalesOffice(String salesOffice)` Constraints: Not nullable, Maximum length: 4
`void`	`setSalesOrganization(String salesOrganization)` Constraints: Not nullable, Maximum length: 4
`void`	`setSDDocumentReason(String sDDocumentReason)` Constraints: Not nullable, Maximum length: 3
`protected void`	`setServicePathForFetch(String servicePathForFetch)` The service path only used for the fetch commands of this entity.
`void`	`setSoldToParty(String soldToParty)` Constraints: Not nullable, Maximum length: 10
`void`	`setTotalCreditCheckStatus(String totalCreditCheckStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setTotalNetAmount(BigDecimal totalNetAmount)` Constraints: Not nullable, Precision: 16, Scale: 3
`void`	`setTransactionCurrency(String transactionCurrency)` Constraints: Not nullable, Maximum length: 5
`protected Map<String,Object>`	`toMapOfFields()`
`protected Map<String,Object>`	`toMapOfNavigationProperties()`
`String`	`toString()`

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

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

- Field Detail
  - ALL_FIELDS
```
public static final CustomerReturnSelectable ALL_FIELDS
```
    Selector for all available fields of CustomerReturn.
  - CUSTOMER_RETURN
```
public static final CustomerReturnField<String> CUSTOMER_RETURN
```
    Use with available fluent helpers to apply the CustomerReturn field to query operations.
  - CUSTOMER_RETURN_TYPE
```
public static final CustomerReturnField<String> CUSTOMER_RETURN_TYPE
```
    Use with available fluent helpers to apply the CustomerReturnType field to query operations.
  - SALES_ORGANIZATION
```
public static final CustomerReturnField<String> SALES_ORGANIZATION
```
    Use with available fluent helpers to apply the SalesOrganization field to query operations.
  - DISTRIBUTION_CHANNEL
```
public static final CustomerReturnField<String> DISTRIBUTION_CHANNEL
```
    Use with available fluent helpers to apply the DistributionChannel field to query operations.
  - ORGANIZATION_DIVISION
```
public static final CustomerReturnField<String> ORGANIZATION_DIVISION
```
    Use with available fluent helpers to apply the OrganizationDivision field to query operations.
  - SALES_GROUP
```
public static final CustomerReturnField<String> SALES_GROUP
```
    Use with available fluent helpers to apply the SalesGroup field to query operations.
  - SALES_OFFICE
```
public static final CustomerReturnField<String> SALES_OFFICE
```
    Use with available fluent helpers to apply the SalesOffice field to query operations.
  - SALES_DISTRICT
```
public static final CustomerReturnField<String> SALES_DISTRICT
```
    Use with available fluent helpers to apply the SalesDistrict field to query operations.
  - SOLD_TO_PARTY
```
public static final CustomerReturnField<String> SOLD_TO_PARTY
```
    Use with available fluent helpers to apply the SoldToParty field to query operations.
  - CREATION_DATE
```
public static final CustomerReturnField<LocalDateTime> CREATION_DATE
```
    Use with available fluent helpers to apply the CreationDate field to query operations.
  - CREATED_BY_USER
```
public static final CustomerReturnField<String> CREATED_BY_USER
```
    Use with available fluent helpers to apply the CreatedByUser field to query operations.
  - LAST_CHANGE_DATE
```
public static final CustomerReturnField<LocalDateTime> LAST_CHANGE_DATE
```
    Use with available fluent helpers to apply the LastChangeDate field to query operations.
  - LAST_CHANGE_DATE_TIME
```
public static final CustomerReturnField<ZonedDateTime> LAST_CHANGE_DATE_TIME
```
    Use with available fluent helpers to apply the LastChangeDateTime field to query operations.
  - PURCHASE_ORDER_BY_CUSTOMER
```
public static final CustomerReturnField<String> PURCHASE_ORDER_BY_CUSTOMER
```
    Use with available fluent helpers to apply the PurchaseOrderByCustomer field to query operations.
  - CUSTOMER_PURCHASE_ORDER_TYPE
```
public static final CustomerReturnField<String> CUSTOMER_PURCHASE_ORDER_TYPE
```
    Use with available fluent helpers to apply the CustomerPurchaseOrderType field to query operations.
  - CUSTOMER_PURCHASE_ORDER_DATE
```
public static final CustomerReturnField<LocalDateTime> CUSTOMER_PURCHASE_ORDER_DATE
```
    Use with available fluent helpers to apply the CustomerPurchaseOrderDate field to query operations.
  - CUSTOMER_RETURN_DATE
```
public static final CustomerReturnField<LocalDateTime> CUSTOMER_RETURN_DATE
```
    Use with available fluent helpers to apply the CustomerReturnDate field to query operations.
  - TOTAL_NET_AMOUNT
```
public static final CustomerReturnField<BigDecimal> TOTAL_NET_AMOUNT
```
    Use with available fluent helpers to apply the TotalNetAmount field to query operations.
  - TRANSACTION_CURRENCY
```
public static final CustomerReturnField<String> TRANSACTION_CURRENCY
```
    Use with available fluent helpers to apply the TransactionCurrency field to query operations.
  - SD_DOCUMENT_REASON
```
public static final CustomerReturnField<String> SD_DOCUMENT_REASON
```
    Use with available fluent helpers to apply the SDDocumentReason field to query operations.
  - PRICING_DATE
```
public static final CustomerReturnField<LocalDateTime> PRICING_DATE
```
    Use with available fluent helpers to apply the PricingDate field to query operations.
  - REQUESTED_DELIVERY_DATE
```
public static final CustomerReturnField<LocalDateTime> REQUESTED_DELIVERY_DATE
```
    Use with available fluent helpers to apply the RequestedDeliveryDate field to query operations.
  - HEADER_BILLING_BLOCK_REASON
```
public static final CustomerReturnField<String> HEADER_BILLING_BLOCK_REASON
```
    Use with available fluent helpers to apply the HeaderBillingBlockReason field to query operations.
  - DELIVERY_BLOCK_REASON
```
public static final CustomerReturnField<String> DELIVERY_BLOCK_REASON
```
    Use with available fluent helpers to apply the DeliveryBlockReason field to query operations.
  - INCOTERMS_CLASSIFICATION
```
public static final CustomerReturnField<String> INCOTERMS_CLASSIFICATION
```
    Use with available fluent helpers to apply the IncotermsClassification field to query operations.
  - INCOTERMS_TRANSFER_LOCATION
```
public static final CustomerReturnField<String> INCOTERMS_TRANSFER_LOCATION
```
    Use with available fluent helpers to apply the IncotermsTransferLocation field to query operations.
  - INCOTERMS_LOCATION1
```
public static final CustomerReturnField<String> INCOTERMS_LOCATION1
```
    Use with available fluent helpers to apply the IncotermsLocation1 field to query operations.
  - INCOTERMS_LOCATION2
```
public static final CustomerReturnField<String> INCOTERMS_LOCATION2
```
    Use with available fluent helpers to apply the IncotermsLocation2 field to query operations.
  - INCOTERMS_VERSION
```
public static final CustomerReturnField<String> INCOTERMS_VERSION
```
    Use with available fluent helpers to apply the IncotermsVersion field to query operations.
  - CUSTOMER_PAYMENT_TERMS
```
public static final CustomerReturnField<String> CUSTOMER_PAYMENT_TERMS
```
    Use with available fluent helpers to apply the CustomerPaymentTerms field to query operations.
  - PAYMENT_METHOD
```
public static final CustomerReturnField<String> PAYMENT_METHOD
```
    Use with available fluent helpers to apply the PaymentMethod field to query operations.
  - RETS_MGMT_PROCESS
```
public static final CustomerReturnField<String> RETS_MGMT_PROCESS
```
    Use with available fluent helpers to apply the RetsMgmtProcess field to query operations.
  - REFERENCE_SD_DOCUMENT
```
public static final CustomerReturnField<String> REFERENCE_SD_DOCUMENT
```
    Use with available fluent helpers to apply the ReferenceSDDocument field to query operations.
  - REFERENCE_SD_DOCUMENT_CATEGORY
```
public static final CustomerReturnField<String> REFERENCE_SD_DOCUMENT_CATEGORY
```
    Use with available fluent helpers to apply the ReferenceSDDocumentCategory field to query operations.
  - RETS_MGMT_LOG_PROCG_STATUS
```
public static final CustomerReturnField<String> RETS_MGMT_LOG_PROCG_STATUS
```
    Use with available fluent helpers to apply the RetsMgmtLogProcgStatus field to query operations.
  - RETS_MGMT_COMPN_PROCG_STATUS
```
public static final CustomerReturnField<String> RETS_MGMT_COMPN_PROCG_STATUS
```
    Use with available fluent helpers to apply the RetsMgmtCompnProcgStatus field to query operations.
  - RETS_MGMT_PROCESSING_STATUS
```
public static final CustomerReturnField<String> RETS_MGMT_PROCESSING_STATUS
```
    Use with available fluent helpers to apply the RetsMgmtProcessingStatus field to query operations.
  - OVERALL_SD_PROCESS_STATUS
```
public static final CustomerReturnField<String> OVERALL_SD_PROCESS_STATUS
```
    Use with available fluent helpers to apply the OverallSDProcessStatus field to query operations.
  - TOTAL_CREDIT_CHECK_STATUS
```
public static final CustomerReturnField<String> TOTAL_CREDIT_CHECK_STATUS
```
    Use with available fluent helpers to apply the TotalCreditCheckStatus field to query operations.
  - OVERALL_SD_DOCUMENT_REJECTION_STS
```
public static final CustomerReturnField<String> OVERALL_SD_DOCUMENT_REJECTION_STS
```
    Use with available fluent helpers to apply the OverallSDDocumentRejectionSts field to query operations.
  - TO_ITEM
```
public static final CustomerReturnLink<CustomerReturnItem> TO_ITEM
```
    Use with available fluent helpers to apply the to_Item navigation property to query operations.
  - TO_PARTNER
```
public static final CustomerReturnLink<CustomerReturnPartner> TO_PARTNER
```
    Use with available fluent helpers to apply the to_Partner navigation property to query operations.
  - TO_PRICING_ELEMENT
```
public static final CustomerReturnLink<CustomerReturnPrcgElmnt> TO_PRICING_ELEMENT
```
    Use with available fluent helpers to apply the to_PricingElement navigation property to query operations.
- Constructor Detail
  - CustomerReturn
```
public CustomerReturn()
```
  - CustomerReturn
```
public CustomerReturn(@Nullable
                      String customerReturn,
                      @Nullable
                      String customerReturnType,
                      @Nullable
                      String salesOrganization,
                      @Nullable
                      String distributionChannel,
                      @Nullable
                      String organizationDivision,
                      @Nullable
                      String salesGroup,
                      @Nullable
                      String salesOffice,
                      @Nullable
                      String salesDistrict,
                      @Nullable
                      String soldToParty,
                      @Nullable
                      LocalDateTime creationDate,
                      @Nullable
                      String createdByUser,
                      @Nullable
                      LocalDateTime lastChangeDate,
                      @Nullable
                      ZonedDateTime lastChangeDateTime,
                      @Nullable
                      String purchaseOrderByCustomer,
                      @Nullable
                      String customerPurchaseOrderType,
                      @Nullable
                      LocalDateTime customerPurchaseOrderDate,
                      @Nullable
                      LocalDateTime customerReturnDate,
                      @Nullable
                      BigDecimal totalNetAmount,
                      @Nullable
                      String transactionCurrency,
                      @Nullable
                      String sDDocumentReason,
                      @Nullable
                      LocalDateTime pricingDate,
                      @Nullable
                      LocalDateTime requestedDeliveryDate,
                      @Nullable
                      String headerBillingBlockReason,
                      @Nullable
                      String deliveryBlockReason,
                      @Nullable
                      String incotermsClassification,
                      @Nullable
                      String incotermsTransferLocation,
                      @Nullable
                      String incotermsLocation1,
                      @Nullable
                      String incotermsLocation2,
                      @Nullable
                      String incotermsVersion,
                      @Nullable
                      String customerPaymentTerms,
                      @Nullable
                      String paymentMethod,
                      @Nullable
                      String retsMgmtProcess,
                      @Nullable
                      String referenceSDDocument,
                      @Nullable
                      String referenceSDDocumentCategory,
                      @Nullable
                      String retsMgmtLogProcgStatus,
                      @Nullable
                      String retsMgmtCompnProcgStatus,
                      @Nullable
                      String retsMgmtProcessingStatus,
                      @Nullable
                      String overallSDProcessStatus,
                      @Nullable
                      String totalCreditCheckStatus,
                      @Nullable
                      String overallSDDocumentRejectionSts,
                      List<CustomerReturnItem> toItem,
                      List<CustomerReturnPartner> toPartner,
                      List<CustomerReturnPrcgElmnt> toPricingElement)
```
- Method Detail
  - getType
```
@Nonnull
public Class<CustomerReturn> getType()
```
    Specified by:
    
    getType in class VdmObject<CustomerReturn>
    
    Returns:
    
    The class of this object.
  - setCustomerReturn
```
public void setCustomerReturn(@Nullable
                              String customerReturn)
```
    (Key Field) Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: CustomerReturn
    
    Parameters:
    
    customerReturn - Customer Return
  - setCustomerReturnType
```
public void setCustomerReturnType(@Nullable
                                  String customerReturnType)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: CustomerReturnType
    
    Parameters:
    
    customerReturnType - Customer Return Type
  - setSalesOrganization
```
public void setSalesOrganization(@Nullable
                                 String salesOrganization)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: SalesOrganization
    
    You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area.
    
    Parameters:
    
    salesOrganization - An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims.
  - setDistributionChannel
```
public void setDistributionChannel(@Nullable
                                   String distributionChannel)
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: DistributionChannel
    
    You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel.You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel.For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area.
    
    Parameters:
    
    distributionChannel - The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.
  - setOrganizationDivision
```
public void setOrganizationDivision(@Nullable
                                    String organizationDivision)
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: OrganizationDivision
    
    A product or service is always assigned to just one division. From the point of view of sales and distribution, the use of divisions lets you organize your sales structure around groups of similar products or product lines. This allows the people in a division who process orders and service customers to specialize within a manageable area of expertise.If a sales organization sells food and non-food products through both retail and wholesaledistribution channels each distribution channel could then be further split into food and non-food divisions.
    
    Parameters:
    
    organizationDivision - A way of grouping materials, products, or services. The system uses divisions to determine the sales areas and the business areas for a material, product, or service.
  - setSalesGroup
```
public void setSalesGroup(@Nullable
                          String salesGroup)
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: SalesGroup
    
    By using sales groups you can designate different areas of responsibility within a sales office. When you generate sales statistics, you can use the sales group as one of the selection criteria.If sales office personnel service both retail and wholesale markets, you can assign a sales group to each market.You assign each salesperson to a sales group in his or her user master record. You assign each customer to a particular sales group in the customer's master record.
    
    Parameters:
    
    salesGroup - A group of sales people who are responsible for processing sales of certain products or services.
  - setSalesOffice
```
public void setSalesOffice(@Nullable
                           String salesOffice)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: SalesOffice
    
    When you create sales statistics, you can use a sales office as one of the selection criteria. When you print out order confirmations, you can include the address of the sales office.You can assign each customer to a sales office in the customer master record.Within a sales office you can establish sales groups (for example, departments) with specific sales responsibilities. Each person who works in the sales office can be assigned to a sales group in his or her user master record. Each customer can also be assigned to a particular sales group in the customer master record.
    
    Parameters:
    
    salesOffice - A physical location (for example, a branch office) that has responsibility for the sale of certain products or services within a given geographical area.
  - setSalesDistrict
```
public void setSalesDistrict(@Nullable
                             String salesDistrict)
```
    Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: SalesDistrict
    
    Each customer can be assigned to a sales district. You can use sales districts to apply pricing conditions. When you want to generate sales statistics, you can use sales districts as a selection criteria.The system can propose a value from the customer master record of the sold-to party. You can change the value manually in the document at the header or item level.
    
    Parameters:
    
    salesDistrict - A geographical sales district or region.
  - setSoldToParty
```
public void setSoldToParty(@Nullable
                           String soldToParty)
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: SoldToParty
    
    Parameters:
    
    soldToParty - The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders.
  - setCreationDate
```
public void setCreationDate(@Nullable
                            LocalDateTime creationDate)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: CreationDate
    
    Parameters:
    
    creationDate - Date on Which Record Was Created
  - setCreatedByUser
```
public void setCreatedByUser(@Nullable
                             String createdByUser)
```
    Constraints: Not nullable, Maximum length: 12
    Original property name from the Odata EDM: CreatedByUser
    
    Parameters:
    
    createdByUser - Name of Person Who Created Object
  - setLastChangeDate
```
public void setLastChangeDate(@Nullable
                              LocalDateTime lastChangeDate)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: LastChangeDate
    
    Parameters:
    
    lastChangeDate - Date of Last Change
  - setLastChangeDateTime
```
public void setLastChangeDateTime(@Nullable
                                  ZonedDateTime lastChangeDateTime)
```
    Constraints: Not nullable, Precision: 7
    Original property name from the Odata EDM: LastChangeDateTime
    
    In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.
    
    Parameters:
    
    lastChangeDateTime - The UTC timestamp displays date and time according to UTC (Universal Coordinated Time).
  - setPurchaseOrderByCustomer
```
public void setPurchaseOrderByCustomer(@Nullable
                                       String purchaseOrderByCustomer)
```
    Constraints: Not nullable, Maximum length: 35
    Original property name from the Odata EDM: PurchaseOrderByCustomer
    
    The number creates the link between the customer purchase order and the sales document that you create. You can use the number used by the customer during correspondence with the customer to find certain document information. If the number refers to a purchase order, you can also print it on the documents that you send to the customer (e.g. on the delivery note).
    
    Parameters:
    
    purchaseOrderByCustomer - Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order).
  - setCustomerPurchaseOrderType
```
public void setCustomerPurchaseOrderType(@Nullable
                                         String customerPurchaseOrderType)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: CustomerPurchaseOrderType
    
    You can record here whether the sales document arrived, for example, by telephone, mail, or fax.Enter one of the values predefined for your system.
    
    Parameters:
    
    customerPurchaseOrderType - The way in which the sales document (the inquiry or sales order, for example) arrives from the customer.
  - setCustomerPurchaseOrderDate
```
public void setCustomerPurchaseOrderDate(@Nullable
                                         LocalDateTime customerPurchaseOrderDate)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: CustomerPurchaseOrderDate
    
    Parameters:
    
    customerPurchaseOrderDate - The date that appears on the customer's purchase order. This date can be, for example, the date on which the customer created the purchase order.
  - setCustomerReturnDate
```
public void setCustomerReturnDate(@Nullable
                                  LocalDateTime customerReturnDate)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: CustomerReturnDate
    
    When you want to generate a list of sales documents or sales statistics, the document date you enter determines which sales documents are selected. You can define the document date to meet the needs of your organization.For sales orders, for example, you can define the document date as the date when the order actually arrives at your offices. Alternatively, you could define it as the date when the order was written up by a field sales representative.The system proposes the current date. You can change it manually in the sales document.
    
    Parameters:
    
    customerReturnDate - The date on which you want the sales document (the sales order, for example) to become effective for sales management purposes.
  - setTotalNetAmount
```
public void setTotalNetAmount(@Nullable
                              BigDecimal totalNetAmount)
```
    Constraints: Not nullable, Precision: 16, Scale: 3
    Original property name from the Odata EDM: TotalNetAmount
    
    Parameters:
    
    totalNetAmount - The total value of all items in the sales document, after any discounts and surcharges are taken into account. The value is expressed in the document currency.
  - setTransactionCurrency
```
public void setTransactionCurrency(@Nullable
                                   String transactionCurrency)
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: TransactionCurrency
    
    The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document.
    
    Parameters:
    
    transactionCurrency - The currency that applies to the document (for example, to a sales order or an invoice).
  - setSDDocumentReason
```
public void setSDDocumentReason(@Nullable
                                String sDDocumentReason)
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: SDDocumentReason
    
    You can freely define order reasons according to the needs of your organization. When you generate sales statistics, you can use the order reason as one of the selection criteria.Enter one of the values predefined for your system. If you are creating a credit or debit memo request, you must enter an order reason.If the order reason specifies, for example, that a customer placed a sales order as a result of contact at a trade fair, you can later generate statistics for all sales orders that were placed at trade fairs.
    
    Parameters:
    
    sDDocumentReason - Indicates the reason for creating the sales document.
  - setPricingDate
```
public void setPricingDate(@Nullable
                           LocalDateTime pricingDate)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: PricingDate
    
    You can use the pricing date as a selection criterion when you process billing documents collectively.The system proposes the current date. You can change it manually in the document. If you change the pricing date, the system recalculates pricing for the entire document. If the date is in the past, you receive a warning before you can continue.Determining the ProposalIn the order: You can customize the order type to determine a proposal, such as the current date or the requested delivery date as the pricing date.In the billing document: The billing date is proposed as the pricing date.
    
    Parameters:
    
    pricingDate - The date that determines date-related pricing elements, such as conditions and foreign exchange rate.
  - setRequestedDeliveryDate
```
public void setRequestedDeliveryDate(@Nullable
                                     LocalDateTime requestedDeliveryDate)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: RequestedDeliveryDate
    
    As a rule, the system suggests the current date. However, if you change the requested delivery date in the header (for example, to a future date), and then create a new item, the system proposes the new date for any schedule lines you create. If you change the date of an existing schedule line, the system advises you that it will only apply the new date to further schedule lines you create and will not change the dates of other existing schedule lines.
    
    Parameters:
    
    requestedDeliveryDate - The date that the system automatically suggests as the delivery date for schedule lines when you create further items in the sales document.
  - setHeaderBillingBlockReason
```
public void setHeaderBillingBlockReason(@Nullable
                                        String headerBillingBlockReason)
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: HeaderBillingBlockReason
    
    The system can propose the billing block according to the type of sales document. The billing block applies to the entire document. You can block or unblock the entire document manually in the header. If you want to block only a particular item, enter a value at the item level.You may want to apply a billing block to certain documents so that prices can be checked before further processing.
    
    Parameters:
    
    headerBillingBlockReason - Indicates if the entire sales document is blocked for billing.
  - setDeliveryBlockReason
```
public void setDeliveryBlockReason(@Nullable
                                   String deliveryBlockReason)
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: DeliveryBlockReason
    
    The system can propose a delivery block on header level according to sales document type. Users can also enter a block manually. A block in the header applies to the entire sales document.The system only proposes a delivery block at header level if delivery blocks have been assigned to the corresponding delivery type using the Define Reasons for Blocking in Shipping and the Assign Blocking Reasons to Delivery Types configuration steps.Additional InformationUsers can also block a sales document manually at schedule line level.The settings made in these configuration steps do not influence any delivery blocks set at schedule line level.The system can block delivery automatically for certain sales document types (for example, sales orders without charge) where it is important that someone checks the details before shipping takes place.
    
    Parameters:
    
    deliveryBlockReason - Indicates if an entire sales document (a sales order, for example) is blocked for delivery.
  - setIncotermsClassification
```
public void setIncotermsClassification(@Nullable
                                       String incotermsClassification)
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: IncotermsClassification
    
    Incoterms specify internationally recognized procedures that the shipper and the receiving party must follow for the shipping transaction to be completed successfully.If goods are shipped through a port of departure, the appropriate Incoterm might be: FOB ("Free On Board"). You can provide further details (for example, the name of the port) in the secondary Incoterm field: FOB Boston, for example.
    
    Parameters:
    
    incotermsClassification - Commonly used trading terms that comply with the standards established by the International Chamber of Commerce (ICC).
  - setIncotermsTransferLocation
```
public void setIncotermsTransferLocation(@Nullable
                                         String incotermsTransferLocation)
```
    Constraints: Not nullable, Maximum length: 28
    Original property name from the Odata EDM: IncotermsTransferLocation
    
    If the primary Incoterm is, for example, FOB ("Free on Board"), then the second field provides details of the port from which the delivery leaves (for example, "FOB Boston").
    
    Parameters:
    
    incotermsTransferLocation - Additional information for the primary Incoterm.
  - setIncotermsLocation1
```
public void setIncotermsLocation1(@Nullable
                                  String incotermsLocation1)
```
    Constraints: Not nullable, Maximum length: 70
    Original property name from the Odata EDM: IncotermsLocation1
    
    1. For sea and inland waterway transport - Port of Shipment2. For any mode of transport - Place of Delivery 2010Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 1 EXW Ex Works Place of DeliveryFCA Free Carrier Place of DeliveryCPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationDAF Delivered at Frontier Place of DeliveryDDP Delivered Duty Paid Place of DestinationDDU Delivered Duty Unpaid Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 1 FAS Free Alongside Ship Port of ShipmentFOB Free On Board Port of ShipmentCFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of DestinationDEQ Delivered Eq Quay (Duty Paid) Port of DestinationDES Delivered Ex Ship Port of DestinationIf the primary incoterm is specified as FOB “Free on Board”, the second field provides details of the port from which the delivery leaves, such as FOB Boston.
    
    Parameters:
    
    incotermsLocation1 - Provides additional information for the primary Incoterm. For Incoterms 2010, this field represents:
  - setIncotermsLocation2
```
public void setIncotermsLocation2(@Nullable
                                  String incotermsLocation2)
```
    Constraints: Not nullable, Maximum length: 70
    Original property name from the Odata EDM: IncotermsLocation2
    
    No Version:This field is disabledIncoterm Version 2000This field is disabled as part of standard delivery unless a customer decides to enable it by the way of Customizing for Sales and Distribution under Master Data -> Business Partners -> Customers -> Billing Document -> Incoterms -> Map Incoterms to Versions.Incoterm Version 2010For this version, the field represents:Sea and inland waterway transport - Port of DestinationAny mode of transport - Place of Destination2010 Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 2CPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 2CFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of Destination
    
    Parameters:
    
    incotermsLocation2 - Provides additional information for the Incoterms. This field is only available for C-Clauses (if customized appropriately). Note the following for the incoterms versions below:
  - setIncotermsVersion
```
public void setIncotermsVersion(@Nullable
                                String incotermsVersion)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: IncotermsVersion
    
    Parameters:
    
    incotermsVersion - An incoterms version is an edition containing a list of international terms for transportation that is defined by the International Chamber of Commerce (ICC).
  - setCustomerPaymentTerms
```
public void setCustomerPaymentTerms(@Nullable
                                    String customerPaymentTerms)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: CustomerPaymentTerms
    
    It is used in sales orders, purchase orders, and invoices. Terms of payment provide information for:Cash managementDunning proceduresPayment transactionsData can be entered in the field for the terms of payment key in various ways as you enter a business transaction:In most business transactions, the system defaults the key specified in the master record of the customer/vendor in question.In some transactions (for example, credit memos), however, the system does not default the key from the master record. Despite this, you can use the key from the customer/vendor master record by entering "*" in the field.Regardless of whether or not a key is defaulted from the master record, you can manually enter a key during document entry at:item level in sales ordersheader level in purchase orders and invoicesMaster records have separate areas for Financial Accounting, Sales, and Purchasing. You can specify different terms of payment keys in each of these areas. When you then enter a business transaction, the application in question will use the key specified in its area of the master record.
    
    Parameters:
    
    customerPaymentTerms - Key for defining payment terms composed of cash discount percentages and payment periods.
  - setPaymentMethod
```
public void setPaymentMethod(@Nullable
                             String paymentMethod)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: PaymentMethod
    
    If you enter a payment method, then only this payment method can be used in automatic payment transactions. Unless you enter a payment method, one of the payment methods that was allowed in the master record is selected in the payment program according to specified rules.For document entry or document changes, you only enter a payment method if you want to switch off the automatic payment method selection of the payment program.
    
    Parameters:
    
    paymentMethod - Payment method with which this item is to be paid.
  - setRetsMgmtProcess
```
public void setRetsMgmtProcess(@Nullable
                               String retsMgmtProcess)
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: RetsMgmtProcess
    
    Parameters:
    
    retsMgmtProcess - Specifies the unique identifier of the advanced returns process.
  - setReferenceSDDocument
```
public void setReferenceSDDocument(@Nullable
                                   String referenceSDDocument)
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: ReferenceSDDocument
    
    Parameters:
    
    referenceSDDocument - Identifies the sales order to which the delivery refers.
  - setReferenceSDDocumentCategory
```
public void setReferenceSDDocumentCategory(@Nullable
                                           String referenceSDDocumentCategory)
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: ReferenceSDDocumentCategory
    
    Parameters:
    
    referenceSDDocumentCategory - Specifies the sales document category of the preceding sales, delivery, or billing document.
  - setRetsMgmtLogProcgStatus
```
public void setRetsMgmtLogProcgStatus(@Nullable
                                      String retsMgmtLogProcgStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtLogProcgStatus
    
    Parameters:
    
    retsMgmtLogProcgStatus - Logistical Processing Status of a Return
  - setRetsMgmtCompnProcgStatus
```
public void setRetsMgmtCompnProcgStatus(@Nullable
                                        String retsMgmtCompnProcgStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtCompnProcgStatus
    
    When selecting the refunding status on the Returns Overview screen, you have the following options:Select Open if you want to select items that have at least one partial process that is not fully credited.Select Error if you want to select items that have at least one partial process that contains an error in a financial document.Select Completed if you want to select items for which all partial processes are fully credited.The selection criteria Process Status and Logistical Status also apply.A process item is only selected if it fulfills ALL status criteria.
    
    Parameters:
    
    retsMgmtCompnProcgStatus - Specifies the refunding status of a returns process or a returns item. Refunding is complete when all quantities of a returns item are fully credited; otherwise refunding is open.
  - setRetsMgmtProcessingStatus
```
public void setRetsMgmtProcessingStatus(@Nullable
                                        String retsMgmtProcessingStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtProcessingStatus
    
    The process can be completed, open, or can contain errors.When selecting the process status on the Returns Overview screen, you have the following options:Select Open if you want to select items that have at least one partial process that is open.Select Error if you want to select items that have at least one partial process that contains an error.Select Completed if you want to select items for which all partial processes are completed.
    
    Parameters:
    
    retsMgmtProcessingStatus - Specifies the processing status of a returns process or process item.
  - setOverallSDProcessStatus
```
public void setOverallSDProcessStatus(@Nullable
                                      String overallSDProcessStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: OverallSDProcessStatus
    
    The system determines the status of the entire sales document by taking into account the status of all header-related information and the status of all individual items. The status message tells you whether processing of the sales document is open, in progress, or complete.
    
    Parameters:
    
    overallSDProcessStatus - The processing status of the entire sales document.
  - setTotalCreditCheckStatus
```
public void setTotalCreditCheckStatus(@Nullable
                                      String totalCreditCheckStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: TotalCreditCheckStatus
    
    Parameters:
    
    totalCreditCheckStatus - Overall Status of Credit Checks
  - setOverallSDDocumentRejectionSts
```
public void setOverallSDDocumentRejectionSts(@Nullable
                                             String overallSDDocumentRejectionSts)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: OverallSDDocumentRejectionSts
    
    The system determines the total status from the status of all individual items in the sales document. The status message tells you whether the sales document has been partially or completely rejected or whether nothing has been rejected.
    
    Parameters:
    
    overallSDDocumentRejectionSts - Displays the rejection status of the entire sales document.
  - getEntityCollection
```
protected String getEntityCollection()
```
    Description copied from class: VdmEntity
    
    Used by fluent helpers and navigation property methods to construct OData queries.
    
    Specified by:
    
    getEntityCollection in class VdmEntity<CustomerReturn>
    
    Returns:
    
    EDMX name of the entity collection identifier.
  - getKey
```
@Nonnull
protected Map<String,Object> getKey()
```
    Overrides:
    
    getKey in class VdmObject<CustomerReturn>
    
    Returns:
    
    The compound key of this object.
  - toMapOfFields
```
@Nonnull
protected Map<String,Object> toMapOfFields()
```
    Overrides:
    
    toMapOfFields in class VdmObject<CustomerReturn>
  - fromMap
```
protected void fromMap(Map<String,Object> inputValues)
```
    Overrides:
    
    fromMap in class VdmObject<CustomerReturn>
  - field
```
@Nonnull
public static <T> CustomerReturnField<T> field(@Nonnull
                                                        String fieldName,
                                                        @Nonnull
                                                        Class<T> fieldType)
```
    Use with available fluent helpers to apply an extension field to query operations.
    
    Type Parameters:
    
    T - The type of the extension field when performing value comparisons.
    
    Parameters:
    
    fieldName - The name of the extension field as returned by the OData service.
    
    fieldType - The Java type to use for the extension field when performing value comparisons.
    
    Returns:
    
    A representation of an extension field from this entity.
  - field
```
@Nonnull
public static <T,DomainT> CustomerReturnField<T> field(@Nonnull
                                                                String fieldName,
                                                                @Nonnull
                                                                TypeConverter<T,DomainT> typeConverter)
```
    Use with available fluent helpers to apply an extension field to query operations.
    
    Type Parameters:
    
    T - The type of the extension field when performing value comparisons.
    
    DomainT - The type of the extension field as returned by the OData service.
    
    Parameters:
    
    typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field
    
    fieldName - The name of the extension field as returned by the OData service.
    
    Returns:
    
    A representation of an extension field from this entity, holding a reference to the given TypeConverter.
  - getDestinationForFetch
```
@Nullable
public HttpDestinationProperties getDestinationForFetch()
```
    Description copied from class: VdmEntity
    
    Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity
    
    Overrides:
    
    getDestinationForFetch in class VdmEntity<CustomerReturn>
    
    Returns:
    
    The stored destination for executing queries, or null if no such context has been set.
  - setServicePathForFetch
```
protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)
```
    Description copied from class: VdmEntity
    
    The service path only used for the fetch commands of this entity.
    Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
    
    Overrides:
    
    setServicePathForFetch in class VdmEntity<CustomerReturn>
  - attachToService
```
public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)
```
    Description copied from class: VdmEntity
    
    Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.
    Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
    
    Overrides:
    
    attachToService in class VdmEntity<CustomerReturn>
    
    Parameters:
    
    servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.
    
    destination - New destination to apply to this entity and any associated entities that were previously fetched.
  - getDefaultServicePath
```
protected String getDefaultServicePath()
```
    Description copied from class: VdmEntity
    
    Used by fluent helpers and navigation property methods to construct OData queries.
    
    Overrides:
    
    getDefaultServicePath in class VdmEntity<CustomerReturn>
    
    Returns:
    
    Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)
  - toMapOfNavigationProperties
```
@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()
```
    Overrides:
    
    toMapOfNavigationProperties in class VdmObject<CustomerReturn>
  - fetchItem
```
@Nonnull
public List<CustomerReturnItem> fetchItem()
                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Fetches the CustomerReturnItem entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Item.
    Please note: This method will not cache or persist the query results.
    
    Returns:
    
    List containing one or more associated CustomerReturnItem entities. If no entities are associated then an empty list is returned.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getItemOrFetch
```
@Nonnull
public List<CustomerReturnItem> getItemOrFetch()
                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Retrieval of associated CustomerReturnItem entities (one to many). This corresponds to the OData navigation property to_Item.
    If the navigation property to_Item of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Returns:
    
    List of associated CustomerReturnItem entities.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getItemIfPresent
```
@Nonnull
public io.vavr.control.Option<List<CustomerReturnItem>> getItemIfPresent()
```
    Retrieval of associated CustomerReturnItem entities (one to many). This corresponds to the OData navigation property to_Item.
    If the navigation property for an entity CustomerReturn has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.
    
    Returns:
    
    If the information for navigation property to_Item is already loaded, the result will contain the CustomerReturnItem entities. If not, an Option with result state empty is returned.
  - setItem
```
public void setItem(@Nonnull
                    List<CustomerReturnItem> value)
```
    Overwrites the list of associated CustomerReturnItem entities for the loaded navigation property to_Item.
    If the navigation property to_Item of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Parameters:
    
    value - List of CustomerReturnItem entities.
  - addItem
```
public void addItem(CustomerReturnItem... entity)
```
    Adds elements to the list of associated CustomerReturnItem entities. This corresponds to the OData navigation property to_Item.
    If the navigation property to_Item of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Parameters:
    
    entity - Array of CustomerReturnItem entities.
  - fetchPartner
```
@Nonnull
public List<CustomerReturnPartner> fetchPartner()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Fetches the CustomerReturnPartner entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Partner.
    Please note: This method will not cache or persist the query results.
    
    Returns:
    
    List containing one or more associated CustomerReturnPartner entities. If no entities are associated then an empty list is returned.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getPartnerOrFetch
```
@Nonnull
public List<CustomerReturnPartner> getPartnerOrFetch()
                                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Retrieval of associated CustomerReturnPartner entities (one to many). This corresponds to the OData navigation property to_Partner.
    If the navigation property to_Partner of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Returns:
    
    List of associated CustomerReturnPartner entities.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getPartnerIfPresent
```
@Nonnull
public io.vavr.control.Option<List<CustomerReturnPartner>> getPartnerIfPresent()
```
    Retrieval of associated CustomerReturnPartner entities (one to many). This corresponds to the OData navigation property to_Partner.
    If the navigation property for an entity CustomerReturn has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.
    
    Returns:
    
    If the information for navigation property to_Partner is already loaded, the result will contain the CustomerReturnPartner entities. If not, an Option with result state empty is returned.
  - setPartner
```
public void setPartner(@Nonnull
                       List<CustomerReturnPartner> value)
```
    Overwrites the list of associated CustomerReturnPartner entities for the loaded navigation property to_Partner.
    If the navigation property to_Partner of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Parameters:
    
    value - List of CustomerReturnPartner entities.
  - addPartner
```
public void addPartner(CustomerReturnPartner... entity)
```
    Adds elements to the list of associated CustomerReturnPartner entities. This corresponds to the OData navigation property to_Partner.
    If the navigation property to_Partner of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Parameters:
    
    entity - Array of CustomerReturnPartner entities.
  - fetchPricingElement
```
@Nonnull
public List<CustomerReturnPrcgElmnt> fetchPricingElement()
                                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Fetches the CustomerReturnPrcgElmnt entities (one to many) associated with this entity. This corresponds to the OData navigation property to_PricingElement.
    Please note: This method will not cache or persist the query results.
    
    Returns:
    
    List containing one or more associated CustomerReturnPrcgElmnt entities. If no entities are associated then an empty list is returned.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getPricingElementOrFetch
```
@Nonnull
public List<CustomerReturnPrcgElmnt> getPricingElementOrFetch()
                                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Retrieval of associated CustomerReturnPrcgElmnt entities (one to many). This corresponds to the OData navigation property to_PricingElement.
    If the navigation property to_PricingElement of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Returns:
    
    List of associated CustomerReturnPrcgElmnt entities.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getPricingElementIfPresent
```
@Nonnull
public io.vavr.control.Option<List<CustomerReturnPrcgElmnt>> getPricingElementIfPresent()
```
    Retrieval of associated CustomerReturnPrcgElmnt entities (one to many). This corresponds to the OData navigation property to_PricingElement.
    If the navigation property for an entity CustomerReturn has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.
    
    Returns:
    
    If the information for navigation property to_PricingElement is already loaded, the result will contain the CustomerReturnPrcgElmnt entities. If not, an Option with result state empty is returned.
  - setPricingElement
```
public void setPricingElement(@Nonnull
                              List<CustomerReturnPrcgElmnt> value)
```
    Overwrites the list of associated CustomerReturnPrcgElmnt entities for the loaded navigation property to_PricingElement.
    If the navigation property to_PricingElement of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Parameters:
    
    value - List of CustomerReturnPrcgElmnt entities.
  - addPricingElement
```
public void addPricingElement(CustomerReturnPrcgElmnt... entity)
```
    Adds elements to the list of associated CustomerReturnPrcgElmnt entities. This corresponds to the OData navigation property to_PricingElement.
    If the navigation property to_PricingElement of a queried CustomerReturn is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Parameters:
    
    entity - Array of CustomerReturnPrcgElmnt entities.
  - builder
```
public static CustomerReturn.CustomerReturnBuilder builder()
```
  - getCustomerReturn
```
@Nullable
public String getCustomerReturn()
```
    (Key Field) Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: CustomerReturn
    
    Returns:
    
    Customer Return
  - getCustomerReturnType
```
@Nullable
public String getCustomerReturnType()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: CustomerReturnType
    
    Returns:
    
    Customer Return Type
  - getSalesOrganization
```
@Nullable
public String getSalesOrganization()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: SalesOrganization
    
    You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area.
    
    Returns:
    
    An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims.
  - getDistributionChannel
```
@Nullable
public String getDistributionChannel()
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: DistributionChannel
    
    You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel.You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel.For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area.
    
    Returns:
    
    The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.
  - getOrganizationDivision
```
@Nullable
public String getOrganizationDivision()
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: OrganizationDivision
    
    A product or service is always assigned to just one division. From the point of view of sales and distribution, the use of divisions lets you organize your sales structure around groups of similar products or product lines. This allows the people in a division who process orders and service customers to specialize within a manageable area of expertise.If a sales organization sells food and non-food products through both retail and wholesaledistribution channels each distribution channel could then be further split into food and non-food divisions.
    
    Returns:
    
    A way of grouping materials, products, or services. The system uses divisions to determine the sales areas and the business areas for a material, product, or service.
  - getSalesGroup
```
@Nullable
public String getSalesGroup()
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: SalesGroup
    
    By using sales groups you can designate different areas of responsibility within a sales office. When you generate sales statistics, you can use the sales group as one of the selection criteria.If sales office personnel service both retail and wholesale markets, you can assign a sales group to each market.You assign each salesperson to a sales group in his or her user master record. You assign each customer to a particular sales group in the customer's master record.
    
    Returns:
    
    A group of sales people who are responsible for processing sales of certain products or services.
  - getSalesOffice
```
@Nullable
public String getSalesOffice()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: SalesOffice
    
    When you create sales statistics, you can use a sales office as one of the selection criteria. When you print out order confirmations, you can include the address of the sales office.You can assign each customer to a sales office in the customer master record.Within a sales office you can establish sales groups (for example, departments) with specific sales responsibilities. Each person who works in the sales office can be assigned to a sales group in his or her user master record. Each customer can also be assigned to a particular sales group in the customer master record.
    
    Returns:
    
    A physical location (for example, a branch office) that has responsibility for the sale of certain products or services within a given geographical area.
  - getSalesDistrict
```
@Nullable
public String getSalesDistrict()
```
    Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: SalesDistrict
    
    Each customer can be assigned to a sales district. You can use sales districts to apply pricing conditions. When you want to generate sales statistics, you can use sales districts as a selection criteria.The system can propose a value from the customer master record of the sold-to party. You can change the value manually in the document at the header or item level.
    
    Returns:
    
    A geographical sales district or region.
  - getSoldToParty
```
@Nullable
public String getSoldToParty()
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: SoldToParty
    
    Returns:
    
    The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders.
  - getCreationDate
```
@Nullable
public LocalDateTime getCreationDate()
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: CreationDate
    
    Returns:
    
    Date on Which Record Was Created
  - getCreatedByUser
```
@Nullable
public String getCreatedByUser()
```
    Constraints: Not nullable, Maximum length: 12
    Original property name from the Odata EDM: CreatedByUser
    
    Returns:
    
    Name of Person Who Created Object
  - getLastChangeDate
```
@Nullable
public LocalDateTime getLastChangeDate()
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: LastChangeDate
    
    Returns:
    
    Date of Last Change
  - getLastChangeDateTime
```
@Nullable
public ZonedDateTime getLastChangeDateTime()
```
    Constraints: Not nullable, Precision: 7
    Original property name from the Odata EDM: LastChangeDateTime
    
    In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.
    
    Returns:
    
    The UTC timestamp displays date and time according to UTC (Universal Coordinated Time).
  - getPurchaseOrderByCustomer
```
@Nullable
public String getPurchaseOrderByCustomer()
```
    Constraints: Not nullable, Maximum length: 35
    Original property name from the Odata EDM: PurchaseOrderByCustomer
    
    The number creates the link between the customer purchase order and the sales document that you create. You can use the number used by the customer during correspondence with the customer to find certain document information. If the number refers to a purchase order, you can also print it on the documents that you send to the customer (e.g. on the delivery note).
    
    Returns:
    
    Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order).
  - getCustomerPurchaseOrderType
```
@Nullable
public String getCustomerPurchaseOrderType()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: CustomerPurchaseOrderType
    
    You can record here whether the sales document arrived, for example, by telephone, mail, or fax.Enter one of the values predefined for your system.
    
    Returns:
    
    The way in which the sales document (the inquiry or sales order, for example) arrives from the customer.
  - getCustomerPurchaseOrderDate
```
@Nullable
public LocalDateTime getCustomerPurchaseOrderDate()
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: CustomerPurchaseOrderDate
    
    Returns:
    
    The date that appears on the customer's purchase order. This date can be, for example, the date on which the customer created the purchase order.
  - getCustomerReturnDate
```
@Nullable
public LocalDateTime getCustomerReturnDate()
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: CustomerReturnDate
    
    When you want to generate a list of sales documents or sales statistics, the document date you enter determines which sales documents are selected. You can define the document date to meet the needs of your organization.For sales orders, for example, you can define the document date as the date when the order actually arrives at your offices. Alternatively, you could define it as the date when the order was written up by a field sales representative.The system proposes the current date. You can change it manually in the sales document.
    
    Returns:
    
    The date on which you want the sales document (the sales order, for example) to become effective for sales management purposes.
  - getTotalNetAmount
```
@Nullable
public BigDecimal getTotalNetAmount()
```
    Constraints: Not nullable, Precision: 16, Scale: 3
    Original property name from the Odata EDM: TotalNetAmount
    
    Returns:
    
    The total value of all items in the sales document, after any discounts and surcharges are taken into account. The value is expressed in the document currency.
  - getTransactionCurrency
```
@Nullable
public String getTransactionCurrency()
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: TransactionCurrency
    
    The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document.
    
    Returns:
    
    The currency that applies to the document (for example, to a sales order or an invoice).
  - getSDDocumentReason
```
@Nullable
public String getSDDocumentReason()
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: SDDocumentReason
    
    You can freely define order reasons according to the needs of your organization. When you generate sales statistics, you can use the order reason as one of the selection criteria.Enter one of the values predefined for your system. If you are creating a credit or debit memo request, you must enter an order reason.If the order reason specifies, for example, that a customer placed a sales order as a result of contact at a trade fair, you can later generate statistics for all sales orders that were placed at trade fairs.
    
    Returns:
    
    Indicates the reason for creating the sales document.
  - getPricingDate
```
@Nullable
public LocalDateTime getPricingDate()
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: PricingDate
    
    You can use the pricing date as a selection criterion when you process billing documents collectively.The system proposes the current date. You can change it manually in the document. If you change the pricing date, the system recalculates pricing for the entire document. If the date is in the past, you receive a warning before you can continue.Determining the ProposalIn the order: You can customize the order type to determine a proposal, such as the current date or the requested delivery date as the pricing date.In the billing document: The billing date is proposed as the pricing date.
    
    Returns:
    
    The date that determines date-related pricing elements, such as conditions and foreign exchange rate.
  - getRequestedDeliveryDate
```
@Nullable
public LocalDateTime getRequestedDeliveryDate()
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: RequestedDeliveryDate
    
    As a rule, the system suggests the current date. However, if you change the requested delivery date in the header (for example, to a future date), and then create a new item, the system proposes the new date for any schedule lines you create. If you change the date of an existing schedule line, the system advises you that it will only apply the new date to further schedule lines you create and will not change the dates of other existing schedule lines.
    
    Returns:
    
    The date that the system automatically suggests as the delivery date for schedule lines when you create further items in the sales document.
  - getHeaderBillingBlockReason
```
@Nullable
public String getHeaderBillingBlockReason()
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: HeaderBillingBlockReason
    
    The system can propose the billing block according to the type of sales document. The billing block applies to the entire document. You can block or unblock the entire document manually in the header. If you want to block only a particular item, enter a value at the item level.You may want to apply a billing block to certain documents so that prices can be checked before further processing.
    
    Returns:
    
    Indicates if the entire sales document is blocked for billing.
  - getDeliveryBlockReason
```
@Nullable
public String getDeliveryBlockReason()
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: DeliveryBlockReason
    
    The system can propose a delivery block on header level according to sales document type. Users can also enter a block manually. A block in the header applies to the entire sales document.The system only proposes a delivery block at header level if delivery blocks have been assigned to the corresponding delivery type using the Define Reasons for Blocking in Shipping and the Assign Blocking Reasons to Delivery Types configuration steps.Additional InformationUsers can also block a sales document manually at schedule line level.The settings made in these configuration steps do not influence any delivery blocks set at schedule line level.The system can block delivery automatically for certain sales document types (for example, sales orders without charge) where it is important that someone checks the details before shipping takes place.
    
    Returns:
    
    Indicates if an entire sales document (a sales order, for example) is blocked for delivery.
  - getIncotermsClassification
```
@Nullable
public String getIncotermsClassification()
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: IncotermsClassification
    
    Incoterms specify internationally recognized procedures that the shipper and the receiving party must follow for the shipping transaction to be completed successfully.If goods are shipped through a port of departure, the appropriate Incoterm might be: FOB ("Free On Board"). You can provide further details (for example, the name of the port) in the secondary Incoterm field: FOB Boston, for example.
    
    Returns:
    
    Commonly used trading terms that comply with the standards established by the International Chamber of Commerce (ICC).
  - getIncotermsTransferLocation
```
@Nullable
public String getIncotermsTransferLocation()
```
    Constraints: Not nullable, Maximum length: 28
    Original property name from the Odata EDM: IncotermsTransferLocation
    
    If the primary Incoterm is, for example, FOB ("Free on Board"), then the second field provides details of the port from which the delivery leaves (for example, "FOB Boston").
    
    Returns:
    
    Additional information for the primary Incoterm.
  - getIncotermsLocation1
```
@Nullable
public String getIncotermsLocation1()
```
    Constraints: Not nullable, Maximum length: 70
    Original property name from the Odata EDM: IncotermsLocation1
    
    1. For sea and inland waterway transport - Port of Shipment2. For any mode of transport - Place of Delivery 2010Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 1 EXW Ex Works Place of DeliveryFCA Free Carrier Place of DeliveryCPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationDAF Delivered at Frontier Place of DeliveryDDP Delivered Duty Paid Place of DestinationDDU Delivered Duty Unpaid Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 1 FAS Free Alongside Ship Port of ShipmentFOB Free On Board Port of ShipmentCFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of DestinationDEQ Delivered Eq Quay (Duty Paid) Port of DestinationDES Delivered Ex Ship Port of DestinationIf the primary incoterm is specified as FOB “Free on Board”, the second field provides details of the port from which the delivery leaves, such as FOB Boston.
    
    Returns:
    
    Provides additional information for the primary Incoterm. For Incoterms 2010, this field represents:
  - getIncotermsLocation2
```
@Nullable
public String getIncotermsLocation2()
```
    Constraints: Not nullable, Maximum length: 70
    Original property name from the Odata EDM: IncotermsLocation2
    
    No Version:This field is disabledIncoterm Version 2000This field is disabled as part of standard delivery unless a customer decides to enable it by the way of Customizing for Sales and Distribution under Master Data -> Business Partners -> Customers -> Billing Document -> Incoterms -> Map Incoterms to Versions.Incoterm Version 2010For this version, the field represents:Sea and inland waterway transport - Port of DestinationAny mode of transport - Place of Destination2010 Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 2CPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 2CFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of Destination
    
    Returns:
    
    Provides additional information for the Incoterms. This field is only available for C-Clauses (if customized appropriately). Note the following for the incoterms versions below:
  - getIncotermsVersion
```
@Nullable
public String getIncotermsVersion()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: IncotermsVersion
    
    Returns:
    
    An incoterms version is an edition containing a list of international terms for transportation that is defined by the International Chamber of Commerce (ICC).
  - getCustomerPaymentTerms
```
@Nullable
public String getCustomerPaymentTerms()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: CustomerPaymentTerms
    
    It is used in sales orders, purchase orders, and invoices. Terms of payment provide information for:Cash managementDunning proceduresPayment transactionsData can be entered in the field for the terms of payment key in various ways as you enter a business transaction:In most business transactions, the system defaults the key specified in the master record of the customer/vendor in question.In some transactions (for example, credit memos), however, the system does not default the key from the master record. Despite this, you can use the key from the customer/vendor master record by entering "*" in the field.Regardless of whether or not a key is defaulted from the master record, you can manually enter a key during document entry at:item level in sales ordersheader level in purchase orders and invoicesMaster records have separate areas for Financial Accounting, Sales, and Purchasing. You can specify different terms of payment keys in each of these areas. When you then enter a business transaction, the application in question will use the key specified in its area of the master record.
    
    Returns:
    
    Key for defining payment terms composed of cash discount percentages and payment periods.
  - getPaymentMethod
```
@Nullable
public String getPaymentMethod()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: PaymentMethod
    
    If you enter a payment method, then only this payment method can be used in automatic payment transactions. Unless you enter a payment method, one of the payment methods that was allowed in the master record is selected in the payment program according to specified rules.For document entry or document changes, you only enter a payment method if you want to switch off the automatic payment method selection of the payment program.
    
    Returns:
    
    Payment method with which this item is to be paid.
  - getRetsMgmtProcess
```
@Nullable
public String getRetsMgmtProcess()
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: RetsMgmtProcess
    
    Returns:
    
    Specifies the unique identifier of the advanced returns process.
  - getReferenceSDDocument
```
@Nullable
public String getReferenceSDDocument()
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: ReferenceSDDocument
    
    Returns:
    
    Identifies the sales order to which the delivery refers.
  - getReferenceSDDocumentCategory
```
@Nullable
public String getReferenceSDDocumentCategory()
```
    Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: ReferenceSDDocumentCategory
    
    Returns:
    
    Specifies the sales document category of the preceding sales, delivery, or billing document.
  - getRetsMgmtLogProcgStatus
```
@Nullable
public String getRetsMgmtLogProcgStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtLogProcgStatus
    
    Returns:
    
    Logistical Processing Status of a Return
  - getRetsMgmtCompnProcgStatus
```
@Nullable
public String getRetsMgmtCompnProcgStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtCompnProcgStatus
    
    When selecting the refunding status on the Returns Overview screen, you have the following options:Select Open if you want to select items that have at least one partial process that is not fully credited.Select Error if you want to select items that have at least one partial process that contains an error in a financial document.Select Completed if you want to select items for which all partial processes are fully credited.The selection criteria Process Status and Logistical Status also apply.A process item is only selected if it fulfills ALL status criteria.
    
    Returns:
    
    Specifies the refunding status of a returns process or a returns item. Refunding is complete when all quantities of a returns item are fully credited; otherwise refunding is open.
  - getRetsMgmtProcessingStatus
```
@Nullable
public String getRetsMgmtProcessingStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtProcessingStatus
    
    The process can be completed, open, or can contain errors.When selecting the process status on the Returns Overview screen, you have the following options:Select Open if you want to select items that have at least one partial process that is open.Select Error if you want to select items that have at least one partial process that contains an error.Select Completed if you want to select items for which all partial processes are completed.
    
    Returns:
    
    Specifies the processing status of a returns process or process item.
  - getOverallSDProcessStatus
```
@Nullable
public String getOverallSDProcessStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: OverallSDProcessStatus
    
    The system determines the status of the entire sales document by taking into account the status of all header-related information and the status of all individual items. The status message tells you whether processing of the sales document is open, in progress, or complete.
    
    Returns:
    
    The processing status of the entire sales document.
  - getTotalCreditCheckStatus
```
@Nullable
public String getTotalCreditCheckStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: TotalCreditCheckStatus
    
    Returns:
    
    Overall Status of Credit Checks
  - getOverallSDDocumentRejectionSts
```
@Nullable
public String getOverallSDDocumentRejectionSts()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: OverallSDDocumentRejectionSts
    
    The system determines the total status from the status of all individual items in the sales document. The status message tells you whether the sales document has been partially or completely rejected or whether nothing has been rejected.
    
    Returns:
    
    Displays the rejection status of the entire sales document.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class VdmObject<CustomerReturn>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class VdmObject<CustomerReturn>
  - canEqual
```
protected boolean canEqual(Object other)
```
    Overrides:
    
    canEqual in class VdmObject<CustomerReturn>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VdmObject<CustomerReturn>

Class CustomerReturn

Nested Class Summary

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELDS

CUSTOMER_RETURN

CUSTOMER_RETURN_TYPE

SALES_ORGANIZATION

DISTRIBUTION_CHANNEL

ORGANIZATION_DIVISION

SALES_GROUP

SALES_OFFICE

SALES_DISTRICT

SOLD_TO_PARTY

CREATION_DATE

CREATED_BY_USER

LAST_CHANGE_DATE

LAST_CHANGE_DATE_TIME

PURCHASE_ORDER_BY_CUSTOMER

CUSTOMER_PURCHASE_ORDER_TYPE

CUSTOMER_PURCHASE_ORDER_DATE

CUSTOMER_RETURN_DATE

TOTAL_NET_AMOUNT

TRANSACTION_CURRENCY

SD_DOCUMENT_REASON

PRICING_DATE

REQUESTED_DELIVERY_DATE

HEADER_BILLING_BLOCK_REASON

DELIVERY_BLOCK_REASON

INCOTERMS_CLASSIFICATION

INCOTERMS_TRANSFER_LOCATION

INCOTERMS_LOCATION1

INCOTERMS_LOCATION2

INCOTERMS_VERSION

CUSTOMER_PAYMENT_TERMS

PAYMENT_METHOD

RETS_MGMT_PROCESS

REFERENCE_SD_DOCUMENT

REFERENCE_SD_DOCUMENT_CATEGORY

RETS_MGMT_LOG_PROCG_STATUS

RETS_MGMT_COMPN_PROCG_STATUS

RETS_MGMT_PROCESSING_STATUS

OVERALL_SD_PROCESS_STATUS

TOTAL_CREDIT_CHECK_STATUS

OVERALL_SD_DOCUMENT_REJECTION_STS

TO_ITEM

TO_PARTNER

TO_PRICING_ELEMENT

Constructor Detail

CustomerReturn

CustomerReturn

Method Detail

getType

setCustomerReturn

setCustomerReturnType

setSalesOrganization

setDistributionChannel

setOrganizationDivision

setSalesGroup

setSalesOffice

setSalesDistrict

setSoldToParty

setCreationDate

setCreatedByUser

setLastChangeDate

setLastChangeDateTime

setPurchaseOrderByCustomer

setCustomerPurchaseOrderType

setCustomerPurchaseOrderDate

setCustomerReturnDate

setTotalNetAmount

setTransactionCurrency

setSDDocumentReason

setPricingDate