Skip to content

Templates

Matter data markers

These markers give details of the matter itself: its reference and dates, where it stands, its address, its tasks and its recorded time. They work in any document, email or SMS produced on a matter. For how to read the tables, see Built-in data markers.

The matter’s names, dates, state and template.

MarkerWhat it gives you
matter.nameName (Text)
A friendly name for this matter based on the Matter Template Name, the Address and the Primary Client.
E.g. Sale of 1 High Street, Tasker
matter.guidGUID (Text)
A unique matter identifier.
E.g. d290f1ee-6c54-4b01-90e6-d701748f0851
matter.referenceReference (Text)
An identifier for a matter that is editable.
E.g. MAT-000123
matter.lastupdatedLast Updated On (Date & Time)
The date and time when this matter was last updated.
E.g. 2025-01-02T03:04:05Z
matter.lastactiondateLast Action On (Date & Time)
The date and time when a task on this matter was last updated.
E.g. 2025-01-02T03:04:05Z
matter.createddateCreated On (Date & Time)
The date and time when this matter was created.
E.g. 2025-01-01T10:11:12Z
matter.leaddateBecame a Lead On (Date & Time)
The date and time when this matter was marked as a lead.
E.g. 2025-01-01T10:11:12Z
matter.openeddateOpened On (Date & Time)
The date and time when this matter was marked as open.
E.g. 2025-01-01T10:11:12Z
matter.completeddateCompleted On (Date & Time)
The date and time when this matter was marked as completed.
E.g. 2025-02-01T10:11:12Z
matter.closeddateClosed On (Date & Time)
The date and time when this matter was marked as closed.
E.g. 2025-03-01T10:11:12Z
matter.archiveddateArchived On (Date & Time)
The date and time when this matter was marked as archived.
E.g. 2025-04-01T10:11:12Z
matter.aborteddateAborted On (Date & Time)
The date and time when this matter was marked as aborted.
E.g. 2025-01-15T10:11:12Z
matter.stateState (Text)
The matter’s current state.
E.g. Open
matter.stickynoteSticky Note (Rich Text)
The sticky note of the matter.
E.g. Call client on Friday
matter.template.nameTemplate Name (Text)
The name of the template associated with the matter.
E.g. Conveyancing Sale
matter.template.guidTemplate GUID (Text)
A unique ID of the template associated with the matter.
E.g. d290f1ee-6c54-4b01-90e6-d701748f0851
matter.template.initialsTemplate Initials (Text)
The initials of the name of the template used to create this matter.
E.g. CS
matter.itrcodeITR Code (Text)
A reference code that identifies this matter. This is commonly used in email subjects with the email server integration.
E.g. ABC-123
matter.lockLock (Text)
“Team” when the matter is locked to the fee earner’s team, otherwise “None”.
E.g. None
matter.upcoming.trafficlightUpcoming Traffic Light (Text)
“Red” or “Amber” when a traffic light is lit on the matter, blank when none is. The firm’s own signal, for staff documents rather than client emails.
E.g. Amber
matter.upcoming.nextalarmUpcoming Next Alarm (Date & Time)
The date and time of the matter’s next alarm. Snoozed alarms are not counted, and an alarm that has already gone off stays here until it is dealt with, so the date can be in the past. Blank when the matter has no alarm, so check it with #if before formatting it with #datetime. The firm’s own signal, for staff documents rather than client emails.
E.g. 2025-01-02T09:00:00Z
matter.upcoming.reviewsUpcoming Reviews (Number)
The number of reviews waiting on the matter. The firm’s own signal, for staff documents rather than client emails.
E.g. 1
matter.next.milestoneNext Milestone (Text)
The name of the first task on the matter still to do, skipping sub-tasks and tasks marked not applicable; blank when there is none. It includes tasks hidden from clients, so in an email or document for a client use the Outstanding Tasks Collection, which lists only the tasks that client can see.
E.g. Exchange
matter.hasmultipleclientsDoes this matter have multiple clients? (Yes or No)
E.g. No
matter.clientlistMatter Client List (Text)
A list of client names.
E.g. Harry Renquist Tasker and Helen Tasker

matter.next.milestone, matter.upcoming.trafficlight, matter.upcoming.nextalarm, matter.upcoming.reviews and matter.lock describe where a matter stands. Use them in staff documents and emails, such as an internal progress report, rather than anything sent to a client. The next milestone includes tasks hidden from clients. In a document or email for a client, use the Outstanding Tasks Collection under Tasks instead, which lists only the tasks that client can see.

