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

Class BR_NFImportDocument

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

Original entity name from the Odata EDM: A_BR_NFImportDocumentType

  • Field Details

    • ALL_FIELDS

      public static final BR_NFImportDocumentSelectable ALL_FIELDS
      Selector for all available fields of BR_NFImportDocument.

    • BR_NOTA_FISCAL

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

    • BRNF_IMPORT_DOCUMENT

      public static final BR_NFImportDocumentField<String> BRNF_IMPORT_DOCUMENT
      Use with available fluent helpers to apply the BR_NFImportDocument field to query operations.

    • BRNF_IMPORT_DOC_REGISTRATION_DATE

      public static final BR_NFImportDocumentField<LocalDateTime> BRNF_IMPORT_DOC_REGISTRATION_DATE
      Use with available fluent helpers to apply the BR_NFImportDocRegistrationDate field to query operations.

    • BRNF_CUSTOMS_CLEARANCE_DESC

      public static final BR_NFImportDocumentField<String> BRNF_CUSTOMS_CLEARANCE_DESC
      Use with available fluent helpers to apply the BR_NFCustomsClearanceDesc field to query operations.

    • BRNF_CUSTOMS_CLEARANCE_TAX_REGION

      public static final BR_NFImportDocumentField<String> BRNF_CUSTOMS_CLEARANCE_TAX_REGION
      Use with available fluent helpers to apply the BR_NFCustomsClearanceTaxRegion field to query operations.

    • BRNF_CUSTOMS_CLEARANCE_DATE

      public static final BR_NFImportDocumentField<LocalDateTime> BRNF_CUSTOMS_CLEARANCE_DATE
      Use with available fluent helpers to apply the BR_NFCustomsClearanceDate field to query operations.

    • BRNF_EXPORTER

      public static final BR_NFImportDocumentField<String> BRNF_EXPORTER
      Use with available fluent helpers to apply the BR_NFExporter field to query operations.

    • BRNF_IMPORT_DECLARATION_TYPE

      public static final BR_NFImportDocumentField<String> BRNF_IMPORT_DECLARATION_TYPE
      Use with available fluent helpers to apply the BR_NFImportDeclarationType field to query operations.

    • BRNF_IMP_DOC_MEANS_OF_TRANSPORT

      public static final BR_NFImportDocumentField<String> BRNF_IMP_DOC_MEANS_OF_TRANSPORT
      Use with available fluent helpers to apply the BR_NFImpDocMeansOfTransport field to query operations.

    • BRNF_MARITIME_FREIGHT_AMOUNT

      public static final BR_NFImportDocumentField<BigDecimal> BRNF_MARITIME_FREIGHT_AMOUNT
      Use with available fluent helpers to apply the BR_NFMaritimeFreightAmount field to query operations.

    • BRNF_INTERMEDIATE_MODE

      public static final BR_NFImportDocumentField<String> BRNF_INTERMEDIATE_MODE
      Use with available fluent helpers to apply the BR_NFIntermediateMode field to query operations.

    • BRNF_BUYER_REQUESTER_CNPJ

      public static final BR_NFImportDocumentField<String> BRNF_BUYER_REQUESTER_CNPJ
      Use with available fluent helpers to apply the BR_NFBuyerRequesterCNPJ field to query operations.

    • BRNF_THIRD_PARTY_REGION

      public static final BR_NFImportDocumentField<String> BRNF_THIRD_PARTY_REGION
      Use with available fluent helpers to apply the BR_NFThirdPartyRegion field to query operations.

    • BRNF_IS_MARITIME_FRT_IN_TOTAL_AMT

      public static final BR_NFImportDocumentField<Boolean> BRNF_IS_MARITIME_FRT_IN_TOTAL_AMT
      Use with available fluent helpers to apply the BR_NFIsMaritimeFrtInTotalAmt field to query operations.

    • SALES_DOCUMENT_CURRENCY

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

    • TO_BRNF_DOC

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

  • Constructor Details

    • BR_NFImportDocument

      public BR_NFImportDocument()

    • BR_NFImportDocument

      public BR_NFImportDocument(@Nullable String bR_NotaFiscal, @Nullable String bR_NFImportDocument, @Nullable LocalDateTime bR_NFImportDocRegistrationDate, @Nullable String bR_NFCustomsClearanceDesc, @Nullable String bR_NFCustomsClearanceTaxRegion, @Nullable LocalDateTime bR_NFCustomsClearanceDate, @Nullable String bR_NFExporter, @Nullable String bR_NFImportDeclarationType, @Nullable String bR_NFImpDocMeansOfTransport, @Nullable BigDecimal bR_NFMaritimeFreightAmount, @Nullable String bR_NFIntermediateMode, @Nullable String bR_NFBuyerRequesterCNPJ, @Nullable String bR_NFThirdPartyRegion, @Nullable Boolean bR_NFIsMaritimeFrtInTotalAmt, @Nullable String salesDocumentCurrency, @Nullable BR_NFDocument toBR_NFDoc)

  • Method Details

    • getType

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

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

      public void setBR_NFImportDocument(@Nullable String bR_NFImportDocument)
      (Key Field) Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: BR_NFImportDocument

      Parameters:
      bR_NFImportDocument - Import Document

    • setBR_NFImportDocRegistrationDate

      public void setBR_NFImportDocRegistrationDate(@Nullable LocalDateTime bR_NFImportDocRegistrationDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BR_NFImportDocRegistrationDate

      Parameters:
      bR_NFImportDocRegistrationDate - Registration Date

    • setBR_NFCustomsClearanceDesc

      public void setBR_NFCustomsClearanceDesc(@Nullable String bR_NFCustomsClearanceDesc)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: BR_NFCustomsClearanceDesc

      Parameters:
      bR_NFCustomsClearanceDesc - Customs Clearance Place

    • setBR_NFCustomsClearanceTaxRegion

      public void setBR_NFCustomsClearanceTaxRegion(@Nullable String bR_NFCustomsClearanceTaxRegion)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BR_NFCustomsClearanceTaxRegion

      Parameters:
      bR_NFCustomsClearanceTaxRegion - Customs Clearance Region

    • setBR_NFCustomsClearanceDate

      public void setBR_NFCustomsClearanceDate(@Nullable LocalDateTime bR_NFCustomsClearanceDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BR_NFCustomsClearanceDate

      Parameters:
      bR_NFCustomsClearanceDate - Customs Clearance Date

    • setBR_NFExporter

      public void setBR_NFExporter(@Nullable String bR_NFExporter)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: BR_NFExporter

      Parameters:
      bR_NFExporter - Exporter code

    • setBR_NFImportDeclarationType

      public void setBR_NFImportDeclarationType(@Nullable String bR_NFImportDeclarationType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BR_NFImportDeclarationType

      Parameters:
      bR_NFImportDeclarationType - Import Document Declaration Type

    • setBR_NFImpDocMeansOfTransport

      public void setBR_NFImpDocMeansOfTransport(@Nullable String bR_NFImpDocMeansOfTransport)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BR_NFImpDocMeansOfTransport

      Parameters:
      bR_NFImpDocMeansOfTransport - Means of Transport

    • setBR_NFMaritimeFreightAmount

      public void setBR_NFMaritimeFreightAmount(@Nullable BigDecimal bR_NFMaritimeFreightAmount)
      Constraints: Not nullable, Precision: 13, Scale: 2

      Original property name from the Odata EDM: BR_NFMaritimeFreightAmount

      Parameters:
      bR_NFMaritimeFreightAmount - Maritime Freight

    • setBR_NFIntermediateMode

      public void setBR_NFIntermediateMode(@Nullable String bR_NFIntermediateMode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BR_NFIntermediateMode

      Parameters:
      bR_NFIntermediateMode - Intermediate mode

    • setBR_NFBuyerRequesterCNPJ

      public void setBR_NFBuyerRequesterCNPJ(@Nullable String bR_NFBuyerRequesterCNPJ)
      Constraints: Not nullable, Maximum length: 14

      Original property name from the Odata EDM: BR_NFBuyerRequesterCNPJ

      Parameters:
      bR_NFBuyerRequesterCNPJ - CNPJ of the Buyer or Requester

    • setBR_NFThirdPartyRegion

      public void setBR_NFThirdPartyRegion(@Nullable String bR_NFThirdPartyRegion)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BR_NFThirdPartyRegion

      Parameters:
      bR_NFThirdPartyRegion - Region of Third Party

    • setBR_NFIsMaritimeFrtInTotalAmt

      public void setBR_NFIsMaritimeFrtInTotalAmt(@Nullable Boolean bR_NFIsMaritimeFrtInTotalAmt)
      Constraints: none

      Original property name from the Odata EDM: BR_NFIsMaritimeFrtInTotalAmt

      Parameters:
      bR_NFIsMaritimeFrtInTotalAmt - Maritime Freight in Total

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BR_NFImportDocumentField<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_NFImportDocumentField<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_NFImportDocument>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • 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_NFImportDocument 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_NFImportDocument 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_NFImportDocument.BR_NFImportDocumentBuilder 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_NFImportDocument

      @Nullable public String getBR_NFImportDocument()
      (Key Field) Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: BR_NFImportDocument

      Returns:
      Import Document

    • getBR_NFImportDocRegistrationDate

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

      Original property name from the Odata EDM: BR_NFImportDocRegistrationDate

      Returns:
      Registration Date

    • getBR_NFCustomsClearanceDesc

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

      Original property name from the Odata EDM: BR_NFCustomsClearanceDesc

      Returns:
      Customs Clearance Place

    • getBR_NFCustomsClearanceTaxRegion

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

      Original property name from the Odata EDM: BR_NFCustomsClearanceTaxRegion

      Returns:
      Customs Clearance Region

    • getBR_NFCustomsClearanceDate

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

      Original property name from the Odata EDM: BR_NFCustomsClearanceDate

      Returns:
      Customs Clearance Date

    • getBR_NFExporter

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

      Original property name from the Odata EDM: BR_NFExporter

      Returns:
      Exporter code

    • getBR_NFImportDeclarationType

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

      Original property name from the Odata EDM: BR_NFImportDeclarationType

      Returns:
      Import Document Declaration Type

    • getBR_NFImpDocMeansOfTransport

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

      Original property name from the Odata EDM: BR_NFImpDocMeansOfTransport

      Returns:
      Means of Transport

    • getBR_NFMaritimeFreightAmount

      @Nullable public BigDecimal getBR_NFMaritimeFreightAmount()
      Constraints: Not nullable, Precision: 13, Scale: 2

      Original property name from the Odata EDM: BR_NFMaritimeFreightAmount

      Returns:
      Maritime Freight

    • getBR_NFIntermediateMode

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

      Original property name from the Odata EDM: BR_NFIntermediateMode

      Returns:
      Intermediate mode

    • getBR_NFBuyerRequesterCNPJ

      @Nullable public String getBR_NFBuyerRequesterCNPJ()
      Constraints: Not nullable, Maximum length: 14

      Original property name from the Odata EDM: BR_NFBuyerRequesterCNPJ

      Returns:
      CNPJ of the Buyer or Requester

    • getBR_NFThirdPartyRegion

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

      Original property name from the Odata EDM: BR_NFThirdPartyRegion

      Returns:
      Region of Third Party

    • getBR_NFIsMaritimeFrtInTotalAmt

      @Nullable public Boolean getBR_NFIsMaritimeFrtInTotalAmt()
      Constraints: none

      Original property name from the Odata EDM: BR_NFIsMaritimeFrtInTotalAmt

      Returns:
      Maritime Freight in Total

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

    • equals

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

    • canEqual

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

    • hashCode

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