Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CustomerReturnItem" of service "API_CUSTOMER_RETURN_SRV". This service is part of the following communication scenarios: Customer Return Integration (SAP_COM_0157). See https://api.sap.com/api/API_CUSTOMER_RETURN_SRV for more information.

Hierarchy

  • Entity
    • CustomerReturnItem

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns CustomerReturnItem

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional batch

batch: string

Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.

nullable

Optional crmLogicalSystem

crmLogicalSystem: string

CRM Logical System. Maximum length: 10.

nullable

Optional crmObjectId

crmObjectId: string

CRM Object ID. Maximum length: 10.

nullable

Optional crmObjectType

crmObjectType: string

CRM Object Type. Maximum length: 10.

nullable

Optional crmObjectUuid

crmObjectUuid: string

CRM Object GUID. Maximum length: 32.

nullable

Optional custRetItmFollowUpActivity

custRetItmFollowUpActivity: string

Follow-Up Activity Code. Specifies the code of the logistical follow-up activity for a returned material in Advanced Returns Management. You use logistical follow-up activities to move returned materials to their final destination. Maximum length: 4.

nullable

Optional custRetMatlAuthzn

custRetMatlAuthzn: string

Customer RMA Number. Specifies the customer return material authorization (RMA) number. Maximum length: 20.

nullable

Optional customerPaymentTerms

customerPaymentTerms: string

Terms of Payment Key. Key for defining payment terms composed of cash discount percentages and payment periods. 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. Maximum length: 4.

nullable

Optional customerRetMatlInspResultCode

customerRetMatlInspResultCode: string

Customer Inspection Code. Specifies the quality of a material that a customer wants to return. The customer informs the company to which he or she wants to return the material about the quality of the material. When you create a return order for the relevant material, the customer inspection code and the corresponding inspection comment provide you with useful information for making the appropriate decisions regarding logistical follow-up activities and refunding. Maximum length: 4.

nullable

customerReturn

customerReturn: string

Customer Return. Maximum length: 10.

customerReturnItem

customerReturnItem: string

Customer Return Item. Maximum length: 6.

Optional customerReturnItemCategory

customerReturnItemCategory: string

Sales Document Item Category. A classification that distinguishes between different types of item (for example, free of charge items and text items) and determines how the system processes the item. The system proposes an item category. If alternatives are defined for your system, you can change the item category manually in the sales document.If, for example, you identify an item as a free or charge item, you tell the system, in this case, to ignore normal pricing procedures. Maximum length: 4.

nullable

Optional customerReturnItemText

customerReturnItemText: string

Short Text for Sales Order Item. A short description of the item. Short texts are used throughout sales order processing, shipping, and billing. They also appear on printed order confirmations.The system proposes the short text from the material master record. If you have included a short text in a customer-material info record, it replaces the material master text during sales document processing. You can change the text at the item level in the sales document or during delivery processing. Maximum length: 40.

nullable

Optional deliveryPriority

deliveryPriority: string

Delivery Priority. The delivery priority assigned to an item. You can assign delivery priority to either a particular material or to a combination of customer and material. When you process deliveries collectively, you can use delivery priority as one of the selection criteria. Maximum length: 2.

nullable

Optional higherLevelItem

higherLevelItem: string

Higher-Level item in bill of material structures. The number of the higher-level item to which this item belongs in a hierarchy. Items can be organized hierarchically. When you assign a sub-item to another item, the other item becomes a higher-level item.Enter the number of a higher-level item. Maximum length: 6.

nullable

Optional incotermsClassification

incotermsClassification: string

Incoterms (Part 1). Commonly used trading terms that comply with the standards established by the International Chamber of Commerce (ICC). 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. Maximum length: 3.

nullable

Optional incotermsLocation1

incotermsLocation1: string

Incoterms Location 1. Provides additional information for the primary Incoterm. For Incoterms 2010, this field represents:

  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. Maximum length: 70.
nullable

Optional incotermsLocation2

incotermsLocation2: string

Incoterms Location 2. 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: 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. Maximum length: 70.

nullable

Optional incotermsTransferLocation

incotermsTransferLocation: string

Incoterms (Part 2). Additional information for the primary Incoterm. 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"). Maximum length: 28.

nullable

Optional itemBillingBlockReason

itemBillingBlockReason: string

Billing Block for Item. Indicates if the item is blocked for billing. To block an item for billing, enter one of the values predefined for your system.You can block an item for billing so that, for example, terms of payment or prices can be checked before further processing takes place. Maximum length: 2.

nullable

Optional itemGrossWeight

itemGrossWeight: BigNumber

Gross Weight of the Item. The total gross weight of the item. The gross weight represents the net weight plus the weight of packaging. The system calculates the gross weight based on the order quantity for the item and the gross weight proposed from the material master record.If the item has more than one schedule line, the system uses the total order quantity of all schedule lines to calculate the gross weight. In sales documents where schedule lines are not allowed (contracts, for example), the system calculates the gross weight using the target quantity.You can change the value manually at the item level.

nullable

Optional itemNetWeight

itemNetWeight: BigNumber

Net Weight of the Item. The total net weight for the item. The net weight represents the gross weight less the weight of packaging. The system calculates the net weight based on the order quantity for the item and the net weight proposed from the material master record. If the item has more than one schedule line, the system uses the total order quantity of all schedule lines to calculate the net weight. In sales documents where schedule lines are not allowed (contracts, for example), the system calculates the net weight using the target quantity.You can change the value manually at the item level.The gross weight of a refrigerator and its packaging (a cardboard box including protective padding) is 350 pounds. The packaging weighs 25 pounds. In this case, the net weight is 325 pounds.

nullable

Optional itemVolume

itemVolume: BigNumber

Volume of the item. The total volume for the item. The system calculates the volume based on the order quantity for the item and the volume proposed from the material master record. If the item has more than one schedule line, the system uses the total order quantity of all schedule lines to calculate the volume. In sales documents where schedule lines are not allowed (contracts, for example), the system calculates the volume using the target quantity.You can change the value manually at the item level.

