com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument

Class MaterialDocumentHeader

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<MaterialDocumentHeader>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument.MaterialDocumentHeader

public class MaterialDocumentHeader
extends VdmEntity<MaterialDocumentHeader>

API exposure Material Document Header

Original entity name from the Odata EDM: A_MaterialDocumentHeaderType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaterialDocumentHeader.MaterialDocumentHeaderBuilder Helper class to allow for fluent creation of MaterialDocumentHeader instances.

Field Summary

Fields

Modifier and Type	Field and Description
static MaterialDocumentHeaderSelectable	ALL_FIELDS Selector for all available fields of MaterialDocumentHeader.
static MaterialDocumentHeaderField<String>	CREATED_BY_USER Use with available fluent helpers to apply the CreatedByUser field to query operations.
static MaterialDocumentHeaderField<LocalDateTime>	CREATION_DATE Use with available fluent helpers to apply the CreationDate field to query operations.
static MaterialDocumentHeaderField<LocalTime>	CREATION_TIME Use with available fluent helpers to apply the CreationTime field to query operations.
static MaterialDocumentHeaderField<LocalDateTime>	DOCUMENT_DATE Use with available fluent helpers to apply the DocumentDate field to query operations.
static MaterialDocumentHeaderField<String>	GOODS_MOVEMENT_CODE Use with available fluent helpers to apply the GoodsMovementCode field to query operations.
static MaterialDocumentHeaderField<String>	INVENTORY_TRANSACTION_TYPE Use with available fluent helpers to apply the InventoryTransactionType field to query operations.
static MaterialDocumentHeaderField<String>	MATERIAL_DOCUMENT Use with available fluent helpers to apply the MaterialDocument field to query operations.
static MaterialDocumentHeaderField<String>	MATERIAL_DOCUMENT_HEADER_TEXT Use with available fluent helpers to apply the MaterialDocumentHeaderText field to query operations.
static MaterialDocumentHeaderField<String>	MATERIAL_DOCUMENT_YEAR Use with available fluent helpers to apply the MaterialDocumentYear field to query operations.
static MaterialDocumentHeaderField<LocalDateTime>	POSTING_DATE Use with available fluent helpers to apply the PostingDate field to query operations.
static MaterialDocumentHeaderField<String>	REFERENCE_DOCUMENT Use with available fluent helpers to apply the ReferenceDocument field to query operations.
static MaterialDocumentHeaderLink<MaterialDocumentItem>	TO_MATERIAL_DOCUMENT_ITEM Use with available fluent helpers to apply the to_MaterialDocumentItem navigation property to query operations.

Fields inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
MaterialDocumentHeader()
MaterialDocumentHeader(String materialDocumentYear, String materialDocument, String inventoryTransactionType, LocalDateTime documentDate, LocalDateTime postingDate, LocalDateTime creationDate, LocalTime creationTime, String createdByUser, String materialDocumentHeaderText, String referenceDocument, String goodsMovementCode, List<MaterialDocumentItem> toMaterialDocumentItem)

Method Summary

