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 PurchaseOrder 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 PurchaseOrder Tags
Assuming you have access to the PurchaseOrder object, you must do one of the following:
1. Prefix the object's name to the required tag
2. If the tag contains an 'Additional Sub Object', then the tag must prefix the sub-object tag and suffix the object
3. If the tag is a list type, then the tag must be looped. The sub-object tags should be nested within the loop.
4. If the object itself is a list type, then the object must be looped. The tags and/or sub-object tags should be nested within the loop.
5. If the object itself and the sub-object are list types, then both objects must be looped. The sub-sub-objects tags and/or objects should be nested within the loop.
Here is a chart displaying these use cases.
Syntax | Example | |
1 | {{PurchaseOrder.TagName}} | {{PurchaseOrder.CreatedDate}} |
2 | {{PurchaseOrder.TagName.SubObjectTagName}} | {{PurchaseOrder.Supplier.Email}} |
3 | <!-- {{#each PurchaseOrder.TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each PurchaseOrder.StockItems}} --> {{Cost}} <br /> <!-- {{/each}} --> |
4 | <!-- {{#each PurchaseOrders}} --> {{TagName}} <br /> <!-- {{/each}} --> | <!-- {{#each PurchaseOrders}} --> {{Number}} <br /> <!-- {{/each}} --> |
5 | <!-- {{#each PurchaseOrders}} --> <!-- {{#each TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> | <!-- {{#each PurchaseOrders}} --> <!-- {{#each StockItems}} --> {{Cost}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> |
Overview
Tag Name | Description | Type | Additional Sub Object |
CreatedByEmployee | The tags relating to an employee can be accessed for the employee who created the purchase order. | Employee | Employee Tags |
CreatedByEmployeeId | The id of the employee who created the purchase order. | Guid | |
CreatedDate | The date the purchase order was created. | Date/Time | |
Id | The id of the purchase order. | Guid | |
Notes | The notes that were input on the purchase order. | Text | |
Number | The purchase order number that has been generated or entered. | Text | |
Pending | |||
Received | |||
ReceivedPartial | |||
Sent | |||
Status | The status of the purchase order. | Text | |
StockItems | The tags relating to a stock item can be accessed for the stocks added on the purchase order. | List | Purchase Order Item Tags |
Supplier | The tags relating to a supplier can be accessed for the supplier selected on the purchase order. | Supplier | Supplier Tags |
SupplierId | The id of the supplier. | Guid | |
SupplyItems | The tags relating to a supply item can be accessed for the supplies added to the purchase order. | List | Purchase Order Item Tags |
TotalCost | The total cost of the purchase order items. | Decimal Values |