> For the complete documentation index, see [llms.txt](https://docs.stayonhire.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stayonhire.com/documents/templates/reference-tags.md).

# Reference Tags

## Job Tags

The following tags can be used anywhere you need documents produced.

<table><thead><tr><th width="249">Tag</th><th width="248">Description</th><th width="250.31640625">Example</th></tr></thead><tbody><tr><td>{{#JobAllocations}}<br>...<br>{{/}}</td><td>Special tag to start and end a list of job allocations. <br><br>After the tag is used you can access nested tags of the allocation data, then use <code>{{/}}</code> to exit the list context and return to primary tags. <br><br>Without these tags at the start and end the document can not know where to start and end the list.<br><br><a href="#job-allocation-tags">View nested tags</a></td><td>Tags needed at start/end but do not appear in the document export:<br><br><img src="https://50563950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lzplo2osBdXGzFtPu2f%2Fuploads%2FUSxJUl8v9te61WpOv0UJ%2FScreenshot%202026-02-18%20at%2012.22.07%E2%80%AFpm.png?alt=media&amp;token=7345fcc4-135d-4ad7-a9f1-25269fd3d563" alt=""></td></tr><tr><td>{{JobAssetIDs}}</td><td>Formatted list of asset IDs that are linked to job, seperated by commas.<br><br>Commonly used inn the reference field of smaller jobs.</td><td>EX01, BU01, BU02, BU03</td></tr><tr><td>{{JobBillingContactAddress}}</td><td>Formatted address of job's client/billing contact</td><td>123 Hamilton Street, Joondalup, WA 6000</td></tr><tr><td>{{JobBillingContactABN}}</td><td>The ABN of job's client/billing contact</td><td>97 123 456 789</td></tr><tr><td>{{JobBillingContactACN}}</td><td>The ACN of job's client/billing contact</td><td>123 456 789</td></tr><tr><td>{{JobBillingContactDetails}}</td><td>Summary of job's client/billing contact details combined into Name, Mobile, Landline and Email information.</td><td>Ben Billing<br>M: 0412 345 678<br>L: 08 1234 5678<br>E: ben@company.com</td></tr><tr><td>{{JobBillingContactEmail}}</td><td>The email of job's client/billing contact</td><td>ben@company.com</td></tr><tr><td>{{JobBillingContactName}}</td><td>The client company name or primary identifier as defined in the Contacts page of your app.</td><td>ABC Company Name</td></tr><tr><td>{{JobBillingContactMobile}}</td><td>Formatted mobile of job's client/billing contact</td><td>0412 345 678</td></tr><tr><td>{{JobBillingContactLandline}}</td><td>Formatted landline of job's client/billing contact</td><td>08 9123 4567</td></tr><tr><td>{{JobBillingContactFax}}</td><td>Formatted fax of job's client/billing contact</td><td>08 9123 4567</td></tr><tr><td>{{JobBillingContactPersonFullName}}</td><td>The full name of job's client/billing contact</td><td>Ben Billing</td></tr><tr><td>{{JobContactName}}</td><td>The primary contact name assigned to a company, business or person who is a client to your business.</td><td>ABC Company Name</td></tr><tr><td>{{JobContactFullName}}</td><td>The full name of the job's job contact (from job contacts section)</td><td>James Job</td></tr><tr><td>{{JobContactDetails}}</td><td>Summary of job's job contact details (from job contacts section)</td><td>James Job<br>M: 0412 345 678<br>L: 08 1234 5678<br>E: james@company.com</td></tr><tr><td>{{JobContactMobile}}</td><td>Formatted mobile of job's job contact (from job contacts section)</td><td>0412 345 678</td></tr><tr><td>{{JobContactLandline}}</td><td>Formatted landline of job's job contact (from job contact section)</td><td>08 1234 5678</td></tr><tr><td>{{JobContactEmail}}</td><td>The email of job's job contact (from job contacts section)</td><td>james@company.com</td></tr><tr><td>{{JobSiteContactFullName}}</td><td>The full name of job's site contact (from job contacts section).<br><br>i.e. The person on site who may receive deliveries.</td><td>Sam Site</td></tr><tr><td>{{JobSiteContactDetails}}</td><td>Summary of job's site contact details combined into Name, Mobile, Landline and Email information.<br><br>i.e. The person on site who may receive deliveries.</td><td>Sam Site<br>M: 0412 345 678<br>L: 08 1234 5678<br>E: sam@company.com</td></tr><tr><td>{{JobSiteContactMobile}}</td><td>The mobile phone number of a job's site contact (from job contacts section).<br><br>i.e. The person on site who may receive deliveries.</td><td>0412 345 678</td></tr><tr><td>{{JobSiteContactLandline}}</td><td>The landline number of a job's site contact (from job contacts section).<br><br>i.e. The person on site who may receive deliveries.</td><td>08 1234 5678</td></tr><tr><td>{{JobSiteContactEmail}}</td><td>The email of a job's site contact (from job contacts section).<br><br>i.e. The person on site who may receive deliveries.</td><td>sam@company.com</td></tr><tr><td>{{JobDescription}}</td><td>Long-form text describing the scope of work.</td><td>Supply and delivery of 20t Excavators for site prep.</td></tr><tr><td>{{JobEstEndDateTime}}</td><td>Estimated completion date and time (ISO/Local).<br><br>This can also be "Ongoing" if the job has no forecast end.</td><td>15/12/2023 05:00 PM<br><br>or<br><br>"Ongoing"</td></tr><tr><td>{{JobEstStartDateTime}}</td><td>Estimated commencement date and time (ISO/Local).</td><td>12/10/2023 08:00 AM</td></tr><tr><td>{{JobFuelCharges}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobCleaningFees}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobLiabilityCover}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobListContacts}}</td><td>Displays Billing, Site and Job, contact names in that order, seperated by commas.<br><br>Used when addressing a document to all on a job. <br><br>i.e. "ATTN: Ben Billing, Sam Site, James Job"</td><td>Ben Billing, Sam Site, James Job</td></tr><tr><td>{{JobListStaffResponsible}}</td><td>Displays team member names assigned reposisible to the job, seperated by commas.<br><br>Used to detail who can be contacted if needed. <br><br>i.e. "Sales Rep: Sarah Sales"</td><td>Sarah Sales</td></tr><tr><td>{{JobName}}</td><td>The descriptive title given to the job.</td><td>Northshore Extension Project</td></tr><tr><td>{{JobNotes}}</td><td>A descriptive field used by companies how they see fit.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobNumber}}</td><td>The unique alphanumeric identifier for the job.</td><td>JOB-10254</td></tr><tr><td>{{JobPONumber}}</td><td>The client's Purchase Order number.</td><td>PO-882190</td></tr><tr><td>{{JobRentalRate}}</td><td>The text box field in Job Details that can be used to write whatever your company likes.<br><br>Thic can be kep private from company documents or also used to pre-fill into documents.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobRateNotes}}</td><td>The text box field in Job Details that can be used to write whatever your company likes.<br><br>Thic can be kep private from company documents or also used to pre-fill into documents.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobSiteAddress}}</td><td>The full formatted physical address of the job site.</td><td>123 Industrial Way, Perth WA 6000</td></tr><tr><td>{{JobSpecialConditions}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>"Any text entered by your business"</td></tr><tr><td>{{JobTransportContactName}}</td><td>The client contact name performing the delivery or collection.</td><td>Transport Company Name</td></tr><tr><td>{{JobTransportCostExTax}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.<br><br>Replaced by {{MobeCost}} and {{DemobeCost}}.</td><td>$1,500</td></tr><tr><td>{{JobTransportDate}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.<br><br>Replaced by {{MobePickupDateTime}} and {{DemobePickupDateTime}}.</td><td>1 Jan 2030</td></tr><tr><td>{{JobTransportFromAddress}}</td><td><strong>This field is longer in use and has been supersceded by newer refernce tags.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>Not applicable / Do not use</td></tr><tr><td>{{JobTransportNotes}}</td><td><strong>This field is longer in use and has been supersceded by newer refernce tags.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>Not applicable / Do not use</td></tr><tr><td>{{JobTransportToAddress}}</td><td><strong>This field is longer in use and has been supersceded by newer refernce tags.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>Not applicable / Do not use</td></tr><tr><td>{{MobeNotes}}</td><td>The text box field in Transport events that can be used to write whatever your company likes.<br><br>Thic can be kep private from company documents or also used to pre-fill into documents.</td><td>"Any text entered by your business"</td></tr><tr><td>{{MobeFreightType}}</td><td>The method chosen within the app to build the transport event.</td><td>"One delivery"<br>"Customer self-pickup"<br>"Not required"</td></tr><tr><td>{{MobeMethod}}</td><td>The method chosen within the app to build the transport event.</td><td>"One delivery"<br>"Customer self-pickup"<br>"Not required"</td></tr><tr><td>{{MobeTransportProviderName}}</td><td>The primary client name of the service provider completing this work.<br><br>This can be an external contact or your internal business name if proviing the service 'in-house'.</td><td>"External Transport Company Pty Ltd"<br><br>or<br><br>"Our Company Name Pty Ltd"</td></tr><tr><td>{{MobeDeliveryContactPerson}}</td><td>Relating specifically to the first mobilisation transport event on a job, this is the site contact person, with their phone number and email.<br><br>This will often pre-fill with the Site Contact from the job, though can also be overridden by users when creating a delivery event.</td><td>Steve Site, 0441 234 567, steve@company.com</td></tr><tr><td>{{MobePickupAddressNickname}}</td><td>A landmark or nickname given to an address. <br><br>This tag is specifically used for customer's who self-pickup. <br><br>i.e. "Fiona Stanley Hospital"</td><td>"Any text entered by your business" <br><br>or<br><br>"Landmark Nickname" prefilled by Google Maps</td></tr><tr><td>{{MobePickupAddress}}</td><td>Origin address for the delivery.<br><br>Used specfically for events relating to start of job where the dirver is travlling to a locaiton to collect.</td><td>45 Yard Lane, Welshpool WA 6106</td></tr><tr><td>{{MobeDeliveryAddressNickname}}</td><td>A landmark or nickname given to an address. <br><br>This tag is specifcally used in relation to mobilisaiton delivery events.<br><br>i.e. "Fiona Stanley Hospital"</td><td>"Any text entered by your business" <br><br>or<br><br>"Landmark Nickname" prefilled by Google Maps</td></tr><tr><td>{{MobeDeliveryAddress}}</td><td>Origin address for the delivery.<br><br>Used specfically for events relating to start of job deliveries to a customer location.</td><td>45 Yard Lane, Welshpool WA 6106</td></tr><tr><td>{{MobePickupPrefix}}</td><td>The transport target or goal defined when scheduling a delivery at the start of a job. Used specifically for customer's who self-pickup.<br><br>This field pairs well with {{MobePickupDateTime}}.<br><br>i.e. "Deliver before 1 Jan 2030, 12:00 am.</td><td>"Deliver before..."<br>"Deliver after..."<br>"Collect before..."<br>"Collect after..."</td></tr><tr><td>{{MobeDeliveryPrefix}}</td><td>The transport target or goal defined when scheduling a delivery at the start of a job.<br><br>This field pairs well with {{MobePickupDateTime}}.<br><br>i.e. "Deliver before 1 Jan 2030, 12:00 am"</td><td>"Deliver before..."<br>"Deliver after..."<br>"Collect before..."<br>"Collect after..."</td></tr><tr><td>{{MobePickupDateTime}}</td><td>The <strong>date and time</strong> of the mobilisation's schedule in one tag.<br><br>Used specifically with deliveries where the customer is self-picking up at the start of the mobilisation.</td><td>31 Dec 2026, 04:00 pm</td></tr><tr><td>{{MobeDeliveryDateTime}}</td><td>The <strong>date and time</strong> of the mobilisation's schedule in one tag.<br><br>Used specifically with deliveries where the driver is collecting from someone at the start of the mobilisation.</td><td>31 Dec 2026, 04:00 pm</td></tr><tr><td>{{MobeCost}}</td><td>The value charged for mobilisation, excluding taxes.</td><td>$550.00</td></tr><tr><td>{{MobeTime}}</td><td>The <strong>time only</strong> of the mobilisation's schedule</td><td>06:00 pm</td></tr><tr><td>{{MobeDate}}</td><td>The <strong>date only</strong> of the mobilisation's schedule</td><td>1 Oct 2026</td></tr><tr><td>{{MobeCompletion}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>Not applicable / Do not use</td></tr><tr><td>{{DemobeNotes}}</td><td>The text box field in Transport events that can be used to write whatever your company likes.<br><br>Thic can be kep private from company documents or also used to pre-fill into documents.</td><td>"Any text entered by your business"</td></tr><tr><td>{{DemobeFreightType}}</td><td>The method chosen within the app to build the transport event.</td><td>"One collection"<br>"Customer self-return"<br>"Not required"</td></tr><tr><td>{{DemobeMethod}}</td><td>The method chosen within the app to build the transport event.</td><td>"One collection"<br>"Customer self-return"<br>"Not required"</td></tr><tr><td>{{DemobeTransportProviderName}}</td><td>The primary client name of the service provider completing this work.<br><br>This can be an external contact or your internal business name if proviing the service 'in-house'.</td><td>"External Transport Company Pty Ltd"<br><br>or<br><br>"Our Company Name Pty Ltd"</td></tr><tr><td>{{DemobeCollectionContactPerson}}</td><td></td><td></td></tr><tr><td>{{DemobePickupAddressNickname}}</td><td>A landmark or nickname given to an address.<br><br>i.e. "Fiona Stanley Hospital"</td><td>"Any text entered by your business" <br><br>or<br><br>"Landmark Nickname" prefilled by Google Maps</td></tr><tr><td>{{DemobePickupAddress}}</td><td>The starting address of a delivery, specific to a demobe transport event.<br><br>This would typically pre-fill with the job's site address, as this would typically be where the asset is being picked up from. </td><td>123 Industrial Way, Perth WA 6000</td></tr><tr><td>{{DemobeDeliveryAddressNickname}}</td><td>A landmark or nickname given to an address.<br><br>i.e. "Fiona Stanley Hospital"</td><td>"Any text entered by your business" <br><br>or<br><br>"Landmark Nickname" prefilled by Google Maps</td></tr><tr><td>{{DemobeDeliveryAddress}}</td><td></td><td></td></tr><tr><td>{{DemobePickupPrefix}}</td><td>The transport target or goal defined when scheduling a customer self-pickup at the end of a job.<br><br>This field pairs well with {{DemobePickupDateTime}}.<br><br>i.e. "Deliver before 1 Jan 2030, 12:00 am"</td><td>"Deliver before..."<br>"Deliver after..."<br>"Collect before..."<br>"Collect after..."</td></tr><tr><td>{{DemobeDeliveryPrefix}}</td><td>The transport target or goal defined when scheduling a delivery at the end of a job.<br><br>This field pairs well with {{DemobePickupDateTime}}.<br><br>i.e. "Deliver before 1 Jan 2030, 12:00 am"</td><td>"Deliver before..."<br>"Deliver after..."<br>"Collect before..."<br>"Collect after..."</td></tr><tr><td>{{DemobePickupDateTime}}</td><td></td><td></td></tr><tr><td>{{DemobeDeliveryDateTime}}</td><td></td><td></td></tr><tr><td>{{DemobeCost}}</td><td>The flat charge amount recorded on the transport event, excluding taxes.</td><td>500.00</td></tr><tr><td>{{DemobeTime}}</td><td>The <strong>time only</strong> of the mobilisation's schedule</td><td>06:00 AM</td></tr><tr><td>{{DemobeDate}}</td><td>The <strong>date only</strong> of the mobilisation's schedule</td><td>1 Oct 2026</td></tr><tr><td>{{DemobeCompletion}}</td><td><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</td><td>Not applicable / Do not use</td></tr><tr><td>{{JobBillingContactAddressLine}}</td><td></td><td></td></tr><tr><td>{{JobBillingContactAddressSuburb}}</td><td></td><td></td></tr><tr><td>{{JobBillingContactAddressState}}</td><td></td><td></td></tr><tr><td>{{JobBillingContactAddressZip}}</td><td></td><td></td></tr><tr><td>{{JobBillingContactFirstName}}</td><td></td><td></td></tr><tr><td>{{JobBillingContactLastName}}</td><td></td><td></td></tr><tr><td>{{JobSiteAddressLine}}</td><td></td><td>191 St Georges Terrace</td></tr><tr><td>{{JobSiteAddressSuburb}}</td><td></td><td>Perth</td></tr><tr><td>{{JobSiteAddressState}}</td><td></td><td>WA</td></tr><tr><td>{{JobSiteAddressZip}}</td><td></td><td>6000</td></tr><tr><td>{{EstHireDuration}}</td><td>The approximate duraiton of time between start and end of hire, displayed shorthand in a readable value of years, months, days, minutes.</td><td>31d 0h 0m</td></tr><tr><td>{{CreatedByUserFullName}}</td><td>The first and last name of the user who drafted the document. <br><br>Commonly used when detailing the author and primary contact for a quote or invoice.</td><td>Steve Smith</td></tr><tr><td>{{CreatedByUserMobile}}</td><td>The internal mobile contact nubmer of the user who drafted the document. <br><br>Commonly used when detailing the author and primary contact for a quote or invoice.</td><td>0412 345 678</td></tr><tr><td>{{CreatedByUserEmail}}</td><td>The work email address of the user who drafted the document. <br><br>Commonly used when detailing the author and primary contact for a quote or invoice.</td><td>steve@company.com</td></tr><tr><td>{{JobBillingContactPhotoIDLicenceNumber}}</td><td>The unique ID of photo identification taken when capturing a customer's details.</td><td>1234567</td></tr><tr><td>{{JobBillingContactPhotoIDLicenceState}}</td><td>The state and country of the origination photo ID</td><td>WA Australia</td></tr><tr><td>{{JobBillingContactPhotoIDFront}}</td><td>A photo of the licence taken of the front.</td><td><p></p><div><figure><img src="https://50563950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lzplo2osBdXGzFtPu2f%2Fuploads%2F11iN8zY6vgKWx9NXCq5B%2FScreenshot%202026-08-05%20at%2011.13.47%E2%80%AFam.png?alt=media&amp;token=58c003d3-e8f7-4f8a-8439-43b7ae1c0fbb" alt=""><figcaption></figcaption></figure></div></td></tr><tr><td>{{JobBillingContactPhotoIDBack}}</td><td>A photo of the licence taken of the rear.</td><td><div><figure><img src="https://50563950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lzplo2osBdXGzFtPu2f%2Fuploads%2Fk8riAFZkwnj1Py3Aev6l%2FScreenshot%202026-08-05%20at%2011.13.51%E2%80%AFam.png?alt=media&amp;token=499e9ade-6832-4dba-97c8-b3e772bdd432" alt=""><figcaption></figcaption></figure></div><p></p></td></tr><tr><td></td><td></td><td></td></tr><tr><td></td><td></td><td></td></tr></tbody></table>

## Org Tags

| Tag                        | Description                                                   | Example                              |
| -------------------------- | ------------------------------------------------------------- | ------------------------------------ |
| {{OrgABN}}                 | ABN of your organisation                                      | 97 123 456 789                       |
| {{OrgBillingAddress}}      | Your company’s primary mailing/billing address.               | Suite 4, 10 Main St, Sydney NSW 2000 |
| {{OrgBillingContactEmail}} | Email of billing contact from organisation settings           |                                      |
| {{OrgBillingContactName}}  | Name of billing contact from organisation settings            | Adam West                            |
| {{OrgBillingContactPhone}} | Formatted phone of billing contact from organisation settings | 0412 345 678                         |
| {{OrgName}}                | Name of your organisation                                     | Example Hire Company                 |

## Table Lists

These tags pull data directly from the Job entity. They are used for primary document headers and site-specific details.

The following tags can only be used when listing multiple asset rows in one context. For example, producing a hire agreement table with multiple rows of several assets.

| Tag                        | Description                                                                                                                                                              | Example                                                         |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
| {{#JobAllocations}}        | <p><strong>REQUIRED:</strong><br>Begin any table listing multiple rows with this special tag to start the list. This can be inserted as a row for easy visualisation</p> | <p>Download template with tags<br>Download document list</p>    |
| {{/}}                      | <p><strong>REQUIRED:</strong><br>Finish any table with this special tag to finish the list</p>                                                                           | <p>Download template with tags<br>Download document list</p>    |
| {{$AssetID}}               | The asset's primary identification tag/acronym. This can often be physically marked on the asset                                                                         | <p>"EX01"<br>"ASSET-0001"<br>"0000001"</p>                      |
| {{$AssetShortDescription}} | A short description of this asset that helps your team quickly identify more information about an asset                                                                  | <p>"Mini Excavator with ROPS"<br>"Cat 301.5 Mini Excavator"</p> |
| {{$Rate}}                  | <p>The position's rate, displayed in a quickly readable format<br>i.<em>e. Amount per Unit of Time</em></p>                                                              | "$200 / day"                                                    |
| {{$HireStatus}}            | The current hire status of the asset allocation, displayed as simple text                                                                                                | <p>"Pending"<br>"In Progress"<br>"Hire finished"</p>            |
| {{$OnHireDate}}            | Pull the start date and time of hire. If not yet known, the job's estimated start date may be inserted here instead.                                                     | "1 Jan 2025 06:00 am"                                           |
| {{$OnHireSMUReading}}      | The service meter reading of this asset at the pre-hire inspection or start of the hire                                                                                  | "12345.00"                                                      |
| {{$AssetSerialNumber}}     | The recorded serial number associated with this asset                                                                                                                    | "123456789"                                                     |

## Job Allocation Table Rows

These tags must be placed inside the `{{#JobAllocations}} ... {{/}}` block. They iterate through each individual asset or service assigned to the job.

| Tag                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                            | Example                                                                           |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| {{$AssetHomeBranch}}                    | <p><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</p>                                                                                                                                                                                                                                   | Not applicable / Do not use                                                       |
| {{$AssetID}}                            | The unique fleet or plant number of the asset.                                                                                                                                                                                                                                                                                                                                                                         | EX-04                                                                             |
| {{$AssetMake}}                          | The manufacturer of the asset. Commonly paired with {{$AssetModel}} inside a single "Make / Model" column of an allocation or freight checklist table.                                                                                                                                                                                                                                                                 | Komatsu                                                                           |
| {{$AssetModel}}                         | The manufacturer's model designation for the asset. Commonly paired with {{$AssetMake}} inside a single "Make / Model" column of an allocation or freight checklist table.                                                                                                                                                                                                                                             | PC200-8                                                                           |
| {{$AssetSerialNumber}}                  | The manufacturer's unique chassis/serial number.                                                                                                                                                                                                                                                                                                                                                                       | KMT12345ABC                                                                       |
| {{$AssetShortDescription}}              | A brief summary of the asset as identified by your team internally.                                                                                                                                                                                                                                                                                                                                                    | 20T Hydraulic Crawler Excavator                                                   |
| {{$AssetRoadRego}}                      | <p>The road registration (number plate) recorded against the asset. <br><br>Only populated for road-registered assets such as trucks and trailers, so design the row to read correctly when it renders empty for unregistered plant.</p>                                                                                                                                                                               | QWE123                                                                            |
| {{$AssetVIN}}                           | <p>The Vehicle Identification Number recorded against the asset. <br><br>Sits alongside {{$AssetSerialNumber}} and {{$AssetEngineNumber}} in the identification of an asset's specifications.</p>                                                                                                                                                                                                                      | 123456789123456                                                                   |
| {{$AssetCategory}}                      | <p>The 'Category Title' assigned to this asset. This will be configured by your business settings and is generally used to describe the Size or Type of a grouped asset category.<br><br>i.e. "5.5t excavators"<br>"Posi Track Skid Steer Loader"</p>                                                                                                                                                                  | 5.5t Excavator                                                                    |
| {{$AssetCategoryGroup}}                 | <p>Asset categories that are in common together under this definition.<br><br>i.e. 1.7t, 5.5t and 20t excavators could be placed under a group titled "Excavators"<br><br>If you have different types, under each group, this is how you could seperate them.<br><br>i.e. A group called "Tracked Excavators" and a seperate group called "Wheeled Excavators" could both contain 5.5t categories underneath them.</p> | <p>"Excavators"<br><br>or<br><br>"Tracked Excavators"<br>"Wheeled Excavators"</p> |
| {{$AssetCategoryCode}}                  | <p>The short code you company may use to refer to this group groups and type of asset.<br><br>This is usually paired with the Asset Category.</p>                                                                                                                                                                                                                                                                      | <p>"EX-5.5"<br><br>or<br><br>"TR-EX-5.5"<br>"WH-EX-5.5"</p>                       |
| {{$ChargeBasedOn}}                      | <p><strong>This field is longer in use and has been supersceded by newer functionality.</strong><br><br>This value is still active for legacy customers still using the feature.</p>                                                                                                                                                                                                                                   | Not applicable                                                                    |
| {{$HireStatus}}                         | The current state of the allocation (e.g. On Hire).                                                                                                                                                                                                                                                                                                                                                                    | On Hire                                                                           |
| {{$OffHireDate}}                        | The date the asset was officially returned from hire.                                                                                                                                                                                                                                                                                                                                                                  | 10/11/2023                                                                        |
| {{$OffHireSMUReading}}                  | The engine hours or odometer reading at end of a hire.                                                                                                                                                                                                                                                                                                                                                                 | 1490.2                                                                            |
| {{$OnHireDate}}                         | The date the asset was officially on hired out to the client.                                                                                                                                                                                                                                                                                                                                                          | 14/11/2023                                                                        |
| {{$OnHireSMUReading}}                   | The engine hours or odometer reading at start of a hire.                                                                                                                                                                                                                                                                                                                                                               | 1450.5                                                                            |
| {{$Rate}}                               | The specific hire rate for this individual allocation.                                                                                                                                                                                                                                                                                                                                                                 | $1,200.00 / Day                                                                   |
| {{$JobRentalRate}}                      | Any text written by your team in the 'Job Rate Notes' field inside a job. These can often be string text, are unformatted text and should be reserved for specific needs.                                                                                                                                                                                                                                              | <p>"Asset #123 @ $495.00+ per week.                                               |
| <br>Transport @ $345.00+ each way."</p> |                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                   |
| {{$AssetPPSRNumber}}                    | A 12-digit reference number generated when you run or create a search on the [Personal Property Securities Register](https://www.google.com/url?sa=i\&source=web\&rct=j\&url=https://www.ppsr.gov.au/\&ved=2ahUKEwigzNKFzN2WAxVqgOEIHeJQJ5kQy_kOegoIAggACAEICBAB\&opi=89978449\&cd\&psig=AOvVaw0erox9DkxrkEBMx1voZ0_h\&ust=1788909152110000)                                                                           | 123456789123                                                                      |
| {{$AssetEngineNumber}}                  | The asset's engine number as recorded in the individual specification tab of the asset.                                                                                                                                                                                                                                                                                                                                | 12345678                                                                          |
| {{$AssetWidth}}                         | <p>The asset's number value as recorded in the individual specification tab of the asset. <br><br>These are not yet tied to any unit of mesure.</p>                                                                                                                                                                                                                                                                    | <p>Any number value set <br>"123"</p>                                             |
| {{$AssetHeight}}                        | <p>The asset's number value as recorded in the individual specification tab of the asset. <br><br>These are not yet tied to any unit of mesure.</p>                                                                                                                                                                                                                                                                    | <p>Any number value set <br>"123"</p>                                             |
| {{$AssetWeight}}                        | <p>The asset's number value as recorded in the individual specification tab of the asset. <br><br>These are not yet tied to any unit of mesure.</p>                                                                                                                                                                                                                                                                    | <p>Any number value set <br>"123"</p>                                             |
| {{$AssetLength}}                        | <p>The asset's number value as recorded in the individual specification tab of the asset. <br><br>These are not yet tied to any unit of mesure.</p>                                                                                                                                                                                                                                                                    | <p>Any number value set <br>"123"</p>                                             |
| {{$AssetCapacity}}                      | <p>The asset's number value as recorded in the individual specification tab of the asset. <br><br>These are not yet tied to any unit of mesure.</p>                                                                                                                                                                                                                                                                    | <p>Any number value set <br>"123"</p>                                             |
| {{$AssetRequiredDesc}}                  | <p>The description recorded on the Asset Request, i.e. what was asked for, rather than the asset that was ultimately allocated. <br><br>Use it on documents that must show the requested specification; use {{$AssetShortDescription}} for the asset actually assigned.</p>                                                                                                                                            |                                                                                   |
| {{$AssetRequiredCategory}}              | <p>The asset category recorded on the Asset Request, i.e. the category asked for rather than the category of the asset ultimately allocated. <br><br>Use {{$AssetCategory}} for the asset actually assigned.</p>                                                                                                                                                                                                       | Excavator                                                                         |
| {{$AssetRequiredCategoryGroup}}         | <p>The asset category group recorded on the Asset Request, i.e. the group asked for rather than the group of the asset ultimately allocated. <br><br>Use {{$AssetCategoryGroup}} for the asset actually assigned.</p>                                                                                                                                                                                                  | Tracked 10T Excavators                                                            |
| {{$AssetRequiredCategoryCode}}          | <p>The asset category code recorded on the Asset Request, i.e. the code asked for rather than the code of the asset ultimately allocated. <br><br>Use {{$AssetCategoryCode}} for the asset actually assigned.</p>                                                                                                                                                                                                      | EX-10T                                                                            |
| {{$AssetEstHireDuration}}               | <p>The estimated length of hire for this individual allocation, formatted as days, hours and minutes. <br><br>Use it inside an allocation table where each asset may run for a different period; use {{EstHireDuration}} for the job as a whole.</p>                                                                                                                                                                   |                                                                                   |
| {{$$}}                                  | <p>The index/row number of the item in the list.<br><br>i.e. The quote/invoice row number: 1, 2, 3, 4, etc.</p>                                                                                                                                                                                                                                                                                                        | 1                                                                                 |
| {{$AssetPlannedStart}}                  | <p>The estimated or planned start date/time an Asset Request was expected to start. <br><br>i.e. The date/time the asset was supposed to start/on hire</p>                                                                                                                                                                                                                                                             | 1 Jan 2027, 6:00 AM                                                               |
| {{$AssetPlannedEnd}}                    | <p>The estimated or planned end date/time an Asset Request was expected to end. <br><br>i.e. The date/time the asset was supposed to end/off hire</p>                                                                                                                                                                                                                                                                  | 31 Jan 2027, 6:00 PM                                                              |

These pull details about your company (the organization using StayOnHire).

## Quotes & Invoices

Used for generating tax invoices or payment summaries.

| Tag                                                                                                                                            | Description                                                                                                                                                                                                                                | Example                                                                                                                                                                                                                                                                                                            |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| {{InvNumber}}                                                                                                                                  | The system-generated invoice number.                                                                                                                                                                                                       | INV-5501                                                                                                                                                                                                                                                                                                           |
| {{InvCurrencySym}}                                                                                                                             | Invoice currency symbol                                                                                                                                                                                                                    | $                                                                                                                                                                                                                                                                                                                  |
| {{InvIssueDate}}                                                                                                                               | The date the invoice was generated.                                                                                                                                                                                                        | 01/11/2023                                                                                                                                                                                                                                                                                                         |
| {{InvDueDate}}                                                                                                                                 | The payment deadline based on terms.                                                                                                                                                                                                       | 15/11/2023                                                                                                                                                                                                                                                                                                         |
| {{InvReference}}                                                                                                                               | Reference from invoice                                                                                                                                                                                                                     | "Any written words"                                                                                                                                                                                                                                                                                                |
| {{InvPeriod}}                                                                                                                                  | Formatted invoice period                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                    |
| {{InvSubtotal}}                                                                                                                                | Formatted subtotal of invoice                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                    |
| {{InvTaxTotal}}                                                                                                                                | Total GST/Tax amount.                                                                                                                                                                                                                      | $200.00                                                                                                                                                                                                                                                                                                            |
| {{InvTotal}}                                                                                                                                   | Formatted total of invoice                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                    |
| {{InvTotalPaid}}                                                                                                                               | Formatted total paid for invoice                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                    |
| {{InvAmountDue}}                                                                                                                               | Formatted amount due for invoice                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                    |
| {{InvFooterNote}}                                                                                                                              | (Currently unavailable)                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactName}}                                                                                                                      | Name of invoice billing contact                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactAddress}}                                                                                                                   | Formatted full address of invoice billing contact                                                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactAddressLine1}}                                                                                                              | Address line 2 of invoice billing contact                                                                                                                                                                                                  |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactAddressLine2}}                                                                                                              | Address line 1 of invoice billing contact                                                                                                                                                                                                  |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactEmail}}                                                                                                                     | Email of invoice billing contact                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactMobile}}                                                                                                                    | Formatted mobile of invoice billing contact                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                    |
| {{InvBillingContactABN}}                                                                                                                       | ABN of invoice billing contact                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                    |
| {{InvoiceNotes}}                                                                                                                               | Notes from invoice                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                    |
| <p>{{#InvoiceRows}}<br><br>{{$InvRowDescription}} {{$InvRowRate}} {{$InvRowQty}} {{$InvRowPrice}} {{$InvRowTax}} {{$InvRowTotal}}<br>{{/}}</p> | Special tag to open list of invoice row information. After the tag is used you can access nested tags of the invoice row data, then use `{{/}}` to exit the list context and return to primary tags. [View nested tags](#invoice-row-tags) | Refer to Quote and                                                                                                                                                                                                                                                                                                 |
| {{PaidStamp}}                                                                                                                                  | If an invoice is fully paid, this will display a large "PAID" text. This field is used to help ensure customer who recevie a paid tax invoice do not mistake it for another invoice.                                                       | "PAID"                                                                                                                                                                                                                                                                                                             |
| {{RecipSign}}                                                                                                                                  | Place a signature field for the recipient of this document to sign.                                                                                                                                                                        | <p><img src="https://50563950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lzplo2osBdXGzFtPu2f%2Fuploads%2FLc85P12k9fEYABUHTXH6%2FScreenshot%202026-08-05%20at%2011.20.45%E2%80%AFam.png?alt=media&amp;token=4f3bc8e7-2cbb-4f9e-9f50-accd118af5cf" alt="" data-size="original"></p><p></p> |
| {{RecipSignDateTime}}                                                                                                                          | This tag will insert the date and time a recipient's signature was placed on the document.                                                                                                                                                 | 21/06/2027, 15:02 AWST                                                                                                                                                                                                                                                                                             |
| {{RecipSignName}}                                                                                                                              | Insert the full name of the signing recipient of this document.                                                                                                                                                                            | Ryan Recipient                                                                                                                                                                                                                                                                                                     |
| {{SenderSign}}                                                                                                                                 | Place a signature field for the sender of this document to sign.                                                                                                                                                                           | <p><img src="https://50563950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lzplo2osBdXGzFtPu2f%2Fuploads%2FdFCMhTQ7un6Xv0hMFflk%2FScreenshot%202026-08-05%20at%2011.20.45%E2%80%AFam.png?alt=media&amp;token=0f4df406-873c-49a5-a8a6-4fda45c378ec" alt="" data-size="original"></p><p></p> |
| {{SenderSignDateTime}}                                                                                                                         | This tag will insert the date and time a sender's signature was placed on the document.                                                                                                                                                    | 21/06/2027, 15:02 AWST                                                                                                                                                                                                                                                                                             |
| {{SenderSignName}}                                                                                                                             | Insert the full name of the signing sender of this document.                                                                                                                                                                               | Steve Sender                                                                                                                                                                                                                                                                                                       |
| {{QuValidity}}                                                                                                                                 | <p>The duration of time this quote is valid for from creation.<br><br>Also referred to as 'Agreement Expiry' when terms are attached to a quote.</p>                                                                                       | <p>"12 months"<br>"23 months"<br>"Ongoing / No expiration"<br>"Custom date"</p>                                                                                                                                                                                                                                    |

## Quotes & Invoices Table Rows

Must be placed inside the `{{#InvoiceRows}} ... {{/}}` block to list line items.

| Tag                    | Description                                                                                                                                                                                                     | Example                                                                                                |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| {{$InvRowItem}}        | An item description text used by a integrated accounting system.                                                                                                                                                | Golf balls                                                                                             |
| {{$InvRowDescription}} | Narrative for the specific line item. These can be customised in [Settings > Billing > Customise Invoice > Invoice Row Descriptions](https://app.stayonhire.com/org/billing/customise-invoice)                  | <p>Hire for {{Asset}}<br>Rate: {{Rate}}<br>Billable usage: {{Usage}}<br>Dates: {{BilledDateRange}}</p> |
| {{$InvRowRate}}        | The specific hire rate for this row's rate.                                                                                                                                                                     | $1,000.00 / Day                                                                                        |
| {{$InvRowQty}}         | Quantity or duration (e.g., days/units).                                                                                                                                                                        | 1.00                                                                                                   |
| {{$InvRowPrice}}       | <p>The line amount before tax, i.e. this row's rate multiplied by its quantity. <br><br>Belongs in the "Price" column, between {{$InvRowQty}} and {{$InvRowTax}}.</p>                                           | 1000.00                                                                                                |
| {{$InvRowTax}}         | <p>The tax amount applied to this line. Belongs in the "Tax" column, between {{$InvRowPrice}} and {{$InvRowTotal}}. <br><br>Row tax amounts add up to {{InvTaxTotal}} in the summary block below the table.</p> | 100.0                                                                                                  |
| {{$InvRowTotal}}       | <p>The line total including tax. Belongs in the final column of the row. <br><br>Row totals add up to {{InvTotal}} in the summary block below the table.</p>                                                    | 1100.00                                                                                                |

## Util Tags

System-level tags for document timestamps.

| Tag             | Description                                                                                                                                                                                                       | Example     |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| {{TodaysDate}}  | The current date the document is generated.                                                                                                                                                                       | 30/12/2023  |
| {{DateCreated}} | The date the record was first created by the system.                                                                                                                                                              | 10/12/2023  |
| {{TimeCreated}} | The precise system time of document generation.                                                                                                                                                                   | 14:45:02    |
| {{DocumentID}}  | <p>The primary unique identifying tag associated with any document generated in your StayOnHire account. <br><br>This helps customers refer to "document 123" and you find the same document in your acocunt.</p> | DOC-000001  |
| {{SvcID}}       |                                                                                                                                                                                                                   | SER-000001  |
| {{InspID}}      |                                                                                                                                                                                                                   | INSP-000001 |
| {{TranspID}}    |                                                                                                                                                                                                                   | TR-000001   |
