public class BR_NFImportDocument extends VdmEntity<BR_NFImportDocument>
Original entity name from the Odata EDM: A_BR_NFImportDocumentType
Modifier and Type | Class and Description |
---|---|
static class |
BR_NFImportDocument.BR_NFImportDocumentBuilder
Helper class to allow for fluent creation of BR_NFImportDocument instances.
|
Modifier and Type | Field and Description |
---|---|
static BR_NFImportDocumentSelectable |
ALL_FIELDS
Selector for all available fields of BR_NFImportDocument.
|
static BR_NFImportDocumentField<String> |
BR_NOTA_FISCAL
Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_BUYER_REQUESTER_CNPJ
Use with available fluent helpers to apply the BR_NFBuyerRequesterCNPJ field to query operations.
|
static BR_NFImportDocumentField<LocalDateTime> |
BRNF_CUSTOMS_CLEARANCE_DATE
Use with available fluent helpers to apply the BR_NFCustomsClearanceDate field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_CUSTOMS_CLEARANCE_DESC
Use with available fluent helpers to apply the BR_NFCustomsClearanceDesc field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_CUSTOMS_CLEARANCE_TAX_REGION
Use with available fluent helpers to apply the BR_NFCustomsClearanceTaxRegion field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_EXPORTER
Use with available fluent helpers to apply the BR_NFExporter field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_IMP_DOC_MEANS_OF_TRANSPORT
Use with available fluent helpers to apply the BR_NFImpDocMeansOfTransport field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_IMPORT_DECLARATION_TYPE
Use with available fluent helpers to apply the BR_NFImportDeclarationType field to query operations.
|
static BR_NFImportDocumentField<LocalDateTime> |
BRNF_IMPORT_DOC_REGISTRATION_DATE
Use with available fluent helpers to apply the BR_NFImportDocRegistrationDate field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_IMPORT_DOCUMENT
Use with available fluent helpers to apply the BR_NFImportDocument field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_INTERMEDIATE_MODE
Use with available fluent helpers to apply the BR_NFIntermediateMode field to query operations.
|
static BR_NFImportDocumentField<Boolean> |
BRNF_IS_MARITIME_FRT_IN_TOTAL_AMT
Use with available fluent helpers to apply the BR_NFIsMaritimeFrtInTotalAmt field to query operations.
|
static BR_NFImportDocumentField<BigDecimal> |
BRNF_MARITIME_FREIGHT_AMOUNT
Use with available fluent helpers to apply the BR_NFMaritimeFreightAmount field to query operations.
|
static BR_NFImportDocumentField<String> |
BRNF_THIRD_PARTY_REGION
Use with available fluent helpers to apply the BR_NFThirdPartyRegion field to query operations.
|
static BR_NFImportDocumentField<String> |
SALES_DOCUMENT_CURRENCY
Use with available fluent helpers to apply the SalesDocumentCurrency field to query operations.
|
static BR_NFImportDocumentOneToOneLink<BR_NFDocument> |
TO_BRNF_DOC
Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.
|
changedOriginalFields
Constructor and Description |
---|
BR_NFImportDocument() |
BR_NFImportDocument(String bR_NotaFiscal,
String bR_NFImportDocument,
LocalDateTime bR_NFImportDocRegistrationDate,
String bR_NFCustomsClearanceDesc,
String bR_NFCustomsClearanceTaxRegion,
LocalDateTime bR_NFCustomsClearanceDate,
String bR_NFExporter,
String bR_NFImportDeclarationType,
String bR_NFImpDocMeansOfTransport,
BigDecimal bR_NFMaritimeFreightAmount,
String bR_NFIntermediateMode,
String bR_NFBuyerRequesterCNPJ,
String bR_NFThirdPartyRegion,
Boolean bR_NFIsMaritimeFrtInTotalAmt,
String salesDocumentCurrency,
BR_NFDocument toBR_NFDoc) |
Modifier and Type | Method and Description |
---|---|
void |
attachToService(String servicePath,
HttpDestinationProperties destination)
Sets the service path and destination for the fetch commands of this entity.
|
static BR_NFImportDocument.BR_NFImportDocumentBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
BR_NFDocument |
fetchBR_NFDoc()
Fetches the BR_NFDocument entity (one to one) associated with this entity.
|
static <T> BR_NFImportDocumentField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
field(String fieldName,
TypeConverter<T,DomainT> typeConverter)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
String |
getBR_NFBuyerRequesterCNPJ()
Constraints: Not nullable, Maximum length: 14
|
LocalDateTime |
getBR_NFCustomsClearanceDate()
Constraints: Not nullable, Precision: 0
|
String |
getBR_NFCustomsClearanceDesc()
Constraints: Not nullable, Maximum length: 60
|
String |
getBR_NFCustomsClearanceTaxRegion()
Constraints: Not nullable, Maximum length: 3
|
io.vavr.control.Option<BR_NFDocument> |
getBR_NFDocIfPresent()
Retrieval of associated BR_NFDocument entity (one to one).
|
BR_NFDocument |
getBR_NFDocOrFetch()
Retrieval of associated BR_NFDocument entity (one to one).
|
String |
getBR_NFExporter()
Constraints: Not nullable, Maximum length: 60
|
String |
getBR_NFImpDocMeansOfTransport()
Constraints: Not nullable, Maximum length: 2
|
String |
getBR_NFImportDeclarationType()
Constraints: Not nullable, Maximum length: 1
|
LocalDateTime |
getBR_NFImportDocRegistrationDate()
Constraints: Not nullable, Precision: 0
|
String |
getBR_NFImportDocument()
(Key Field) Constraints: Not nullable, Maximum length: 20
|
String |
getBR_NFIntermediateMode()
Constraints: Not nullable, Maximum length: 1
|
Boolean |
getBR_NFIsMaritimeFrtInTotalAmt()
Constraints: none
|
BigDecimal |
getBR_NFMaritimeFreightAmount()
Constraints: Not nullable, Precision: 13, Scale: 2
|
String |
getBR_NFThirdPartyRegion()
Constraints: Not nullable, Maximum length: 2
|
String |
getBR_NotaFiscal()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
protected String |
getDefaultServicePath()
Used by fluent helpers and navigation property methods to construct OData queries.
|
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
protected String |
getEntityCollection()
Used by fluent helpers and navigation property methods to construct OData queries.
|
protected Map<String,Object> |
getKey() |
String |
getSalesDocumentCurrency()
Constraints: Not nullable, Maximum length: 5
|
Class<BR_NFImportDocument> |
getType() |
int |
hashCode() |
void |
setBR_NFBuyerRequesterCNPJ(String bR_NFBuyerRequesterCNPJ)
Constraints: Not nullable, Maximum length: 14
|
void |
setBR_NFCustomsClearanceDate(LocalDateTime bR_NFCustomsClearanceDate)
Constraints: Not nullable, Precision: 0
|
void |
setBR_NFCustomsClearanceDesc(String bR_NFCustomsClearanceDesc)
Constraints: Not nullable, Maximum length: 60
|
void |
setBR_NFCustomsClearanceTaxRegion(String bR_NFCustomsClearanceTaxRegion)
Constraints: Not nullable, Maximum length: 3
|
void |
setBR_NFDoc(BR_NFDocument value)
Overwrites the associated BR_NFDocument entity for the loaded navigation property to_BR_NFDoc.
|
void |
setBR_NFExporter(String bR_NFExporter)
Constraints: Not nullable, Maximum length: 60
|
void |
setBR_NFImpDocMeansOfTransport(String bR_NFImpDocMeansOfTransport)
Constraints: Not nullable, Maximum length: 2
|
void |
setBR_NFImportDeclarationType(String bR_NFImportDeclarationType)
Constraints: Not nullable, Maximum length: 1
|
void |
setBR_NFImportDocRegistrationDate(LocalDateTime bR_NFImportDocRegistrationDate)
Constraints: Not nullable, Precision: 0
|
void |
setBR_NFImportDocument(String bR_NFImportDocument)
(Key Field) Constraints: Not nullable, Maximum length: 20
|
void |
setBR_NFIntermediateMode(String bR_NFIntermediateMode)
Constraints: Not nullable, Maximum length: 1
|
void |
setBR_NFIsMaritimeFrtInTotalAmt(Boolean bR_NFIsMaritimeFrtInTotalAmt)
Constraints: none
|
void |
setBR_NFMaritimeFreightAmount(BigDecimal bR_NFMaritimeFreightAmount)
Constraints: Not nullable, Precision: 13, Scale: 2
|
void |
setBR_NFThirdPartyRegion(String bR_NFThirdPartyRegion)
Constraints: Not nullable, Maximum length: 2
|
void |
setBR_NotaFiscal(String bR_NotaFiscal)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setSalesDocumentCurrency(String salesDocumentCurrency)
Constraints: Not nullable, Maximum length: 5
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final BR_NFImportDocumentSelectable ALL_FIELDS
public static final BR_NFImportDocumentField<String> BR_NOTA_FISCAL
public static final BR_NFImportDocumentField<String> BRNF_IMPORT_DOCUMENT
public static final BR_NFImportDocumentField<LocalDateTime> BRNF_IMPORT_DOC_REGISTRATION_DATE
public static final BR_NFImportDocumentField<String> BRNF_CUSTOMS_CLEARANCE_DESC
public static final BR_NFImportDocumentField<String> BRNF_CUSTOMS_CLEARANCE_TAX_REGION
public static final BR_NFImportDocumentField<LocalDateTime> BRNF_CUSTOMS_CLEARANCE_DATE
public static final BR_NFImportDocumentField<String> BRNF_EXPORTER
public static final BR_NFImportDocumentField<String> BRNF_IMPORT_DECLARATION_TYPE
public static final BR_NFImportDocumentField<String> BRNF_IMP_DOC_MEANS_OF_TRANSPORT
public static final BR_NFImportDocumentField<BigDecimal> BRNF_MARITIME_FREIGHT_AMOUNT
public static final BR_NFImportDocumentField<String> BRNF_INTERMEDIATE_MODE
public static final BR_NFImportDocumentField<String> BRNF_BUYER_REQUESTER_CNPJ
public static final BR_NFImportDocumentField<String> BRNF_THIRD_PARTY_REGION
public static final BR_NFImportDocumentField<Boolean> BRNF_IS_MARITIME_FRT_IN_TOTAL_AMT
public static final BR_NFImportDocumentField<String> SALES_DOCUMENT_CURRENCY
public static final BR_NFImportDocumentOneToOneLink<BR_NFDocument> TO_BRNF_DOC
public 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)
@Nonnull public Class<BR_NFImportDocument> getType()
getType
in class VdmObject<BR_NFImportDocument>
public void setBR_NotaFiscal(@Nullable String bR_NotaFiscal)
Original property name from the Odata EDM: BR_NotaFiscal
bR_NotaFiscal
- Identifies a nota fiscal or any other electronic fiscal document within the SAP environment. The
system assigns a unique number to each document; this number is used internally by various programs.public void setBR_NFImportDocument(@Nullable String bR_NFImportDocument)
Original property name from the Odata EDM: BR_NFImportDocument
bR_NFImportDocument
- Import Documentpublic void setBR_NFImportDocRegistrationDate(@Nullable LocalDateTime bR_NFImportDocRegistrationDate)
Original property name from the Odata EDM: BR_NFImportDocRegistrationDate
bR_NFImportDocRegistrationDate
- Registration Datepublic void setBR_NFCustomsClearanceDesc(@Nullable String bR_NFCustomsClearanceDesc)
Original property name from the Odata EDM: BR_NFCustomsClearanceDesc
bR_NFCustomsClearanceDesc
- Customs Clearance Placepublic void setBR_NFCustomsClearanceTaxRegion(@Nullable String bR_NFCustomsClearanceTaxRegion)
Original property name from the Odata EDM: BR_NFCustomsClearanceTaxRegion
bR_NFCustomsClearanceTaxRegion
- Customs Clearance Regionpublic void setBR_NFCustomsClearanceDate(@Nullable LocalDateTime bR_NFCustomsClearanceDate)
Original property name from the Odata EDM: BR_NFCustomsClearanceDate
bR_NFCustomsClearanceDate
- Customs Clearance Datepublic void setBR_NFExporter(@Nullable String bR_NFExporter)
Original property name from the Odata EDM: BR_NFExporter
bR_NFExporter
- Exporter codepublic void setBR_NFImportDeclarationType(@Nullable String bR_NFImportDeclarationType)
Original property name from the Odata EDM: BR_NFImportDeclarationType
bR_NFImportDeclarationType
- Import Document Declaration Typepublic void setBR_NFImpDocMeansOfTransport(@Nullable String bR_NFImpDocMeansOfTransport)
Original property name from the Odata EDM: BR_NFImpDocMeansOfTransport
bR_NFImpDocMeansOfTransport
- Specifies the means of transport used in the international leg of the transportation of the goods or
materials informed in the DI (Import Document, in Portuguese, Documento de Importação).public void setBR_NFMaritimeFreightAmount(@Nullable BigDecimal bR_NFMaritimeFreightAmount)
Original property name from the Odata EDM: BR_NFMaritimeFreightAmount
This field is only relevant if the imported goods or materials have been transported by maritime means of transportation.
bR_NFMaritimeFreightAmount
- Specifies the amount related to the AFRMM tax (additional freight cost for the renewing of the
Merchant Marine, in Portuguese, Adicional de Frete para Renovação da Marinha Mercante).public void setBR_NFIntermediateMode(@Nullable String bR_NFIntermediateMode)
Original property name from the Odata EDM: BR_NFIntermediateMode
bR_NFIntermediateMode
- Specifies how the import transaction has been realized, for instance, by own means, using the services
of intermediaries, or even on behalf of third parties.public void setBR_NFBuyerRequesterCNPJ(@Nullable String bR_NFBuyerRequesterCNPJ)
Original property name from the Odata EDM: BR_NFBuyerRequesterCNPJ
bR_NFBuyerRequesterCNPJ
- CNPJ of the Buyer or Requesterpublic void setBR_NFThirdPartyRegion(@Nullable String bR_NFThirdPartyRegion)
Original property name from the Odata EDM: BR_NFThirdPartyRegion
bR_NFThirdPartyRegion
- Region of Third Partypublic void setBR_NFIsMaritimeFrtInTotalAmt(@Nullable Boolean bR_NFIsMaritimeFrtInTotalAmt)
Original property name from the Odata EDM: BR_NFIsMaritimeFrtInTotalAmt
You use this check box to add the maritime freight value, that has been previously mapped by the system, in the total amount value in your electronic nota fiscal (NF-e).NoteThis procedure is only valid for import scenarios.
bR_NFIsMaritimeFrtInTotalAmt
- Maps the respective values for maritime freight that the system will sum to the total amount value in
your electronic nota fiscal (NF-e).public void setSalesDocumentCurrency(@Nullable String salesDocumentCurrency)
Original property name from the Odata EDM: SalesDocumentCurrency
The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document.
salesDocumentCurrency
- The currency that applies to the document (for example, to a sales order or an invoice).protected String getEntityCollection()
VdmEntity
getEntityCollection
in class VdmEntity<BR_NFImportDocument>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<BR_NFImportDocument>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<BR_NFImportDocument>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<BR_NFImportDocument>
@Nonnull public static <T> BR_NFImportDocumentField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> BR_NFImportDocumentField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<BR_NFImportDocument>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
setServicePathForFetch
in class VdmEntity<BR_NFImportDocument>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
attachToService
in class VdmEntity<BR_NFImportDocument>
servicePath
- Optional parameter. New service path to apply to this entity and any associated entities that were
previously fetched. If a null value is provided and the service path has never been set, then the
service path will be set to the default defined in the corresponding service interface.destination
- New destination to apply to this entity and any associated entities that were previously fetched.protected String getDefaultServicePath()
VdmEntity
getDefaultServicePath
in class VdmEntity<BR_NFImportDocument>
protocol://hostname:port
and the OData resource name (entity set, $metadata
, etc.)@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<BR_NFImportDocument>
@Nullable public BR_NFDocument fetchBR_NFDoc() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
null
if an entity is not associated.com.sap.cloud.sdk.odatav2.connectivity.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.@Nullable public BR_NFDocument getBR_NFDocOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
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.
com.sap.cloud.sdk.odatav2.connectivity.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.@Nonnull public io.vavr.control.Option<BR_NFDocument> getBR_NFDocIfPresent()
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
.
Option
with result state empty
is
returned.public void setBR_NFDoc(BR_NFDocument value)
value
- New BR_NFDocument entity.public static BR_NFImportDocument.BR_NFImportDocumentBuilder builder()
@Nullable public String getBR_NotaFiscal()
Original property name from the Odata EDM: BR_NotaFiscal
@Nullable public String getBR_NFImportDocument()
Original property name from the Odata EDM: BR_NFImportDocument
@Nullable public LocalDateTime getBR_NFImportDocRegistrationDate()
Original property name from the Odata EDM: BR_NFImportDocRegistrationDate
@Nullable public String getBR_NFCustomsClearanceDesc()
Original property name from the Odata EDM: BR_NFCustomsClearanceDesc
@Nullable public String getBR_NFCustomsClearanceTaxRegion()
Original property name from the Odata EDM: BR_NFCustomsClearanceTaxRegion
@Nullable public LocalDateTime getBR_NFCustomsClearanceDate()
Original property name from the Odata EDM: BR_NFCustomsClearanceDate
@Nullable public String getBR_NFExporter()
Original property name from the Odata EDM: BR_NFExporter
@Nullable public String getBR_NFImportDeclarationType()
Original property name from the Odata EDM: BR_NFImportDeclarationType
@Nullable public String getBR_NFImpDocMeansOfTransport()
Original property name from the Odata EDM: BR_NFImpDocMeansOfTransport
@Nullable public BigDecimal getBR_NFMaritimeFreightAmount()
Original property name from the Odata EDM: BR_NFMaritimeFreightAmount
This field is only relevant if the imported goods or materials have been transported by maritime means of transportation.
@Nullable public String getBR_NFIntermediateMode()
Original property name from the Odata EDM: BR_NFIntermediateMode
@Nullable public String getBR_NFBuyerRequesterCNPJ()
Original property name from the Odata EDM: BR_NFBuyerRequesterCNPJ
@Nullable public String getBR_NFThirdPartyRegion()
Original property name from the Odata EDM: BR_NFThirdPartyRegion
@Nullable public Boolean getBR_NFIsMaritimeFrtInTotalAmt()
Original property name from the Odata EDM: BR_NFIsMaritimeFrtInTotalAmt
You use this check box to add the maritime freight value, that has been previously mapped by the system, in the total amount value in your electronic nota fiscal (NF-e).NoteThis procedure is only valid for import scenarios.
@Nullable public String getSalesDocumentCurrency()
Original property name from the Odata EDM: SalesDocumentCurrency
The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document.
public String toString()
toString
in class VdmObject<BR_NFImportDocument>
public boolean equals(Object o)
equals
in class VdmObject<BR_NFImportDocument>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<BR_NFImportDocument>
public int hashCode()
hashCode
in class VdmObject<BR_NFImportDocument>
Copyright © 2020 SAP SE. All rights reserved.