Modifier and Type	Method and Description
void	addMaterialDocumentItem(MaterialDocumentItem... entity) Adds elements to the list of associated MaterialDocumentItem entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static MaterialDocumentHeader.MaterialDocumentHeaderBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<MaterialDocumentItem>	fetchMaterialDocumentItem() Fetches the MaterialDocumentItem entities (one to many) associated with this entity.
static <T> MaterialDocumentHeaderField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> MaterialDocumentHeaderField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
String	getCreatedByUser() Constraints: Not nullable, Maximum length: 12
LocalDateTime	getCreationDate() Constraints: Not nullable, Precision: 0
LocalTime	getCreationTime() Constraints: Not nullable, Precision: 0
protected String	getDefaultServicePath()
LocalDateTime	getDocumentDate() Constraints: Not nullable, Precision: 0
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getGoodsMovementCode() Constraints: Not nullable, Maximum length: 2
String	getInventoryTransactionType() Constraints: Not nullable, Maximum length: 2
protected Map<String,Object>	getKey()
String	getMaterialDocument() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getMaterialDocumentHeaderText() Constraints: Not nullable, Maximum length: 25
Optional<List<MaterialDocumentItem>>	getMaterialDocumentItemIfPresent() Retrieval of associated MaterialDocumentItem entities (one to many).
List<MaterialDocumentItem>	getMaterialDocumentItemOrFetch() Retrieval of associated MaterialDocumentItem entities (one to many).
String	getMaterialDocumentYear() (Key Field) Constraints: Not nullable, Maximum length: 4
LocalDateTime	getPostingDate() Constraints: Not nullable, Precision: 0
String	getReferenceDocument() Constraints: Not nullable, Maximum length: 16
Class<MaterialDocumentHeader>	getType()
int	hashCode()
void	setCreatedByUser(String createdByUser) Constraints: Not nullable, Maximum length: 12
void	setCreationDate(LocalDateTime creationDate) Constraints: Not nullable, Precision: 0
void	setCreationTime(LocalTime creationTime) Constraints: Not nullable, Precision: 0
void	setDocumentDate(LocalDateTime documentDate) Constraints: Not nullable, Precision: 0
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setGoodsMovementCode(String goodsMovementCode) Constraints: Not nullable, Maximum length: 2
void	setInventoryTransactionType(String inventoryTransactionType) Constraints: Not nullable, Maximum length: 2
void	setMaterialDocument(String materialDocument) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setMaterialDocumentHeaderText(String materialDocumentHeaderText) Constraints: Not nullable, Maximum length: 25
void	setMaterialDocumentItem(List<MaterialDocumentItem> value) Overwrites the list of associated MaterialDocumentItem entities for the loaded navigation property to_MaterialDocumentItem.
void	setMaterialDocumentYear(String materialDocumentYear) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setPostingDate(LocalDateTime postingDate) Constraints: Not nullable, Precision: 0
void	setReferenceDocument(String referenceDocument) Constraints: Not nullable, Maximum length: 16
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final MaterialDocumentHeaderSelectable ALL_FIELDS

Selector for all available fields of MaterialDocumentHeader.

MATERIAL_DOCUMENT_YEAR

public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT_YEAR

Use with available fluent helpers to apply the MaterialDocumentYear field to query operations.

MATERIAL_DOCUMENT

public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT

Use with available fluent helpers to apply the MaterialDocument field to query operations.

INVENTORY_TRANSACTION_TYPE

public static final MaterialDocumentHeaderField<String> INVENTORY_TRANSACTION_TYPE

Use with available fluent helpers to apply the InventoryTransactionType field to query operations.

DOCUMENT_DATE

public static final MaterialDocumentHeaderField<LocalDateTime> DOCUMENT_DATE

Use with available fluent helpers to apply the DocumentDate field to query operations.

POSTING_DATE

public static final MaterialDocumentHeaderField<LocalDateTime> POSTING_DATE

Use with available fluent helpers to apply the PostingDate field to query operations.

CREATION_DATE

public static final MaterialDocumentHeaderField<LocalDateTime> CREATION_DATE

Use with available fluent helpers to apply the CreationDate field to query operations.

CREATION_TIME

public static final MaterialDocumentHeaderField<LocalTime> CREATION_TIME

Use with available fluent helpers to apply the CreationTime field to query operations.

CREATED_BY_USER

public static final MaterialDocumentHeaderField<String> CREATED_BY_USER

Use with available fluent helpers to apply the CreatedByUser field to query operations.

MATERIAL_DOCUMENT_HEADER_TEXT

public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT_HEADER_TEXT

Use with available fluent helpers to apply the MaterialDocumentHeaderText field to query operations.

REFERENCE_DOCUMENT

public static final MaterialDocumentHeaderField<String> REFERENCE_DOCUMENT

Use with available fluent helpers to apply the ReferenceDocument field to query operations.

GOODS_MOVEMENT_CODE

public static final MaterialDocumentHeaderField<String> GOODS_MOVEMENT_CODE

Use with available fluent helpers to apply the GoodsMovementCode field to query operations.

TO_MATERIAL_DOCUMENT_ITEM

public static final MaterialDocumentHeaderLink<MaterialDocumentItem> TO_MATERIAL_DOCUMENT_ITEM

Use with available fluent helpers to apply the to_MaterialDocumentItem navigation property to query operations.

Constructor Detail

MaterialDocumentHeader

public MaterialDocumentHeader()

MaterialDocumentHeader

