Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 71 Next »

3.35.0

The Concession object contains special promotions or discounts that are applied to specific product types and sub-types. A single concession definition can cover multiple product types and sub-types. The Concession object is always used inside other objects and never used as a stand alone object. 

The Concession object is currently used by:

 

Concession Object Formats

JSON Format
{
	"ConcessionID": "",
	"Deleted": false,
	"Desc": {
		"en": ""
	},
	"Extensions": {},
	"Fixed": 0,
	"LookupCode": "",
	"Percentage": 0,
	"ProdTypes": [
		"${ProdType[.SubType]}"
	]
}

Concession Object Properties

(info) Required properties are in bold.

Please note that Fixed or Percentage is a required property. The other required properties are in bold.


PropertyTypeDescription
ConcessionIDstringThis property uniquely identifies the concession.

Deleted

boolean

Identifies if the concession information is to be deleted.

Valid values are:

  • true - The concession object should be deleted
  • false - The concession object should not be deleted. This is the default value if this property is not specified.
DescobjectThis object contains a list of localized descriptions for the concession. Each entry in the collection contains a key/value pair combination. The key identifies the language code (see: Language Culture Codes) and the value refers to the localized description for the language.
Extensionsobject

This object contains an optional collection of key/value pairs.

These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system.

FixeddecimalIdentifies the fixed concession discount amount that can be applied for the specified product type/sub-type.
LookupCodestringThis specialized code helps in finding concession to be applied to the invoice for a work order.
PercentagedecimalSpecifies a percentage based concession discount.
ProdTypescollection

Collection of one or more product types and/or sub-types the concession discount applies to. The .SubType portion is optional.

Examples

  • 1001 - Specifies a product type of 1001
  • 1001.100 - Specifies a product sub-type of 100 of the product type 1001
  • No labels