Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ServiceConfirmationItem" of service "API_SERVICE_CONFIRMATION_SRV". This service is part of the following communication scenarios: Service Confirmation Integration (SAP_COM_0352). See https://api.sap.com/api/API_SERVICE_CONFIRMATION_SRV for more information.

Hierarchy

  • Entity
    • ServiceConfirmationItem

Implements

Index

Constructors

Properties

Methods

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 actualServiceDuration

actualServiceDuration: BigNumber

Confirmed Duration.

nullable

Optional actualServiceDurationUnit

actualServiceDurationUnit: string

Time Unit for Confirmed Duration. Maximum length: 3.

nullable

Optional actualServiceEndDateTime

actualServiceEndDateTime: Moment

Service Actual End Date.

nullable

Optional actualServiceStartDateTime

actualServiceStartDateTime: Moment

Service Actual Start Date.

nullable

Optional billableControl

billableControl: string

Accounting Indicator. Specifies the ID of an accounting indicator that enables you to control the following for products that you do not want fully bill for: PricingDifferentiation of actual costs in controllingIf you want to post costs in an integrated Controlling system using the accounting indicator as a key, you need to ensure that the accounting indicators that you create in this step are identical to the accounting indicators in the SAP system.For services performed in goodwill, you want to offer a discount of 50%. You also want to track costs for goodwill services in controlling. Maximum length: 2.

nullable

Optional executingServiceEmployee

executingServiceEmployee: string

Executing Service Employee. The 32-digit GUID for identifying a service employee. Maximum length: 10.

nullable

Optional language

language: string

Short Text Language for an Item. Maximum length: 2.

nullable

Optional parentServiceConfItem

parentServiceConfItem: string

Shortened Item Number in Document. Maximum length: 6.

nullable

Optional product

product: string

Product Name Entered. Product that the customer originally ordered. If, for whatever reason, you have to deliver a substitute product for the one originally required, you can see which product the customer originally ordered. Maximum length: 54.

nullable

Optional quantity

quantity: BigNumber

CRM: Order Quantity. Total (rounded) order quantity in sales units of measure for this item. This field is only filled for a sales or opportunity item. This field remains empty for other item object types.

nullable

Optional quantityUnit

quantityUnit: string

Unit of Measure in Which the Product Is Sold. Unit of measure in which the product is sold. Maximum length: 3.

nullable

Optional referenceServiceOrder

referenceServiceOrder: string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

nullable

Optional referenceServiceOrderItem

referenceServiceOrderItem: string

Shortened Item Number in Document. 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 serviceConfItemCategory

serviceConfItemCategory: string

Item Category. Key that identifies an item category. An item category defines the characteristics and attributes of a transaction item and thus controls the processing of an item. Maximum length: 4.

nullable

Optional serviceConfItemDescription

serviceConfItemDescription: string

Product Description. Maximum length: 40.

nullable

Optional serviceConfItemIsCompleted

serviceConfItemIsCompleted: string

Service Conf Item Is Completed. Maximum length: 1.

nullable

serviceConfirmation

serviceConfirmation: string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

serviceConfirmationItem

serviceConfirmationItem: string

Shortened Item Number in Document. Maximum length: 6.

Optional serviceConfirmationItemUuid

serviceConfirmationItemUuid: string

GUID of a CRM Order Object. The unique ID for an operation is a technical key by which the operation can be uniquely identified. This key is only used internally, and the operation number is always displayed on the interface. However, the operation number is not necessarily unique.

nullable

Optional timeSheetOvertimeCategory

timeSheetOvertimeCategory: string

Overtime Category. Overtime is defined as the time an employee works outside the regular working times. Overtime Category is the classification of the overtime hours. It is used in the Manage My Timesheet app to efficiently create time entries. Maximum length: 4.

nullable

toPricingElement

toPricingElement: ServiceConfItemPriceElement[]

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

toReferenceObject

toReferenceObject: ServiceConfItmRefObject[]

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

toServiceConfirmation

toServiceConfirmation: ServiceConfirmation

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

toText

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACTUAL_SERVICE_DURATION

ACTUAL_SERVICE_DURATION: BigNumberField<ServiceConfirmationItem> = new BigNumberField('ActualServiceDuration', ServiceConfirmationItem, 'Edm.Decimal')

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

Static ACTUAL_SERVICE_DURATION_UNIT

