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.
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 "*".
Physical Inventory Created by User. Maximum length: 12.
Document Date in Document. The document date is the date on which the original document was issued.
Posting Period. Maximum length: 2.
Fiscal Year. Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be. Maximum length: 4.
Special Stock Indicator. Specifies the special stock type. If you need to separately manage certain stock (for example, consignment stock) of a material, the stock type in question is defined using this indicator. Maximum length: 1.
Inventory Transaction Type. Maximum length: 2.
Last Change Timestamp.
Planned Date of Inventory Count. Indicates the date on which the physical inventory count is to take place. The planned count date determines the fiscal year in which the physical inventory document is posted. All other postings involving this document must be effected during this fiscal year.
Physical Inventory Reference. Maximum length: 16.
Status of Adjustment Posting (Inventory Differences). Indicates that differences have been posted for this physical inventory document. Status A means that inventory differences have been posted for some of the items of the physical inventory document only. For these items, the physical inventory has been completed.Status X means that differences have been posted for all items of the physical inventory document. The document can now be archived. Maximum length: 1.
Status of Deletion. Indicates that items of this physical inventory document have been deleted. Status A means that only some items have been deleted.Status X means that all items of the document have been deleted. However, physical deletion of the document is not possible, because inventory differences have been posted for at least one item.The delete status (in conjunction with the adjustment status) is relevant to the archiving of the documents: A document can only be archived after all items have been deleted or all inventory differences have been posted.If an already counted item is still open, you must process this item before you can archive or delete the document. Maximum length: 1.
Book Inventory Freeze.
Count Status. Indicates that items from this physical inventory document have been counted. Status A means that only some items have been counted.Status X means that all items have been counted. Maximum length: 1.
Physical Inventory Document. Maximum length: 10.
Description of Physical Inventory Document. Maximum length: 40.
Grouping Criterion of Physical Inventory Document Item. Indicates the grouping criterion of the items in a physical inventory document. Physical inventory documents can be created so that all items in a document have one common characteristic.The materials of all items in a document belong to material group '001'. The grouping characteristic stored in the document header then has the value '001'. Maximum length: 10.
Type of Grouping Criterion. Specifies the grouping type for the physical inventory document items. Physical inventory documents can be created so that all items in the document have one common characteristic. The field defines which characteristic this is.One of the values of this indicator defines that the materials of all items in a physical inventory document belong to the same material group. Maximum length: 2.
Date of Last Count. Specifies the date of the last physical inventory count. The actual count date must be in the same year as the planned count date.The date of the first entry of count results for a physical inventory document determines the posting period in which all further count results as well as the inventory differences relating to this physical inventory document must be posted.
Physical Inventory Number. Maximum length: 16.
Physical Inventory Type. Maximum length: 1.
Plant. Key uniquely identifying a plant. Maximum length: 4.
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).
Posting Block Due to Physical Inventory. Indicates that no goods movements involving the materials listed in the physical inventory document can be posted for the duration of a physical inventory count. The indicator is set for the affected stocks in each case (storage location stock, batch stock, or special stock) for all associated stock types and is not cancelled until the count results are posted.The indicator remains in the physical document header even if the stock is unblocked through the posting of inventory differences. It then only indicates that a posting block was set for the documents.The blocking indicator can be set in one of two ways:Directly upon entry of the physical inventory document (if the count is to take place immediately)Shortly before the count (if the count is to take place later)You can set the indicator by choosing Physical inventory document -> Change in the header data of the physical inventory document or via batch input.
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.
Storage Location. Number of the storage location in which the material is stored. A plant may contain one or more storage locations. Maximum length: 4.
One-to-many navigation property to the PhysInventoryDocItem entity.
ETag version identifier accessor.
All fields selector.
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 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 representation of the fiscalPeriod property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the fiscalYear property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the inventorySpecialStockType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 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 representation of the physicalInventoryCountStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryDocumentDesc property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryGroupType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryLastCountDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physicalInventoryType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physInventoryPlannedCountDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physInventoryReferenceNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physInvtryAdjustmentPostingSts property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physInvtryDeletionStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the physInvtryDocHasQtySnapshot property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the plant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the postingIsBlockedForPhysInvtry property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the storageLocation property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toPhysicalInventoryDocumentItem for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the PhysInventoryDocHeader entity.
Default url path for the according service.
Technical entity name for PhysInventoryDocHeader.
All key fields of the PhysInventoryDocHeader entity.
Mapping of all key field names to the respective static field property PhysInventoryDocHeader.
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
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.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
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.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
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.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances PhysInventoryDocHeader
.
A builder that constructs instances of entity type PhysInventoryDocHeader
.
Returns a selectable object that allows the selection of custom field in a get request for the entity PhysInventoryDocHeader
.
Name of the custom field to select
A builder that constructs instances of entity type PhysInventoryDocHeader
.
Returns a request builder to construct requests for operations on the PhysInventoryDocHeader
entity type.
A PhysInventoryDocHeader
request builder.
This class represents the entity "A_PhysInventoryDocHeader" of service "API_PHYSICAL_INVENTORY_DOC_SRV". This service is part of the following communication scenarios: Physical Inventory Document Integration (SAP_COM_0107). See https://api.sap.com/api/API_PHYSICAL_INVENTORY_DOC_SRV for more information.