Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ServiceEntrySheet" of service "API_SERVICE_ENTRY_SHEET_SRV". This service is part of the following communication scenarios: Service Entry Sheet Integration (SAP_COM_0146). See https://api.sap.com/api/API_SERVICE_ENTRY_SHEET_SRV for more information.

Hierarchy

  • Entity
    • ServiceEntrySheet

Implements

Index

Constructors

constructor

  • Returns ServiceEntrySheet

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 approvalDateTime

approvalDateTime: Moment

Date and Time of SES Approval (UTC).

nullable

Optional approvalStatus

approvalStatus: undefined | string

Approval Status for Service Entry Sheet. Maximum length: 2.

nullable

Optional createdByUser

createdByUser: undefined | string

User Name. Maximum length: 12.

nullable

Optional creationDateTime

creationDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional currency

currency: undefined | string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

Optional externalRevisionDateTime

externalRevisionDateTime: Moment

Timestamp for Revision of External Calls.

nullable

Optional isDeleted

isDeleted: undefined | string

Deletion indicator in purchasing document. Determines whether the item in the purchasing document is deleted or blocked. You can set the deletion indicator by choosing Edit -> Delete if:You want to cancel an itemAn item is closed and can be archivedYou can set the blocking indicator by selecting the item and then choosing Edit -> Block if you do not want to allow subsequent functions for the item. Note that you must manually remove the indicator as soon as subsequent functions are allowed again.You have entered a purchase order item by mistake. You cancel it by setting the deletion indicator.A purchase order item has been delivered, invoiced, and paid for, and can now be archived. You can set the deletion indicator. Maximum length: 1.

nullable

Optional isEndOfPurposeBlocked

isEndOfPurposeBlocked: undefined | string

Business Purpose Completed. Indicates whether the end of purpose (EoP) has been reached. The EoP is the point in time for a data set when the processing of personal data is no longer required for the primary business purpose. After the EoP has been reached, the data is blocked and can only be accessed by users with special authorization. Maximum length: 1.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

User Name. Maximum length: 12.

nullable

Optional materialDocument

materialDocument: undefined | string

Number of Material Document. Alphanumeric key uniquely identifying the document. Number of the material document with which a goods movement was posted.Together with the material document year, the document number constitutes the key via which a material document is accessed. Maximum length: 10.

nullable

Optional materialDocumentYear

materialDocumentYear: undefined | string

Material Document Year. Calendar year in which the material document was posted. In conjunction with the document number, the material document year constitutes the key via which a material document is accessed. Maximum length: 4.

nullable

Optional originObjectType

originObjectType: undefined | string

Origin of Service Entry Sheet. Specifies the origin of the data of the service entry sheets. A service entry sheet can be created in one of the following ways:Externally using an interface (integration with another system)Manually in your SAP S/4HANA systemBased on a time sheet in your SAP S/4HANA system.Using the filter criterion “Origin”, you can decide which service entry sheets are to be displayed in the list. Maximum length: 2.

nullable

Optional postingDate

postingDate: Moment

GR Posting Date. Date that is used as the posting date of the goods receipt document. In the service entry sheet, you can enter the date that is to be used by the system as posting date of the goods receipt document. When the service entry sheet is approved, the goods receipt document is automatically created and the posting date for the goods receipt is adopted.From the posting date, the system derives the fiscal year and the period for which an update of the accounts or cost elements specified in the document is made.The posting date can differ from both the entry date (day of entry into the system) and the document date (day of creation of the original document).

nullable

Optional purchaseOrder

purchaseOrder: undefined | string

Reference Purchase Order. Maximum length: 10.

nullable

Optional purchasingGroup

purchasingGroup: undefined | string

Purchasing Group. Key for a buyer or a group of buyers, who is/are responsible for certain purchasing activities. Frequently, purchasing documents (such as purchase orders) are monitored by the purchasing group. Urging letters (in the case of overdue deliveries) fall also within the group's scope of activities.For each purchasing group, statistical analyses can be performed. The purchasing group can be used as a sort criterion when creating purchasing-specific reports. Maximum length: 3.

nullable

Optional purchasingOrganization

purchasingOrganization: undefined | string

Purchasing Organization. Denotes the purchasing organization. Maximum length: 4.

nullable

Optional purgDocExternalReference

purgDocExternalReference: undefined | string

