Document toolboxDocument toolbox

Discounts Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 18, 2024 by Jason Andrew

3.12.0

The Discounts object contains discounts that are applied to specific product types and sub-types. A single discount definition can cover multiple product types and sub-types. The Discounts object is always used inside other objects and never used as a stand alone object. A separate MaxDiscounts object is used to set limits on the discounts being calculated. 

The Discount object is currently used by:


On this page:

Related pages

 

Product Types and Sub-Types

Product is a general term used to refer to a line item in a product catalog. A product does not have to represent a physical item and could instead refer to a travel charge or labor code. Products are classified (grouped) by type and sub-type codes. When working with discounts you identify what product types and/or sub-types are applicable to the discount.

See: Product Types

Percentage Based Discounts

Discounts can be calculated as a percentage of the total dollar amount for the product types/sub-types listed in the discount object. If the percentage discount is associated with a product type, then the discount will also apply to all sub-types unless the sub-type has a specific percentage discount override. 

Maximum Discount Limits

Maximum discounts limits can be set for specific product types/sub-types with the MaxDiscounts object. When dealing with maximum discounts, you can provide both a fixed maximum dollar amount or percentage. If both are provided the lesser of the two calculated values will be used. 

Discount Object Formats

JSON Format 
"Discounts": [
	{
		"ID": "",
		"Desc": "",
		"IsApplied" : true,
 		"Fixed": 0.00,
		"ProdTypes": ["${ProdType}","${ProdType}","${ProdType}"]
		"Percentage" : 0.00,
		"Delete": false
	}
]
 
"MaxDiscounts" : {
	"${ProdType[.SubType]}" : {
		"Percentage" : 0.0,
		"Fixed" : 0.0
	}
}

Discount Object Properties

(info) Required properties are in bold.

PropertyValueDescription
IDstring

Optional property.

This property uniquely identifies the discount object.

3.19.1

DescstringContains a human readable description of the discount.
ProdTypesobjectContains one or more objects each describing the discount for the specific product type and/or sub-type
${ProdType[.SubType]}string

Identifies the product type and/or sub-type the 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
IsAppliedboolean

Specifies if the discount can be applied. The application can be configured to allow the technician to selectively apply or remove discounts.

Valid values are:

  • true = Discount will be applied
  • false = Discount will not be applied

If this property is not specified then the default value is true

3.16.0

Percentagedecimal

Specifies a percentage based discount.


FixeddecimalIdentifies the fixed discount amount that can be applied for the specified product type/sub-type.
Deleteboolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.

3.19.1

MaxDiscount Object Properties

PropertyValueDescription
MaxFixeddecimal

Identifies the maximum fixed discount amount that can be applied for the specified product type/sub-type.

3.16.0

MaxPercentagedecimal

Identifies the maximum percentage dollar value that can be applied for the specified product type/sub-type.

3.16.0