create new ticket
check ticket statusGetting 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 Customer 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 Customer Tags
Assuming you have access to the Customer 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 | {{Customer.TagName}} | {{Customer.Name}} |
2 | {{Customer.TagName.SubObjectTagName}} | {{Customer.ShippingLocation.City}} |
3 | <!-- {{#each Customer.TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Customer.Transaction}} --> {{Date}} <br /> <!-- {{/each}} --> |
4 | <!-- {{#each Customers}} --> {{TagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Customers}} --> {{Number}} <br /> <!-- {{/each}} --> |
| 5 | <!-- {{#each Customers}} --> <!-- {{#each TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> | <!-- {{#each Customers}} --> <!-- {{#each Orders}} --> {{Number}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> |
Customer Tags Available
| Tag Name | Description | Type | Sub Object |
| AccountsPayable | The tags relating to a contact can be accessed for the contact who is set as the accounts payable contact on the customer. | Contact Tags | |
| AccountsPayableContactId | The id of the accounts payable contact set on the customer. | Guid | |
| Avatar | The image uploaded to the customer. | Image | Small Large |
| Balances | The tags relating to balances can be accesses for the customer. | Customer Balances Tags | |
| Barcode | A barcode can be generated to populate the url to the customer. | Text | |
| BillingLocation | The tags relating to a location can be accessed for the default billing location input on the customer. | Location Tags | |
| CreditLimit | The credit limit value that has been set | Decimal Value | |
| ExternalId | The external id that was input on the customer. | Text | |
| Id | The id of customer. | Guid | |
| InvoiceDelivery | The invoice delivery that has been selected on the customer. | Text | |
| LastOrderDate | The date of the most recent order that this customer has been attached to | Date/Time | |
| Name | The name of the customer that has been input on the customer. | Text | |
| Number | The number that was assigned to the customer on creation. | Number | |
| Orders | The tags relating to an order can be accessed for orders belonging to the customer. | List | Order Tags |
| PaymentTerms | The payment term that has been selected on the customer. | Text | |
| RequiresPurchaseOrder | True if the customer is set to a require a PO, False if they do not require one. | True/False | |
| SalesRep | The tags relating to a employee can be accessed for the employee who is set as the sales rep on the customer. | Employee Tags | |
| SalesRepId | The id of the sales rep employee set on the customer. | Guid | |
| ShippingLocation | The tags relating to a location can be accessed for the default shipping location input on the customer. | Location Tags | |
| SinceDate | The date they became a customer. | Date/Time | |
| Tags | A list of the tag (names) applied to the customer. | List | |
| TaxExemptNumber | The tax exempt number that has been input on the customer. | Text | |
| Transactions | The tags relating to transaction records can be accessed for posted orders, entries and payments for the customer. | List | Transaction Tags |
| UrlPath | The url to the customer. | Text |