NF-e history in Miscellaneous(EFDocHist_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	EFDocHist_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 history	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Miscellaneous/EFDocHist_BR
ContingencyMode		Miscellaneous/EFDocHist_BR
ContingencyReason		Miscellaneous/EFDocHist_BR
Date		Miscellaneous/EFDocHist_BR
EFDocAuthority		Miscellaneous/EFDocHist_BR
EFDRefRecId		Miscellaneous/EFDocHist_BR
FiscalDocStatus		Miscellaneous/EFDocHist_BR
MessageStatus		Miscellaneous/EFDocHist_BR
MessageType		Miscellaneous/EFDocHist_BR
ReceiptNumber		Miscellaneous/EFDocHist_BR
ReturnCodeDescription		Miscellaneous/EFDocHist_BR
ReturnCodeRefRecId		Miscellaneous/EFDocHist_BR
ReturnMessage		Miscellaneous/EFDocHist_BR
Time		Miscellaneous/EFDocHist_BR
DataAreaId		Miscellaneous/EFDocHist_BR
Relationship_EFDocAuthorityRelationshipId		Miscellaneous/EFDocHist_BR
Relationship_EFDReturnCode_BRRelationshipId		Miscellaneous/EFDocHist_BR
Relationship_ElectronicFiscalDoc_BRRelationshipId		Miscellaneous/EFDocHist_BR
Relationship_CompanyRelationshipId		Miscellaneous/EFDocHist_BR

RecId

First included in: Miscellaneous/EFDocHist_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	EFDocHist_BR/(resolvedAttributes)/RecId	attribute

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

ContingencyMode

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ContingencyMode attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ContingencyReason

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Date

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the Date attribute are listed below.

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

is.dataFormat.date

EFDocAuthority

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

EFDRefRecId

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

FiscalDocStatus

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the FiscalDocStatus attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

MessageStatus

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MessageStatus attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

MessageType

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MessageType attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ReceiptNumber

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ReturnCodeDescription

First included in: Miscellaneous/EFDocHist_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

ReturnCodeRefRecId

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

ReturnMessage

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Time

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
displayName	Time
dataFormat	time
isNullable	true

Traits

List of traits for the Time attribute are listed below.

is.dataFormat.time
means.measurement.time
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 Time	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.time

DataAreaId

First included in: Miscellaneous/EFDocHist_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_EFDocAuthorityRelationshipId

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_EFDocAuthorityRelationshipId 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/Miscellaneous/EFDocAuthority_BR.cdm.json/EFDocAuthority_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_EFDReturnCode_BRRelationshipId

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_EFDReturnCode_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/Miscellaneous/EFDReturnCode_BR.cdm.json/EFDReturnCode_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_ElectronicFiscalDoc_BRRelationshipId

First included in: Miscellaneous/EFDocHist_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_ElectronicFiscalDoc_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: Miscellaneous/EFDocHist_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	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