External Reference ID. Represents the node of an external document or of a subordinate entity. The ID can refer, for example, to the external document, to the item, or to the condition line of the external document. In any case, the ID must be unique. Maximum length: 70.

nullable

Optional purgDocExternalSystem

purgDocExternalSystem: undefined | string

ID of External Reference System. Maximum length: 60.

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 responsiblePerson

responsiblePerson: undefined | string

Personnel Number. The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data. Maximum length: 8.

nullable

serviceEntrySheet

serviceEntrySheet: string

Service Entry Sheet. Maximum length: 10.

Optional serviceEntrySheetName

serviceEntrySheetName: undefined | string

Name of Service Entry Sheet. Maximum length: 40.

nullable

Optional serviceEntrySheetUuid

serviceEntrySheetUuid: undefined | string

UUID serving as key (parent key, root key).

nullable

Optional supplier

supplier: undefined | string

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

nullable

toServiceEntrySheetItem

toServiceEntrySheetItem: ServiceEntrySheetItem[]

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

Static ALL_FIELDS

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

All fields selector.

Static APPROVAL_DATE_TIME

APPROVAL_DATE_TIME: DateField<ServiceEntrySheet> = new DateField('ApprovalDateTime', ServiceEntrySheet, 'Edm.DateTimeOffset')

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

Static APPROVAL_STATUS

