DepositAndFeeRule
A Deposit and Fee Rule defines the deposit or fee amount to be added to a POS receipt when a specific item is sold. For example, a PET bottle of water carries a plastic bottle deposit: the amount (including VAT) is added to the transaction at point of sale, and refunded to the customer when the empty bottle is returned to any participating store.
type DepositAndFeeRule {
status: DepositAndFeeRuleStatus!
type: DepositAndFeeRuleType!
amount: Decimal!
code: String
isPercentage: Boolean!
countryCode: String
taxableGroupId: String
additionalProperties: [AdditionalProperty]
isIncludedInPrice: Boolean!
conditionIds: [String]
globalUniqueId: String
id: String
correlationId: String
tenantId: String
name: String
description: String
businessUnitId: String @deprecated
businessUnitIds: [String]
businessUnitGroupId: String
businessUnitHierarchyLevel: Int
version: Int!
revision: Long!
created: DateTime!
createdBy: String
modified: DateTime!
modifiedBy: String
}
Fields
DepositAndFeeRule.status ● DepositAndFeeRuleStatus! non-null enum
Status of the entity.
DepositAndFeeRule.type ● DepositAndFeeRuleType! non-null enum
The type of the entity.
DepositAndFeeRule.amount ● Decimal! non-null scalar
The monetary value representing a deposit or fee applied to a transaction. This can be added to the purchase price at the point of sale (POS) or be used to accumulate the correct return sum during a deposit-return process (e.g. using a reverse vending machine).
DepositAndFeeRule.code ● String scalar
An additional code can be applied in case several Sales Price Modifier Rules of the same type can apply and they must be separated by a code. Example: EcoTax in Portugal must be identified in the SAF-T report as a tax, and hence must be marked with the product code I.
DepositAndFeeRule.isPercentage ● Boolean! non-null scalar
If set to true, the amount must be treated as a percentage of the total sales amount for the Item being purchased.
DepositAndFeeRule.countryCode ● String scalar
An ISO-3166 country code + ISO-3166_2 sub division code as a single string separated by a '-'.
DepositAndFeeRule.taxableGroupId ● String scalar
The ID of the taxable group used for this deposit and fee rule. A taxable group is the logical name for the tax, independent of the tax rate assigned. The tax rate for a single taxable group can differ depending on region.
DepositAndFeeRule.additionalProperties ● [AdditionalProperty] list object
List of customer specific values on the entity level. NOT nullable, but can be empty.
DepositAndFeeRule.isIncludedInPrice ● Boolean! non-null scalar
A boolean flag indicating whether the deposit or fee amount is included in the price of the item.
DepositAndFeeRule.conditionIds ● [String] list scalar
Identifiers of the Entity Conditions applicable to this Deposit and Fee Rule. Entity Conditions are intent-based metadata records, owned by the Entity Conditions service, that instruct consuming systems (e.g. POS, UI, Electronic Shelf Labels, external devices) how an entity must be handled - covering legal, business, sales, entity and 3rd party requirements such as age verification or security tag removal.
DepositAndFeeRule.globalUniqueId ● String scalar
Internal unique ID for CRUD operations and relations. A typical example is: TenantId_itemId_BusinessUnitGroupId
DepositAndFeeRule.id ● String scalar
Id for the entity. Either external or internal
DepositAndFeeRule.correlationId ● String scalar
ID for tracing an entity and/or a group of sub entities through the application. Might be external, and if missing from the producer of data the API will add an ID. Must be used in all logging and tracing.
DepositAndFeeRule.tenantId ● String scalar
To support multi tenancy we need to be able to identify the customer that owns this information.
DepositAndFeeRule.name ● String scalar
The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.
DepositAndFeeRule.description ● String scalar
The description of the entity.
DepositAndFeeRule.businessUnitId ● String deprecated scalar
BusinessUnitId is obsolete. Use BusinessUnitIds property instead.
Used to assign the entity to tenant's specific business unit.
DepositAndFeeRule.businessUnitIds ● [String] list scalar
The business units associated with the entity.
DepositAndFeeRule.businessUnitGroupId ● String scalar
Used to assign the entity to a specific level in a business unit group hierarchy specific to the tenant.
DepositAndFeeRule.businessUnitHierarchyLevel ● Int scalar
Indicates on which level in the business unit group hierarchy the entity is defined. The property is used for prioritizing which definition to use, if several exists. The higher the number the higher the priority should be considered.
DepositAndFeeRule.version ● Int! non-null scalar
Version of the entity. Must be updated when there is a change to the entity. An ever increasing Integer.
Use revision instead of version if you need a more precise versioning mechanism.
DepositAndFeeRule.revision ● Long! non-null scalar
Contains evergrowing number used to validate the version of an entity.
DepositAndFeeRule.created ● DateTime! non-null scalar
When the object was first created. This timestamp will be set by the input API POST-endpoints before creating the AVRO data for processing.
DepositAndFeeRule.createdBy ● String scalar
Who created. Will be an ID and must be looked up in the user DB. This ID will be set by the input API POST-endpoints before creating the AVRO data for processing.
DepositAndFeeRule.modified ● DateTime! non-null scalar
When the object was modified. Will be updated along with the Version property. This timestamp will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.
DepositAndFeeRule.modifiedBy ● String scalar
Who created or modified the object. Will be an ID and must be looked up in the user DB. This ID will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.
Returned By
depositAndFeeRule query
Member Of
DepositAndFeeRulesConnection object ● DepositAndFeeRulesEdge object