nullable

Optional itemVolumeUnit

itemVolumeUnit: string

Volume Unit. Unit referring to the volume of the material. If you specify a volume, you have to enter the corresponding volume unit here. Maximum length: 3.

nullable

Optional itemWeightUnit

itemWeightUnit: string

Unit of Weight. Unit referring to the gross weight or net weight of the material. If you specify a weight, you must enter the corresponding unit of weight here. Maximum length: 3.

nullable

Optional material

material: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

nullable

Optional materialByCustomer

materialByCustomer: string

Material Number Used by Customer. Uniquely identifies the material from the customer's point of view. If the customer uses a different identifier than the one you use for the material, you can include this information in a customer-material info record. You can also include in this record specific shipping details, such asMinimum delivery quantityPartial delivery conditionsEnter a value from an existing customer-material info record. Maximum length: 35.

nullable

Optional materialGroup

materialGroup: string

Material Group. Key that you use to group together several materials or services with the same attributes, and to assign them to a particular material group. You can use material groups to:Restrict the scope of analysesSearch specifically for material master records via search helps. Maximum length: 9.

nullable

Optional netAmount

netAmount: BigNumber

Net Value of the Order Item in Document Currency. The net value of the item, after any discounts and surcharges are taken into account. Sales taxes are not included. The value is expressed in the document currency.

nullable

Optional nextFllwUpActivityForMatlInsp

nextFllwUpActivityForMatlInsp: string

Default for Next Follow-Up Activity in Material Inspection. Specifies the code of the next logistical follow-up activity for a returned material that is used as the default in the Material Inspection in Warehouse transaction as part of Advanced Returns Management. In the Next Follow-Up Activity field, you define a default value in the returns order for the next logistical processing step for the material inspection in the warehouse. When you call the Material Inspection in Warehouse transaction, the system proposes the value you entered here in the Follow-Up Activity field for the relevant item of the returns delivery. However, the inspector can overwrite this value if necessary.You would typically define a next follow-up activity if you have chosen the follow-up activity 0001 Receive into Plant in the returns order.You cannot enter any relevant parameters for the next follow-up activity entered in this field, such as the supplier for the next follow-up activity 0005 Ship to Supplier. You enter the relevant parameters in the material inspection.Note the following special cases for setting the default value in material inspection:Even if you have not selected the Material Received checkbox (because the customer contacted your company by phone, for example), you can still choose 0004 Ship to Other Plant, 0005 Ship to Supplier, or 0006 Ship to Supplier via Other Plant as the Follow-Up Activity.In this case, the system copies the value entered for the logistical follow-up activity to the material inspection as the default value. This enables you to enter the relevant parameters for the follow-up activity in the returns order, such as the supplier or the next plant, which are then copied to the appropriate fields in the material inspection.For a store return, if you choose 0004 Ship to Other Plant as the Follow-Up Activity in the returns order and also select the Material Received checkbox, the system uses this as the default value for the material inspection in the warehouse of the receiving plant.The system ignores the value in the Next Follow-Up Activity field if the entry does not make sense for the process flow defined by the logistical follow-up activity. This applies to immediate goods receipts, for example, that is if you choose 0002 Immediately Move to Free Available Stock or 0003 Immediately Move to Scrap, since the logistical process is then already completed. If you choose 0004 Ship to Other Plant, 0005 Ship to Supplier, or 0006 Ship to Supplier via Other Plant as the Follow-Up Activity, the system ignores any entry you make in the Next Follow-Up Activity field.In the Customizing activity Activate and Rename Follow-Up Activities, you can replace the standard descriptions with your own.According to the customer on the phone, the material is still originally packaged. When you create the returns order for the relevant material, you specify Transfer to Free Available Stock as the next logistical follow-up activity for the returns order item. After the material has arrived at your company and the inspector performs the Material Inspection transaction, the system uses Transfer to Free Available Stock as the default in the logistical follow-up field. Maximum length: 4.

nullable

Optional nextPlantForFollowUpActivity

nextPlantForFollowUpActivity: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

nullable

Optional prelimRefundIsDetermined

prelimRefundIsDetermined: boolean

Preliminary Refund Determined.

nullable

Optional productIsInspectedAtCustSite

productIsInspectedAtCustSite: string

Product Is Inspected At Cust Site. Maximum length: 1.

nullable

Optional productionPlant

productionPlant: string

Plant (Own or External). Key that uniquely identifies a plant. Maximum length: 4.

nullable

Optional purchaseOrderByCustomer

purchaseOrderByCustomer: string

Customer Reference. Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order). 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). Maximum length: 35.

nullable

Optional referenceSdDocument

referenceSdDocument: string

Document Number of the Reference Document. Identifies the sales order to which the delivery refers. Maximum length: 10.

nullable

Optional referenceSdDocumentCategory

referenceSdDocumentCategory: string

Document Category of Preceding SD Document. Specifies the sales document category of the preceding sales, delivery, or billing document. Maximum length: 4.

nullable

Optional referenceSdDocumentItem

referenceSdDocumentItem: string

Item Number of the Reference Item. The number of the sales order item to which the delivery item refers. Maximum length: 6.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional replacementMaterial

replacementMaterial: string

Replacement Material. Specifies the material that is given to a customer as a replacement for a returned material. The replacement material is usually identical to the returned material. You can, however, specify a different material as the replacement. Maximum length: 40.

nullable

Optional replacementMaterialIsRequested

replacementMaterialIsRequested: boolean

Replacement Material from Supplier Requested.

nullable

Optional replacementMaterialQtyUnit

replacementMaterialQtyUnit: string

Replacement Material Unit of Measure. Indicates the unit of measure for the quantity of the replacement material. Maximum length: 3.

nullable

Optional replacementMaterialQuantity

replacementMaterialQuantity: BigNumber

