Nota Fiscal eletronica - NF-e in Transaction(EFDocument_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	EFDocument_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 Nota Fiscal eletronica - NF-e	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Transaction/EFDocument_BR
AverageResponseTime		Transaction/EFDocument_BR
ContingencyMode		Transaction/EFDocument_BR
ContingencyModeRefRecID		Transaction/EFDocument_BR
ContingencyReason		Transaction/EFDocument_BR
Date		Transaction/EFDocument_BR
MessageStatus		Transaction/EFDocument_BR
MessageType		Transaction/EFDocument_BR
ProtocolNumber		Transaction/EFDocument_BR
ReceiptNumber		Transaction/EFDocument_BR
RefRecId		Transaction/EFDocument_BR
ReturnCodeDescription		Transaction/EFDocument_BR
ReturnCodeRefRecId		Transaction/EFDocument_BR
ReturnMessage		Transaction/EFDocument_BR
Time		Transaction/EFDocument_BR
ConsumerEFDocInquiryUrl		Transaction/EFDocument_BR
ContingencyDateTime		Transaction/EFDocument_BR
ContingencyDateTimeOffset		Transaction/EFDocument_BR
QrcodeText		Transaction/EFDocument_BR
DataAreaId		Transaction/EFDocument_BR
Relationship_EFDocContigencyMode_BRRelationshipId		Transaction/EFDocument_BR
Relationship_EFDReturnCodeRelationshipId		Transaction/EFDocument_BR
Relationship_FiscalDocumentRelationshipId		Transaction/EFDocument_BR
Relationship_CompanyRelationshipId		Transaction/EFDocument_BR

RecId

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

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

AverageResponseTime

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
displayName	Average response time
dataFormat	int32
isNullable	true

Traits

List of traits for the AverageResponseTime 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 Average response time	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ContingencyMode

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

ContingencyModeRefRecID

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

ContingencyReason

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

MessageStatus

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

ProtocolNumber

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ReceiptNumber

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

RefRecId

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

ReturnCodeDescription

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

ConsumerEFDocInquiryUrl

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
displayName	Internet address for NFC-e inquiry
dataFormat	string
isNullable	true

Traits

List of traits for the ConsumerEFDocInquiryUrl 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 Internet address for NFC-e inquiry	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ContingencyDateTime

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ContingencyDateTime attribute are listed below.

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

is.dataFormat.date

ContingencyDateTimeOffset

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

QrcodeText

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the QrcodeText 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/EFDocument_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_EFDocContigencyMode_BRRelationshipId

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_EFDocContigencyMode_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/EFDocContingencyMode_BR.cdm.json/EFDocContingencyMode_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_EFDReturnCodeRelationshipId

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

First included in: Transaction/EFDocument_BR (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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