Received NF-e XML documents in Transaction(EFDocumentReceivedXmlView_BR)
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | EFDocumentReceivedXmlView_BR/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.1" | string | semantic version number of the entity |
is.application.releaseVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| releaseVersion | "10.0.13.0" | string | semantic version number of the application introducing this entity |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| isPrimaryKey | true |
| dataFormat | int64 |
| isReadOnly | true |
Traits
List of traits for the RecId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | EFDocumentReceivedXmlView_BR/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
EFDocumentReceivedXML_BR
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | int64 |
| isNullable | true |
Traits
List of traits for the EFDocumentReceivedXML_BR attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
is.dataFormat.big
ICMSAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | ICMS |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the ICMSAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
ICMSBaseAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | ICMS base amount |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the ICMSBaseAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
ICMSSTAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | ICMS-ST |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the ICMSSTAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
ICMSSTBaseAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | ICMS-ST base amount |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the ICMSSTBaseAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
IPIAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | IPI |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the IPIAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
IssueDate
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | date |
| isNullable | true |
Traits
List of traits for the IssueDate attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
ThirdPartyCNPJ
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ThirdPartyCNPJ attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ThirdPartyIE
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ThirdPartyIE attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ThirdPartyIEST
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Tributary Substitution Registry |
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ThirdPartyIEST attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
ThirdPartyName
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ThirdPartyName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
TotalAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total amount |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalDiscount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total discount |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalDiscount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalMarkupFreightAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalMarkupFreightAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalMarkupInsuranceAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalMarkupInsuranceAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalMarkupOtherAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalMarkupOtherAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalProductAmount
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total products amount |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalProductAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
IssueTime
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | time |
| isNullable | true |
Traits
List of traits for the IssueTime attribute are listed below.
is.dataFormat.time
means.measurement.time
is.nullable
The attribute value may be set to NULL.
is.dataFormat.time
IssueTimezone
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the IssueTimezone attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
DataAreaId
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the DataAreaId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
Relationship_EFDocumentReceivedXml_BRRelationshipId
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the Relationship_EFDocumentReceivedXml_BRRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_CompanyRelationshipId
First included in: Transaction/EFDocumentReceivedXmlView_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the Relationship_CompanyRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for