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

  • Entity
    • ReturnsDeliveryDocFlow

Implements

Index

Constructors

constructor

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 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.

Optional 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.

Optional 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

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 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.

Optional 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

Optional 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

Optional transferOrderInWrhsMgmtIsConfd

transferOrderInWrhsMgmtIsConfd: boolean

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

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<ReturnsDeliveryDocFlow> = 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: Array<StringField<ReturnsDeliveryDocFlow> | BigNumberField<ReturnsDeliveryDocFlow> | BooleanField<ReturnsDeliveryDocFlow>> = [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: object = ReturnsDeliveryDocFlow._keyFields.reduce((acc: { [keys: string]: Selectable<ReturnsDeliveryDocFlow> }, field: Selectable<ReturnsDeliveryDocFlow>) => {acc[field.fieldName] = field;return acc;}, {})

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

Type declaration

Static _serviceName

_serviceName: string = "API_CUSTOMER_RETURNS_DELIVERY_SRV"
deprecated

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

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 ReturnsDeliveryDocFlow.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ReturnsDeliveryDocFlow>

    A builder that constructs instances of entity type ReturnsDeliveryDocFlow.

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, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns ReturnsDeliveryDocFlowRequestBuilder

    A ReturnsDeliveryDocFlow request builder.