Replacement Material Quantity. Indicates the quantity of the replacement material that you give as compensation in a customer returns process created in Advanced Returns Management. Normally, when you decide to compensate a customer for a returned material with a replacement material, you would replace the entire returned quantity. However, you can also just replace part of the returned quantity if, for example, you do not have the full quantity on stock. You could then refund the customer for the remaining quantity with a credit memo.The customer returns 7 pieces of Material A. However, you only have 5 pieces of this material on stock. You decide to compensate the customer with these 5 pieces and create a credit memo request for the remaining 2 pieces. In this case, the value in both the Replaced Quantity field and the Replacement Quantity field is 5. You would then enter 2 in the CMR Quantity (Credit Memo Request Quantity) field so that the customer is compensated for the remaining 2 pieces.

nullable

Optional replacementMatlSupplyingPlant

replacementMatlSupplyingPlant: string

Supplying Plant for Replacement Material. Specifies the plant from which the replacement material should be delivered to the customer. Maximum length: 4.

nullable

Optional requestedQuantity

requestedQuantity: BigNumber

Requested Quantity.

nullable

Optional requestedQuantityUnit

requestedQuantityUnit: string

Requested Quantity Unit. Maximum length: 3.

nullable

Optional retMatlInspResultCode

retMatlInspResultCode: string

Inspection Code. Specifies the quality of the returned material as determined during inspection. Maximum length: 4.

nullable

Optional retsMgmtItmCompnProcgStatus

retsMgmtItmCompnProcgStatus: string

Status of Returns Refund Determination. 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. 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. Maximum length: 1.

nullable

Optional retsMgmtItmLogProcgStatus

retsMgmtItmLogProcgStatus: string

Logistical Processing Status of a Return. Maximum length: 1.

nullable

Optional retsMgmtItmProcgStatus

retsMgmtItmProcgStatus: string

Processing Status. Specifies the processing status of a returns process or process item. 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. Maximum length: 1.

nullable

Optional retsMgmtProcess

retsMgmtProcess: string

Process Identification Number. Specifies the unique identifier of the advanced returns process. Maximum length: 10.

nullable

Optional retsMgmtProcessItem

retsMgmtProcessItem: string

Item Number. Specifies an item in the start document of a returns process. This can be a returns order, a returns purchase order, or a returns stock transport order. Maximum length: 6.

nullable

Optional retsMgmtProcessingBlock

retsMgmtProcessingBlock: string

Approval Block. Specifies whether a customer returns order is to be blocked pending approval. The further processing of a returns order is blocked if the user who is creating or modifying the returns order is not authorized to do so for the receiving plant. The system sets the block to Blocked for Release.If the authorized user at the next receiving plant does not approve the order, he or she can set the blodk to Item to Be Revised. Maximum length: 1.

nullable

Optional returnReason

returnReason: string

Return Reason. Specifies the return reason code for a customer return in Advanced Returns Management. You enter the return reason in the returns order. Maximum length: 3.

nullable

Optional returnsDocumentApprovalStatus

returnsDocumentApprovalStatus: string

Approval Status of Returns Process. Maximum length: 1.

nullable

Optional returnsDocumentStatus

returnsDocumentStatus: string

Status of Document Item. Specifies the status of the document item. A document item can have the following statuses:ActiveThe document item has been created without errors.Deletion Flag SetThe document item has been deleted.Document Was CancelledThe document item has been cancelled and a corresponding reversal or cancellation document exists.Reversal (Cancellation) DocumentThis is a cancellation or reversal document and a corresponding cancelled document exists. Maximum length: 1.

nullable

Optional returnsMaterialHasBeenReceived

returnsMaterialHasBeenReceived: boolean

Material Received.

nullable

Optional returnsRefundExtent

returnsRefundExtent: string

Returns Refund Code. Can be used in pricing to calculate the refund amount. The system can determine the returns refund code automatically from the combination of inspection code and return reason, but the user can also select it manually.You define a returns refund code R01 with description 10% reduction = 90% refund.If the item value of the original order item were 100 euros, then the customer would receive a credit memo for 90 euros. Maximum length: 3.

nullable

Optional returnsRefundProcgMode

returnsRefundProcgMode: string

Refund Processing Mode for a Return. Maximum length: 1.

nullable

Optional returnsRefundRjcnReason

returnsRefundRjcnReason: string

Rejection Reason for Credit Memo Request. Specifies the reason for rejection for the credit memo request as a follow-up document. Maximum length: 2.

nullable

Optional returnsRefundType

returnsRefundType: string

Refund Type. Specifies the type of refund a customer will get for a returned material. You can specify Credit Memo to give the customer monetary compensation or Replacement Material to replace the returned material by the same or another material. Maximum length: 1.

nullable

Optional returnsTransshipmentPlant

returnsTransshipmentPlant: string

Transshipment Plant. Transshipment plants can be included for information purposes when forwarding returned material to other plants or to a supplier. Transshipment plants can thus be listed in delivery documents, but they are not considered for follow-up documents, such as returns stock transport orders or returns purchase orders. Maximum length: 1.

nullable

Optional salesDocumentRjcnReason

salesDocumentRjcnReason: string

Reason for Rejection of Sales Documents. The reason for rejecting a sales document (for example, a sales quotation or a sales order). The rejection can come from your organization (for example, you can reject a customer request for a credit memo because it is unreasonable) or from the customer (for example, the customer rejects a quotation because the price is too high). The following list shows the effects on different document types after you enter a reason for rejection:Inquiries and quotations: no further references by other documentsSales orders: no further delivery of itemsContracts: no further creation of release ordersCredit and debit memo requests: no further processing of credit or debit memosEnter one of the values predefined for your system.If you enter a reason for rejection, the system automatically cancels any MRP requirements previously generated for the items. Maximum length: 2.

nullable

Optional sdDocumentRejectionStatus

sdDocumentRejectionStatus: string

