Coupons in Miscellaneous(RetailCoupon)

Article
02/22/2022

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	RetailCoupon/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.0"	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

languageTag	displayText
en	Coupons

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Miscellaneous/RetailCoupon
CouponNumber		Miscellaneous/RetailCoupon
Description		Miscellaneous/RetailCoupon
Status		Miscellaneous/RetailCoupon
ValidFrom		Miscellaneous/RetailCoupon
ValidTo		Miscellaneous/RetailCoupon
UsageLimit		Miscellaneous/RetailCoupon
UsageLimitType		Miscellaneous/RetailCoupon
IsCustomerRequired		Miscellaneous/RetailCoupon
IsExclusive		Miscellaneous/RetailCoupon
DiscountOfferId		Miscellaneous/RetailCoupon
ApplyWithoutCouponCode		Miscellaneous/RetailCoupon
DataAreaId		Miscellaneous/RetailCoupon
Relationship_RetailPeriodicDiscountRelationshipRelationshipId		Miscellaneous/RetailCoupon
Relationship_CompanyRelationshipId		Miscellaneous/RetailCoupon

RecId

First included in: Miscellaneous/RetailCoupon (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	RetailCoupon/(resolvedAttributes)/RecId	attribute

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

CouponNumber

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the CouponNumber attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

Description

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Description 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: Miscellaneous/RetailCoupon (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

ValidFrom

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ValidFrom attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

ValidTo

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ValidTo attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

UsageLimit

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the UsageLimit attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

UsageLimitType

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the UsageLimitType attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

IsCustomerRequired

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IsCustomerRequired attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

IsExclusive

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IsExclusive attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

DiscountOfferId

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ApplyWithoutCouponCode

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ApplyWithoutCouponCode attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

DataAreaId

First included in: Miscellaneous/RetailCoupon (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_RetailPeriodicDiscountRelationshipRelationshipId

First included in: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

entityReference	attributeReference
/core/operationsCommon/Tables/Commerce/Merchandising/WorksheetHeader/RetailPeriodicDiscount.cdm.json/RetailPeriodicDiscount	RecId

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: Miscellaneous/RetailCoupon (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo	RecId

entity

a reference to the constant entity holding the list of entity references

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

Share via

Coupons in Miscellaneous(RetailCoupon)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources