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

Class SetlDoc

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<SetlDoc>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.settlementdocument.SetlDoc
All Implemented Interfaces:
VdmEntitySet
public class SetlDoc extends VdmEntity<SetlDoc> implements VdmEntitySet
Settlement Document

Original entity name from the Odata EDM: SetlDocType

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setSettlmtDoc

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

      Original property name from the Odata EDM: SettlmtDoc

      Parameters:
      settlmtDoc - Settlement Document Number

    • setSettlmtDocType

      public void setSettlmtDocType(@Nullable String settlmtDocType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SettlmtDocType

      Parameters:
      settlmtDocType - Settlement Document Type

    • setSettlmtProcessType

      public void setSettlmtProcessType(@Nullable String settlmtProcessType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SettlmtProcessType

      Parameters:
      settlmtProcessType - Settlement Process Type

    • setPostingDate

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

      Original property name from the Odata EDM: PostingDate

      Parameters:
      postingDate - Posting Date

    • setInvoicingParty

      public void setInvoicingParty(@Nullable String invoicingParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: InvoicingParty

      Parameters:
      invoicingParty - Different Invoicing Party

    • setPayeeParty

      public void setPayeeParty(@Nullable String payeeParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PayeeParty

      Parameters:
      payeeParty - Payee

    • setBillToParty

      public void setBillToParty(@Nullable String billToParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BillToParty

      Parameters:
      billToParty - Bill-to Party

    • setPayerParty

      public void setPayerParty(@Nullable String payerParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PayerParty

      Parameters:
      payerParty - Payer

    • setPurchasingOrganization

      public void setPurchasingOrganization(@Nullable String purchasingOrganization)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: PurchasingOrganization

      Parameters:
      purchasingOrganization - Purchasing Organization

    • setPurchasingGroup

      public void setPurchasingGroup(@Nullable String purchasingGroup)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: PurchasingGroup

      Parameters:
      purchasingGroup - Purchasing Group

    • setSalesOrganization

      public void setSalesOrganization(@Nullable String salesOrganization)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOrganization

      Parameters:
      salesOrganization - Sales Organization

    • setDistributionChannel

      public void setDistributionChannel(@Nullable String distributionChannel)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: DistributionChannel

      Parameters:
      distributionChannel - Distribution Channel

    • setDivision

      public void setDivision(@Nullable String division)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: Division

      Parameters:
      division - Division

    • setSuplrSettlmtCompanyCode

      public void setSuplrSettlmtCompanyCode(@Nullable String suplrSettlmtCompanyCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SuplrSettlmtCompanyCode

      Parameters:
      suplrSettlmtCompanyCode - Supplier Company Code

    • setCustSettlmtCompanyCode

      public void setCustSettlmtCompanyCode(@Nullable String custSettlmtCompanyCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CustSettlmtCompanyCode

      Parameters:
      custSettlmtCompanyCode - Customer Company Code

    • setDocumentDate

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

      Original property name from the Odata EDM: DocumentDate

      Parameters:
      documentDate - Document Date in Settlement Management Document

    • setDocumentReferenceID

      public void setDocumentReferenceID(@Nullable String documentReferenceID)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: DocumentReferenceID

      Parameters:
      documentReferenceID - Reference Document Number

    • setAssignmentReference

      public void setAssignmentReference(@Nullable String assignmentReference)
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: AssignmentReference

      Parameters:
      assignmentReference - Assignment number

    • setSettlmtDocCurrency

      public void setSettlmtDocCurrency(@Nullable String settlmtDocCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: SettlmtDocCurrency

      Parameters:
      settlmtDocCurrency - Currency of Settlement Document

    • setSettlmtDocCurrencyISOCode

      public void setSettlmtDocCurrencyISOCode(@Nullable String settlmtDocCurrencyISOCode)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: SettlmtDocCurrencyISOCode

      Parameters:
      settlmtDocCurrencyISOCode - ISO Code Currency

    • setExchangeRate

      public void setExchangeRate(@Nullable BigDecimal exchangeRate)
      Constraints: Not nullable, Precision: 9, Scale: 5

      Original property name from the Odata EDM: ExchangeRate

      Parameters:
      exchangeRate - Conversion Rate (Not Converted)

    • setExchangeRateIsFixed

      public void setExchangeRateIsFixed(@Nullable Boolean exchangeRateIsFixed)
      Constraints: Not nullable

      Original property name from the Odata EDM: ExchangeRateIsFixed

      Parameters:
      exchangeRateIsFixed - Indicator for Fixed Exchange Rate

    • setSupplierTotalGrossAmount

      public void setSupplierTotalGrossAmount(@Nullable BigDecimal supplierTotalGrossAmount)
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: SupplierTotalGrossAmount

      Parameters:
      supplierTotalGrossAmount - Total Gross Amount for Supplier in Document Currency

    • setSupplierTotalNetAmount

      public void setSupplierTotalNetAmount(@Nullable BigDecimal supplierTotalNetAmount)
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: SupplierTotalNetAmount

      Parameters:
      supplierTotalNetAmount - Total Net Amount for Supplier in Document Currency

    • setSupplierTotalTaxAmount

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

      Original property name from the Odata EDM: SupplierTotalTaxAmount

      Parameters:
      supplierTotalTaxAmount - Total Tax Amount for Supplier in Document Currency

    • setCustomerTotalGrossAmount

      public void setCustomerTotalGrossAmount(@Nullable BigDecimal customerTotalGrossAmount)
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: CustomerTotalGrossAmount

      Parameters:
      customerTotalGrossAmount - Total Gross Amount for Customer in Document Currency

    • setCustomerTotalNetAmount

      public void setCustomerTotalNetAmount(@Nullable BigDecimal customerTotalNetAmount)
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: CustomerTotalNetAmount

      Parameters:
      customerTotalNetAmount - Total Net Amount for Customer in Document Currency

    • setCustomerTotalTaxAmount

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

      Original property name from the Odata EDM: CustomerTotalTaxAmount

      Parameters:
      customerTotalTaxAmount - Total Tax Amount for Customer in Document Currency

    • setSupplierPaymentTerms

      public void setSupplierPaymentTerms(@Nullable String supplierPaymentTerms)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SupplierPaymentTerms

      Parameters:
      supplierPaymentTerms - Terms of Payment Key for Supplier

    • setSupplierCashDiscount1Days

      public void setSupplierCashDiscount1Days(@Nullable BigDecimal supplierCashDiscount1Days)
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: SupplierCashDiscount1Days

      Parameters:
      supplierCashDiscount1Days - Supplier Cash Discount First Payment in Days

    • setSupplierCashDiscount2Days

      public void setSupplierCashDiscount2Days(@Nullable BigDecimal supplierCashDiscount2Days)
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: SupplierCashDiscount2Days

      Parameters:
      supplierCashDiscount2Days - Supplier Cash Discount Second Payment in Days

    • setSupplierNetPaymentDays

      public void setSupplierNetPaymentDays(@Nullable BigDecimal supplierNetPaymentDays)
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: SupplierNetPaymentDays

      Parameters:
      supplierNetPaymentDays - Supplier Cash Discount Days

    • setSupplierCashDiscount1Percent

      public void setSupplierCashDiscount1Percent(@Nullable BigDecimal supplierCashDiscount1Percent)
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: SupplierCashDiscount1Percent

      Parameters:
      supplierCashDiscount1Percent - Supplier Cash Discount for First Payment in %

    • setSupplierCashDiscount2Percent

      public void setSupplierCashDiscount2Percent(@Nullable BigDecimal supplierCashDiscount2Percent)
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: SupplierCashDiscount2Percent

      Parameters:
      supplierCashDiscount2Percent - Supplier Cash Discount for Second Payment in %

    • setSupplierPaymentMethod

      public void setSupplierPaymentMethod(@Nullable String supplierPaymentMethod)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: SupplierPaymentMethod

      Parameters:
      supplierPaymentMethod - Supplier Payment Method

    • setCustomerPaymentTerms

      public void setCustomerPaymentTerms(@Nullable String customerPaymentTerms)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CustomerPaymentTerms

      Parameters:
      customerPaymentTerms - Terms of Payment Key for Customer

    • setCustomerCashDiscount1Days

      public void setCustomerCashDiscount1Days(@Nullable BigDecimal customerCashDiscount1Days)
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: CustomerCashDiscount1Days

      Parameters:
      customerCashDiscount1Days - Customer Cash Discount First Payment in Days

    • setCustomerCashDiscount2Days

      public void setCustomerCashDiscount2Days(@Nullable BigDecimal customerCashDiscount2Days)
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: CustomerCashDiscount2Days

      Parameters:
      customerCashDiscount2Days - Customer Cash Discount Second Payment in Days

    • setCustomerNetPaymentDays

      public void setCustomerNetPaymentDays(@Nullable BigDecimal customerNetPaymentDays)
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: CustomerNetPaymentDays

      Parameters:
      customerNetPaymentDays - Customer Cash Discount Days

    • setCustomerCashDiscount1Percent

      public void setCustomerCashDiscount1Percent(@Nullable BigDecimal customerCashDiscount1Percent)
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: CustomerCashDiscount1Percent

      Parameters:
      customerCashDiscount1Percent - Customer Cash Discount for First Payment in %

    • setCustomerCashDiscount2Percent

      public void setCustomerCashDiscount2Percent(@Nullable BigDecimal customerCashDiscount2Percent)
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: CustomerCashDiscount2Percent

      Parameters:
      customerCashDiscount2Percent - Custromer Cash Discount for Second Payment in %

    • setCustomerPaymentMethod

      public void setCustomerPaymentMethod(@Nullable String customerPaymentMethod)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CustomerPaymentMethod

      Parameters:
      customerPaymentMethod - Customer Payment Method

    • setSuplrTotEligibleAmtForCshDisc

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

      Original property name from the Odata EDM: SuplrTotEligibleAmtForCshDisc

      Parameters:
      suplrTotEligibleAmtForCshDisc - Total Amount Eligible for Cash Discount of Supplier

    • setCustTotEligibleAmtForCshDisc

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

      Original property name from the Odata EDM: CustTotEligibleAmtForCshDisc

      Parameters:
      custTotEligibleAmtForCshDisc - Total Amount Eligible for Cash Discount of Customer

    • setSettlmtDocIsCanceled

      public void setSettlmtDocIsCanceled(@Nullable Boolean settlmtDocIsCanceled)
      Constraints: Not nullable

      Original property name from the Odata EDM: SettlmtDocIsCanceled

      Parameters:
      settlmtDocIsCanceled - Settlement Document is Reversed

    • setCanceledSettlmtDoc

      public void setCanceledSettlmtDoc(@Nullable String canceledSettlmtDoc)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CanceledSettlmtDoc

      Parameters:
      canceledSettlmtDoc - Reversed Document

    • setSettlmtDocActivityReason

      public void setSettlmtDocActivityReason(@Nullable String settlmtDocActivityReason)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: SettlmtDocActivityReason

      Parameters:
      settlmtDocActivityReason - Header Activity Reason for Document Creation

    • setPaymentReference

      public void setPaymentReference(@Nullable String paymentReference)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: PaymentReference

      Parameters:
      paymentReference - Payment Reference

    • setSettlmtApplSts

      public void setSettlmtApplSts(@Nullable String settlmtApplSts)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SettlmtApplSts

      Parameters:
      settlmtApplSts - Application Status for a Settlement Management Document

    • setSalesOffice

      public void setSalesOffice(@Nullable String salesOffice)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOffice

      Parameters:
      salesOffice - Sales Office

    • setSalesGroup

      public void setSalesGroup(@Nullable String salesGroup)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: SalesGroup

      Parameters:
      salesGroup - Sales Group

    • setSupplierSettlmtBlkgReason

      public void setSupplierSettlmtBlkgReason(@Nullable String supplierSettlmtBlkgReason)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: SupplierSettlmtBlkgReason

      Parameters:
      supplierSettlmtBlkgReason - Reason for Supplier Settlement Block

    • setCustomerSettlmtBlkgReason

      public void setCustomerSettlmtBlkgReason(@Nullable String customerSettlmtBlkgReason)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: CustomerSettlmtBlkgReason

      Parameters:
      customerSettlmtBlkgReason - Reason for Customer Settlement Block

    • setTaxDepartureCountry

      public void setTaxDepartureCountry(@Nullable String taxDepartureCountry)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TaxDepartureCountry

      Parameters:
      taxDepartureCountry - Tax Departure Country/Region

    • setTaxDestinationCountry

      public void setTaxDestinationCountry(@Nullable String taxDestinationCountry)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TaxDestinationCountry

      Parameters:
      taxDestinationCountry - Tax Destination Country/Region

    • setIsEUTriangularDeal

      public void setIsEUTriangularDeal(@Nullable Boolean isEUTriangularDeal)
      Constraints: Not nullable

      Original property name from the Odata EDM: IsEUTriangularDeal

      Parameters:
      isEUTriangularDeal - Indicator: Triangular Deal Within the EU

    • setSupplierVATRegistration

      public void setSupplierVATRegistration(@Nullable String supplierVATRegistration)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: SupplierVATRegistration

      Parameters:
      supplierVATRegistration - Supplier VAT Registration Number

    • setCustomerVATRegistration

      public void setCustomerVATRegistration(@Nullable String customerVATRegistration)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: CustomerVATRegistration

      Parameters:
      customerVATRegistration - Customer VAT Registration Number

    • setTotalGrossAmount

      public void setTotalGrossAmount(@Nullable BigDecimal totalGrossAmount)
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: TotalGrossAmount

      Parameters:
      totalGrossAmount - Gross Amount of Settlement Management Doc. in Doc. Currency

    • 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<SetlDoc>

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getCustomerPricingElementIfPresent

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

      If the navigation property for an entity SetlDoc 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 _CustomerPricingElement is already loaded, the result will contain the CustPricingElement entities. If not, an Option with result state empty is returned.

    • setCustomerPricingElement

      public void setCustomerPricingElement(@Nonnull List<CustPricingElement> value)
      Overwrites the list of associated CustPricingElement entities for the loaded navigation property _CustomerPricingElement.

      If the navigation property _CustomerPricingElement of a queried SetlDoc 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 CustPricingElement entities.

    • addCustomerPricingElement

      public void addCustomerPricingElement(CustPricingElement... entity)
      Adds elements to the list of associated CustPricingElement entities. This corresponds to the OData navigation property _CustomerPricingElement.

      If the navigation property _CustomerPricingElement of a queried SetlDoc 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 CustPricingElement entities.

    • getSettlmtDocItemIfPresent

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

      If the navigation property for an entity SetlDoc 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 _SettlmtDocItem is already loaded, the result will contain the SetlDocItm entities. If not, an Option with result state empty is returned.

    • setSettlmtDocItem

      public void setSettlmtDocItem(@Nonnull List<SetlDocItm> value)
      Overwrites the list of associated SetlDocItm entities for the loaded navigation property _SettlmtDocItem.

      If the navigation property _SettlmtDocItem of a queried SetlDoc 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 SetlDocItm entities.

    • addSettlmtDocItem

      public void addSettlmtDocItem(SetlDocItm... entity)
      Adds elements to the list of associated SetlDocItm entities. This corresponds to the OData navigation property _SettlmtDocItem.

      If the navigation property _SettlmtDocItem of a queried SetlDoc 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 SetlDocItm entities.

    • getSettlmtDocPartnerIfPresent

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

      If the navigation property for an entity SetlDoc 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 _SettlmtDocPartner is already loaded, the result will contain the SettlementDocumentPartner entities. If not, an Option with result state empty is returned.

    • setSettlmtDocPartner

      public void setSettlmtDocPartner(@Nonnull List<SettlementDocumentPartner> value)
      Overwrites the list of associated SettlementDocumentPartner entities for the loaded navigation property _SettlmtDocPartner.

      If the navigation property _SettlmtDocPartner of a queried SetlDoc 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 SettlementDocumentPartner entities.

    • addSettlmtDocPartner

      public void addSettlmtDocPartner(SettlementDocumentPartner... entity)
      Adds elements to the list of associated SettlementDocumentPartner entities. This corresponds to the OData navigation property _SettlmtDocPartner.

      If the navigation property _SettlmtDocPartner of a queried SetlDoc 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 SettlementDocumentPartner entities.

    • getSupplierPricingElementIfPresent

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

      If the navigation property for an entity SetlDoc 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 _SupplierPricingElement is already loaded, the result will contain the SuplrPricingElement entities. If not, an Option with result state empty is returned.

    • setSupplierPricingElement

      public void setSupplierPricingElement(@Nonnull List<SuplrPricingElement> value)
      Overwrites the list of associated SuplrPricingElement entities for the loaded navigation property _SupplierPricingElement.

      If the navigation property _SupplierPricingElement of a queried SetlDoc 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 SuplrPricingElement entities.

    • addSupplierPricingElement

      public void addSupplierPricingElement(SuplrPricingElement... entity)
      Adds elements to the list of associated SuplrPricingElement entities. This corresponds to the OData navigation property _SupplierPricingElement.

      If the navigation property _SupplierPricingElement of a queried SetlDoc 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 SuplrPricingElement entities.

    • completeSettlmtDoc

      @Nonnull public static BoundAction.SingleToSingle<SetlDoc,Void> completeSettlmtDoc()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • revokeCompletionSettlmtDoc

      @Nonnull public static BoundAction.SingleToSingle<SetlDoc,Void> revokeCompletionSettlmtDoc()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • release

      @Nonnull public static BoundAction.SingleToSingle<SetlDoc,Void> release()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • reverse

      @Nonnull public static BoundAction.SingleToSingle<SetlDoc,Void> reverse()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • builder

      @Nonnull public static SetlDoc.SetlDocBuilder builder()

    • getSettlmtDoc

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

      Original property name from the Odata EDM: SettlmtDoc

      Returns:
      Settlement Document Number

    • getSettlmtDocType

      @Nullable public String getSettlmtDocType()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SettlmtDocType

      Returns:
      Settlement Document Type

    • getSettlmtProcessType

      @Nullable public String getSettlmtProcessType()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SettlmtProcessType

      Returns:
      Settlement Process Type

    • getPostingDate

      @Nullable public LocalDate getPostingDate()
      Constraints: Nullable

      Original property name from the Odata EDM: PostingDate

      Returns:
      Posting Date

    • getInvoicingParty

      @Nullable public String getInvoicingParty()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: InvoicingParty

      Returns:
      Different Invoicing Party

    • getPayeeParty

      @Nullable public String getPayeeParty()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PayeeParty

      Returns:
      Payee

    • getBillToParty

      @Nullable public String getBillToParty()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BillToParty

      Returns:
      Bill-to Party

    • getPayerParty

      @Nullable public String getPayerParty()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PayerParty

      Returns:
      Payer

    • getPurchasingOrganization

      @Nullable public String getPurchasingOrganization()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: PurchasingOrganization

      Returns:
      Purchasing Organization

    • getPurchasingGroup

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

      Original property name from the Odata EDM: PurchasingGroup

      Returns:
      Purchasing Group

    • getSalesOrganization

      @Nullable public String getSalesOrganization()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOrganization

      Returns:
      Sales Organization

    • getDistributionChannel

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

      Original property name from the Odata EDM: DistributionChannel

      Returns:
      Distribution Channel

    • getDivision

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

      Original property name from the Odata EDM: Division

      Returns:
      Division

    • getSuplrSettlmtCompanyCode

      @Nullable public String getSuplrSettlmtCompanyCode()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SuplrSettlmtCompanyCode

      Returns:
      Supplier Company Code

    • getCustSettlmtCompanyCode

      @Nullable public String getCustSettlmtCompanyCode()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CustSettlmtCompanyCode

      Returns:
      Customer Company Code

    • getDocumentDate

      @Nullable public LocalDate getDocumentDate()
      Constraints: Nullable

      Original property name from the Odata EDM: DocumentDate

      Returns:
      Document Date in Settlement Management Document

    • getDocumentReferenceID

      @Nullable public String getDocumentReferenceID()
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: DocumentReferenceID

      Returns:
      Reference Document Number

    • getAssignmentReference

      @Nullable public String getAssignmentReference()
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: AssignmentReference

      Returns:
      Assignment number

    • getSettlmtDocCurrency

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

      Original property name from the Odata EDM: SettlmtDocCurrency

      Returns:
      Currency of Settlement Document

    • getSettlmtDocCurrencyISOCode

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

      Original property name from the Odata EDM: SettlmtDocCurrencyISOCode

      Returns:
      ISO Code Currency

    • getExchangeRate

      @Nullable public BigDecimal getExchangeRate()
      Constraints: Not nullable, Precision: 9, Scale: 5

      Original property name from the Odata EDM: ExchangeRate

      Returns:
      Conversion Rate (Not Converted)

    • getExchangeRateIsFixed

      @Nullable public Boolean getExchangeRateIsFixed()
      Constraints: Not nullable

      Original property name from the Odata EDM: ExchangeRateIsFixed

      Returns:
      Indicator for Fixed Exchange Rate

    • getSupplierTotalGrossAmount

      @Nullable public BigDecimal getSupplierTotalGrossAmount()
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: SupplierTotalGrossAmount

      Returns:
      Total Gross Amount for Supplier in Document Currency

    • getSupplierTotalNetAmount

      @Nullable public BigDecimal getSupplierTotalNetAmount()
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: SupplierTotalNetAmount

      Returns:
      Total Net Amount for Supplier in Document Currency

    • getSupplierTotalTaxAmount

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

      Original property name from the Odata EDM: SupplierTotalTaxAmount

      Returns:
      Total Tax Amount for Supplier in Document Currency

    • getCustomerTotalGrossAmount

      @Nullable public BigDecimal getCustomerTotalGrossAmount()
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: CustomerTotalGrossAmount

      Returns:
      Total Gross Amount for Customer in Document Currency

    • getCustomerTotalNetAmount

      @Nullable public BigDecimal getCustomerTotalNetAmount()
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: CustomerTotalNetAmount

      Returns:
      Total Net Amount for Customer in Document Currency

    • getCustomerTotalTaxAmount

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

      Original property name from the Odata EDM: CustomerTotalTaxAmount

      Returns:
      Total Tax Amount for Customer in Document Currency

    • getSupplierPaymentTerms

      @Nullable public String getSupplierPaymentTerms()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SupplierPaymentTerms

      Returns:
      Terms of Payment Key for Supplier

    • getSupplierCashDiscount1Days

      @Nullable public BigDecimal getSupplierCashDiscount1Days()
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: SupplierCashDiscount1Days

      Returns:
      Supplier Cash Discount First Payment in Days

    • getSupplierCashDiscount2Days

      @Nullable public BigDecimal getSupplierCashDiscount2Days()
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: SupplierCashDiscount2Days

      Returns:
      Supplier Cash Discount Second Payment in Days

    • getSupplierNetPaymentDays

      @Nullable public BigDecimal getSupplierNetPaymentDays()
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: SupplierNetPaymentDays

      Returns:
      Supplier Cash Discount Days

    • getSupplierCashDiscount1Percent

      @Nullable public BigDecimal getSupplierCashDiscount1Percent()
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: SupplierCashDiscount1Percent

      Returns:
      Supplier Cash Discount for First Payment in %

    • getSupplierCashDiscount2Percent

      @Nullable public BigDecimal getSupplierCashDiscount2Percent()
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: SupplierCashDiscount2Percent

      Returns:
      Supplier Cash Discount for Second Payment in %

    • getSupplierPaymentMethod

      @Nullable public String getSupplierPaymentMethod()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: SupplierPaymentMethod

      Returns:
      Supplier Payment Method

    • getCustomerPaymentTerms

      @Nullable public String getCustomerPaymentTerms()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CustomerPaymentTerms

      Returns:
      Terms of Payment Key for Customer

    • getCustomerCashDiscount1Days

      @Nullable public BigDecimal getCustomerCashDiscount1Days()
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: CustomerCashDiscount1Days

      Returns:
      Customer Cash Discount First Payment in Days

    • getCustomerCashDiscount2Days

      @Nullable public BigDecimal getCustomerCashDiscount2Days()
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: CustomerCashDiscount2Days

      Returns:
      Customer Cash Discount Second Payment in Days

    • getCustomerNetPaymentDays

      @Nullable public BigDecimal getCustomerNetPaymentDays()
      Constraints: Not nullable, Precision: 3

      Original property name from the Odata EDM: CustomerNetPaymentDays

      Returns:
      Customer Cash Discount Days

    • getCustomerCashDiscount1Percent

      @Nullable public BigDecimal getCustomerCashDiscount1Percent()
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: CustomerCashDiscount1Percent

      Returns:
      Customer Cash Discount for First Payment in %

    • getCustomerCashDiscount2Percent

      @Nullable public BigDecimal getCustomerCashDiscount2Percent()
      Constraints: Not nullable, Precision: 5, Scale: 3

      Original property name from the Odata EDM: CustomerCashDiscount2Percent

      Returns:
      Custromer Cash Discount for Second Payment in %

    • getCustomerPaymentMethod

      @Nullable public String getCustomerPaymentMethod()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CustomerPaymentMethod

      Returns:
      Customer Payment Method

    • getSuplrTotEligibleAmtForCshDisc

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

      Original property name from the Odata EDM: SuplrTotEligibleAmtForCshDisc

      Returns:
      Total Amount Eligible for Cash Discount of Supplier

    • getCustTotEligibleAmtForCshDisc

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

      Original property name from the Odata EDM: CustTotEligibleAmtForCshDisc

      Returns:
      Total Amount Eligible for Cash Discount of Customer

    • getSettlmtDocIsCanceled

      @Nullable public Boolean getSettlmtDocIsCanceled()
      Constraints: Not nullable

      Original property name from the Odata EDM: SettlmtDocIsCanceled

      Returns:
      Settlement Document is Reversed

    • getCanceledSettlmtDoc

      @Nullable public String getCanceledSettlmtDoc()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CanceledSettlmtDoc

      Returns:
      Reversed Document

    • getSettlmtDocActivityReason

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

      Original property name from the Odata EDM: SettlmtDocActivityReason

      Returns:
      Header Activity Reason for Document Creation

    • getPaymentReference

      @Nullable public String getPaymentReference()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: PaymentReference

      Returns:
      Payment Reference

    • getSettlmtApplSts

      @Nullable public String getSettlmtApplSts()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SettlmtApplSts

      Returns:
      Application Status for a Settlement Management Document

    • getSalesOffice

      @Nullable public String getSalesOffice()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOffice

      Returns:
      Sales Office

    • getSalesGroup

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

      Original property name from the Odata EDM: SalesGroup

      Returns:
      Sales Group

    • getSupplierSettlmtBlkgReason

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

      Original property name from the Odata EDM: SupplierSettlmtBlkgReason

      Returns:
      Reason for Supplier Settlement Block

    • getCustomerSettlmtBlkgReason

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

      Original property name from the Odata EDM: CustomerSettlmtBlkgReason

      Returns:
      Reason for Customer Settlement Block

    • getTaxDepartureCountry

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

      Original property name from the Odata EDM: TaxDepartureCountry

      Returns:
      Tax Departure Country/Region

    • getTaxDestinationCountry

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

      Original property name from the Odata EDM: TaxDestinationCountry

      Returns:
      Tax Destination Country/Region

    • getIsEUTriangularDeal

      @Nullable public Boolean getIsEUTriangularDeal()
      Constraints: Not nullable

      Original property name from the Odata EDM: IsEUTriangularDeal

      Returns:
      Indicator: Triangular Deal Within the EU

    • getSupplierVATRegistration

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

      Original property name from the Odata EDM: SupplierVATRegistration

      Returns:
      Supplier VAT Registration Number

    • getCustomerVATRegistration

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

      Original property name from the Odata EDM: CustomerVATRegistration

      Returns:
      Customer VAT Registration Number

    • getTotalGrossAmount

      @Nullable public BigDecimal getTotalGrossAmount()
      Constraints: Not nullable, Precision: 15, Scale: 0

      Original property name from the Odata EDM: TotalGrossAmount

      Returns:
      Gross Amount of Settlement Management Doc. in Doc. Currency

    • 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<SetlDoc>

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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