Muokkaa

Jaa


Received NF-e XML documents in Transaction(EFDocumentReceivedXML_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

ParameterValueData typeExplanation
attributeEFDocumentReceivedXML_BR/(resolvedAttributes)/RecIdattribute

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.application.releaseVersion

ParameterValueData typeExplanation
releaseVersion"10.0.13.0"stringsemantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReceived NF-e XML documents
entitya 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

NameValue
isPrimaryKeytrue
dataFormatint64
isReadOnlytrue

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

ParameterValueData typeExplanation
attributeEFDocumentReceivedXML_BR/(resolvedAttributes)/RecIdattribute

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

Accesskey

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

NameValue
dataFormatstring

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

NameValue
dataFormatstring
isNullabletrue

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

NameValue
dataFormatint64
isNullabletrue

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

NameValue
dataFormatstring
isNullabletrue

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

NameValue
dataFormatstring
isNullabletrue

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

NameValue
dataFormatint64

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

NameValue
dataFormatstring
isNullabletrue

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

NameValue
displayNameStatus from SEFAZ
dataFormatint32
isNullabletrue

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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus from SEFAZ
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

LastInquiry

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

NameValue
dataFormatdate
isNullabletrue

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

NameValue
displayNameManual insertion
dataFormatint32
isNullabletrue

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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enManual insertion
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

Posted

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

NameValue
displayNamePosted
dataFormatint32
isNullabletrue

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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPosted
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ReturnCode

First included in: Transaction/EFDocumentReceivedXML_BR (this entity)

Properties

NameValue
displayNameReturn Code
dataFormatstring
isNullabletrue

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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReturn Code
entitya 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

NameValue
dataFormatstring
isNullabletrue

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

NameValue
dataFormatstring
isReadOnlytrue

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

NameValue
dataFormatguid

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/FiscalBooksBrazil/Transaction/FiscalDocument_BR.cdm.json/FiscalDocument_BRRecId
entitya 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

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/FiscalBooksBrazil/Main/FiscalEstablishment_BR.cdm.json/FiscalEstablishment_BRRecId
entitya 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

NameValue
dataFormatguid

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfoRecId
entitya reference to the constant entity holding the list of entity references

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