Rejection Status for Sales Document Item. Indicates whether the sales document item (for example, an item in a quotation) is rejected. The system uses the rejection status of items to determine the rejection status at the header level. For example, if a customer rejects only one of several items in a quotation, the status of the header shows that the quotation is partly rejected. Maximum length: 1.

nullable

Optional sdProcessStatus

sdProcessStatus: string

Overall Processing Status of the SD Document Item. Displays the overall processing status of the item. The system determines the overall status from all statuses (for example, delivery and billing) for this item. The status message tells you whether processing of the item is open, in progress, or complete. Maximum length: 1.

nullable

Optional shippingPoint

shippingPoint: string

Shipping Point / Receiving Point. The physical location (for example, a warehouse or collection of loading ramps) from which you ship the item. You can predefine shipping/receiving points in the system, based on different combinations ofPlantsShipping conditionsLoading groupsDuring delivery processing, the shipping/receiving point is the most important criterion that you use to select deliveries.A delivery can be shipped from only one shipping point or received at only one receiving point.If you want to provide more detailed information about a shipping point you can specify a loading point (for example, one of a number of different loading ramps).If, for example, you want to ship refrigerated goods to a certain customer by rail, the system proposes a shipping point with a suitable location and equipment for loading refrigerated goods onto rail cars.The system can propose a shipping/receiving point. If valid alternatives are predefined in your system, you can change the shipping/receiving point manually. Maximum length: 4.

nullable

Optional storageLocation

storageLocation: string

Storage Location. Number of the storage location in which the material is stored. A plant may contain one or more storage locations. Maximum length: 4.

nullable

Optional suplrRetMatlAuthznIsRequired

suplrRetMatlAuthznIsRequired: boolean

Supplier RMA Number Required.

nullable

Optional supplier

supplier: string

Account Number of Supplier. Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system. Maximum length: 10.

nullable

Optional supplierRetMatlAuthzn

supplierRetMatlAuthzn: string

Supplier RMA Number. Specifies the return material authorization (RMA) number from the supplier. You can enter the RMA in the following documents:Initial returns documentLogistical follow-upReturns purchase orderYou must enter an RMA at the latest in the returns purchase order before the goods can be issued and a delivery can be created.You only have to enter an RMA if the supplier master or purchasing info record indicates so. Maximum length: 20.

nullable

toCustomerReturn

toCustomerReturn: CustomerReturn

One-to-one navigation property to the CustomerReturn entity.

toPartner

One-to-many navigation property to the CustomerReturnItemPartner entity.

toPricingElement

toPricingElement: CustomerReturnItemPrcgElmnt[]

One-to-many navigation property to the CustomerReturnItemPrcgElmnt entity.

toProcessStep

toProcessStep: CustomerReturnProcessStep[]

One-to-many navigation property to the CustomerReturnProcessStep entity.

toScheduleLine

toScheduleLine: CustomerReturnScheduleLine[]

One-to-many navigation property to the CustomerReturnScheduleLine entity.

Optional transactionCurrency

transactionCurrency: string

SD document currency. The currency that applies to the document (for example, to a sales order or an invoice). 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. Maximum length: 5.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static ALL_FIELDS

ALL_FIELDS: AllFields<CustomerReturnItem> = new AllFields('*', CustomerReturnItem)

All fields selector.

Static BATCH

BATCH: StringField<CustomerReturnItem> = new StringField('Batch', CustomerReturnItem, 'Edm.String')

Static representation of the batch property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CRM_LOGICAL_SYSTEM

CRM_LOGICAL_SYSTEM: StringField<CustomerReturnItem> = new StringField('CRMLogicalSystem', CustomerReturnItem, 'Edm.String')

Static representation of the crmLogicalSystem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CRM_OBJECT_ID

CRM_OBJECT_ID: StringField<CustomerReturnItem> = new StringField('CRMObjectID', CustomerReturnItem, 'Edm.String')

Static representation of the crmObjectId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CRM_OBJECT_TYPE

CRM_OBJECT_TYPE: StringField<CustomerReturnItem> = new StringField('CRMObjectType', CustomerReturnItem, 'Edm.String')

Static representation of the crmObjectType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CRM_OBJECT_UUID

CRM_OBJECT_UUID: StringField<CustomerReturnItem> = new StringField('CRMObjectUUID', CustomerReturnItem, 'Edm.String')

Static representation of the crmObjectUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_PAYMENT_TERMS

CUSTOMER_PAYMENT_TERMS: StringField<CustomerReturnItem> = new StringField('CustomerPaymentTerms', CustomerReturnItem, 'Edm.String')

Static representation of the customerPaymentTerms property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_RETURN

CUSTOMER_RETURN: StringField<CustomerReturnItem> = new StringField('CustomerReturn', CustomerReturnItem, 'Edm.String')

Static representation of the customerReturn property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_RETURN_ITEM

CUSTOMER_RETURN_ITEM: StringField<CustomerReturnItem> = new StringField('CustomerReturnItem', CustomerReturnItem, 'Edm.String')

Static representation of the customerReturnItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_RETURN_ITEM_CATEGORY

CUSTOMER_RETURN_ITEM_CATEGORY: StringField<CustomerReturnItem> = new StringField('CustomerReturnItemCategory', CustomerReturnItem, 'Edm.String')

Static representation of the customerReturnItemCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_RETURN_ITEM_TEXT

CUSTOMER_RETURN_ITEM_TEXT: StringField<CustomerReturnItem> = new StringField('CustomerReturnItemText', CustomerReturnItem, 'Edm.String')

Static representation of the customerReturnItemText property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_RET_MATL_INSP_RESULT_CODE

CUSTOMER_RET_MATL_INSP_RESULT_CODE: StringField<CustomerReturnItem> = new StringField('CustomerRetMatlInspResultCode', CustomerReturnItem, 'Edm.String')

Static representation of the customerRetMatlInspResultCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUST_RET_ITM_FOLLOW_UP_ACTIVITY

CUST_RET_ITM_FOLLOW_UP_ACTIVITY: StringField<CustomerReturnItem> = new StringField('CustRetItmFollowUpActivity', CustomerReturnItem, 'Edm.String')

