Voided retail fiscal documents in Transaction(RetailFiscalDocumentCancel_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 | RetailFiscalDocumentCancel_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/RetailFiscalDocumentCancel_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 | RetailFiscalDocumentCancel_BR/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
AccessKey
First included in: Transaction/RetailFiscalDocumentCancel_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
CancelAccountingDate
First included in: Transaction/RetailFiscalDocumentCancel_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Cancel accounting date |
dataFormat | date |
isNullable | true |
Traits
List of traits for the CancelAccountingDate attribute are listed below.
is.dataFormat.date
means.measurement.date
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.date
CancelReasonComment
First included in: Transaction/RetailFiscalDocumentCancel_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CancelReasonComment 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/RetailFiscalDocumentCancel_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
MessageStatus
First included in: Transaction/RetailFiscalDocumentCancel_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
ProtocolNumber
First included in: Transaction/RetailFiscalDocumentCancel_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
ReplicationCounterFromOrigin
First included in: Transaction/RetailFiscalDocumentCancel_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/RetailFiscalDocumentCancel_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
store
First included in: Transaction/RetailFiscalDocumentCancel_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/RetailFiscalDocumentCancel_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
transactionId
First included in: Transaction/RetailFiscalDocumentCancel_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/RetailFiscalDocumentCancel_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/RetailFiscalDocumentCancel_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
CancelAccessKey
First included in: Transaction/RetailFiscalDocumentCancel_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CancelAccessKey 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
CancelQrcodeText
First included in: Transaction/RetailFiscalDocumentCancel_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CancelQrcodeText 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
CancelTaxAuthorityInfo
First included in: Transaction/RetailFiscalDocumentCancel_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CancelTaxAuthorityInfo 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
CancelTotalAmount
First included in: Transaction/RetailFiscalDocumentCancel_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Total amount |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the CancelTotalAmount 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
DataAreaId
First included in: Transaction/RetailFiscalDocumentCancel_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: Transaction/RetailFiscalDocumentCancel_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