Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.productionrevenueaccountingrevenueaccountingdocument

Class RevenueAccountingHeader

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<RevenueAccountingHeader>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.productionrevenueaccountingrevenueaccountingdocument.RevenueAccountingHeader
All Implemented Interfaces:
VdmEntitySet
public class RevenueAccountingHeader extends VdmEntity<RevenueAccountingHeader> implements VdmEntitySet
Revenue Accounting Header details

Original entity name from the Odata EDM: RevenueAccountingHeader_Type

  • Field Details

  • Constructor Details

  • Method Details

    • getType

      @Nonnull public Class<RevenueAccountingHeader> getType()
      Specified by:
      getType in class VdmObject<RevenueAccountingHeader>

    • setCompanyCode

      public void setCompanyCode(@Nullable String companyCode)
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CompanyCode

      Parameters:
      companyCode - Company Code

    • setPRAAccountingPeriod

      public void setPRAAccountingPeriod(@Nullable String pRAAccountingPeriod)
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: PRAAccountingPeriod

      Parameters:
      pRAAccountingPeriod - PRA Accounting Period

    • setAccountingDocument

      public void setAccountingDocument(@Nullable String accountingDocument)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: AccountingDocument

      Parameters:
      accountingDocument - Revenue Accounting Document Number

    • setDocumentDescription

      public void setDocumentDescription(@Nullable String documentDescription)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: DocumentDescription

      Parameters:
      documentDescription - Document Description

    • setPRAOrigin

      public void setPRAOrigin(@Nullable String pRAOrigin)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRAOrigin

      Parameters:
      pRAOrigin - Application

    • setAccountingDocumentType

      public void setAccountingDocumentType(@Nullable String accountingDocumentType)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: AccountingDocumentType

      Parameters:
      accountingDocumentType - Document Type

    • setOriginReferenceDocument

      public void setOriginReferenceDocument(@Nullable String originReferenceDocument)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: OriginReferenceDocument

      Parameters:
      originReferenceDocument - Source Reference Document (VL,CI,SS,FT)

    • setAccountingDocumentStatus

      public void setAccountingDocumentStatus(@Nullable String accountingDocumentStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: AccountingDocumentStatus

      Parameters:
      accountingDocumentStatus - Accounting Document Status

    • setAccountingDocumentIsReversed

      public void setAccountingDocumentIsReversed(@Nullable Boolean accountingDocumentIsReversed)
      Constraints: Not nullable

      Original property name from the Odata EDM: AccountingDocumentIsReversed

      Parameters:
      accountingDocumentIsReversed - Accounting Reverse Flag

    • setAccountingDocumentCrossCoRef

      public void setAccountingDocumentCrossCoRef(@Nullable String accountingDocumentCrossCoRef)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: AccountingDocumentCrossCoRef

      Parameters:
      accountingDocumentCrossCoRef - Cross Company key for Accounting Document Header

    • setPostingDate

      public void setPostingDate(@Nullable LocalDate postingDate)
      Constraints: Nullable

      Original property name from the Odata EDM: PostingDate

      Parameters:
      postingDate - Accounting Document Posting Date

    • setDocumentDate

      public void setDocumentDate(@Nullable LocalDate documentDate)
      Constraints: Nullable

      Original property name from the Odata EDM: DocumentDate

      Parameters:
      documentDate - Document Date

    • setTotalDebitAmount

      public void setTotalDebitAmount(@Nullable BigDecimal totalDebitAmount)
      Constraints: Not nullable, Precision: 13, Scale: 0

      Original property name from the Odata EDM: TotalDebitAmount

      Parameters:
      totalDebitAmount - Debit Amount

    • setTotalCreditAmount

      public void setTotalCreditAmount(@Nullable BigDecimal totalCreditAmount)
      Constraints: Not nullable, Precision: 13, Scale: 0

      Original property name from the Odata EDM: TotalCreditAmount

      Parameters:
      totalCreditAmount - Credit Amount

    • setTotalStatisticalAmount

      public void setTotalStatisticalAmount(@Nullable BigDecimal totalStatisticalAmount)
      Constraints: Not nullable, Precision: 13, Scale: 0

      Original property name from the Odata EDM: TotalStatisticalAmount

      Parameters:
      totalStatisticalAmount - Statitical Amount

    • setCompanyCodeCurrency

      public void setCompanyCodeCurrency(@Nullable String companyCodeCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: CompanyCodeCurrency

      Parameters:
      companyCodeCurrency - Currency Key

    • setCreatedByUser

      public void setCreatedByUser(@Nullable String createdByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Parameters:
      createdByUser - Created By

    • setCreationDateTime

      public void setCreationDateTime(@Nullable OffsetDateTime creationDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: CreationDateTime

      Parameters:
      creationDateTime - Created On Timestamp

    • setLastChangedByUser

      public void setLastChangedByUser(@Nullable String lastChangedByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: LastChangedByUser

      Parameters:
      lastChangedByUser - Changed By

    • setChangedDateTime

      public void setChangedDateTime(@Nullable OffsetDateTime changedDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: ChangedDateTime

      Parameters:
      changedDateTime - Changed On Timestamp

    • setNumberOfItems

      public void setNumberOfItems(@Nullable Integer numberOfItems)
      Constraints: Not nullable

      Original property name from the Odata EDM: NumberOfItems

      Parameters:
      numberOfItems - Number of Items

    • setNumberOfRejectedItems

      public void setNumberOfRejectedItems(@Nullable Integer numberOfRejectedItems)
      Constraints: Not nullable

      Original property name from the Odata EDM: NumberOfRejectedItems

      Parameters:
      numberOfRejectedItems - Number of Rejected Items

    • set_Messages

      public void set_Messages(@Nullable Collection<SAP__Message> _Messages)
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Parameters:
      _Messages - The _Messages to set.

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<RevenueAccountingHeader>

    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<RevenueAccountingHeader>

    • toMapOfFields

      @Nonnull protected Map<String,Object> toMapOfFields()
      Overrides:
      toMapOfFields in class VdmObject<RevenueAccountingHeader>

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<RevenueAccountingHeader>

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<RevenueAccountingHeader>

    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<RevenueAccountingHeader>

    • getPRAAcctgDocDetailIfPresent

      @Nonnull public io.vavr.control.Option<List<RevenueAccountingItems>> getPRAAcctgDocDetailIfPresent()
      Retrieval of associated RevenueAccountingItems entities (one to many). This corresponds to the OData navigation property _PRAAcctgDocDetail.

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

      Returns:
      If the information for navigation property _PRAAcctgDocDetail is already loaded, the result will contain the RevenueAccountingItems entities. If not, an Option with result state empty is returned.

    • setPRAAcctgDocDetail

      public void setPRAAcctgDocDetail(@Nonnull List<RevenueAccountingItems> value)
      Overwrites the list of associated RevenueAccountingItems entities for the loaded navigation property _PRAAcctgDocDetail.

      If the navigation property _PRAAcctgDocDetail of a queried RevenueAccountingHeader 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 RevenueAccountingItems entities.

    • addPRAAcctgDocDetail

      public void addPRAAcctgDocDetail(RevenueAccountingItems... entity)
      Adds elements to the list of associated RevenueAccountingItems entities. This corresponds to the OData navigation property _PRAAcctgDocDetail.

      If the navigation property _PRAAcctgDocDetail of a queried RevenueAccountingHeader 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 RevenueAccountingItems entities.

    • simulateDocument

      @Nonnull public static BoundAction.CollectionToCollection<RevenueAccountingHeader,SimulateWithPRAKeysResult_Type> simulateDocument(@Nonnull String companyCode, @Nonnull String pRAAccountingPeriod, @Nonnull String accountingDocument, @Nonnull String documentDescription, @Nonnull String pRAOrigin, @Nonnull String accountingDocumentType, @Nonnull String originReferenceDocument, @Nonnull Collection<D_PRAAcctgDocDetailSmlteP> _PRAAcctgDocDetail)
      Action that can be applied to a collection of entities of this class.

      Parameters:
      companyCode - Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: CompanyCode

      accountingDocumentType - Constraints: Not nullable, Maximum length: 2

      Original parameter name from the Odata EDM: AccountingDocumentType

      documentDescription - Constraints: Not nullable, Maximum length: 60

      Original parameter name from the Odata EDM: DocumentDescription

      accountingDocument - Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: AccountingDocument

      pRAOrigin - Constraints: Not nullable, Maximum length: 2

      Original parameter name from the Odata EDM: PRAOrigin

      pRAAccountingPeriod - Constraints: Not nullable, Maximum length: 6

      Original parameter name from the Odata EDM: PRAAccountingPeriod

      originReferenceDocument - Constraints: Not nullable, Maximum length: 20

      Original parameter name from the Odata EDM: OriginReferenceDocument

      _PRAAcctgDocDetail - Constraints: Not nullable

      Original parameter name from the Odata EDM: _PRAAcctgDocDetail

      Returns:
      Action object prepared with the given parameters to be applied to a collection of entities of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.

    • builder

      @Nonnull public static RevenueAccountingHeader.RevenueAccountingHeaderBuilder builder()

    • getCompanyCode

      @Nullable public String getCompanyCode()
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getPRAAccountingPeriod

      @Nullable public String getPRAAccountingPeriod()
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: PRAAccountingPeriod

      Returns:
      PRA Accounting Period

    • getAccountingDocument

      @Nullable public String getAccountingDocument()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: AccountingDocument

      Returns:
      Revenue Accounting Document Number

    • getDocumentDescription

      @Nullable public String getDocumentDescription()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: DocumentDescription

      Returns:
      Document Description

    • getPRAOrigin

      @Nullable public String getPRAOrigin()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRAOrigin

      Returns:
      Application

    • getAccountingDocumentType

      @Nullable public String getAccountingDocumentType()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: AccountingDocumentType

      Returns:
      Document Type

    • getOriginReferenceDocument

      @Nullable public String getOriginReferenceDocument()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: OriginReferenceDocument

      Returns:
      Source Reference Document (VL,CI,SS,FT)

    • getAccountingDocumentStatus

      @Nullable public String getAccountingDocumentStatus()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: AccountingDocumentStatus

      Returns:
      Accounting Document Status

    • getAccountingDocumentIsReversed

      @Nullable public Boolean getAccountingDocumentIsReversed()
      Constraints: Not nullable

      Original property name from the Odata EDM: AccountingDocumentIsReversed

      Returns:
      Accounting Reverse Flag

    • getAccountingDocumentCrossCoRef

      @Nullable public String getAccountingDocumentCrossCoRef()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: AccountingDocumentCrossCoRef

      Returns:
      Cross Company key for Accounting Document Header

    • getPostingDate

      @Nullable public LocalDate getPostingDate()
      Constraints: Nullable

      Original property name from the Odata EDM: PostingDate

      Returns:
      Accounting Document Posting Date

    • getDocumentDate

      @Nullable public LocalDate getDocumentDate()
      Constraints: Nullable

      Original property name from the Odata EDM: DocumentDate

      Returns:
      Document Date

    • getTotalDebitAmount

      @Nullable public BigDecimal getTotalDebitAmount()
      Constraints: Not nullable, Precision: 13, Scale: 0

      Original property name from the Odata EDM: TotalDebitAmount

      Returns:
      Debit Amount

    • getTotalCreditAmount

      @Nullable public BigDecimal getTotalCreditAmount()
      Constraints: Not nullable, Precision: 13, Scale: 0

      Original property name from the Odata EDM: TotalCreditAmount

      Returns:
      Credit Amount

    • getTotalStatisticalAmount

      @Nullable public BigDecimal getTotalStatisticalAmount()
      Constraints: Not nullable, Precision: 13, Scale: 0

      Original property name from the Odata EDM: TotalStatisticalAmount

      Returns:
      Statitical Amount

    • getCompanyCodeCurrency

      @Nullable public String getCompanyCodeCurrency()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: CompanyCodeCurrency

      Returns:
      Currency Key

    • getCreatedByUser

      @Nullable public String getCreatedByUser()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      Created By

    • getCreationDateTime

      @Nullable public OffsetDateTime getCreationDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: CreationDateTime

      Returns:
      Created On Timestamp

    • getLastChangedByUser

      @Nullable public String getLastChangedByUser()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: LastChangedByUser

      Returns:
      Changed By

    • getChangedDateTime

      @Nullable public OffsetDateTime getChangedDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: ChangedDateTime

      Returns:
      Changed On Timestamp

    • getNumberOfItems

      @Nullable public Integer getNumberOfItems()
      Constraints: Not nullable

      Original property name from the Odata EDM: NumberOfItems

      Returns:
      Number of Items

    • getNumberOfRejectedItems

      @Nullable public Integer getNumberOfRejectedItems()
      Constraints: Not nullable

      Original property name from the Odata EDM: NumberOfRejectedItems

      Returns:
      Number of Rejected Items

    • get_Messages

      @Nullable public Collection<SAP__Message> get_Messages()
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Returns:
      The _Messages contained in this VdmEntity.

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<RevenueAccountingHeader>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<RevenueAccountingHeader>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<RevenueAccountingHeader>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<RevenueAccountingHeader>

    • getOdataType

      public String getOdataType()
      Specified by:
      getOdataType in class VdmObject<RevenueAccountingHeader>