Static representation of the custRetItmFollowUpActivity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUST_RET_MATL_AUTHZN

CUST_RET_MATL_AUTHZN: StringField<CustomerReturnItem> = new StringField('CustRetMatlAuthzn', CustomerReturnItem, 'Edm.String')

Static representation of the custRetMatlAuthzn property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static DELIVERY_PRIORITY

DELIVERY_PRIORITY: StringField<CustomerReturnItem> = new StringField('DeliveryPriority', CustomerReturnItem, 'Edm.String')

Static representation of the deliveryPriority property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static HIGHER_LEVEL_ITEM

HIGHER_LEVEL_ITEM: StringField<CustomerReturnItem> = new StringField('HigherLevelItem', CustomerReturnItem, 'Edm.String')

Static representation of the higherLevelItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INCOTERMS_CLASSIFICATION

INCOTERMS_CLASSIFICATION: StringField<CustomerReturnItem> = new StringField('IncotermsClassification', CustomerReturnItem, 'Edm.String')

Static representation of the incotermsClassification property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INCOTERMS_LOCATION_1

INCOTERMS_LOCATION_1: StringField<CustomerReturnItem> = new StringField('IncotermsLocation1', CustomerReturnItem, 'Edm.String')

Static representation of the incotermsLocation1 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INCOTERMS_LOCATION_2

INCOTERMS_LOCATION_2: StringField<CustomerReturnItem> = new StringField('IncotermsLocation2', CustomerReturnItem, 'Edm.String')

Static representation of the incotermsLocation2 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INCOTERMS_TRANSFER_LOCATION

INCOTERMS_TRANSFER_LOCATION: StringField<CustomerReturnItem> = new StringField('IncotermsTransferLocation', CustomerReturnItem, 'Edm.String')

Static representation of the incotermsTransferLocation property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ITEM_BILLING_BLOCK_REASON

ITEM_BILLING_BLOCK_REASON: StringField<CustomerReturnItem> = new StringField('ItemBillingBlockReason', CustomerReturnItem, 'Edm.String')

Static representation of the itemBillingBlockReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ITEM_GROSS_WEIGHT

ITEM_GROSS_WEIGHT: BigNumberField<CustomerReturnItem> = new BigNumberField('ItemGrossWeight', CustomerReturnItem, 'Edm.Decimal')

Static representation of the itemGrossWeight property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ITEM_NET_WEIGHT

ITEM_NET_WEIGHT: BigNumberField<CustomerReturnItem> = new BigNumberField('ItemNetWeight', CustomerReturnItem, 'Edm.Decimal')

Static representation of the itemNetWeight property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ITEM_VOLUME

ITEM_VOLUME: BigNumberField<CustomerReturnItem> = new BigNumberField('ItemVolume', CustomerReturnItem, 'Edm.Decimal')

Static representation of the itemVolume property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ITEM_VOLUME_UNIT

ITEM_VOLUME_UNIT: StringField<CustomerReturnItem> = new StringField('ItemVolumeUnit', CustomerReturnItem, 'Edm.String')

Static representation of the itemVolumeUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ITEM_WEIGHT_UNIT

ITEM_WEIGHT_UNIT: StringField<CustomerReturnItem> = new StringField('ItemWeightUnit', CustomerReturnItem, 'Edm.String')

Static representation of the itemWeightUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MATERIAL

MATERIAL: StringField<CustomerReturnItem> = new StringField('Material', CustomerReturnItem, 'Edm.String')

Static representation of the material property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MATERIAL_BY_CUSTOMER

MATERIAL_BY_CUSTOMER: StringField<CustomerReturnItem> = new StringField('MaterialByCustomer', CustomerReturnItem, 'Edm.String')

Static representation of the materialByCustomer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MATERIAL_GROUP

MATERIAL_GROUP: StringField<CustomerReturnItem> = new StringField('MaterialGroup', CustomerReturnItem, 'Edm.String')

Static representation of the materialGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static NET_AMOUNT

NET_AMOUNT: BigNumberField<CustomerReturnItem> = new BigNumberField('NetAmount', CustomerReturnItem, 'Edm.Decimal')

Static representation of the netAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static NEXT_FLLW_UP_ACTIVITY_FOR_MATL_INSP

NEXT_FLLW_UP_ACTIVITY_FOR_MATL_INSP: StringField<CustomerReturnItem> = new StringField('NextFllwUpActivityForMatlInsp', CustomerReturnItem, 'Edm.String')

Static representation of the nextFllwUpActivityForMatlInsp property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static NEXT_PLANT_FOR_FOLLOW_UP_ACTIVITY

NEXT_PLANT_FOR_FOLLOW_UP_ACTIVITY: StringField<CustomerReturnItem> = new StringField('NextPlantForFollowUpActivity', CustomerReturnItem, 'Edm.String')

Static representation of the nextPlantForFollowUpActivity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRELIM_REFUND_IS_DETERMINED

PRELIM_REFUND_IS_DETERMINED: BooleanField<CustomerReturnItem> = new BooleanField('PrelimRefundIsDetermined', CustomerReturnItem, 'Edm.Boolean')

Static representation of the prelimRefundIsDetermined property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCTION_PLANT

PRODUCTION_PLANT: StringField<CustomerReturnItem> = new StringField('ProductionPlant', CustomerReturnItem, 'Edm.String')

Static representation of the productionPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT_IS_INSPECTED_AT_CUST_SITE

PRODUCT_IS_INSPECTED_AT_CUST_SITE: StringField<CustomerReturnItem> = new StringField('ProductIsInspectedAtCustSite', CustomerReturnItem, 'Edm.String')

Static representation of the productIsInspectedAtCustSite property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PURCHASE_ORDER_BY_CUSTOMER

PURCHASE_ORDER_BY_CUSTOMER: StringField<CustomerReturnItem> = new StringField('PurchaseOrderByCustomer', CustomerReturnItem, 'Edm.String')

