Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ReturnsDeliveryDocFlow" of service "API_CUSTOMER_RETURNS_DELIVERY_SRV". This service is part of the following communication scenarios: Delivery Processing Integration (SAP_COM_0106). See https://api.sap.com/api/API_CUSTOMER_RETURNS_DELIVERY_SRV;v=0002 for more information.

Hierarchy

  • any
    • ReturnsDeliveryDocFlow

Implements

Index

Properties

deliveryVersion

deliveryVersion: string

Delivery Version. Maximum length: 4.

nullable

precedingDocument

precedingDocument: string

Preceding sales and distribution document. Number that uniquely identifies the preceding sales, delivery, or billing document (for example, the quotation from which you created a sales order). Maximum length: 10.

precedingDocumentCategory

precedingDocumentCategory: string

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

nullable

precedingDocumentItem

precedingDocumentItem: string

Preceding Item of an SD Document. Maximum length: 6.

quantityInBaseUnit

quantityInBaseUnit: BigNumber

Referenced quantity in base unit of measure. Specifies how much of an item quantity has already been processed in a subsequent document. The referenced quantity is expressed in basic stock units. A sales order item has an order quantity of 100 pieces. You create two delivery notes against the order: the first for 20 pieces, the second for 80 pieces. In the first case, the referenced quantity is 20 pieces; in the second case, 80 pieces.

nullable

sdFulfillmentCalculationRule

sdFulfillmentCalculationRule: string

Quantity is calculated positively, negatively or not at all. Indicates whether, during copying, the quantity or value in the target document has a negative effect, positive effect, or no effect at all on the quantity still to be completed in the source document. The system uses this indicator to determine how the quantity in the source document is affected. For example, if youCreate a quotation item for 100 pieces,Copy the quotation into a sales order, andCreate a sales order item for 80 pieces,the copying has a positive effect on the quotation. In effect, you have added 80 pieces to the quotation quantity that is now considered complete. 20 pieces in the quotation remain to be completed.If you do not make an entry in this field, or set indicator 0, the source document is not blocked, which allows you to create several target documents at once (for example, when using EDI and frequent contract releases).While the source document (such as quotation or quantity contract) is being processed, it is blocked. For instance, if you are working on a quantity contract, no one can create a release order for that contract).In sales documents, for example, you can expect the following results:Quotation -> Sales order: positiveContract -> Return: negativeSales order -> Sales order: no effectIn billing documents, for example, you can expect the following results:Delivery -> Invoice: positiveDelivery -> Cancellation: negativeDelivery -> Pro-forma invoice: no effect. Maximum length: 1.

nullable

subsequentDocumentCategory

subsequentDocumentCategory: string

Document Category of Subsequent Document. The document category of the sales document that you have created from a preceding document (for example, a delivery note that has been created from a sales order). Maximum length: 4.

subsequentDocumentItem

subsequentDocumentItem: string

Subsequent Item of an SD Document. Number that uniquely identifies the item in the subsequent document (for example, in a sales order that you created from a quotation). Maximum length: 6.

nullable

subsequentdocument

subsequentdocument: string

Subsequent Sales and Distribution Document. Number that uniquely identifies the subsequent sales, delivery, or billing document (for example, the sales order that you create from a previous quotation). Maximum length: 10.

nullable

transferOrderInWrhsMgmtIsConfd

transferOrderInWrhsMgmtIsConfd: boolean

ID: MM-WM Transfer Order Confirmed. Indicates whether the transfer order in the warehouse management (WM) system is confirmed.

nullable

Static ALL_FIELDS

ALL_FIELDS: any = new AllFields('*', ReturnsDeliveryDocFlow)

All fields selector.

Static DELIVERY_VERSION

