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

Class BR_NFePayment

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BR_NFePayment>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.brazilnotafiscal.BR_NFePayment
public class BR_NFePayment extends VdmEntity<BR_NFePayment>
Brazil Nota Fiscal Payment

Original entity name from the Odata EDM: A_BR_NFePaymentType

  • Field Details

    • ALL_FIELDS

      public static final BR_NFePaymentSelectable ALL_FIELDS
      Selector for all available fields of BR_NFePayment.

    • BR_NOTA_FISCAL

      public static final BR_NFePaymentField<String> BR_NOTA_FISCAL
      Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.

    • SEQUENCE_NUMBER

      public static final BR_NFePaymentField<String> SEQUENCE_NUMBER
      Use with available fluent helpers to apply the SequenceNumber field to query operations.

    • PAYMENT_METHOD

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

    • PAYMENT_AMOUNT

      public static final BR_NFePaymentField<BigDecimal> PAYMENT_AMOUNT
      Use with available fluent helpers to apply the PaymentAmount field to query operations.

    • PAYMENT_SYSTEM_INTEGRATION_TYPE

      public static final BR_NFePaymentField<String> PAYMENT_SYSTEM_INTEGRATION_TYPE
      Use with available fluent helpers to apply the PaymentSystemIntegrationType field to query operations.

    • BR_CREDIT_CARD_COMPANY_CNPJ

      public static final BR_NFePaymentField<String> BR_CREDIT_CARD_COMPANY_CNPJ
      Use with available fluent helpers to apply the BR_CreditCardCompanyCNPJ field to query operations.

    • CREDIT_CARD_BRAND

      public static final BR_NFePaymentField<String> CREDIT_CARD_BRAND
      Use with available fluent helpers to apply the CreditCardBrand field to query operations.

    • CREDIT_CARD_TRANSACTION_AUTHZN_ID

      public static final BR_NFePaymentField<String> CREDIT_CARD_TRANSACTION_AUTHZN_ID
      Use with available fluent helpers to apply the CreditCardTransactionAuthznID field to query operations.

    • PAYMENT_FORM

      public static final BR_NFePaymentField<String> PAYMENT_FORM
      Use with available fluent helpers to apply the PaymentForm field to query operations.

    • BRNF_PAYMENT_METHOD_MANUAL_DESC

      public static final BR_NFePaymentField<String> BRNF_PAYMENT_METHOD_MANUAL_DESC
      Use with available fluent helpers to apply the BR_NFPaymentMethodManualDesc field to query operations.

    • SALES_DOCUMENT_CURRENCY

      public static final BR_NFePaymentField<String> SALES_DOCUMENT_CURRENCY
      Use with available fluent helpers to apply the SalesDocumentCurrency field to query operations.

    • TO_BRNF_DOC

      public static final BR_NFePaymentOneToOneLink<BR_NFDocument> TO_BRNF_DOC
      Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.

  • Constructor Details

    • BR_NFePayment

      public BR_NFePayment()

    • BR_NFePayment

      public BR_NFePayment(@Nullable String bR_NotaFiscal, @Nullable String sequenceNumber, @Nullable String paymentMethod, @Nullable BigDecimal paymentAmount, @Nullable String paymentSystemIntegrationType, @Nullable String bR_CreditCardCompanyCNPJ, @Nullable String creditCardBrand, @Nullable String creditCardTransactionAuthznID, @Nullable String paymentForm, @Nullable String bR_NFPaymentMethodManualDesc, @Nullable String salesDocumentCurrency, @Nullable BR_NFDocument toBR_NFDoc)

  • Method Details

    • getType

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

    • setBR_NotaFiscal

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

      Original property name from the Odata EDM: BR_NotaFiscal

      Parameters:
      bR_NotaFiscal - Document Number

    • setSequenceNumber

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

      Original property name from the Odata EDM: SequenceNumber

      Parameters:
      sequenceNumber - Counter

    • setPaymentMethod

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

      Original property name from the Odata EDM: PaymentMethod

      Parameters:
      paymentMethod - Method

    • setPaymentAmount

      public void setPaymentAmount(@Nullable BigDecimal paymentAmount)
      Constraints: Not nullable, Precision: 15, Scale: 2

      Original property name from the Odata EDM: PaymentAmount

      Parameters:
      paymentAmount - Amount

    • setPaymentSystemIntegrationType

      public void setPaymentSystemIntegrationType(@Nullable String paymentSystemIntegrationType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentSystemIntegrationType

      Parameters:
      paymentSystemIntegrationType - Payment Integration Type

    • setBR_CreditCardCompanyCNPJ

      public void setBR_CreditCardCompanyCNPJ(@Nullable String bR_CreditCardCompanyCNPJ)
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: BR_CreditCardCompanyCNPJ

      Parameters:
      bR_CreditCardCompanyCNPJ - Credit Card Issuer CNPJ

    • setCreditCardBrand

      public void setCreditCardBrand(@Nullable String creditCardBrand)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: CreditCardBrand

      Parameters:
      creditCardBrand - Credit/Debit Card Company

    • setCreditCardTransactionAuthznID

      public void setCreditCardTransactionAuthznID(@Nullable String creditCardTransactionAuthznID)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: CreditCardTransactionAuthznID

      Parameters:
      creditCardTransactionAuthznID - Authorization Number

    • setPaymentForm

      public void setPaymentForm(@Nullable String paymentForm)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentForm

      Parameters:
      paymentForm - Form

    • setBR_NFPaymentMethodManualDesc

      public void setBR_NFPaymentMethodManualDesc(@Nullable String bR_NFPaymentMethodManualDesc)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: BR_NFPaymentMethodManualDesc

      Parameters:
      bR_NFPaymentMethodManualDesc - Method Description

    • setSalesDocumentCurrency

      public void setSalesDocumentCurrency(@Nullable String salesDocumentCurrency)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: SalesDocumentCurrency

      Parameters:
      salesDocumentCurrency - SD Document Currency

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BR_NFePaymentField<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> BR_NFePaymentField<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<BR_NFePayment>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBR_NFDoc

      @Nullable public BR_NFDocument fetchBR_NFDoc()
      Fetches the BR_NFDocument entity (one to one) associated with this entity. This corresponds to the OData navigation property to_BR_NFDoc.

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

      Returns:
      The single associated BR_NFDocument 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.

    • getBR_NFDocOrFetch

      @Nullable public BR_NFDocument getBR_NFDocOrFetch()
      Retrieval of associated BR_NFDocument entity (one to one). This corresponds to the OData navigation property to_BR_NFDoc.

      If the navigation property to_BR_NFDoc of a queried BR_NFePayment 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 BR_NFDocument 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.

    • getBR_NFDocIfPresent

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

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

    • setBR_NFDoc

      public void setBR_NFDoc(BR_NFDocument value)
      Overwrites the associated BR_NFDocument entity for the loaded navigation property to_BR_NFDoc.
      Parameters:
      value - New BR_NFDocument entity.

    • builder

      @Nonnull public static BR_NFePayment.BR_NFePaymentBuilder builder()

    • getBR_NotaFiscal

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

      Original property name from the Odata EDM: BR_NotaFiscal

      Returns:
      Document Number

    • getSequenceNumber

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

      Original property name from the Odata EDM: SequenceNumber

      Returns:
      Counter

    • getPaymentMethod

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

      Original property name from the Odata EDM: PaymentMethod

      Returns:
      Method

    • getPaymentAmount

      @Nullable public BigDecimal getPaymentAmount()
      Constraints: Not nullable, Precision: 15, Scale: 2

      Original property name from the Odata EDM: PaymentAmount

      Returns:
      Amount

    • getPaymentSystemIntegrationType

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

      Original property name from the Odata EDM: PaymentSystemIntegrationType

      Returns:
      Payment Integration Type

    • getBR_CreditCardCompanyCNPJ

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

      Original property name from the Odata EDM: BR_CreditCardCompanyCNPJ

      Returns:
      Credit Card Issuer CNPJ

    • getCreditCardBrand

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

      Original property name from the Odata EDM: CreditCardBrand

      Returns:
      Credit/Debit Card Company

    • getCreditCardTransactionAuthznID

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

      Original property name from the Odata EDM: CreditCardTransactionAuthznID

      Returns:
      Authorization Number

    • getPaymentForm

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

      Original property name from the Odata EDM: PaymentForm

      Returns:
      Form

    • getBR_NFPaymentMethodManualDesc

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

      Original property name from the Odata EDM: BR_NFPaymentMethodManualDesc

      Returns:
      Method Description

    • getSalesDocumentCurrency

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

      Original property name from the Odata EDM: SalesDocumentCurrency

      Returns:
      SD Document Currency

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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