Getting Started
If you are new to the HTML document/canned email tag system, you can get an overview of tags, objects and loops here.
Accessing The Commission Object
Access to this object is dependent on what document or canned email type you are trying to access the object from. Start by finding the document or canned email type you are working with from the links provided below. Follow the chart for your specified document or canned email type to see if the object is accessible, and if so, where it is located. You may need to use a combination of loops and/or chaining to access this object.
Accessing The Commission Tags
Assuming you have access to the Commission object, since the object itself is a list type, the object must be looped. The tags and/or sub-object tags should be nested within the loop.
Here is a chart displaying these use cases.
Syntax | Example | |
<!-- {{#each Commissions}} --> {{TagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Commissions}} --> {{Id}} <br /> <!-- {{/each}} --> | |
<!-- {{#each Commissions}} --> {{TagName.SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Commissions}} --> {{Employee.CellNumber}} <br /> <!-- {{/each}} --> |
Overview
Tag Name | Description | Type | Additional Sub Object |
CommissionPayment | The tags relating to commission can be accessed for the commission record on the item. | Commission Payment Tags | |
Employee | The tags relating to an employee can be accessed for the commission contact on the item. | Employee Tags | |
EmployeeId | The id of the employee who is the commission contact on the item. | Guid | |
Id | The id of the commission record on the item. | Guid | |
OrderItemId | The id of the order item. | Guid | |
Percentage | The percentage value of the commission record on this item. | Decimal Value | |
Total | The amount of the value of the commission record on this item. | Decimal Value |