Static representation of the purchaseOrderByCustomer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SD_DOCUMENT

REFERENCE_SD_DOCUMENT: StringField<CustomerReturnItem> = new StringField('ReferenceSDDocument', CustomerReturnItem, 'Edm.String')

Static representation of the referenceSdDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SD_DOCUMENT_CATEGORY

REFERENCE_SD_DOCUMENT_CATEGORY: StringField<CustomerReturnItem> = new StringField('ReferenceSDDocumentCategory', CustomerReturnItem, 'Edm.String')

Static representation of the referenceSdDocumentCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SD_DOCUMENT_ITEM

REFERENCE_SD_DOCUMENT_ITEM: StringField<CustomerReturnItem> = new StringField('ReferenceSDDocumentItem', CustomerReturnItem, 'Edm.String')

Static representation of the referenceSdDocumentItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REPLACEMENT_MATERIAL

REPLACEMENT_MATERIAL: StringField<CustomerReturnItem> = new StringField('ReplacementMaterial', CustomerReturnItem, 'Edm.String')

Static representation of the replacementMaterial property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REPLACEMENT_MATERIAL_IS_REQUESTED

REPLACEMENT_MATERIAL_IS_REQUESTED: BooleanField<CustomerReturnItem> = new BooleanField('ReplacementMaterialIsRequested', CustomerReturnItem, 'Edm.Boolean')

Static representation of the replacementMaterialIsRequested property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REPLACEMENT_MATERIAL_QTY_UNIT

REPLACEMENT_MATERIAL_QTY_UNIT: StringField<CustomerReturnItem> = new StringField('ReplacementMaterialQtyUnit', CustomerReturnItem, 'Edm.String')

Static representation of the replacementMaterialQtyUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REPLACEMENT_MATERIAL_QUANTITY

REPLACEMENT_MATERIAL_QUANTITY: BigNumberField<CustomerReturnItem> = new BigNumberField('ReplacementMaterialQuantity', CustomerReturnItem, 'Edm.Decimal')

Static representation of the replacementMaterialQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REPLACEMENT_MATL_SUPPLYING_PLANT

REPLACEMENT_MATL_SUPPLYING_PLANT: StringField<CustomerReturnItem> = new StringField('ReplacementMatlSupplyingPlant', CustomerReturnItem, 'Edm.String')

Static representation of the replacementMatlSupplyingPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REQUESTED_QUANTITY

REQUESTED_QUANTITY: BigNumberField<CustomerReturnItem> = new BigNumberField('RequestedQuantity', CustomerReturnItem, 'Edm.Decimal')

Static representation of the requestedQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REQUESTED_QUANTITY_UNIT

REQUESTED_QUANTITY_UNIT: StringField<CustomerReturnItem> = new StringField('RequestedQuantityUnit', CustomerReturnItem, 'Edm.String')

Static representation of the requestedQuantityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETS_MGMT_ITM_COMPN_PROCG_STATUS

RETS_MGMT_ITM_COMPN_PROCG_STATUS: StringField<CustomerReturnItem> = new StringField('RetsMgmtItmCompnProcgStatus', CustomerReturnItem, 'Edm.String')

Static representation of the retsMgmtItmCompnProcgStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETS_MGMT_ITM_LOG_PROCG_STATUS

RETS_MGMT_ITM_LOG_PROCG_STATUS: StringField<CustomerReturnItem> = new StringField('RetsMgmtItmLogProcgStatus', CustomerReturnItem, 'Edm.String')

Static representation of the retsMgmtItmLogProcgStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETS_MGMT_ITM_PROCG_STATUS

RETS_MGMT_ITM_PROCG_STATUS: StringField<CustomerReturnItem> = new StringField('RetsMgmtItmProcgStatus', CustomerReturnItem, 'Edm.String')

Static representation of the retsMgmtItmProcgStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETS_MGMT_PROCESS

RETS_MGMT_PROCESS: StringField<CustomerReturnItem> = new StringField('RetsMgmtProcess', CustomerReturnItem, 'Edm.String')

Static representation of the retsMgmtProcess property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETS_MGMT_PROCESSING_BLOCK

RETS_MGMT_PROCESSING_BLOCK: StringField<CustomerReturnItem> = new StringField('RetsMgmtProcessingBlock', CustomerReturnItem, 'Edm.String')

Static representation of the retsMgmtProcessingBlock property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETS_MGMT_PROCESS_ITEM

RETS_MGMT_PROCESS_ITEM: StringField<CustomerReturnItem> = new StringField('RetsMgmtProcessItem', CustomerReturnItem, 'Edm.String')

Static representation of the retsMgmtProcessItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_DOCUMENT_APPROVAL_STATUS

RETURNS_DOCUMENT_APPROVAL_STATUS: StringField<CustomerReturnItem> = new StringField('ReturnsDocumentApprovalStatus', CustomerReturnItem, 'Edm.String')

Static representation of the returnsDocumentApprovalStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_DOCUMENT_STATUS

RETURNS_DOCUMENT_STATUS: StringField<CustomerReturnItem> = new StringField('ReturnsDocumentStatus', CustomerReturnItem, 'Edm.String')

Static representation of the returnsDocumentStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_MATERIAL_HAS_BEEN_RECEIVED

RETURNS_MATERIAL_HAS_BEEN_RECEIVED: BooleanField<CustomerReturnItem> = new BooleanField('ReturnsMaterialHasBeenReceived', CustomerReturnItem, 'Edm.Boolean')

Static representation of the returnsMaterialHasBeenReceived property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_REFUND_EXTENT

RETURNS_REFUND_EXTENT: StringField<CustomerReturnItem> = new StringField('ReturnsRefundExtent', CustomerReturnItem, 'Edm.String')

Static representation of the returnsRefundExtent property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_REFUND_PROCG_MODE