ACTUAL_SERVICE_DURATION_UNIT: StringField<ServiceConfirmationItem> = new StringField('ActualServiceDurationUnit', ServiceConfirmationItem, 'Edm.String')

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

Static ACTUAL_SERVICE_END_DATE_TIME

ACTUAL_SERVICE_END_DATE_TIME: DateField<ServiceConfirmationItem> = new DateField('ActualServiceEndDateTime', ServiceConfirmationItem, 'Edm.DateTimeOffset')

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

Static ACTUAL_SERVICE_START_DATE_TIME

ACTUAL_SERVICE_START_DATE_TIME: DateField<ServiceConfirmationItem> = new DateField('ActualServiceStartDateTime', ServiceConfirmationItem, 'Edm.DateTimeOffset')

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

Static ALL_FIELDS

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

All fields selector.

Static BILLABLE_CONTROL

BILLABLE_CONTROL: StringField<ServiceConfirmationItem> = new StringField('BillableControl', ServiceConfirmationItem, 'Edm.String')

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

Static EXECUTING_SERVICE_EMPLOYEE

EXECUTING_SERVICE_EMPLOYEE: StringField<ServiceConfirmationItem> = new StringField('ExecutingServiceEmployee', ServiceConfirmationItem, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<ServiceConfirmationItem> = new StringField('Language', ServiceConfirmationItem, 'Edm.String')

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

Static PARENT_SERVICE_CONF_ITEM

PARENT_SERVICE_CONF_ITEM: StringField<ServiceConfirmationItem> = new StringField('ParentServiceConfItem', ServiceConfirmationItem, 'Edm.String')

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

Static PRODUCT

PRODUCT: StringField<ServiceConfirmationItem> = new StringField('Product', ServiceConfirmationItem, 'Edm.String')

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

Static QUANTITY

QUANTITY: BigNumberField<ServiceConfirmationItem> = new BigNumberField('Quantity', ServiceConfirmationItem, 'Edm.Decimal')

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

Static QUANTITY_UNIT

QUANTITY_UNIT: StringField<ServiceConfirmationItem> = new StringField('QuantityUnit', ServiceConfirmationItem, 'Edm.String')

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

Static REFERENCE_SERVICE_ORDER

REFERENCE_SERVICE_ORDER: StringField<ServiceConfirmationItem> = new StringField('ReferenceServiceOrder', ServiceConfirmationItem, 'Edm.String')

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

Static REFERENCE_SERVICE_ORDER_ITEM

REFERENCE_SERVICE_ORDER_ITEM: StringField<ServiceConfirmationItem> = new StringField('ReferenceServiceOrderItem', ServiceConfirmationItem, 'Edm.String')

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

Static SERVICE_CONFIRMATION

SERVICE_CONFIRMATION: StringField<ServiceConfirmationItem> = new StringField('ServiceConfirmation', ServiceConfirmationItem, 'Edm.String')

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

Static SERVICE_CONFIRMATION_ITEM

SERVICE_CONFIRMATION_ITEM: StringField<ServiceConfirmationItem> = new StringField('ServiceConfirmationItem', ServiceConfirmationItem, 'Edm.String')

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

Static SERVICE_CONFIRMATION_ITEM_UUID

SERVICE_CONFIRMATION_ITEM_UUID: StringField<ServiceConfirmationItem> = new StringField('ServiceConfirmationItemUUID', ServiceConfirmationItem, 'Edm.Guid')

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

Static SERVICE_CONF_ITEM_CATEGORY

SERVICE_CONF_ITEM_CATEGORY: StringField<ServiceConfirmationItem> = new StringField('ServiceConfItemCategory', ServiceConfirmationItem, 'Edm.String')

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

Static SERVICE_CONF_ITEM_DESCRIPTION

SERVICE_CONF_ITEM_DESCRIPTION: StringField<ServiceConfirmationItem> = new StringField('ServiceConfItemDescription', ServiceConfirmationItem, 'Edm.String')

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

Static SERVICE_CONF_ITEM_IS_COMPLETED

SERVICE_CONF_ITEM_IS_COMPLETED: StringField<ServiceConfirmationItem> = new StringField('ServiceConfItemIsCompleted', ServiceConfirmationItem, 'Edm.String')

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

Static TIME_SHEET_OVERTIME_CATEGORY

TIME_SHEET_OVERTIME_CATEGORY: StringField<ServiceConfirmationItem> = new StringField('TimeSheetOvertimeCategory', ServiceConfirmationItem, 'Edm.String')

Static representation of the timeSheetOvertimeCategory property 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<ServiceConfirmationItem, ServiceConfItemPriceElement> = new Link('to_PricingElement', ServiceConfirmationItem, ServiceConfItemPriceElement)

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_REFERENCE_OBJECT

TO_REFERENCE_OBJECT: Link<ServiceConfirmationItem, ServiceConfItmRefObject> = new Link('to_ReferenceObject', ServiceConfirmationItem, ServiceConfItmRefObject)

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

Static TO_SERVICE_CONFIRMATION

TO_SERVICE_CONFIRMATION: OneToOneLink<ServiceConfirmationItem, ServiceConfirmation> = new OneToOneLink('to_ServiceConfirmation', ServiceConfirmationItem, ServiceConfirmation)

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

Static TO_TEXT

TO_TEXT: Link<ServiceConfirmationItem, ServiceConfirmationItemText> = new Link('to_Text', ServiceConfirmationItem, ServiceConfirmationItemText)

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

Static _allFields

_allFields: Array<StringField<ServiceConfirmationItem> | BigNumberField<ServiceConfirmationItem> | DateField<ServiceConfirmationItem> | Link<ServiceConfirmationItem, ServiceConfItemPriceElement> | Link<ServiceConfirmationItem, ServiceConfItmRefObject> | OneToOneLink<ServiceConfirmationItem, ServiceConfirmation> | Link<ServiceConfirmationItem, ServiceConfirmationItemText>> = [ServiceConfirmationItem.SERVICE_CONFIRMATION,ServiceConfirmationItem.SERVICE_CONFIRMATION_ITEM,ServiceConfirmationItem.SERVICE_CONFIRMATION_ITEM_UUID,ServiceConfirmationItem.SERVICE_CONF_ITEM_DESCRIPTION,ServiceConfirmationItem.LANGUAGE,ServiceConfirmationItem.PRODUCT,ServiceConfirmationItem.QUANTITY,ServiceConfirmationItem.QUANTITY_UNIT,ServiceConfirmationItem.ACTUAL_SERVICE_DURATION,ServiceConfirmationItem.ACTUAL_SERVICE_DURATION_UNIT,ServiceConfirmationItem.SERVICE_CONF_ITEM_CATEGORY,ServiceConfirmationItem.SERVICE_CONF_ITEM_IS_COMPLETED,ServiceConfirmationItem.EXECUTING_SERVICE_EMPLOYEE,ServiceConfirmationItem.BILLABLE_CONTROL,ServiceConfirmationItem.REFERENCE_SERVICE_ORDER,ServiceConfirmationItem.REFERENCE_SERVICE_ORDER_ITEM,ServiceConfirmationItem.TIME_SHEET_OVERTIME_CATEGORY,ServiceConfirmationItem.PARENT_SERVICE_CONF_ITEM,ServiceConfirmationItem.ACTUAL_SERVICE_START_DATE_TIME,ServiceConfirmationItem.ACTUAL_SERVICE_END_DATE_TIME,ServiceConfirmationItem.TO_PRICING_ELEMENT,ServiceConfirmationItem.TO_REFERENCE_OBJECT,ServiceConfirmationItem.TO_SERVICE_CONFIRMATION,ServiceConfirmationItem.TO_TEXT]

All fields of the ServiceConfirmationItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ServiceConfirmationItem"

Technical entity name for ServiceConfirmationItem.

Static _keyFields

_keyFields: Array<Selectable<ServiceConfirmationItem>> = [ServiceConfirmationItem.SERVICE_CONFIRMATION, ServiceConfirmationItem.SERVICE_CONFIRMATION_ITEM]

All key fields of the ServiceConfirmationItem entity.

Static _keys

_keys: object = ServiceConfirmationItem._keyFields.reduce((acc: { [keys: string]: Selectable<ServiceConfirmationItem> }, field: Selectable<ServiceConfirmationItem>) => {acc[field.fieldName] = field;return acc;}, {})

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

Type declaration

Static _serviceName

_serviceName: string = "API_SERVICE_CONFIRMATION_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ServiceConfirmationItem>

    A builder that constructs instances of entity type ServiceConfirmationItem.

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 ServiceConfirmationItem entity type.

    Returns ServiceConfirmationItemRequestBuilder

    A ServiceConfirmationItem request builder.