Retail Fiscal Document in Transaction(RetailFiscalDocument_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 | RetailFiscalDocument_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 |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Transaction/RetailFiscalDocument_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 | RetailFiscalDocument_BR/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
AccessKey
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the AccessKey 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
ApplicationVersion
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ApplicationVersion 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
AuthorityCode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the AuthorityCode 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
Channel
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
Traits
List of traits for the Channel attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big
ConsumerEFDocInquiryUrl
First included in: Transaction/RetailFiscalDocument_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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
ContingencyDateTime
First included in: Transaction/RetailFiscalDocument_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/RetailFiscalDocument_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
ContingencyMode
First included in: Transaction/RetailFiscalDocument_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: Transaction/RetailFiscalDocument_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
DanfePrintFormat
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | The print format for DANFE |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the DanfePrintFormat 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
Direction
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
Traits
List of traits for the Direction attribute are listed below.
is.dataFormat.integer
is.readOnly
is.dataFormat.integer
EnvironmentType
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the EnvironmentType attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
FEAddressBacenCode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressBacenCode 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
FEAddressCity
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressCity 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
FEAddressComplement
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressComplement 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
FEAddressCountry
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressCountry 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
FEAddressDistrict
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressDistrict 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
FEAddressIBGECode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressIBGECode 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
FEAddressState
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressState 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
FEAddressStreet
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressStreet 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
FEAddressStreetNumber
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressStreetNumber 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
FEAddressZipCode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FEAddressZipCode 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
FinalUser
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the FinalUser attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
FiscalDocumentAccountNum
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalDocumentAccountNum 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
FiscalDocumentDateTime
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the FiscalDocumentDateTime attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
FiscalDocumentDateTimeOffset
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the FiscalDocumentDateTimeOffset 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/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the FiscalDocumentNumber attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
FiscalDocumentSeries
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the FiscalDocumentSeries attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
FiscalEstablishment
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the FiscalEstablishment attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
FiscalEstablishmentCCMNum
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentCCMNum 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
FiscalEstablishmentCNAE
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentCNAE 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
FiscalEstablishmentCNPJCPF
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentCNPJCPF 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
FiscalEstablishmentIE
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentIE 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
FiscalEstablishmentName
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Name |
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentName 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
FiscalEstablishmentPhone
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentPhone 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
FiscalEstablishmentPostalAddress
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentPostalAddress 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
MessageStatus
First included in: Transaction/RetailFiscalDocument_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/RetailFiscalDocument_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
Model
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Model |
dataFormat | string |
isNullable | true |
Traits
List of traits for the Model 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
NumericCode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Numeric code |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the NumericCode 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
OperationDescription
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the OperationDescription 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
PresenceType
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the PresenceType attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ProtocolDate
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the ProtocolDate attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
ProtocolNumber
First included in: Transaction/RetailFiscalDocument_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
QrcodeText
First included in: Transaction/RetailFiscalDocument_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
ReceiptNumber
First included in: Transaction/RetailFiscalDocument_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
ReceiptType
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ReceiptType attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ReplicationCounterFromOrigin
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ReplicationCounterFromOrigin attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ReturnCodeDescription
First included in: Transaction/RetailFiscalDocument_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/RetailFiscalDocument_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/RetailFiscalDocument_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
Status
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
Traits
List of traits for the Status attribute are listed below.
is.dataFormat.integer
is.dataFormat.integer
store
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the store attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
terminal
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the terminal attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
ThirdPartyAddressBacenCode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressBacenCode 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
ThirdPartyAddressCity
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressCity 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
ThirdPartyAddressComplement
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressComplement 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
ThirdPartyAddressCountry
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the ThirdPartyAddressCountry attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
ThirdPartyAddressCountryRegionId
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressCountryRegionId 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
ThirdPartyAddressDistrict
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressDistrict 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
ThirdPartyAddressIBGECode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressIBGECode 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
ThirdPartyAddressState
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressState 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
ThirdPartyAddressStreet
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressStreet 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
ThirdPartyAddressStreetNumber
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressStreetNumber 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
ThirdPartyAddressZipCode
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyAddressZipCode 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
ThirdPartyCNPJCPF
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyCNPJCPF 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
ThirdPartyEmail
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyEmail 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
ThirdPartyForeignerId
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyForeignerId 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
ThirdPartyName
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Name |
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyName 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
ThirdPartyPhone
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyPhone 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
ThirdPartyPostalAddress
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ThirdPartyPostalAddress 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
TotalAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Total amount |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalDiscountAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Total discount |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalDiscountAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalGoodsAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalGoodsAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalMarkupFreightAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalMarkupFreightAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalMarkupInsuranceAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalMarkupInsuranceAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalMarkupOtherAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalMarkupOtherAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalServicesAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalServicesAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
transactionId
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the transactionId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
XmlRequest
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Request |
dataFormat | string |
isNullable | true |
Traits
List of traits for the XmlRequest 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
XmlResponse
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Response |
dataFormat | string |
isNullable | true |
Traits
List of traits for the XmlResponse 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
XmlReturnRequest
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Request |
dataFormat | string |
isNullable | true |
Traits
List of traits for the XmlReturnRequest 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
XmlReturnResponse
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Response |
dataFormat | string |
isNullable | true |
Traits
List of traits for the XmlReturnResponse 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
Purpose
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the Purpose attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
SendByEmail
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the SendByEmail attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ThirdPartyFormattedAddress
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyFormattedAddress 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
ThirdPartyICMSContributor
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ThirdPartyICMSContributor attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ThirdPartyIE
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ThirdPartyIE 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
ChangeAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Change amount |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ChangeAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
EFRRegisterNumber
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the EFRRegisterNumber attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
EFRSignature
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the EFRSignature 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
TaxAuthorityInfo
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TaxAuthorityInfo 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
OriginalDiscountAmount
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the OriginalDiscountAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.nullable
The attribute value may be set to NULL.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
SoftwareHouseCNPJ
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Software house CNPJ |
dataFormat | string |
isNullable | true |
Traits
List of traits for the SoftwareHouseCNPJ 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
FiscalEstablishmentTradeName
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Trade name |
dataFormat | string |
isNullable | true |
Traits
List of traits for the FiscalEstablishmentTradeName 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
TechnicalResponsibleCNPJ
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TechnicalResponsibleCNPJ 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
TechnicalResponsibleContactName
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TechnicalResponsibleContactName 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
TechnicalResponsibleEmail
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TechnicalResponsibleEmail 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
TechnicalResponsiblePhone
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TechnicalResponsiblePhone 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/RetailFiscalDocument_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_EFDReturnCode_BRRelationshipId
First included in: Transaction/RetailFiscalDocument_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 |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_FiscalEstablishmentPostalAddressRelationshipId
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_FiscalEstablishmentPostalAddressRelationshipId 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_ThirdPartyPostalAddressRelationshipId
First included in: Transaction/RetailFiscalDocument_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_ThirdPartyPostalAddressRelationshipId 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 |
| 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/RetailFiscalDocument_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 |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array