RETURNS_REFUND_PROCG_MODE: StringField<CustomerReturnItem> = new StringField('ReturnsRefundProcgMode', CustomerReturnItem, 'Edm.String')

Static representation of the returnsRefundProcgMode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_REFUND_RJCN_REASON

RETURNS_REFUND_RJCN_REASON: StringField<CustomerReturnItem> = new StringField('ReturnsRefundRjcnReason', CustomerReturnItem, 'Edm.String')

Static representation of the returnsRefundRjcnReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_REFUND_TYPE

RETURNS_REFUND_TYPE: StringField<CustomerReturnItem> = new StringField('ReturnsRefundType', CustomerReturnItem, 'Edm.String')

Static representation of the returnsRefundType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURNS_TRANSSHIPMENT_PLANT

RETURNS_TRANSSHIPMENT_PLANT: StringField<CustomerReturnItem> = new StringField('ReturnsTransshipmentPlant', CustomerReturnItem, 'Edm.String')

Static representation of the returnsTransshipmentPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RETURN_REASON

RETURN_REASON: StringField<CustomerReturnItem> = new StringField('ReturnReason', CustomerReturnItem, 'Edm.String')

Static representation of the returnReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RET_MATL_INSP_RESULT_CODE

RET_MATL_INSP_RESULT_CODE: StringField<CustomerReturnItem> = new StringField('RetMatlInspResultCode', CustomerReturnItem, 'Edm.String')

Static representation of the retMatlInspResultCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SALES_DOCUMENT_RJCN_REASON

SALES_DOCUMENT_RJCN_REASON: StringField<CustomerReturnItem> = new StringField('SalesDocumentRjcnReason', CustomerReturnItem, 'Edm.String')

Static representation of the salesDocumentRjcnReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SD_DOCUMENT_REJECTION_STATUS

SD_DOCUMENT_REJECTION_STATUS: StringField<CustomerReturnItem> = new StringField('SDDocumentRejectionStatus', CustomerReturnItem, 'Edm.String')

Static representation of the sdDocumentRejectionStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SD_PROCESS_STATUS

SD_PROCESS_STATUS: StringField<CustomerReturnItem> = new StringField('SDProcessStatus', CustomerReturnItem, 'Edm.String')

Static representation of the sdProcessStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SHIPPING_POINT

SHIPPING_POINT: StringField<CustomerReturnItem> = new StringField('ShippingPoint', CustomerReturnItem, 'Edm.String')

Static representation of the shippingPoint property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static STORAGE_LOCATION

STORAGE_LOCATION: StringField<CustomerReturnItem> = new StringField('StorageLocation', CustomerReturnItem, 'Edm.String')

Static representation of the storageLocation property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SUPLR_RET_MATL_AUTHZN_IS_REQUIRED

SUPLR_RET_MATL_AUTHZN_IS_REQUIRED: BooleanField<CustomerReturnItem> = new BooleanField('SuplrRetMatlAuthznIsRequired', CustomerReturnItem, 'Edm.Boolean')

Static representation of the suplrRetMatlAuthznIsRequired property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SUPPLIER

SUPPLIER: StringField<CustomerReturnItem> = new StringField('Supplier', CustomerReturnItem, 'Edm.String')

Static representation of the supplier property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SUPPLIER_RET_MATL_AUTHZN

SUPPLIER_RET_MATL_AUTHZN: StringField<CustomerReturnItem> = new StringField('SupplierRetMatlAuthzn', CustomerReturnItem, 'Edm.String')

Static representation of the supplierRetMatlAuthzn property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_CUSTOMER_RETURN

TO_CUSTOMER_RETURN: OneToOneLink<CustomerReturnItem, CustomerReturn> = new OneToOneLink('to_CustomerReturn', CustomerReturnItem, CustomerReturn)

Static representation of the one-to-one navigation property toCustomerReturn for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PARTNER

TO_PARTNER: Link<CustomerReturnItem, CustomerReturnItemPartner> = new Link('to_Partner', CustomerReturnItem, CustomerReturnItemPartner)

Static representation of the one-to-many navigation property toPartner for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRICING_ELEMENT

TO_PRICING_ELEMENT: Link<CustomerReturnItem, CustomerReturnItemPrcgElmnt> = new Link('to_PricingElement', CustomerReturnItem, CustomerReturnItemPrcgElmnt)

Static representation of the one-to-many navigation property toPricingElement for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PROCESS_STEP

TO_PROCESS_STEP: Link<CustomerReturnItem, CustomerReturnProcessStep> = new Link('to_ProcessStep', CustomerReturnItem, CustomerReturnProcessStep)

Static representation of the one-to-many navigation property toProcessStep for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_SCHEDULE_LINE

TO_SCHEDULE_LINE: Link<CustomerReturnItem, CustomerReturnScheduleLine> = new Link('to_ScheduleLine', CustomerReturnItem, CustomerReturnScheduleLine)

Static representation of the one-to-many navigation property toScheduleLine for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TRANSACTION_CURRENCY

TRANSACTION_CURRENCY: StringField<CustomerReturnItem> = new StringField('TransactionCurrency', CustomerReturnItem, 'Edm.String')

