NF-e sent/protocol XML documents in Transaction(EFDocumentXML_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	EFDocumentXML_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	NF-e sent/protocol XML documents

entity

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

Attributes

Name	Description	First Included in Instance
RecId		Transaction/EFDocumentXML_BR
Cancel		Transaction/EFDocumentXML_BR
CancelResponse		Transaction/EFDocumentXML_BR
EFDocRefRecId		Transaction/EFDocumentXML_BR
Submission		Transaction/EFDocumentXML_BR
SubmissionResponse		Transaction/EFDocumentXML_BR
SubmitReturn		Transaction/EFDocumentXML_BR
SubmitReturnResponse		Transaction/EFDocumentXML_BR
Moved		Transaction/EFDocumentXML_BR
DataAreaId		Transaction/EFDocumentXML_BR
Relationship_EFDocument_BRRelationshipId		Transaction/EFDocumentXML_BR
Relationship_CompanyRelationshipId		Transaction/EFDocumentXML_BR

RecId

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

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

Cancel

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	Request
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

CancelResponse

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	Response
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

EFDocRefRecId

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

Submission

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	Request
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

SubmissionResponse

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	Response
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

SubmitReturn

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	Request
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

SubmitReturnResponse

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	Response
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

Moved

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
displayName	XML was moved as attachment
dataFormat	int32
isNullable	true

Traits

List of traits for the Moved 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	XML was moved as attachment

entity

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

is.dataFormat.integer

DataAreaId

First included in: Transaction/EFDocumentXML_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_EFDocument_BRRelationshipId

First included in: Transaction/EFDocumentXML_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_EFDocument_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/EFDocument_BR.cdm.json/EFDocument_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/EFDocumentXML_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

NF-e sent/protocol XML documents in Transaction(EFDocumentXML_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

Feedback

Feedback

Additional resources