public MaterialDocumentHeader(@Nullable
                              String materialDocumentYear,
                              @Nullable
                              String materialDocument,
                              @Nullable
                              String inventoryTransactionType,
                              @Nullable
                              LocalDateTime documentDate,
                              @Nullable
                              LocalDateTime postingDate,
                              @Nullable
                              LocalDateTime creationDate,
                              @Nullable
                              LocalTime creationTime,
                              @Nullable
                              String createdByUser,
                              @Nullable
                              String materialDocumentHeaderText,
                              @Nullable
                              String referenceDocument,
                              @Nullable
                              String goodsMovementCode,
                              List<MaterialDocumentItem> toMaterialDocumentItem)

Method Detail

getType

@Nonnull
public Class<MaterialDocumentHeader> getType()

Specified by:

getType in class VdmObject<MaterialDocumentHeader>

Returns:

The class of this object.

setMaterialDocumentYear

public void setMaterialDocumentYear(@Nullable
                                    String materialDocumentYear)

(Key Field) Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: MaterialDocumentYear

Parameters:

materialDocumentYear - Material Document Year

setMaterialDocument

public void setMaterialDocument(@Nullable
                                String materialDocument)

(Key Field) Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: MaterialDocument

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.

Parameters:

materialDocument - Alphanumeric key uniquely identifying the document.

setInventoryTransactionType

public void setInventoryTransactionType(@Nullable
                                        String inventoryTransactionType)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: InventoryTransactionType

Parameters:

inventoryTransactionType - Identifier for a certain transaction or event. (Example: GR for "Goods receipt against a purchase order".)

setDocumentDate

