Received NF-e XML documents in Transaction(EFDocumentReceivedXML_BR)

Article
02/22/2022

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	EFDocumentReceivedXML_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

languageTag	displayText
en	Received NF-e XML documents

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Transaction/EFDocumentReceivedXML_BR
Accesskey		Transaction/EFDocumentReceivedXML_BR
CNPJNum_BR		Transaction/EFDocumentReceivedXML_BR
FiscalDocument_BR		Transaction/EFDocumentReceivedXML_BR
FiscalDocumentNumber		Transaction/EFDocumentReceivedXML_BR
FiscalDocumentSeries		Transaction/EFDocumentReceivedXML_BR
FiscalEstablishment_BR		Transaction/EFDocumentReceivedXML_BR
IBGECode		Transaction/EFDocumentReceivedXML_BR
InquiryStatus		Transaction/EFDocumentReceivedXML_BR
LastInquiry		Transaction/EFDocumentReceivedXML_BR
ManualEntry		Transaction/EFDocumentReceivedXML_BR
Posted		Transaction/EFDocumentReceivedXML_BR
ReturnCode		Transaction/EFDocumentReceivedXML_BR
ReturnCodeDescription		Transaction/EFDocumentReceivedXML_BR
DataAreaId		Transaction/EFDocumentReceivedXML_BR
Relationship_FiscalDocument_BRRelationshipId		Transaction/EFDocumentReceivedXML_BR
Relationship_FiscalEstablisment_BRRelationshipId		Transaction/EFDocumentReceivedXML_BR
Relationship_CompanyRelationshipId		Transaction/EFDocumentReceivedXML_BR

RecId

First included in: Transaction/EFDocumentReceivedXML_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	EFDocumentReceivedXML_BR/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

Accesskey

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the Accesskey attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

CNPJNum_BR

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CNPJNum_BR 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

FiscalDocument_BR

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the FiscalDocument_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

FiscalDocumentNumber

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the FiscalDocumentNumber 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

FiscalDocumentSeries

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the FiscalDocumentSeries 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

FiscalEstablishment_BR

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the FiscalEstablishment_BR attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

IBGECode

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the IBGECode 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

InquiryStatus

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
displayName	Status from SEFAZ
dataFormat	int32
isNullable	true

Traits

List of traits for the InquiryStatus attribute are listed below.

is.dataFormat.integer
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

languageTag	displayText
en	Status from SEFAZ

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

LastInquiry

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the LastInquiry attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

ManualEntry

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
displayName	Manual insertion
dataFormat	int32
isNullable	true

Traits

List of traits for the ManualEntry attribute are listed below.

is.dataFormat.integer
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

languageTag	displayText
en	Manual insertion

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Posted

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
displayName	Posted
dataFormat	int32
isNullable	true

Traits

List of traits for the Posted attribute are listed below.

is.dataFormat.integer
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

languageTag	displayText
en	Posted

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ReturnCode

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
displayName	Return Code
dataFormat	string
isNullable	true

Traits

List of traits for the ReturnCode 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

languageTag	displayText
en	Return Code

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ReturnCodeDescription

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ReturnCodeDescription 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/EFDocumentReceivedXML_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_FiscalDocument_BRRelationshipId

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_FiscalDocument_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

entityReference	attributeReference
/core/operationsCommon/Tables/Finance/FiscalBooksBrazil/Transaction/FiscalDocument_BR.cdm.json/FiscalDocument_BR	RecId

entity

a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_FiscalEstablisment_BRRelationshipId

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_FiscalEstablisment_BRRelationshipId attribute are listed below.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/operationsCommon/Tables/Finance/FiscalBooksBrazil/Main/FiscalEstablishment_BR.cdm.json/FiscalEstablishment_BR	RecId

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/EFDocumentReceivedXML_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo	RecId

entity

a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Share via

Received NF-e XML documents in Transaction(EFDocumentReceivedXML_BR)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources