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

Class BR_NFTAX

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

Original entity name from the Odata EDM: A_BR_NFTAXType

  • Field Details

    • ALL_FIELDS

      public static final BR_NFTAXSelectable ALL_FIELDS
      Selector for all available fields of BR_NFTAX.

    • BR_NOTA_FISCAL

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

    • BR_NOTA_FISCAL_ITEM

      public static final BR_NFTAXField<String> BR_NOTA_FISCAL_ITEM
      Use with available fluent helpers to apply the BR_NotaFiscalItem field to query operations.

    • BR_TAX_TYPE

      public static final BR_NFTAXField<String> BR_TAX_TYPE
      Use with available fluent helpers to apply the BR_TaxType field to query operations.

    • TAX_GROUP

      public static final BR_NFTAXField<String> TAX_GROUP
      Use with available fluent helpers to apply the TaxGroup field to query operations.

    • BRNF_ITEM_BASE_AMOUNT

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_BASE_AMOUNT
      Use with available fluent helpers to apply the BR_NFItemBaseAmount field to query operations.

    • BRNF_ITEM_TAX_RATE

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_TAX_RATE
      Use with available fluent helpers to apply the BR_NFItemTaxRate field to query operations.

    • BRNF_ITEM_TAX_AMOUNT

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_TAX_AMOUNT
      Use with available fluent helpers to apply the BR_NFItemTaxAmount field to query operations.

    • BRNF_ITEM_EXCLUDED_BASE_AMOUNT

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_EXCLUDED_BASE_AMOUNT
      Use with available fluent helpers to apply the BR_NFItemExcludedBaseAmount field to query operations.

    • BRNF_ITEM_OTHER_BASE_AMOUNT

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_OTHER_BASE_AMOUNT
      Use with available fluent helpers to apply the BR_NFItemOtherBaseAmount field to query operations.

    • BRNF_ITEM_TAX_BASE_PCT1_UNIT

      public static final BR_NFTAXField<String> BRNF_ITEM_TAX_BASE_PCT1_UNIT
      Use with available fluent helpers to apply the BR_NFItemTaxBasePct1Unit field to query operations.

    • BRNF_ITEM_TAX_BASE_PCT1

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_TAX_BASE_PCT1
      Use with available fluent helpers to apply the BR_NFItemTaxBasePct1 field to query operations.

    • BRNF_ITEM_TAX_BASE_PCT2_UNIT

      public static final BR_NFTAXField<String> BRNF_ITEM_TAX_BASE_PCT2_UNIT
      Use with available fluent helpers to apply the BR_NFItemTaxBasePct2Unit field to query operations.

    • BRNF_ITEM_TAX_BASE_PCT2

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_TAX_BASE_PCT2
      Use with available fluent helpers to apply the BR_NFItemTaxBasePct2 field to query operations.

    • BRNF_ITEM_IS_STATISTICAL_TAX

      public static final BR_NFTAXField<Boolean> BRNF_ITEM_IS_STATISTICAL_TAX
      Use with available fluent helpers to apply the BR_NFItemIsStatisticalTax field to query operations.

    • BRNF_ITEM_HAS_FIXED_MKT_TARIFF

      public static final BR_NFTAXField<String> BRNF_ITEM_HAS_FIXED_MKT_TARIFF
      Use with available fluent helpers to apply the BR_NFItemHasFixedMktTariff field to query operations.

    • BRNF_ITEM_FIXED_MKT_TARIFF_BASE_QTY

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_FIXED_MKT_TARIFF_BASE_QTY
      Use with available fluent helpers to apply the BR_NFItemFixedMktTariffBaseQty field to query operations.

    • BRNF_ITEM_FIXED_MARKET_TARIFF_UNIT

      public static final BR_NFTAXField<String> BRNF_ITEM_FIXED_MARKET_TARIFF_UNIT
      Use with available fluent helpers to apply the BR_NFItemFixedMarketTariffUnit field to query operations.

    • BRNF_ITEM_WHLDG_COLLECTION_CODE

      public static final BR_NFTAXField<String> BRNF_ITEM_WHLDG_COLLECTION_CODE
      Use with available fluent helpers to apply the BR_NFItemWhldgCollectionCode field to query operations.

    • BRNF_ITEM_FIXED_MKT_TARIFF_TAX_RATE

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_FIXED_MKT_TARIFF_TAX_RATE
      Use with available fluent helpers to apply the BR_NFItemFixedMktTariffTaxRate field to query operations.

    • BRNF_ITEM_FIXED_MKT_TARIFF_QTY

      public static final BR_NFTAXField<BigDecimal> BRNF_ITEM_FIXED_MKT_TARIFF_QTY
      Use with available fluent helpers to apply the BR_NFItemFixedMktTariffQty field to query operations.

    • BRNF_ITM_FXD_MKT_TARIFF_UNIT4_DCMLS

      public static final BR_NFTAXField<String> BRNF_ITM_FXD_MKT_TARIFF_UNIT4_DCMLS
      Use with available fluent helpers to apply the BR_NFItmFxdMktTariffUnit4Dcmls field to query operations.

    • TAXES_ARE_INCLUDED_IN_NET_AMOUNT

      public static final BR_NFTAXField<Boolean> TAXES_ARE_INCLUDED_IN_NET_AMOUNT
      Use with available fluent helpers to apply the TaxesAreIncludedInNetAmount field to query operations.

    • BRNF_ITEM_HAS_WITHHOLDING_TAX

      public static final BR_NFTAXField<Boolean> BRNF_ITEM_HAS_WITHHOLDING_TAX
      Use with available fluent helpers to apply the BR_NFItemHasWithholdingTax field to query operations.

    • BRNFS_SERVICE_TYPE_INCOMING

      public static final BR_NFTAXField<String> BRNFS_SERVICE_TYPE_INCOMING
      Use with available fluent helpers to apply the BR_NFSServiceTypeIncoming field to query operations.

    • BRNFS_SERVICE_TYPE_OUTGOING

      public static final BR_NFTAXField<String> BRNFS_SERVICE_TYPE_OUTGOING
      Use with available fluent helpers to apply the BR_NFSServiceTypeOutgoing field to query operations.

    • TAX_JURISDICTION

      public static final BR_NFTAXField<String> TAX_JURISDICTION
      Use with available fluent helpers to apply the TaxJurisdiction field to query operations.

    • AGGREGATE_BASE_AMOUNT

      public static final BR_NFTAXField<BigDecimal> AGGREGATE_BASE_AMOUNT
      Use with available fluent helpers to apply the AggregateBaseAmount field to query operations.

    • SALES_DOCUMENT_CURRENCY

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

    • TO_BRNF_ITEM

      public static final BR_NFTAXOneToOneLink<BR_NFItem> TO_BRNF_ITEM
      Use with available fluent helpers to apply the to_BR_NFItem navigation property to query operations.

    • TO_BRNF_DOC

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

  • Constructor Details

    • BR_NFTAX

      public BR_NFTAX()

    • BR_NFTAX

      public BR_NFTAX(@Nullable String bR_NotaFiscal, @Nullable String bR_NotaFiscalItem, @Nullable String bR_TaxType, @Nullable String taxGroup, @Nullable BigDecimal bR_NFItemBaseAmount, @Nullable BigDecimal bR_NFItemTaxRate, @Nullable BigDecimal bR_NFItemTaxAmount, @Nullable BigDecimal bR_NFItemExcludedBaseAmount, @Nullable BigDecimal bR_NFItemOtherBaseAmount, @Nullable String bR_NFItemTaxBasePct1Unit, @Nullable BigDecimal bR_NFItemTaxBasePct1, @Nullable String bR_NFItemTaxBasePct2Unit, @Nullable BigDecimal bR_NFItemTaxBasePct2, @Nullable Boolean bR_NFItemIsStatisticalTax, @Nullable String bR_NFItemHasFixedMktTariff, @Nullable BigDecimal bR_NFItemFixedMktTariffBaseQty, @Nullable String bR_NFItemFixedMarketTariffUnit, @Nullable String bR_NFItemWhldgCollectionCode, @Nullable BigDecimal bR_NFItemFixedMktTariffTaxRate, @Nullable BigDecimal bR_NFItemFixedMktTariffQty, @Nullable String bR_NFItmFxdMktTariffUnit4Dcmls, @Nullable Boolean taxesAreIncludedInNetAmount, @Nullable Boolean bR_NFItemHasWithholdingTax, @Nullable String bR_NFSServiceTypeIncoming, @Nullable String bR_NFSServiceTypeOutgoing, @Nullable String taxJurisdiction, @Nullable BigDecimal aggregateBaseAmount, @Nullable String salesDocumentCurrency, @Nullable BR_NFItem toBR_NFItem, @Nullable BR_NFDocument toBR_NFDoc)

  • Method Details

    • getType

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

    • 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

    • setBR_NotaFiscalItem

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

      Original property name from the Odata EDM: BR_NotaFiscalItem

      Parameters:
      bR_NotaFiscalItem - Document Item Number

    • setBR_TaxType

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

      Original property name from the Odata EDM: BR_TaxType

      Parameters:
      bR_TaxType - Tax Type

    • setTaxGroup

      public void setTaxGroup(@Nullable String taxGroup)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: TaxGroup

      Parameters:
      taxGroup - Tax Group

    • setBR_NFItemBaseAmount

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

      Original property name from the Odata EDM: BR_NFItemBaseAmount

      Parameters:
      bR_NFItemBaseAmount - Base Amount

    • setBR_NFItemTaxRate

      public void setBR_NFItemTaxRate(@Nullable BigDecimal bR_NFItemTaxRate)
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemTaxRate

      Parameters:
      bR_NFItemTaxRate - Tax Rate

    • setBR_NFItemTaxAmount

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

      Original property name from the Odata EDM: BR_NFItemTaxAmount

      Parameters:
      bR_NFItemTaxAmount - Tax value

    • setBR_NFItemExcludedBaseAmount

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

      Original property name from the Odata EDM: BR_NFItemExcludedBaseAmount

      Parameters:
      bR_NFItemExcludedBaseAmount - Excluded Base Amount

    • setBR_NFItemOtherBaseAmount

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

      Original property name from the Odata EDM: BR_NFItemOtherBaseAmount

      Parameters:
      bR_NFItemOtherBaseAmount - Other base amount

    • setBR_NFItemTaxBasePct1Unit

      public void setBR_NFItemTaxBasePct1Unit(@Nullable String bR_NFItemTaxBasePct1Unit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BR_NFItemTaxBasePct1Unit

      Parameters:
      bR_NFItemTaxBasePct1Unit - Unit of Measurement

    • setBR_NFItemTaxBasePct1

      public void setBR_NFItemTaxBasePct1(@Nullable BigDecimal bR_NFItemTaxBasePct1)
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemTaxBasePct1

      Parameters:
      bR_NFItemTaxBasePct1 - Tax Base

    • setBR_NFItemTaxBasePct2Unit

      public void setBR_NFItemTaxBasePct2Unit(@Nullable String bR_NFItemTaxBasePct2Unit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BR_NFItemTaxBasePct2Unit

      Parameters:
      bR_NFItemTaxBasePct2Unit - Unit of Measurement

    • setBR_NFItemTaxBasePct2

      public void setBR_NFItemTaxBasePct2(@Nullable BigDecimal bR_NFItemTaxBasePct2)
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemTaxBasePct2

      Parameters:
      bR_NFItemTaxBasePct2 - Tax base (%)

    • setBR_NFItemIsStatisticalTax

      public void setBR_NFItemIsStatisticalTax(@Nullable Boolean bR_NFItemIsStatisticalTax)
      Constraints: none

      Original property name from the Odata EDM: BR_NFItemIsStatisticalTax

      Parameters:
      bR_NFItemIsStatisticalTax - Statistical Tax Item

    • setBR_NFItemHasFixedMktTariff

      public void setBR_NFItemHasFixedMktTariff(@Nullable String bR_NFItemHasFixedMktTariff)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BR_NFItemHasFixedMktTariff

      Parameters:
      bR_NFItemHasFixedMktTariff - Nota Fiscal tax record type

    • setBR_NFItemFixedMktTariffBaseQty

      public void setBR_NFItemFixedMktTariffBaseQty(@Nullable BigDecimal bR_NFItemFixedMktTariffBaseQty)
      Constraints: Not nullable, Precision: 16, Scale: 4

      Original property name from the Odata EDM: BR_NFItemFixedMktTariffBaseQty

      Parameters:
      bR_NFItemFixedMktTariffBaseQty - Pauta Base Four Decimals

    • setBR_NFItemFixedMarketTariffUnit

      public void setBR_NFItemFixedMarketTariffUnit(@Nullable String bR_NFItemFixedMarketTariffUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BR_NFItemFixedMarketTariffUnit

      Parameters:
      bR_NFItemFixedMarketTariffUnit - Pauta Unit

    • setBR_NFItemWhldgCollectionCode

      public void setBR_NFItemWhldgCollectionCode(@Nullable String bR_NFItemWhldgCollectionCode)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: BR_NFItemWhldgCollectionCode

      Parameters:
      bR_NFItemWhldgCollectionCode - Official Withholding Tax Collection Code

    • setBR_NFItemFixedMktTariffTaxRate

      public void setBR_NFItemFixedMktTariffTaxRate(@Nullable BigDecimal bR_NFItemFixedMktTariffTaxRate)
      Constraints: Not nullable, Precision: 8, Scale: 4

      Original property name from the Odata EDM: BR_NFItemFixedMktTariffTaxRate

      Parameters:
      bR_NFItemFixedMktTariffTaxRate - Tax Rate with 4 Decimal Places

    • setBR_NFItemFixedMktTariffQty

      public void setBR_NFItemFixedMktTariffQty(@Nullable BigDecimal bR_NFItemFixedMktTariffQty)
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemFixedMktTariffQty

      Parameters:
      bR_NFItemFixedMktTariffQty - Number of Units for Pauta with 4 DP (for Reporting Only)

    • setBR_NFItmFxdMktTariffUnit4Dcmls

      public void setBR_NFItmFxdMktTariffUnit4Dcmls(@Nullable String bR_NFItmFxdMktTariffUnit4Dcmls)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BR_NFItmFxdMktTariffUnit4Dcmls

      Parameters:
      bR_NFItmFxdMktTariffUnit4Dcmls - UoM for Pauta with 4 Decimal Places (for Reporting Only)

    • setTaxesAreIncludedInNetAmount

      public void setTaxesAreIncludedInNetAmount(@Nullable Boolean taxesAreIncludedInNetAmount)
      Constraints: none

      Original property name from the Odata EDM: TaxesAreIncludedInNetAmount

      Parameters:
      taxesAreIncludedInNetAmount - Tax Already Included in Net Value

    • setBR_NFItemHasWithholdingTax

      public void setBR_NFItemHasWithholdingTax(@Nullable Boolean bR_NFItemHasWithholdingTax)
      Constraints: none

      Original property name from the Odata EDM: BR_NFItemHasWithholdingTax

      Parameters:
      bR_NFItemHasWithholdingTax - Withholding Tax

    • setBR_NFSServiceTypeIncoming

      public void setBR_NFSServiceTypeIncoming(@Nullable String bR_NFSServiceTypeIncoming)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: BR_NFSServiceTypeIncoming

      Parameters:
      bR_NFSServiceTypeIncoming - Service Type (Incoming)

    • setBR_NFSServiceTypeOutgoing

      public void setBR_NFSServiceTypeOutgoing(@Nullable String bR_NFSServiceTypeOutgoing)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: BR_NFSServiceTypeOutgoing

      Parameters:
      bR_NFSServiceTypeOutgoing - Service Type (Outgoing)

    • setTaxJurisdiction

      public void setTaxJurisdiction(@Nullable String taxJurisdiction)
      Constraints: Not nullable, Maximum length: 15

      Original property name from the Odata EDM: TaxJurisdiction

      Parameters:
      taxJurisdiction - Tax Jurisdiction Code For Brazilian Tax Calculation

    • setAggregateBaseAmount

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

      Original property name from the Odata EDM: AggregateBaseAmount

      Parameters:
      aggregateBaseAmount - The aggregateBaseAmount to set.

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BR_NFTAXField<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_NFTAXField<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_NFTAX>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBR_NFItem

      @Nullable public BR_NFItem fetchBR_NFItem()
      Fetches the BR_NFItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_BR_NFItem.

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

      Returns:
      The single associated BR_NFItem 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_NFItemOrFetch

      @Nullable public BR_NFItem getBR_NFItemOrFetch()
      Retrieval of associated BR_NFItem entity (one to one). This corresponds to the OData navigation property to_BR_NFItem.

      If the navigation property to_BR_NFItem of a queried BR_NFTAX 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_NFItem 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_NFItemIfPresent

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

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

    • setBR_NFItem

      public void setBR_NFItem(BR_NFItem value)
      Overwrites the associated BR_NFItem entity for the loaded navigation property to_BR_NFItem.
      Parameters:
      value - New BR_NFItem entity.

    • 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_NFTAX 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_NFTAX 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_NFTAX.BR_NFTAXBuilder 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

    • getBR_NotaFiscalItem

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

      Original property name from the Odata EDM: BR_NotaFiscalItem

      Returns:
      Document Item Number

    • getBR_TaxType

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

      Original property name from the Odata EDM: BR_TaxType

      Returns:
      Tax Type

    • getTaxGroup

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

      Original property name from the Odata EDM: TaxGroup

      Returns:
      Tax Group

    • getBR_NFItemBaseAmount

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

      Original property name from the Odata EDM: BR_NFItemBaseAmount

      Returns:
      Base Amount

    • getBR_NFItemTaxRate

      @Nullable public BigDecimal getBR_NFItemTaxRate()
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemTaxRate

      Returns:
      Tax Rate

    • getBR_NFItemTaxAmount

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

      Original property name from the Odata EDM: BR_NFItemTaxAmount

      Returns:
      Tax value

    • getBR_NFItemExcludedBaseAmount

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

      Original property name from the Odata EDM: BR_NFItemExcludedBaseAmount

      Returns:
      Excluded Base Amount

    • getBR_NFItemOtherBaseAmount

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

      Original property name from the Odata EDM: BR_NFItemOtherBaseAmount

      Returns:
      Other base amount

    • getBR_NFItemTaxBasePct1Unit

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

      Original property name from the Odata EDM: BR_NFItemTaxBasePct1Unit

      Returns:
      Unit of Measurement

    • getBR_NFItemTaxBasePct1

      @Nullable public BigDecimal getBR_NFItemTaxBasePct1()
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemTaxBasePct1

      Returns:
      Tax Base

    • getBR_NFItemTaxBasePct2Unit

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

      Original property name from the Odata EDM: BR_NFItemTaxBasePct2Unit

      Returns:
      Unit of Measurement

    • getBR_NFItemTaxBasePct2

      @Nullable public BigDecimal getBR_NFItemTaxBasePct2()
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemTaxBasePct2

      Returns:
      Tax base (%)

    • getBR_NFItemIsStatisticalTax

      @Nullable public Boolean getBR_NFItemIsStatisticalTax()
      Constraints: none

      Original property name from the Odata EDM: BR_NFItemIsStatisticalTax

      Returns:
      Statistical Tax Item

    • getBR_NFItemHasFixedMktTariff

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

      Original property name from the Odata EDM: BR_NFItemHasFixedMktTariff

      Returns:
      Nota Fiscal tax record type

    • getBR_NFItemFixedMktTariffBaseQty

      @Nullable public BigDecimal getBR_NFItemFixedMktTariffBaseQty()
      Constraints: Not nullable, Precision: 16, Scale: 4

      Original property name from the Odata EDM: BR_NFItemFixedMktTariffBaseQty

      Returns:
      Pauta Base Four Decimals

    • getBR_NFItemFixedMarketTariffUnit

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

      Original property name from the Odata EDM: BR_NFItemFixedMarketTariffUnit

      Returns:
      Pauta Unit

    • getBR_NFItemWhldgCollectionCode

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

      Original property name from the Odata EDM: BR_NFItemWhldgCollectionCode

      Returns:
      Official Withholding Tax Collection Code

    • getBR_NFItemFixedMktTariffTaxRate

      @Nullable public BigDecimal getBR_NFItemFixedMktTariffTaxRate()
      Constraints: Not nullable, Precision: 8, Scale: 4

      Original property name from the Odata EDM: BR_NFItemFixedMktTariffTaxRate

      Returns:
      Tax Rate with 4 Decimal Places

    • getBR_NFItemFixedMktTariffQty

      @Nullable public BigDecimal getBR_NFItemFixedMktTariffQty()
      Constraints: Not nullable, Precision: 6, Scale: 2

      Original property name from the Odata EDM: BR_NFItemFixedMktTariffQty

      Returns:
      Number of Units for Pauta with 4 DP (for Reporting Only)

    • getBR_NFItmFxdMktTariffUnit4Dcmls

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

      Original property name from the Odata EDM: BR_NFItmFxdMktTariffUnit4Dcmls

      Returns:
      UoM for Pauta with 4 Decimal Places (for Reporting Only)

    • getTaxesAreIncludedInNetAmount

      @Nullable public Boolean getTaxesAreIncludedInNetAmount()
      Constraints: none

      Original property name from the Odata EDM: TaxesAreIncludedInNetAmount

      Returns:
      Tax Already Included in Net Value

    • getBR_NFItemHasWithholdingTax

      @Nullable public Boolean getBR_NFItemHasWithholdingTax()
      Constraints: none

      Original property name from the Odata EDM: BR_NFItemHasWithholdingTax

      Returns:
      Withholding Tax

    • getBR_NFSServiceTypeIncoming

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

      Original property name from the Odata EDM: BR_NFSServiceTypeIncoming

      Returns:
      Service Type (Incoming)

    • getBR_NFSServiceTypeOutgoing

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

      Original property name from the Odata EDM: BR_NFSServiceTypeOutgoing

      Returns:
      Service Type (Outgoing)

    • getTaxJurisdiction

      @Nullable public String getTaxJurisdiction()
      Constraints: Not nullable, Maximum length: 15

      Original property name from the Odata EDM: TaxJurisdiction

      Returns:
      Tax Jurisdiction Code For Brazilian Tax Calculation

    • getAggregateBaseAmount

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

      Original property name from the Odata EDM: AggregateBaseAmount

      Returns:
      The aggregateBaseAmount contained in this entity.

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

    • equals

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

    • canEqual

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

    • hashCode

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