Back

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 Deposit 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. 


HTML Tags by Document Type

HTML Tags by Email Type


Accessing The Deposit Tags


Assuming you have access to the Deposit 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.


 
SyntaxExample
1
{{Deposit.TagName}}
{{Deposit.Amount}}
  2{{Deposit.TagName.SubObjectTagName}}
{{Deposit.Payment.DepositDate}}
3
 
<!-- {{#each Deposit.TagName}} -->
        {{SubObjectTagName}} <br />
<!-- {{/each}} -->
  		 
<!-- {{#each Deposit.Payments}} -->
        {{CashDate}} <br />
<!-- {{/each}} -->
  
  4
<!-- {{#each Deposits}} -->
        {{TagName}} <br />
<!-- {{/each}} -->

<!-- {{#each Deposits}} -->
        {{DepositDate}} <br />
<!-- {{/each}} -->
  5<!-- {{#each  Deposits}} -->
  <!-- {{#each  TagName}} -->
          {{SubObjectTagName}} <br />
  <!-- {{/each}} -->
<!-- {{/each}} -->
<!-- {{#each  Deposits}} -->
  <!-- {{#each  Payments}} -->
          {{CashDate}} <br />
  <!-- {{/each}} -->
<!-- {{/each}} -->


Overview


Tag NameDescription
Type
Additional Sub Object
AmountThe value that has been entered in the payment total field of the deposit.Decimal Value

CodeThe system generated code for the deposit.Whole Number
DepositDateThe date that is selected on the deposit.Date/Time
IDThe id of the deposit.Guid
NotesThe notes that have been input on the deposit.Text
PaymentsThe tags relating to payments that can be accessed for the payment.ListPayment Tags