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

Class LockboxClearing

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<LockboxClearing>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.postlockbox.LockboxClearing
public class LockboxClearing extends VdmEntity<LockboxClearing>
Lockbox Payment Advice Item

Original entity name from the Odata EDM: LockboxClearing_Type

  • Field Details

    • ALL_FIELDS

      public static final LockboxClearingSelectable ALL_FIELDS
      Selector for all available fields of LockboxClearing.

    • PAYMENT_ADVICE

      public static final LockboxClearingField<String> PAYMENT_ADVICE
      Use with available fluent helpers to apply the PaymentAdvice field to query operations.

    • PAYMENT_ADVICE_ITEM

      public static final LockboxClearingField<String> PAYMENT_ADVICE_ITEM
      Use with available fluent helpers to apply the PaymentAdviceItem field to query operations.

    • PAYMENT_ADVICE_ACCOUNT

      public static final LockboxClearingField<String> PAYMENT_ADVICE_ACCOUNT
      Use with available fluent helpers to apply the PaymentAdviceAccount field to query operations.

    • PAYMENT_ADVICE_ACCOUNT_TYPE

      public static final LockboxClearingField<String> PAYMENT_ADVICE_ACCOUNT_TYPE
      Use with available fluent helpers to apply the PaymentAdviceAccountType field to query operations.

    • COMPANY_CODE

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

    • LOCKBOX_BATCH_INTERNAL_KEY

      public static final LockboxClearingField<String> LOCKBOX_BATCH_INTERNAL_KEY
      Use with available fluent helpers to apply the LockboxBatchInternalKey field to query operations.

    • LOCKBOX_BATCH_ITEM

      public static final LockboxClearingField<String> LOCKBOX_BATCH_ITEM
      Use with available fluent helpers to apply the LockboxBatchItem field to query operations.

    • LOCKBOX_BATCH

      public static final LockboxClearingField<String> LOCKBOX_BATCH
      Use with available fluent helpers to apply the LockboxBatch field to query operations.

    • PAYMENT_REFERENCE

      public static final LockboxClearingField<String> PAYMENT_REFERENCE
      Use with available fluent helpers to apply the PaymentReference field to query operations.

    • NET_PAYMENT_AMOUNT_IN_PAYT_CURRENCY

      public static final LockboxClearingField<BigDecimal> NET_PAYMENT_AMOUNT_IN_PAYT_CURRENCY
      Use with available fluent helpers to apply the NetPaymentAmountInPaytCurrency field to query operations.

    • DEDUCTION_AMOUNT_IN_PAYT_CURRENCY

      public static final LockboxClearingField<BigDecimal> DEDUCTION_AMOUNT_IN_PAYT_CURRENCY
      Use with available fluent helpers to apply the DeductionAmountInPaytCurrency field to query operations.

    • PAYMENT_DIFFERENCE_REASON

      public static final LockboxClearingField<String> PAYMENT_DIFFERENCE_REASON
      Use with available fluent helpers to apply the PaymentDifferenceReason field to query operations.

    • CURRENCY

      public static final LockboxClearingField<String> CURRENCY
      Use with available fluent helpers to apply the Currency field to query operations.

    • TO_BATCH_ITEM

      public static final LockboxClearingOneToOneLink<LockboxBatchItem> TO_BATCH_ITEM
      Use with available fluent helpers to apply the to_BatchItem navigation property to query operations.

    • TO_ROOT

      public static final LockboxClearingOneToOneLink<LockboxBatch> TO_ROOT
      Use with available fluent helpers to apply the to_Root navigation property to query operations.

  • Constructor Details

    • LockboxClearing

      public LockboxClearing()

    • LockboxClearing

      public LockboxClearing(@Nullable String paymentAdvice, @Nullable String paymentAdviceItem, @Nullable String paymentAdviceAccount, @Nullable String paymentAdviceAccountType, @Nullable String companyCode, @Nullable String lockboxBatchInternalKey, @Nullable String lockboxBatchItem, @Nullable String lockboxBatch, @Nullable String paymentReference, @Nullable BigDecimal netPaymentAmountInPaytCurrency, @Nullable BigDecimal deductionAmountInPaytCurrency, @Nullable String paymentDifferenceReason, @Nullable String currency, @Nullable LockboxBatchItem toBatchItem, @Nullable LockboxBatch toRoot)

  • Method Details

    • getType

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

    • setPaymentAdvice

      public void setPaymentAdvice(@Nullable String paymentAdvice)
      (Key Field) Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: PaymentAdvice

      Parameters:
      paymentAdvice - Payment Advice Number

    • setPaymentAdviceItem

      public void setPaymentAdviceItem(@Nullable String paymentAdviceItem)
      (Key Field) Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: PaymentAdviceItem

      Parameters:
      paymentAdviceItem - Payment Advice Line Item

    • setPaymentAdviceAccount

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

      Original property name from the Odata EDM: PaymentAdviceAccount

      Parameters:
      paymentAdviceAccount - Account Number

    • setPaymentAdviceAccountType

      public void setPaymentAdviceAccountType(@Nullable String paymentAdviceAccountType)
      (Key Field) Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentAdviceAccountType

      Parameters:
      paymentAdviceAccountType - Payment Advice Account Type

    • setCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Parameters:
      companyCode - Company Code

    • setLockboxBatchInternalKey

      public void setLockboxBatchInternalKey(@Nullable String lockboxBatchInternalKey)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: LockboxBatchInternalKey

      Parameters:
      lockboxBatchInternalKey - Short Key for Bank Statement (Surrogate Key)

    • setLockboxBatchItem

      public void setLockboxBatchItem(@Nullable String lockboxBatchItem)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: LockboxBatchItem

      Parameters:
      lockboxBatchItem - Memo Record Number (Line Item Number in Bank Statement)

    • setLockboxBatch

      public void setLockboxBatch(@Nullable String lockboxBatch)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LockboxBatch

      Parameters:
      lockboxBatch - Batch number (bundle number)

    • 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

    • setNetPaymentAmountInPaytCurrency

      public void setNetPaymentAmountInPaytCurrency(@Nullable BigDecimal netPaymentAmountInPaytCurrency)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: NetPaymentAmountInPaytCurrency

      Parameters:
      netPaymentAmountInPaytCurrency - Net Payment Amount with +/- Sign

    • setDeductionAmountInPaytCurrency

      public void setDeductionAmountInPaytCurrency(@Nullable BigDecimal deductionAmountInPaytCurrency)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: DeductionAmountInPaytCurrency

      Parameters:
      deductionAmountInPaytCurrency - Deduction Amount

    • setPaymentDifferenceReason

      public void setPaymentDifferenceReason(@Nullable String paymentDifferenceReason)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: PaymentDifferenceReason

      Parameters:
      paymentDifferenceReason - Reason Code for Payments

    • setCurrency

      public void setCurrency(@Nullable String currency)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: Currency

      Parameters:
      currency - Currency Key

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> LockboxClearingField<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> LockboxClearingField<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<LockboxClearing>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBatchItem

      @Nullable public LockboxBatchItem fetchBatchItem()
      Fetches the LockboxBatchItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_BatchItem.

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

      Returns:
      The single associated LockboxBatchItem entity, or null if an entity is not associated.
      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.

    • getBatchItemOrFetch

      @Nullable public LockboxBatchItem getBatchItemOrFetch()
      Retrieval of associated LockboxBatchItem entity (one to one). This corresponds to the OData navigation property to_BatchItem.

      If the navigation property to_BatchItem of a queried LockboxClearing 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 LockboxBatchItem entity.
      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.

    • getBatchItemIfPresent

      @Nonnull public io.vavr.control.Option<LockboxBatchItem> getBatchItemIfPresent()
      Retrieval of associated LockboxBatchItem entity (one to one). This corresponds to the OData navigation property to_BatchItem.

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

    • setBatchItem

      public void setBatchItem(LockboxBatchItem value)
      Overwrites the associated LockboxBatchItem entity for the loaded navigation property to_BatchItem.
      Parameters:
      value - New LockboxBatchItem entity.

    • fetchRoot

      @Nullable public LockboxBatch fetchRoot()
      Fetches the LockboxBatch entity (one to one) associated with this entity. This corresponds to the OData navigation property to_Root.

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

      Returns:
      The single associated LockboxBatch entity, or null if an entity is not associated.
      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.

    • getRootOrFetch

      @Nullable public LockboxBatch getRootOrFetch()
      Retrieval of associated LockboxBatch entity (one to one). This corresponds to the OData navigation property to_Root.

      If the navigation property to_Root of a queried LockboxClearing 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 LockboxBatch entity.
      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.

    • getRootIfPresent

      @Nonnull public io.vavr.control.Option<LockboxBatch> getRootIfPresent()
      Retrieval of associated LockboxBatch entity (one to one). This corresponds to the OData navigation property to_Root.

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

    • setRoot

      public void setRoot(LockboxBatch value)
      Overwrites the associated LockboxBatch entity for the loaded navigation property to_Root.
      Parameters:
      value - New LockboxBatch entity.

    • builder

      @Nonnull public static LockboxClearing.LockboxClearingBuilder builder()

    • getPaymentAdvice

      @Nullable public String getPaymentAdvice()
      (Key Field) Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: PaymentAdvice

      Returns:
      Payment Advice Number

    • getPaymentAdviceItem

      @Nullable public String getPaymentAdviceItem()
      (Key Field) Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: PaymentAdviceItem

      Returns:
      Payment Advice Line Item

    • getPaymentAdviceAccount

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

      Original property name from the Odata EDM: PaymentAdviceAccount

      Returns:
      Account Number

    • getPaymentAdviceAccountType

      @Nullable public String getPaymentAdviceAccountType()
      (Key Field) Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentAdviceAccountType

      Returns:
      Payment Advice Account Type

    • getCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getLockboxBatchInternalKey

      @Nullable public String getLockboxBatchInternalKey()
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: LockboxBatchInternalKey

      Returns:
      Short Key for Bank Statement (Surrogate Key)

    • getLockboxBatchItem

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

      Original property name from the Odata EDM: LockboxBatchItem

      Returns:
      Memo Record Number (Line Item Number in Bank Statement)

    • getLockboxBatch

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

      Original property name from the Odata EDM: LockboxBatch

      Returns:
      Batch number (bundle number)

    • getPaymentReference

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

      Original property name from the Odata EDM: PaymentReference

      Returns:
      Payment Reference

    • getNetPaymentAmountInPaytCurrency

      @Nullable public BigDecimal getNetPaymentAmountInPaytCurrency()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: NetPaymentAmountInPaytCurrency

      Returns:
      Net Payment Amount with +/- Sign

    • getDeductionAmountInPaytCurrency

      @Nullable public BigDecimal getDeductionAmountInPaytCurrency()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: DeductionAmountInPaytCurrency

      Returns:
      Deduction Amount

    • getPaymentDifferenceReason

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

      Original property name from the Odata EDM: PaymentDifferenceReason

      Returns:
      Reason Code for Payments

    • getCurrency

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

      Original property name from the Odata EDM: Currency

      Returns:
      Currency Key

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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