Retail Fiscal Document Payment Transactions in Transaction(FiscalDocumentPaymentTrans_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 | FiscalDocumentPaymentTrans_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/FiscalDocumentPaymentTrans_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 | FiscalDocumentPaymentTrans_BR/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
Amount
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Total amount |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the Amount 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
CardAuthorizationNumber
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CardAuthorizationNumber 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
CardLogo
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the CardLogo attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
CardProcessorCNPJCPF
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
displayName | Card processor CNPJ |
dataFormat | string |
isNullable | true |
Traits
List of traits for the CardProcessorCNPJCPF 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
FiscalDocument
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the FiscalDocument 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
LineNum
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the LineNum 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
PaymentType
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the PaymentType attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
TenderTypeId
First included in: Transaction/FiscalDocumentPaymentTrans_BR (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TenderTypeId 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/FiscalDocumentPaymentTrans_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_FiscalDocumentRelationshipId
First included in: Transaction/FiscalDocumentPaymentTrans_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 |
| 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/FiscalDocumentPaymentTrans_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