public void setDocumentDate(@Nullable
                            LocalDateTime documentDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: DocumentDate

Parameters:

documentDate - The document date is the date on which the original document was issued.

setPostingDate

public void setPostingDate(@Nullable
                           LocalDateTime postingDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: PostingDate

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

Parameters:

postingDate - Date which is used when entering the document in Financial Accounting or Controlling.

setCreationDate

public void setCreationDate(@Nullable
                            LocalDateTime creationDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: CreationDate

Note The posting date can differ from the entry date (date of entry in the system) and the document date.

Parameters:

creationDate - Specifies the date on which the accounting document is entered.

setCreationTime

public void setCreationTime(@Nullable
                            LocalTime creationTime)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: CreationTime

Parameters:

creationTime - Time of Entry

setCreatedByUser

public void setCreatedByUser(@Nullable
                             String createdByUser)

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: CreatedByUser

Parameters:

createdByUser - User Name

setMaterialDocumentHeaderText

public void setMaterialDocumentHeaderText(@Nullable
                                          String materialDocumentHeaderText)

Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: MaterialDocumentHeaderText

Parameters:

materialDocumentHeaderText - The document header text contains explanations or notes which apply to the document as a whole, that is, not only for certain line items.

setReferenceDocument

public void setReferenceDocument(@Nullable
                                 String referenceDocument)

Constraints: Not nullable, Maximum length: 16

Original property name from the Odata EDM: ReferenceDocument

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

Parameters:

referenceDocument - The reference document number can contain the document number of the customer/vendor. However it may contain a different value.

setGoodsMovementCode

public void setGoodsMovementCode(@Nullable
                                 String goodsMovementCode)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: GoodsMovementCode

Parameters:

goodsMovementCode - Goods Movement Code

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<MaterialDocumentHeader>

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<MaterialDocumentHeader>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<MaterialDocumentHeader>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<MaterialDocumentHeader>

field

@Nonnull
public static <T> MaterialDocumentHeaderField<T> field(@Nonnull
                                                                String fieldName,
                                                                @Nonnull
                                                                Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

field

@Nonnull
public static <T,DomainT> MaterialDocumentHeaderField<T> field(@Nonnull
                                                                        String fieldName,
                                                                        @Nonnull
                                                                        TypeConverter<T,DomainT> typeConverter)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

fieldName - The name of the extension field as returned by the OData service.

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<MaterialDocumentHeader>

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Overrides:

setErpConfigContext in class VdmEntity<MaterialDocumentHeader>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<MaterialDocumentHeader>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<MaterialDocumentHeader>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<MaterialDocumentHeader>

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<MaterialDocumentHeader>

fetchMaterialDocumentItem

@Nonnull
public List<MaterialDocumentItem> fetchMaterialDocumentItem()
                                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the MaterialDocumentItem entities (one to many) associated with this entity. This corresponds to the OData navigation property to_MaterialDocumentItem.

Please note: This method will not cache or persist the query results.

Returns:

List containing one or more associated MaterialDocumentItem entities. If no entities are associated then an empty list is returned.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getMaterialDocumentItemOrFetch

@Nonnull
public List<MaterialDocumentItem> getMaterialDocumentItemOrFetch()
                                                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated MaterialDocumentItem entities (one to many). This corresponds to the OData navigation property to_MaterialDocumentItem.

If the navigation property to_MaterialDocumentItem of a queried MaterialDocumentHeader is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Returns:

List of associated MaterialDocumentItem entities.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getMaterialDocumentItemIfPresent

@Nonnull
public Optional<List<MaterialDocumentItem>> getMaterialDocumentItemIfPresent()

Retrieval of associated MaterialDocumentItem entities (one to many). This corresponds to the OData navigation property to_MaterialDocumentItem.

If the navigation property for an entity MaterialDocumentHeader has not been resolved yet, this method will not query further information. Instead its Optional result state will be empty.

Returns:

If the information for navigation property to_MaterialDocumentItem is already loaded, the result will contain the MaterialDocumentItem entities. If not, an Optional with result state empty is returned.

setMaterialDocumentItem

public void setMaterialDocumentItem(@Nonnull
                                    List<MaterialDocumentItem> value)

Overwrites the list of associated MaterialDocumentItem entities for the loaded navigation property to_MaterialDocumentItem.

If the navigation property to_MaterialDocumentItem of a queried MaterialDocumentHeader is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Parameters:

value - List of MaterialDocumentItem entities.

addMaterialDocumentItem

public void addMaterialDocumentItem(MaterialDocumentItem... entity)

Adds elements to the list of associated MaterialDocumentItem entities. This corresponds to the OData navigation property to_MaterialDocumentItem.

If the navigation property to_MaterialDocumentItem of a queried MaterialDocumentHeader is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Parameters:

entity - Array of MaterialDocumentItem entities.

builder

public static MaterialDocumentHeader.MaterialDocumentHeaderBuilder builder()

getMaterialDocumentYear

@Nullable
public String getMaterialDocumentYear()

(Key Field) Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: MaterialDocumentYear

Returns:

Material Document Year

getMaterialDocument

@Nullable
public String getMaterialDocument()

(Key Field) Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: MaterialDocument

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.

Returns:

Alphanumeric key uniquely identifying the document.

getInventoryTransactionType

@Nullable
public String getInventoryTransactionType()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: InventoryTransactionType

Returns:

Identifier for a certain transaction or event. (Example: GR for "Goods receipt against a purchase order".)

getDocumentDate

@Nullable
public LocalDateTime getDocumentDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: DocumentDate

Returns:

The document date is the date on which the original document was issued.

getPostingDate

@Nullable
public LocalDateTime getPostingDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: PostingDate

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

Returns:

Date which is used when entering the document in Financial Accounting or Controlling.

getCreationDate

@Nullable
public LocalDateTime getCreationDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: CreationDate

Note The posting date can differ from the entry date (date of entry in the system) and the document date.

Returns:

Specifies the date on which the accounting document is entered.

getCreationTime

@Nullable
public LocalTime getCreationTime()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: CreationTime

Returns:

Time of Entry

getCreatedByUser

@Nullable
public String getCreatedByUser()

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: CreatedByUser

Returns:

User Name

getMaterialDocumentHeaderText

@Nullable
public String getMaterialDocumentHeaderText()

Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: MaterialDocumentHeaderText

Returns:

The document header text contains explanations or notes which apply to the document as a whole, that is, not only for certain line items.

getReferenceDocument

@Nullable
public String getReferenceDocument()

Constraints: Not nullable, Maximum length: 16

Original property name from the Odata EDM: ReferenceDocument

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

Returns:

The reference document number can contain the document number of the customer/vendor. However it may contain a different value.

getGoodsMovementCode

@Nullable
public String getGoodsMovementCode()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: GoodsMovementCode

Returns:

Goods Movement Code

toString

public String toString()

Overrides:

toString in class VdmObject<MaterialDocumentHeader>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<MaterialDocumentHeader>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<MaterialDocumentHeader>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<MaterialDocumentHeader>