Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest

Class BillingDocumentRequest

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BillingDocumentRequest>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
public class BillingDocumentRequest extends VdmEntity<BillingDocumentRequest>
Billing Document Request Header

Original entity name from the Odata EDM: A_BillingDocumentRequestType

  • Field Details

    • ALL_FIELDS

      public static final BillingDocumentRequestSelectable ALL_FIELDS
      Selector for all available fields of BillingDocumentRequest.

    • BILLING_DOCUMENT_REQUEST

      public static final BillingDocumentRequestField<String> BILLING_DOCUMENT_REQUEST
      Use with available fluent helpers to apply the BillingDocumentRequest field to query operations.

    • BILLING_DOCUMENT_REQUEST_TYPE

      public static final BillingDocumentRequestField<String> BILLING_DOCUMENT_REQUEST_TYPE
      Use with available fluent helpers to apply the BillingDocumentRequestType field to query operations.

    • PROPOSED_BILLING_DOCUMENT_TYPE

      public static final BillingDocumentRequestField<String> PROPOSED_BILLING_DOCUMENT_TYPE
      Use with available fluent helpers to apply the ProposedBillingDocumentType field to query operations.

    • CREATION_DATE

      public static final BillingDocumentRequestField<LocalDateTime> CREATION_DATE
      Use with available fluent helpers to apply the CreationDate field to query operations.

    • CREATION_TIME

      public static final BillingDocumentRequestField<LocalTime> CREATION_TIME
      Use with available fluent helpers to apply the CreationTime field to query operations.

    • LAST_CHANGE_DATE

      public static final BillingDocumentRequestField<LocalDateTime> LAST_CHANGE_DATE
      Use with available fluent helpers to apply the LastChangeDate field to query operations.

    • LAST_CHANGE_DATE_TIME

      public static final BillingDocumentRequestField<ZonedDateTime> LAST_CHANGE_DATE_TIME
      Use with available fluent helpers to apply the LastChangeDateTime field to query operations.

    • LOGICAL_SYSTEM

      public static final BillingDocumentRequestField<String> LOGICAL_SYSTEM
      Use with available fluent helpers to apply the LogicalSystem field to query operations.

    • SALES_ORGANIZATION

      public static final BillingDocumentRequestField<String> SALES_ORGANIZATION
      Use with available fluent helpers to apply the SalesOrganization field to query operations.

    • DISTRIBUTION_CHANNEL

      public static final BillingDocumentRequestField<String> DISTRIBUTION_CHANNEL
      Use with available fluent helpers to apply the DistributionChannel field to query operations.

    • DIVISION

      public static final BillingDocumentRequestField<String> DIVISION
      Use with available fluent helpers to apply the Division field to query operations.

    • BILLING_DOCUMENT_DATE

      public static final BillingDocumentRequestField<LocalDateTime> BILLING_DOCUMENT_DATE
      Use with available fluent helpers to apply the BillingDocumentDate field to query operations.

    • TOTAL_NET_AMOUNT

      public static final BillingDocumentRequestField<BigDecimal> TOTAL_NET_AMOUNT
      Use with available fluent helpers to apply the TotalNetAmount field to query operations.

    • TRANSACTION_CURRENCY

      public static final BillingDocumentRequestField<String> TRANSACTION_CURRENCY
      Use with available fluent helpers to apply the TransactionCurrency field to query operations.

    • TOTAL_TAX_AMOUNT

      public static final BillingDocumentRequestField<BigDecimal> TOTAL_TAX_AMOUNT
      Use with available fluent helpers to apply the TotalTaxAmount field to query operations.

    • TOTAL_GROSS_AMOUNT

      public static final BillingDocumentRequestField<BigDecimal> TOTAL_GROSS_AMOUNT
      Use with available fluent helpers to apply the TotalGrossAmount field to query operations.

    • TAX_DEPARTURE_COUNTRY

      public static final BillingDocumentRequestField<String> TAX_DEPARTURE_COUNTRY
      Use with available fluent helpers to apply the TaxDepartureCountry field to query operations.

    • PAYER_PARTY

      public static final BillingDocumentRequestField<String> PAYER_PARTY
      Use with available fluent helpers to apply the PayerParty field to query operations.

    • CONTRACT_ACCOUNT

      public static final BillingDocumentRequestField<String> CONTRACT_ACCOUNT
      Use with available fluent helpers to apply the ContractAccount field to query operations.

    • CUSTOMER_PAYMENT_TERMS

      public static final BillingDocumentRequestField<String> CUSTOMER_PAYMENT_TERMS
      Use with available fluent helpers to apply the CustomerPaymentTerms field to query operations.

    • PAYMENT_METHOD

      public static final BillingDocumentRequestField<String> PAYMENT_METHOD
      Use with available fluent helpers to apply the PaymentMethod field to query operations.

    • SEPA_MANDATE

      public static final BillingDocumentRequestField<String> SEPA_MANDATE
      Use with available fluent helpers to apply the SEPAMandate field to query operations.

    • COMPANY_CODE

      public static final BillingDocumentRequestField<String> COMPANY_CODE
      Use with available fluent helpers to apply the CompanyCode field to query operations.

    • REFERENCE_DOCUMENT

      public static final BillingDocumentRequestField<String> REFERENCE_DOCUMENT
      Use with available fluent helpers to apply the ReferenceDocument field to query operations.

    • REFERENCE_DOCUMENT_LOGICAL_SYSTEM

      public static final BillingDocumentRequestField<String> REFERENCE_DOCUMENT_LOGICAL_SYSTEM
      Use with available fluent helpers to apply the ReferenceDocumentLogicalSystem field to query operations.

    • REFERENCE_DOC_SD_DOC_CATEGORY

      public static final BillingDocumentRequestField<String> REFERENCE_DOC_SD_DOC_CATEGORY
      Use with available fluent helpers to apply the ReferenceDocSDDocCategory field to query operations.

    • SOLD_TO_PARTY

      public static final BillingDocumentRequestField<String> SOLD_TO_PARTY
      Use with available fluent helpers to apply the SoldToParty field to query operations.

    • PURCHASE_ORDER_BY_CUSTOMER

      public static final BillingDocumentRequestField<String> PURCHASE_ORDER_BY_CUSTOMER
      Use with available fluent helpers to apply the PurchaseOrderByCustomer field to query operations.

    • PRICING_DOCUMENT

      public static final BillingDocumentRequestField<String> PRICING_DOCUMENT
      Use with available fluent helpers to apply the PricingDocument field to query operations.

    • BILLING_ISSUE_TYPE

      public static final BillingDocumentRequestField<String> BILLING_ISSUE_TYPE
      Use with available fluent helpers to apply the BillingIssueType field to query operations.

    • INCOTERMS_VERSION

      public static final BillingDocumentRequestField<String> INCOTERMS_VERSION
      Use with available fluent helpers to apply the IncotermsVersion field to query operations.

    • INCOTERMS_CLASSIFICATION

      public static final BillingDocumentRequestField<String> INCOTERMS_CLASSIFICATION
      Use with available fluent helpers to apply the IncotermsClassification field to query operations.

    • INCOTERMS_TRANSFER_LOCATION

      public static final BillingDocumentRequestField<String> INCOTERMS_TRANSFER_LOCATION
      Use with available fluent helpers to apply the IncotermsTransferLocation field to query operations.

    • INCOTERMS_LOCATION1

      public static final BillingDocumentRequestField<String> INCOTERMS_LOCATION1
      Use with available fluent helpers to apply the IncotermsLocation1 field to query operations.

    • INCOTERMS_LOCATION2

      public static final BillingDocumentRequestField<String> INCOTERMS_LOCATION2
      Use with available fluent helpers to apply the IncotermsLocation2 field to query operations.

    • OVERALL_BILLING_DOC_REQ_STATUS

      public static final BillingDocumentRequestField<String> OVERALL_BILLING_DOC_REQ_STATUS
      Use with available fluent helpers to apply the OverallBillingDocReqStatus field to query operations.

    • OVERALL_PRICING_INCOMPLETION_STS

      public static final BillingDocumentRequestField<String> OVERALL_PRICING_INCOMPLETION_STS
      Use with available fluent helpers to apply the OverallPricingIncompletionSts field to query operations.

    • TO_ITEM

      public static final BillingDocumentRequestLink<BillingDocumentRequestItem> TO_ITEM
      Use with available fluent helpers to apply the to_Item navigation property to query operations.

    • TO_PARTNER

      public static final BillingDocumentRequestLink<BillingDocReqPartner> TO_PARTNER
      Use with available fluent helpers to apply the to_Partner navigation property to query operations.

    • TO_PRICING_ELEMENT

      public static final BillingDocumentRequestLink<BillingDocReqPrcgElmnt> TO_PRICING_ELEMENT
      Use with available fluent helpers to apply the to_PricingElement navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setBillingDocumentRequest

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

      Original property name from the Odata EDM: BillingDocumentRequest

      Parameters:
      billingDocumentRequest - Billing Document Request

    • setBillingDocumentRequestType

      public void setBillingDocumentRequestType(@Nullable String billingDocumentRequestType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: BillingDocumentRequestType

      Parameters:
      billingDocumentRequestType - Billing Document Request Type

    • setProposedBillingDocumentType

      public void setProposedBillingDocumentType(@Nullable String proposedBillingDocumentType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: ProposedBillingDocumentType

      Parameters:
      proposedBillingDocumentType - Proposed Billing Document Type

    • setCreationDate

      public void setCreationDate(@Nullable LocalDateTime creationDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationDate

      Parameters:
      creationDate - Record Created On

    • setCreationTime

      public void setCreationTime(@Nullable LocalTime creationTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationTime

      Parameters:
      creationTime - Entry time

    • setLastChangeDate

      public void setLastChangeDate(@Nullable LocalDateTime lastChangeDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDate

      Parameters:
      lastChangeDate - Last Changed On

    • setLastChangeDateTime

      public void setLastChangeDateTime(@Nullable ZonedDateTime lastChangeDateTime)
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: LastChangeDateTime

      Parameters:
      lastChangeDateTime - UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun)

    • setLogicalSystem

      public void setLogicalSystem(@Nullable String logicalSystem)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: LogicalSystem

      Parameters:
      logicalSystem - Logical System

    • 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

    • setBillingDocumentDate

      public void setBillingDocumentDate(@Nullable LocalDateTime billingDocumentDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BillingDocumentDate

      Parameters:
      billingDocumentDate - Billing Date

    • setTotalNetAmount

      public void setTotalNetAmount(@Nullable BigDecimal totalNetAmount)
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: TotalNetAmount

      Parameters:
      totalNetAmount - Net Value in Document Currency

    • setTransactionCurrency

      public void setTransactionCurrency(@Nullable String transactionCurrency)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: TransactionCurrency

      Parameters:
      transactionCurrency - SD Document Currency

    • setTotalTaxAmount

      public void setTotalTaxAmount(@Nullable BigDecimal totalTaxAmount)
      Constraints: Not nullable, Precision: 14, Scale: 3

      Original property name from the Odata EDM: TotalTaxAmount

      Parameters:
      totalTaxAmount - Tax Amount in Document Currency

    • setTotalGrossAmount

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

      Original property name from the Odata EDM: TotalGrossAmount

      Parameters:
      totalGrossAmount - The totalGrossAmount to set.

    • 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

    • setPayerParty

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

      Original property name from the Odata EDM: PayerParty

      Parameters:
      payerParty - Payer

    • setContractAccount

      public void setContractAccount(@Nullable String contractAccount)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ContractAccount

      Parameters:
      contractAccount - Contract Account Number

    • 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

    • setPaymentMethod

      public void setPaymentMethod(@Nullable String paymentMethod)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentMethod

      Parameters:
      paymentMethod - Payment Method

    • setSEPAMandate

      public void setSEPAMandate(@Nullable String sEPAMandate)
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: SEPAMandate

      Parameters:
      sEPAMandate - Unique Reference to Mandate for each Payee

    • setCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Parameters:
      companyCode - Company Code

    • setReferenceDocument

      public void setReferenceDocument(@Nullable String referenceDocument)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReferenceDocument

      Parameters:
      referenceDocument - Source document of data contained in billing doc. request

    • setReferenceDocumentLogicalSystem

      public void setReferenceDocumentLogicalSystem(@Nullable String referenceDocumentLogicalSystem)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReferenceDocumentLogicalSystem

      Parameters:
      referenceDocumentLogicalSystem - Source system of the data contained in the billing doc. req.

    • setReferenceDocSDDocCategory

      public void setReferenceDocSDDocCategory(@Nullable String referenceDocSDDocCategory)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: ReferenceDocSDDocCategory

      Parameters:
      referenceDocSDDocCategory - Source Document Category

    • setSoldToParty

      public void setSoldToParty(@Nullable String soldToParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: SoldToParty

      Parameters:
      soldToParty - Sold-to Party

    • setPurchaseOrderByCustomer

      public void setPurchaseOrderByCustomer(@Nullable String purchaseOrderByCustomer)
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: PurchaseOrderByCustomer

      Parameters:
      purchaseOrderByCustomer - Customer Reference

    • setPricingDocument

      public void setPricingDocument(@Nullable String pricingDocument)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PricingDocument

      Parameters:
      pricingDocument - Number of the Document Condition

    • setBillingIssueType

      public void setBillingIssueType(@Nullable String billingIssueType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BillingIssueType

      Parameters:
      billingIssueType - Billing Issue Type

    • setIncotermsVersion

      public void setIncotermsVersion(@Nullable String incotermsVersion)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: IncotermsVersion

      Parameters:
      incotermsVersion - Incoterms Version

    • setIncotermsClassification

      public void setIncotermsClassification(@Nullable String incotermsClassification)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: IncotermsClassification

      Parameters:
      incotermsClassification - Incoterms (Part 1)

    • setIncotermsTransferLocation

      public void setIncotermsTransferLocation(@Nullable String incotermsTransferLocation)
      Constraints: Not nullable, Maximum length: 28

      Original property name from the Odata EDM: IncotermsTransferLocation

      Parameters:
      incotermsTransferLocation - Incoterms (Part 2)

    • setIncotermsLocation1

      public void setIncotermsLocation1(@Nullable String incotermsLocation1)
      Constraints: Not nullable, Maximum length: 70

      Original property name from the Odata EDM: IncotermsLocation1

      Parameters:
      incotermsLocation1 - Incoterms Location 1

    • setIncotermsLocation2

      public void setIncotermsLocation2(@Nullable String incotermsLocation2)
      Constraints: Not nullable, Maximum length: 70

      Original property name from the Odata EDM: IncotermsLocation2

      Parameters:
      incotermsLocation2 - Incoterms Location 2

    • setOverallBillingDocReqStatus

      public void setOverallBillingDocReqStatus(@Nullable String overallBillingDocReqStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: OverallBillingDocReqStatus

      Parameters:
      overallBillingDocReqStatus - Billing Document Request Status

    • setOverallPricingIncompletionSts

      public void setOverallPricingIncompletionSts(@Nullable String overallPricingIncompletionSts)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: OverallPricingIncompletionSts

      Parameters:
      overallPricingIncompletionSts - Pricing Incompletion Status (All Items)

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BillingDocumentRequestField<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> BillingDocumentRequestField<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<T, DomainT> 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.

    • getDestinationForFetch

      @Nullable public HttpDestinationProperties getDestinationForFetch()
      Overrides:
      getDestinationForFetch in class VdmEntity<BillingDocumentRequest>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<BillingDocumentRequest>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<BillingDocumentRequest>

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchItem

      @Nonnull public List<BillingDocumentRequestItem> fetchItem()
      Fetches the BillingDocumentRequestItem entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Item.

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

      Returns:
      List containing one or more associated BillingDocumentRequestItem entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getItemOrFetch

      @Nonnull public List<BillingDocumentRequestItem> getItemOrFetch()
      Retrieval of associated BillingDocumentRequestItem entities (one to many). This corresponds to the OData navigation property to_Item.

      If the navigation property to_Item of a queried BillingDocumentRequest 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 BillingDocumentRequestItem entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getItemIfPresent

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

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

    • setItem

      public void setItem(@Nonnull List<BillingDocumentRequestItem> value)
      Overwrites the list of associated BillingDocumentRequestItem entities for the loaded navigation property to_Item.

      If the navigation property to_Item of a queried BillingDocumentRequest 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 BillingDocumentRequestItem entities.

    • addItem

      public void addItem(BillingDocumentRequestItem... entity)
      Adds elements to the list of associated BillingDocumentRequestItem entities. This corresponds to the OData navigation property to_Item.

      If the navigation property to_Item of a queried BillingDocumentRequest 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 BillingDocumentRequestItem entities.

    • fetchPartner

      @Nonnull public List<BillingDocReqPartner> fetchPartner()
      Fetches the BillingDocReqPartner entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Partner.

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

      Returns:
      List containing one or more associated BillingDocReqPartner entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getPartnerOrFetch

      @Nonnull public List<BillingDocReqPartner> getPartnerOrFetch()
      Retrieval of associated BillingDocReqPartner entities (one to many). This corresponds to the OData navigation property to_Partner.

      If the navigation property to_Partner of a queried BillingDocumentRequest 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 BillingDocReqPartner entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getPartnerIfPresent

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

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

    • setPartner

      public void setPartner(@Nonnull List<BillingDocReqPartner> value)
      Overwrites the list of associated BillingDocReqPartner entities for the loaded navigation property to_Partner.

      If the navigation property to_Partner of a queried BillingDocumentRequest 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 BillingDocReqPartner entities.

    • addPartner

      public void addPartner(BillingDocReqPartner... entity)
      Adds elements to the list of associated BillingDocReqPartner entities. This corresponds to the OData navigation property to_Partner.

      If the navigation property to_Partner of a queried BillingDocumentRequest 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 BillingDocReqPartner entities.

    • fetchPricingElement

      @Nonnull public List<BillingDocReqPrcgElmnt> fetchPricingElement()
      Fetches the BillingDocReqPrcgElmnt entities (one to many) associated with this entity. This corresponds to the OData navigation property to_PricingElement.

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

      Returns:
      List containing one or more associated BillingDocReqPrcgElmnt entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getPricingElementOrFetch

      @Nonnull public List<BillingDocReqPrcgElmnt> getPricingElementOrFetch()
      Retrieval of associated BillingDocReqPrcgElmnt entities (one to many). This corresponds to the OData navigation property to_PricingElement.

      If the navigation property to_PricingElement of a queried BillingDocumentRequest 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 BillingDocReqPrcgElmnt entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getPricingElementIfPresent

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

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

    • setPricingElement

      public void setPricingElement(@Nonnull List<BillingDocReqPrcgElmnt> value)
      Overwrites the list of associated BillingDocReqPrcgElmnt entities for the loaded navigation property to_PricingElement.

      If the navigation property to_PricingElement of a queried BillingDocumentRequest 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 BillingDocReqPrcgElmnt entities.

    • addPricingElement

      public void addPricingElement(BillingDocReqPrcgElmnt... entity)
      Adds elements to the list of associated BillingDocReqPrcgElmnt entities. This corresponds to the OData navigation property to_PricingElement.

      If the navigation property to_PricingElement of a queried BillingDocumentRequest 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 BillingDocReqPrcgElmnt entities.

    • builder

      @Nonnull public static BillingDocumentRequest.BillingDocumentRequestBuilder builder()

    • getBillingDocumentRequest

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

      Original property name from the Odata EDM: BillingDocumentRequest

      Returns:
      Billing Document Request

    • getBillingDocumentRequestType

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

      Original property name from the Odata EDM: BillingDocumentRequestType

      Returns:
      Billing Document Request Type

    • getProposedBillingDocumentType

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

      Original property name from the Odata EDM: ProposedBillingDocumentType

      Returns:
      Proposed Billing Document Type

    • getCreationDate

      @Nullable public LocalDateTime getCreationDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationDate

      Returns:
      Record Created On

    • getCreationTime

      @Nullable public LocalTime getCreationTime()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationTime

      Returns:
      Entry time

    • getLastChangeDate

      @Nullable public LocalDateTime getLastChangeDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDate

      Returns:
      Last Changed On

    • getLastChangeDateTime

      @Nullable public ZonedDateTime getLastChangeDateTime()
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: LastChangeDateTime

      Returns:
      UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun)

    • getLogicalSystem

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

      Original property name from the Odata EDM: LogicalSystem

      Returns:
      Logical System

    • 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

    • getBillingDocumentDate

      @Nullable public LocalDateTime getBillingDocumentDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BillingDocumentDate

      Returns:
      Billing Date

    • getTotalNetAmount

      @Nullable public BigDecimal getTotalNetAmount()
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: TotalNetAmount

      Returns:
      Net Value in Document Currency

    • getTransactionCurrency

      @Nullable public String getTransactionCurrency()
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: TransactionCurrency

      Returns:
      SD Document Currency

    • getTotalTaxAmount

      @Nullable public BigDecimal getTotalTaxAmount()
      Constraints: Not nullable, Precision: 14, Scale: 3

      Original property name from the Odata EDM: TotalTaxAmount

      Returns:
      Tax Amount in Document Currency

    • getTotalGrossAmount

      @Nullable public BigDecimal getTotalGrossAmount()
      Constraints: Not nullable, Precision: 17, Scale: 3

      Original property name from the Odata EDM: TotalGrossAmount

      Returns:
      The totalGrossAmount contained in this entity.

    • getTaxDepartureCountry

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

      Original property name from the Odata EDM: TaxDepartureCountry

      Returns:
      Tax Departure Country/Region

    • getPayerParty

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

      Original property name from the Odata EDM: PayerParty

      Returns:
      Payer

    • getContractAccount

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

      Original property name from the Odata EDM: ContractAccount

      Returns:
      Contract Account Number

    • getCustomerPaymentTerms

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

      Original property name from the Odata EDM: CustomerPaymentTerms

      Returns:
      Terms of Payment Key

    • getPaymentMethod

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

      Original property name from the Odata EDM: PaymentMethod

      Returns:
      Payment Method

    • getSEPAMandate

      @Nullable public String getSEPAMandate()
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: SEPAMandate

      Returns:
      Unique Reference to Mandate for each Payee

    • getCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getReferenceDocument

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

      Original property name from the Odata EDM: ReferenceDocument

      Returns:
      Source document of data contained in billing doc. request

    • getReferenceDocumentLogicalSystem

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

      Original property name from the Odata EDM: ReferenceDocumentLogicalSystem

      Returns:
      Source system of the data contained in the billing doc. req.

    • getReferenceDocSDDocCategory

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

      Original property name from the Odata EDM: ReferenceDocSDDocCategory

      Returns:
      Source Document Category

    • getSoldToParty

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

      Original property name from the Odata EDM: SoldToParty

      Returns:
      Sold-to Party

    • getPurchaseOrderByCustomer

      @Nullable public String getPurchaseOrderByCustomer()
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: PurchaseOrderByCustomer

      Returns:
      Customer Reference

    • getPricingDocument

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

      Original property name from the Odata EDM: PricingDocument

      Returns:
      Number of the Document Condition

    • getBillingIssueType

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

      Original property name from the Odata EDM: BillingIssueType

      Returns:
      Billing Issue Type

    • getIncotermsVersion

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

      Original property name from the Odata EDM: IncotermsVersion

      Returns:
      Incoterms Version

    • getIncotermsClassification

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

      Original property name from the Odata EDM: IncotermsClassification

      Returns:
      Incoterms (Part 1)

    • getIncotermsTransferLocation

      @Nullable public String getIncotermsTransferLocation()
      Constraints: Not nullable, Maximum length: 28

      Original property name from the Odata EDM: IncotermsTransferLocation

      Returns:
      Incoterms (Part 2)

    • getIncotermsLocation1

      @Nullable public String getIncotermsLocation1()
      Constraints: Not nullable, Maximum length: 70

      Original property name from the Odata EDM: IncotermsLocation1

      Returns:
      Incoterms Location 1

    • getIncotermsLocation2

      @Nullable public String getIncotermsLocation2()
      Constraints: Not nullable, Maximum length: 70

      Original property name from the Odata EDM: IncotermsLocation2

      Returns:
      Incoterms Location 2

    • getOverallBillingDocReqStatus

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

      Original property name from the Odata EDM: OverallBillingDocReqStatus

      Returns:
      Billing Document Request Status

    • getOverallPricingIncompletionSts

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

      Original property name from the Odata EDM: OverallPricingIncompletionSts

      Returns:
      Pricing Incompletion Status (All Items)

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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