APPROVAL_STATUS: StringField<ServiceEntrySheet> = new StringField('ApprovalStatus', ServiceEntrySheet, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<ServiceEntrySheet> = new StringField('CreatedByUser', ServiceEntrySheet, 'Edm.String')

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

Static CREATION_DATE_TIME

CREATION_DATE_TIME: DateField<ServiceEntrySheet> = new DateField('CreationDateTime', ServiceEntrySheet, 'Edm.DateTimeOffset')

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

Static CURRENCY

CURRENCY: StringField<ServiceEntrySheet> = new StringField('Currency', ServiceEntrySheet, 'Edm.String')

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

Static EXTERNAL_REVISION_DATE_TIME

EXTERNAL_REVISION_DATE_TIME: DateField<ServiceEntrySheet> = new DateField('ExternalRevisionDateTime', ServiceEntrySheet, 'Edm.DateTimeOffset')

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

Static IS_DELETED

IS_DELETED: StringField<ServiceEntrySheet> = new StringField('IsDeleted', ServiceEntrySheet, 'Edm.String')

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

Static IS_END_OF_PURPOSE_BLOCKED

IS_END_OF_PURPOSE_BLOCKED: StringField<ServiceEntrySheet> = new StringField('IsEndOfPurposeBlocked', ServiceEntrySheet, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<ServiceEntrySheet> = new StringField('LastChangedByUser', ServiceEntrySheet, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<ServiceEntrySheet> = new DateField('LastChangeDateTime', ServiceEntrySheet, 'Edm.DateTimeOffset')

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

Static MATERIAL_DOCUMENT

MATERIAL_DOCUMENT: StringField<ServiceEntrySheet> = new StringField('MaterialDocument', ServiceEntrySheet, 'Edm.String')

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

Static MATERIAL_DOCUMENT_YEAR

MATERIAL_DOCUMENT_YEAR: StringField<ServiceEntrySheet> = new StringField('MaterialDocumentYear', ServiceEntrySheet, 'Edm.String')

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

Static ORIGIN_OBJECT_TYPE

ORIGIN_OBJECT_TYPE: StringField<ServiceEntrySheet> = new StringField('OriginObjectType', ServiceEntrySheet, 'Edm.String')

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

Static POSTING_DATE

POSTING_DATE: DateField<ServiceEntrySheet> = new DateField('PostingDate', ServiceEntrySheet, 'Edm.DateTime')

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

Static PURCHASE_ORDER

PURCHASE_ORDER: StringField<ServiceEntrySheet> = new StringField('PurchaseOrder', ServiceEntrySheet, 'Edm.String')

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

Static PURCHASING_GROUP

PURCHASING_GROUP: StringField<ServiceEntrySheet> = new StringField('PurchasingGroup', ServiceEntrySheet, 'Edm.String')

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

Static PURCHASING_ORGANIZATION

PURCHASING_ORGANIZATION: StringField<ServiceEntrySheet> = new StringField('PurchasingOrganization', ServiceEntrySheet, 'Edm.String')

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

Static PURG_DOC_EXTERNAL_REFERENCE

PURG_DOC_EXTERNAL_REFERENCE: StringField<ServiceEntrySheet> = new StringField('PurgDocExternalReference', ServiceEntrySheet, 'Edm.String')

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

Static PURG_DOC_EXTERNAL_SYSTEM

PURG_DOC_EXTERNAL_SYSTEM: StringField<ServiceEntrySheet> = new StringField('PurgDocExternalSystem', ServiceEntrySheet, 'Edm.String')

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

Static RESPONSIBLE_PERSON

RESPONSIBLE_PERSON: StringField<ServiceEntrySheet> = new StringField('ResponsiblePerson', ServiceEntrySheet, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET

SERVICE_ENTRY_SHEET: StringField<ServiceEntrySheet> = new StringField('ServiceEntrySheet', ServiceEntrySheet, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET_NAME

SERVICE_ENTRY_SHEET_NAME: StringField<ServiceEntrySheet> = new StringField('ServiceEntrySheetName', ServiceEntrySheet, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET_UUID

SERVICE_ENTRY_SHEET_UUID: StringField<ServiceEntrySheet> = new StringField('ServiceEntrySheetUUID', ServiceEntrySheet, 'Edm.Guid')

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

Static SUPPLIER

SUPPLIER: StringField<ServiceEntrySheet> = new StringField('Supplier', ServiceEntrySheet, '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 TO_SERVICE_ENTRY_SHEET_ITEM

TO_SERVICE_ENTRY_SHEET_ITEM: Link<ServiceEntrySheet, ServiceEntrySheetItem> = new Link('to_ServiceEntrySheetItem', ServiceEntrySheet, ServiceEntrySheetItem)

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

Static _allFields

_allFields: Array<StringField<ServiceEntrySheet> | DateField<ServiceEntrySheet> | Link<ServiceEntrySheet, ServiceEntrySheetItem>> = [ServiceEntrySheet.SERVICE_ENTRY_SHEET,ServiceEntrySheet.APPROVAL_DATE_TIME,ServiceEntrySheet.APPROVAL_STATUS,ServiceEntrySheet.CREATED_BY_USER,ServiceEntrySheet.CREATION_DATE_TIME,ServiceEntrySheet.PURCHASING_ORGANIZATION,ServiceEntrySheet.PURCHASING_GROUP,ServiceEntrySheet.IS_END_OF_PURPOSE_BLOCKED,ServiceEntrySheet.CURRENCY,ServiceEntrySheet.IS_DELETED,ServiceEntrySheet.LAST_CHANGE_DATE_TIME,ServiceEntrySheet.LAST_CHANGED_BY_USER,ServiceEntrySheet.MATERIAL_DOCUMENT,ServiceEntrySheet.MATERIAL_DOCUMENT_YEAR,ServiceEntrySheet.ORIGIN_OBJECT_TYPE,ServiceEntrySheet.PURCHASE_ORDER,ServiceEntrySheet.RESPONSIBLE_PERSON,ServiceEntrySheet.SERVICE_ENTRY_SHEET_NAME,ServiceEntrySheet.SERVICE_ENTRY_SHEET_UUID,ServiceEntrySheet.SUPPLIER,ServiceEntrySheet.PURG_DOC_EXTERNAL_SYSTEM,ServiceEntrySheet.PURG_DOC_EXTERNAL_REFERENCE,ServiceEntrySheet.EXTERNAL_REVISION_DATE_TIME,ServiceEntrySheet.POSTING_DATE,ServiceEntrySheet.TO_SERVICE_ENTRY_SHEET_ITEM]

All fields of the ServiceEntrySheet entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ServiceEntrySheet"

Technical entity name for ServiceEntrySheet.

Static _keyFields

_keyFields: Array<Selectable<ServiceEntrySheet>> = [ServiceEntrySheet.SERVICE_ENTRY_SHEET]

All key fields of the ServiceEntrySheet entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SERVICE_ENTRY_SHEET_SRV"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

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

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.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    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 | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ServiceEntrySheet>

    A builder that constructs instances of entity type ServiceEntrySheet.

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, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

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

    Returns ServiceEntrySheetRequestBuilder

    A ServiceEntrySheet request builder.