Static representation of the transactionCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<CustomerReturnItem> | BigNumberField<CustomerReturnItem> | BooleanField<CustomerReturnItem> | OneToOneLink<CustomerReturnItem, CustomerReturn> | Link<CustomerReturnItem, CustomerReturnItemPartner> | Link<CustomerReturnItem, CustomerReturnItemPrcgElmnt> | Link<CustomerReturnItem, CustomerReturnProcessStep> | Link<CustomerReturnItem, CustomerReturnScheduleLine>> = [CustomerReturnItem.CUSTOMER_RETURN,CustomerReturnItem.CUSTOMER_RETURN_ITEM,CustomerReturnItem.HIGHER_LEVEL_ITEM,CustomerReturnItem.CUSTOMER_RETURN_ITEM_CATEGORY,CustomerReturnItem.CUSTOMER_RETURN_ITEM_TEXT,CustomerReturnItem.PURCHASE_ORDER_BY_CUSTOMER,CustomerReturnItem.MATERIAL,CustomerReturnItem.MATERIAL_BY_CUSTOMER,CustomerReturnItem.REQUESTED_QUANTITY,CustomerReturnItem.REQUESTED_QUANTITY_UNIT,CustomerReturnItem.ITEM_GROSS_WEIGHT,CustomerReturnItem.ITEM_NET_WEIGHT,CustomerReturnItem.ITEM_WEIGHT_UNIT,CustomerReturnItem.ITEM_VOLUME,CustomerReturnItem.ITEM_VOLUME_UNIT,CustomerReturnItem.TRANSACTION_CURRENCY,CustomerReturnItem.NET_AMOUNT,CustomerReturnItem.MATERIAL_GROUP,CustomerReturnItem.BATCH,CustomerReturnItem.PRODUCTION_PLANT,CustomerReturnItem.STORAGE_LOCATION,CustomerReturnItem.SHIPPING_POINT,CustomerReturnItem.DELIVERY_PRIORITY,CustomerReturnItem.INCOTERMS_CLASSIFICATION,CustomerReturnItem.INCOTERMS_TRANSFER_LOCATION,CustomerReturnItem.INCOTERMS_LOCATION_1,CustomerReturnItem.INCOTERMS_LOCATION_2,CustomerReturnItem.CUSTOMER_PAYMENT_TERMS,CustomerReturnItem.SALES_DOCUMENT_RJCN_REASON,CustomerReturnItem.ITEM_BILLING_BLOCK_REASON,CustomerReturnItem.RETS_MGMT_PROCESS,CustomerReturnItem.RETS_MGMT_PROCESS_ITEM,CustomerReturnItem.RETURN_REASON,CustomerReturnItem.RETS_MGMT_PROCESSING_BLOCK,CustomerReturnItem.CUST_RET_ITM_FOLLOW_UP_ACTIVITY,CustomerReturnItem.RETURNS_MATERIAL_HAS_BEEN_RECEIVED,CustomerReturnItem.RETURNS_REFUND_TYPE,CustomerReturnItem.RETURNS_REFUND_PROCG_MODE,CustomerReturnItem.RETURNS_REFUND_EXTENT,CustomerReturnItem.PRELIM_REFUND_IS_DETERMINED,CustomerReturnItem.RETURNS_REFUND_RJCN_REASON,CustomerReturnItem.REPLACEMENT_MATERIAL,CustomerReturnItem.REPLACEMENT_MATERIAL_QUANTITY,CustomerReturnItem.REPLACEMENT_MATERIAL_QTY_UNIT,CustomerReturnItem.REPLACEMENT_MATERIAL_IS_REQUESTED,CustomerReturnItem.REPLACEMENT_MATL_SUPPLYING_PLANT,CustomerReturnItem.NEXT_PLANT_FOR_FOLLOW_UP_ACTIVITY,CustomerReturnItem.RETURNS_TRANSSHIPMENT_PLANT,CustomerReturnItem.SUPPLIER,CustomerReturnItem.SUPPLIER_RET_MATL_AUTHZN,CustomerReturnItem.SUPLR_RET_MATL_AUTHZN_IS_REQUIRED,CustomerReturnItem.CUSTOMER_RET_MATL_INSP_RESULT_CODE,CustomerReturnItem.NEXT_FLLW_UP_ACTIVITY_FOR_MATL_INSP,CustomerReturnItem.RET_MATL_INSP_RESULT_CODE,CustomerReturnItem.PRODUCT_IS_INSPECTED_AT_CUST_SITE,CustomerReturnItem.CUST_RET_MATL_AUTHZN,CustomerReturnItem.CRM_LOGICAL_SYSTEM,CustomerReturnItem.CRM_OBJECT_UUID,CustomerReturnItem.CRM_OBJECT_ID,CustomerReturnItem.CRM_OBJECT_TYPE,CustomerReturnItem.RETS_MGMT_ITM_LOG_PROCG_STATUS,CustomerReturnItem.RETS_MGMT_ITM_COMPN_PROCG_STATUS,CustomerReturnItem.RETS_MGMT_ITM_PROCG_STATUS,CustomerReturnItem.RETURNS_DOCUMENT_STATUS,CustomerReturnItem.RETURNS_DOCUMENT_APPROVAL_STATUS,CustomerReturnItem.SD_PROCESS_STATUS,CustomerReturnItem.REFERENCE_SD_DOCUMENT,CustomerReturnItem.REFERENCE_SD_DOCUMENT_ITEM,CustomerReturnItem.REFERENCE_SD_DOCUMENT_CATEGORY,CustomerReturnItem.SD_DOCUMENT_REJECTION_STATUS,CustomerReturnItem.TO_CUSTOMER_RETURN,CustomerReturnItem.TO_PARTNER,CustomerReturnItem.TO_PRICING_ELEMENT,CustomerReturnItem.TO_PROCESS_STEP,CustomerReturnItem.TO_SCHEDULE_LINE]

All fields of the CustomerReturnItem entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_CUSTOMER_RETURN_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_CustomerReturnItem"

Technical entity name for CustomerReturnItem.

Static _keyFields

_keyFields: Array<Selectable<CustomerReturnItem>> = [CustomerReturnItem.CUSTOMER_RETURN, CustomerReturnItem.CUSTOMER_RETURN_ITEM]

All key fields of the CustomerReturnItem entity.

Static _keys

_keys: any = CustomerReturnItem._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property CustomerReturnItem.

Static _serviceName

_serviceName: string = "API_CUSTOMER_RETURN_SRV"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for CustomerReturnItem.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity CustomerReturnItem.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CustomerReturnItem>

    A builder that constructs instances of entity type CustomerReturnItem.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the CustomerReturnItem entity type.

    Returns CustomerReturnItemRequestBuilder

    A CustomerReturnItem request builder.