Options
All
  • Public
  • Public/Protected
  • All
Menu

API exposure Material Document Header

Hierarchy

  • Entity
    • MaterialDocumentHeader

Implements

Index

Properties

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

createdByUser

createdByUser: string

User Name. Maximum length: 12.

nullable

creationDate

creationDate: Moment

Day On Which Accounting Document Was Entered. Specifies the date on which the accounting document is entered. NoteThe posting date can differ from the entry date (date of entry in the system) and the document date.

nullable

creationTime

creationTime: Time

Time of Entry.

nullable

documentDate

documentDate: Moment

Document Date in Document. The document date is the date on which the original document was issued.

nullable

goodsMovementCode

goodsMovementCode: string

Goods Movement Code. Maximum length: 2.

nullable

inventoryTransactionType

inventoryTransactionType: string

Transaction/Event Type. Identifier for a certain transaction or event. (Example: GR for "Goods receipt against a purchase order".). Maximum length: 2.

nullable

materialDocument

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

materialDocumentHeaderText

materialDocumentHeaderText: string

Document Header Text. The document header text contains explanations or notes which apply to the document as a whole, that is, not only for certain line items. Maximum length: 25.

nullable

materialDocumentYear

materialDocumentYear: string

Material Document Year. Maximum length: 4.

postingDate

postingDate: Moment

Posting Date in the Document. Date which is used when entering the document in Financial Accounting or Controlling. The fiscal year and the period for which an update of the accounts specified in the document or cost elements is made, are derived from the posting date.When entering documents, the system checks whether the posting date entered is allowed by means of the posting period permitted.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

referenceDocument

referenceDocument: string

Reference Document Number. The reference document number can contain the document number of the customer/vendor. However it may contain a different value. The reference document number is used as a search criterion when displaying or changing documents. In correspondence, the reference document number is sometimes printed in place of the document number.Enter the number specified by the business partner. If the document was created in-house and you do not know the business partner document number, you can copy the document number into the reference number field by entering "*". Maximum length: 16.

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

toMaterialDocumentItem

toMaterialDocumentItem: MaterialDocumentItem[]

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<MaterialDocumentHeader> = new StringField('CreatedByUser', MaterialDocumentHeader, '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

CREATION_DATE: DateField<MaterialDocumentHeader> = new DateField('CreationDate', MaterialDocumentHeader, 'Edm.DateTime')

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

Static CREATION_TIME

CREATION_TIME: TimeField<MaterialDocumentHeader> = new TimeField('CreationTime', MaterialDocumentHeader, 'Edm.Time')

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

Static DOCUMENT_DATE

DOCUMENT_DATE: DateField<MaterialDocumentHeader> = new DateField('DocumentDate', MaterialDocumentHeader, 'Edm.DateTime')

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

Static GOODS_MOVEMENT_CODE

GOODS_MOVEMENT_CODE: StringField<MaterialDocumentHeader> = new StringField('GoodsMovementCode', MaterialDocumentHeader, 'Edm.String')

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

Static INVENTORY_TRANSACTION_TYPE

INVENTORY_TRANSACTION_TYPE: StringField<MaterialDocumentHeader> = new StringField('InventoryTransactionType', MaterialDocumentHeader, 'Edm.String')

Static representation of the inventoryTransactionType 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<MaterialDocumentHeader> = new StringField('MaterialDocument', MaterialDocumentHeader, '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_HEADER_TEXT

MATERIAL_DOCUMENT_HEADER_TEXT: StringField<MaterialDocumentHeader> = new StringField('MaterialDocumentHeaderText', MaterialDocumentHeader, 'Edm.String')

Static representation of the materialDocumentHeaderText 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<MaterialDocumentHeader> = new StringField('MaterialDocumentYear', MaterialDocumentHeader, '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 POSTING_DATE

POSTING_DATE: DateField<MaterialDocumentHeader> = new DateField('PostingDate', MaterialDocumentHeader, '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 REFERENCE_DOCUMENT

REFERENCE_DOCUMENT: StringField<MaterialDocumentHeader> = new StringField('ReferenceDocument', MaterialDocumentHeader, 'Edm.String')

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

Static TO_MATERIAL_DOCUMENT_ITEM

TO_MATERIAL_DOCUMENT_ITEM: Link<MaterialDocumentHeader, MaterialDocumentItem> = new Link('to_MaterialDocumentItem', MaterialDocumentHeader, MaterialDocumentItem)

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

Static _allFields

_allFields: (StringField<MaterialDocumentHeader> | DateField<MaterialDocumentHeader> | TimeField<MaterialDocumentHeader> | Link<MaterialDocumentHeader, MaterialDocumentItem>)[] = [MaterialDocumentHeader.MATERIAL_DOCUMENT_YEAR,MaterialDocumentHeader.MATERIAL_DOCUMENT,MaterialDocumentHeader.INVENTORY_TRANSACTION_TYPE,MaterialDocumentHeader.DOCUMENT_DATE,MaterialDocumentHeader.POSTING_DATE,MaterialDocumentHeader.CREATION_DATE,MaterialDocumentHeader.CREATION_TIME,MaterialDocumentHeader.CREATED_BY_USER,MaterialDocumentHeader.MATERIAL_DOCUMENT_HEADER_TEXT,MaterialDocumentHeader.REFERENCE_DOCUMENT,MaterialDocumentHeader.GOODS_MOVEMENT_CODE,MaterialDocumentHeader.TO_MATERIAL_DOCUMENT_ITEM]

All fields of the MaterialDocumentHeader entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_MaterialDocumentHeader"

Technical entity name for MaterialDocumentHeader.

Static _keyFields

_keyFields: Array<Selectable<MaterialDocumentHeader>> = [MaterialDocumentHeader.MATERIAL_DOCUMENT_YEAR, MaterialDocumentHeader.MATERIAL_DOCUMENT]

All key fields of the MaterialDocumentHeader entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_MATERIAL_DOCUMENT_SRV"

Technical service name for MaterialDocumentHeader.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): this
  • Returns this

getUpdatedProperties

  • getUpdatedProperties(): this
  • Returns all changed properties compared to the last known remote state.

    Returns this

    Entity with all properties that changed

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.

    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

Static builder

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

    Returns MaterialDocumentHeaderRequestBuilder

    A MaterialDocumentHeader request builder.