DELIVERY_VERSION: StringField<ReturnsDeliveryDocFlow> = new StringField('DeliveryVersion', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static PRECEDING_DOCUMENT

PRECEDING_DOCUMENT: StringField<ReturnsDeliveryDocFlow> = new StringField('PrecedingDocument', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static PRECEDING_DOCUMENT_CATEGORY

PRECEDING_DOCUMENT_CATEGORY: StringField<ReturnsDeliveryDocFlow> = new StringField('PrecedingDocumentCategory', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static PRECEDING_DOCUMENT_ITEM

PRECEDING_DOCUMENT_ITEM: StringField<ReturnsDeliveryDocFlow> = new StringField('PrecedingDocumentItem', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static QUANTITY_IN_BASE_UNIT

QUANTITY_IN_BASE_UNIT: BigNumberField<ReturnsDeliveryDocFlow> = new BigNumberField('QuantityInBaseUnit', ReturnsDeliveryDocFlow, 'Edm.Decimal')

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

Static SD_FULFILLMENT_CALCULATION_RULE

SD_FULFILLMENT_CALCULATION_RULE: StringField<ReturnsDeliveryDocFlow> = new StringField('SDFulfillmentCalculationRule', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static SUBSEQUENTDOCUMENT

SUBSEQUENTDOCUMENT: StringField<ReturnsDeliveryDocFlow> = new StringField('Subsequentdocument', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static SUBSEQUENT_DOCUMENT_CATEGORY

SUBSEQUENT_DOCUMENT_CATEGORY: StringField<ReturnsDeliveryDocFlow> = new StringField('SubsequentDocumentCategory', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static SUBSEQUENT_DOCUMENT_ITEM

SUBSEQUENT_DOCUMENT_ITEM: StringField<ReturnsDeliveryDocFlow> = new StringField('SubsequentDocumentItem', ReturnsDeliveryDocFlow, 'Edm.String')

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

Static TRANSFER_ORDER_IN_WRHS_MGMT_IS_CONFD

TRANSFER_ORDER_IN_WRHS_MGMT_IS_CONFD: BooleanField<ReturnsDeliveryDocFlow> = new BooleanField('TransferOrderInWrhsMgmtIsConfd', ReturnsDeliveryDocFlow, 'Edm.Boolean')

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

Static _allFields

_allFields: any[] = [ReturnsDeliveryDocFlow.DELIVERY_VERSION,ReturnsDeliveryDocFlow.PRECEDING_DOCUMENT,ReturnsDeliveryDocFlow.PRECEDING_DOCUMENT_CATEGORY,ReturnsDeliveryDocFlow.PRECEDING_DOCUMENT_ITEM,ReturnsDeliveryDocFlow.SUBSEQUENTDOCUMENT,ReturnsDeliveryDocFlow.QUANTITY_IN_BASE_UNIT,ReturnsDeliveryDocFlow.SUBSEQUENT_DOCUMENT_ITEM,ReturnsDeliveryDocFlow.SD_FULFILLMENT_CALCULATION_RULE,ReturnsDeliveryDocFlow.SUBSEQUENT_DOCUMENT_CATEGORY,ReturnsDeliveryDocFlow.TRANSFER_ORDER_IN_WRHS_MGMT_IS_CONFD]

All fields of the ReturnsDeliveryDocFlow entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_CUSTOMER_RETURNS_DELIVERY_SRV;v=0002"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ReturnsDeliveryDocFlow"

Technical entity name for ReturnsDeliveryDocFlow.

Static _keyFields

_keyFields: Array<Selectable<ReturnsDeliveryDocFlow>> = [ReturnsDeliveryDocFlow.PRECEDING_DOCUMENT, ReturnsDeliveryDocFlow.PRECEDING_DOCUMENT_ITEM, ReturnsDeliveryDocFlow.SUBSEQUENT_DOCUMENT_CATEGORY]

All key fields of the ReturnsDeliveryDocFlow entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_CUSTOMER_RETURNS_DELIVERY_SRV"

Technical service name for ReturnsDeliveryDocFlow.

Methods

Static builder

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ReturnsDeliveryDocFlow>

    A builder that constructs instances of entity type ReturnsDeliveryDocFlow.

Static requestBuilder

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

    Returns ReturnsDeliveryDocFlowRequestBuilder

    A ReturnsDeliveryDocFlow request builder.