The next alarm is blank when the matter has no alarm, so check it before formatting it:

{{#if matter.upcoming.nextalarm}}
Next alarm: {{#datetime matter.upcoming.nextalarm}}
{{#endif}}

The matter’s address, in the pattern every address follows. See Addresses.

MarkerWhat it gives you
matter.address.line1Address Line 1 (Text)
The first line of the matter’s address: street address.
E.g. 1 High Street
matter.address.line2Address Line 2 (Text)
The second line of the matter’s address: apartment, suite, unit, building or floor.
E.g. Westminster
matter.address.line3Address Line 3 (Text)
The third line of the matter’s address: town/city.
E.g. London
matter.address.line4Address Line 4 (Text)
The fourth line of the matter’s address: county.
E.g. Greater London
matter.address.postcodePostcode (Text)
The postcode of the matter’s address.
E.g. SW1A 1AA
matter.address.cityCity (Text)
Alias for line 3.
E.g. London
matter.address.countyCounty (Text)
Alias for line 4.
E.g. Greater London
matter.address.shortaddressShort Address (Text)
Line 1, Line 2, Postcode.
E.g. 1 High Street, Westminster, SW1A 1AA
matter.address.singlelineSingle Line Address (Text)
Comma separated address on one line.
E.g. 1 High Street, Westminster, London, Greater London, SW1A 1AA

Whether the matter has tasks done or still to do, how far through they are, and lists of the tasks themselves.

Every task marker counts only top-level tasks that aren’t marked not applicable; sub-tasks are left out. The three Yes or No markers and the four task lists also count only the tasks the recipient can see. Unless the email, SMS or document is produced for a particular stakeholder, the lists are empty and the three markers give No. Tasks Completed % and matter.next.milestone count those tasks whoever can see them.

Tasks Completed % is a whole number printed with two decimals, e.g. 50.00, rounded down. It gives 0.00 for a matter with no such tasks, although the matter list shows a dash.

MarkerWhat it gives you
matter.hasCompletedTasksMatter has completed tasks (Yes or No)
Flag to indicate if this matter has any completed tasks.
E.g. Yes
matter.hasIncompleteTasksMatter has incomplete tasks (Yes or No)
Flag to indicate if this matter has any outstanding tasks.
E.g. Yes
matter.hasNewCompletedTasksMatter has newly completed tasks (Yes or No)
Flag to indicate if this matter has newly completed tasks since the recipient was last updated.
E.g. No
matter.percentagecompletedTasks Completed % (Number)
The percentage of this matter’s tasks that have been completed. Blank in the matter list when the matter has no applicable top-level task.
E.g. 50.00
matter.completedtasksCompleted Tasks Collection (Collection)
The recipient’s completed tasks. Each item has taskname, description, completedon (blank until done) and a nested list notes whose items have content, createdby, createdon, lastupdatedby and lastupdated. All four lists are empty unless the document has a recipient.
matter.incompletetasksOutstanding Tasks Collection (Collection)
The recipient’s tasks still to do. Each item has taskname, description, completedon (blank until done) and a nested list notes whose items have content, createdby, createdon, lastupdatedby and lastupdated. All four lists are empty unless the document has a recipient.
matter.newcompletedtasksNewly Completed Tasks Collection (Collection)
The recipient’s tasks completed since their last update email. Each item has taskname, description, completedon (blank until done) and a nested list notes whose items have content, createdby, createdon, lastupdatedby and lastupdated. All four lists are empty unless the document has a recipient.
matter.tasksTasks Collection (Collection)
Every task visible to the recipient, complete or not. Each item has taskname, description, completedon (blank until done) and a nested list notes whose items have content, createdby, createdon, lastupdatedby and lastupdated. All four lists are empty unless the document has a recipient.

The value of the matter’s recorded time, and the time records themselves. See Time recording for what each figure includes.

MarkerWhat it gives you
matter.timerecordsTime Records Collection (Collection)
Every time record on the matter. Each item has date, status (Outstanding, Receivable Raised or Free), feeearner, type, notes, rate, rateperhour, units and amount.
matter.time.wipWIP (Currency)
Chargeable time not yet raised as a receivable (the time tab’s “Outstanding”).
E.g. 1,234.56
matter.time.receivable.raisedReceivable Raised Time (Currency)
Time that has been raised as a receivable.
E.g. 2,345.67
matter.time.freeFree Time (Currency)
Non-chargeable time.
E.g. 345.67
matter.time.totalTotal Time (Currency)
All recorded time, whatever its state (WIP + Receivable Raised Time + Free Time).
E.g. 3,925.90