Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
title3.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:

 



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Concession Object Formats

Excerpt


Code Block
languagejs
titleJSON Format
linenumberstrue
collapsetrue
{
	"ConcessionID": "",
	"Deleted": false,
	"Desc": {
		"en": ""
	},
	"Extensions": {},
	"Fixed": 0,
	"LookupCode": "",
	"Percentage": 0,
	"ProdTypes": [
		"${ProdType[.SubType]}"
	]
}



Concession Object Properties

(info) Required properties are in bold.

Note

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

Include Page
_def_Extensions
_def_Extensions

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