Fiscal receipt payment transactions in TransactionHeader(RetailFiscalDocumentModel2_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 | RetailFiscalDocumentModel2_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: TransactionHeader/RetailFiscalDocumentModel2_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 | RetailFiscalDocumentModel2_BR/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
ConsumerCNPJCPFNumber
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ConsumerCNPJCPFNumber 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
FiscalDocumentAccountNum
First included in: TransactionHeader/RetailFiscalDocumentModel2_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
FiscalDocumentDate
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | date |
Traits
List of traits for the FiscalDocumentDate attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.date
FiscalDocumentNumber
First included in: TransactionHeader/RetailFiscalDocumentModel2_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: TransactionHeader/RetailFiscalDocumentModel2_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
Origin
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the Origin 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
ReplicationCounterFromOrigin
First included in: TransactionHeader/RetailFiscalDocumentModel2_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
Status
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the Status attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
StoreId
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
Traits
List of traits for the StoreId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
TerminalId
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
Traits
List of traits for the TerminalId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
TotalAmount
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| 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.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalDiscountAmount
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| 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.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalSurchargeAmount
First included in: TransactionHeader/RetailFiscalDocumentModel2_BR (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total surcharge amount |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the TotalSurchargeAmount 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
TransactionId
First included in: TransactionHeader/RetailFiscalDocumentModel2_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
DataAreaId
First included in: TransactionHeader/RetailFiscalDocumentModel2_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_CompanyRelationshipId
First included in: TransactionHeader/RetailFiscalDocumentModel2_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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for