What are merge tags?

Merge tags allow you to add dynamic, personalised data (such as a customer's name or job cost) to message templates and document templates.

Use the merge tag icon in message and document templates to add merge tags relating to:

• your Business details and socials
• Customer information
• your Documents
• Invoice details
• Job details
• Links to the customer portal or payment widget
• unread Messages
• Payment details
• Quote details
• User information

Business merge tags

These merge tags are pulled from Tools > Settings > Business > Business Details and can be added to all message and document templates.

The social media merge tags show exactly what you entered in Business Details. For most of them that's your username rather than a full link, so if you want a link, add the start of the address yourself, for example facebook.com/{{business.facebook}}.

{{business.bluesky}}

Your business's Bluesky handle, if available.

{{business.facebook}}

Your business's Facebook page name, if available.

{{business.google}}

A link to your business's Google My Business profile, if available.

{{business.instagram}}

Your business's Instagram username, if available.

{{business.mastodon}}

A link to your business's Mastodon page, if available.

{{business.name}}

The name of your business.

{{business.phoneNumber}}

Your business's phone number.

{{business.tagline}}

Your business's tagline, if available.

{{business.taxId}}

Your business's Tax ID, if available.

{{business.threads}}

Your business's Threads username, if available.

{{business.trustPilot}}

Your business's TrustPilot page name (the part after trustpilot.com/review/), if available.

{{business.twitter}}

Your business's Twitter username, if available.

{{business.website}}

A link to your business's website, if available.

{{business.whatsApp}}

Your business's WhatsApp number, if available.

{{business.youtube}}

Your business's YouTube handle, if available.

Customer merge tags

These merge tags are pulled from the customer details page and can be added to all customer message templates and broadcasts, and the invoice, itemisation and payment receipt document templates.

{{customer.addressCountry}}

The customer's address (country).

{{customer.addressFirstLine}}

The customer's address (first line).

{{customer.address}}

The customer's full address.

{{customer.addressPostcode}}

The customer's address (postcode).

{{customer.addressStreetName}}

The customer's address (street name).

{{customer.addressTown}}

The customer's address (town).

{{customer.autoName}}

The customer's preferred name if they have one. Otherwise, their business name if the customer type is business, or their full name if not.

{{customer.balance}}

The customer's current balance, for example, "-£20.00".

{{customer.balanceStatus}}

The status of the customer's balance, either 'Debit', 'Settled', or 'Credit'.

{{customer.businessName}}

The customer's business name, if applicable.

{{customer.code}}

The customer's unique code, for example, "XY12". This code is also used to match bank transfers to customers if they include it in the payment reference.

{{customer.email}}

The customer's email address, if available.

{{customer.firstName}}

The customer's first name.

{{customer.name}}

The customer's full name.

{{customer.lastName}}

The customer's last name.

{{customer.phoneNumber}}

The customer's phone number, if available.

{{customer.pin}}

The customer's portal PIN, for example, "123456".

{{customer.postcode}}

The customer's postcode.

{{customer.preferredName}}

The customer's preferred name, if available.

{{customer.status}}

The customer's status, for example, "Active".

{{customer.type}}

The type of customer, either 'Business', 'Individual', or 'Unknown'.

Document merge tags

These merge tags are pulled from Tools > Settings > Business > Policies & Documents and can be added to all message and document templates.

There are no set keys for these merge tags. When you upload a document, a suggested key is generated according to your document title and can be customised as required.

Invoice merge tags

These merge tags are pulled from the customer invoice. They can be added to the "Customer Invoice Became Overdue" message templates (including the 2nd and 3rd reminders), the "Customer Invoice Instalment Due" message template, the "Customer Job Marked as Done (Paid)" and "(Owing)" message templates if the job was invoiced, and the invoice document template.

{{invoice.amountDue}}

The amount the customer needs to pay by {{invoice.dueDate}}. For an invoice paid in instalments, this is what is still owed on the instalments due by that date. Otherwise it is the same as {{invoice.outstanding}}.

{{invoice.code}}

A unique code for the invoice, for example, "#K441KZ".

{{invoice.dueDate}}

The date the customer needs to make payment by, for example, "4th May".

{{invoice.instalments}}

Adds a line for each of the invoice's instalments, with the amount and due date, for example, "£50.00 due 14th Jul".

{{invoice.instalmentsFormatted}}

The invoice's instalments on one line, for example, "14th Jul (£50.00), 28th Jul (£50.00)".

{{invoice.issuedAt}}

The date the invoice was first issued, for example, "4th May".

{{invoice.leadTime}}

The number of days the customer has to pay the invoice, for example, "14".

{{invoice.modifiedAt}}

The date the invoice was last modified, for example, "4th May".

{{invoice.number}}

The unique number of the invoice, made of the customer's code and an incrementing counter, for example, "#XY12-0001".

{{invoice.outstanding}}

The amount outstanding on the invoice. This may be the same as {{invoice.total}}, or less if partial payment has been made.

{{invoice.paid}}

The amount of the invoice which has been paid. For example, "£0.00" if no payment has been made.

{{invoice.paidAt}}

The date the invoice was paid, for example, "4th May".

{{invoice.relevantDate}}

The invoice date shown on documents: the issued date, and if the invoice was modified on a different day, "(modified [date])" is shown underneath.

{{invoice.status}}

The Status of the invoice, for example, "Outstanding" if payment is still to be made, or "Paid" if it has.

{{invoice.total}}

The total cost of the invoice, for example, "£18.00".

Job merge tags

These merge tags are pulled from the job details and can be added to all customer message templates related to jobs or invoices, and the invoice and itemisation document templates.

{{job.addressCountry}}

The job's address (country). Falls back to the customer's address if the job doesn't have its own.

{{job.addressFirstLine}}

The job's address (first line). Falls back to the customer's address if the job doesn't have its own.

{{job.address}}

The job's full address. A job can have its own address, which is useful when you work at more than one location for the same customer. If the job doesn't have its own address, the customer's address is used instead.

{{job.addressPostcode}}

The job's address (postcode). Falls back to the customer's address if the job doesn't have its own.

{{job.addressStreetName}}

The job's address (street name). Falls back to the customer's address if the job doesn't have its own.

{{job.addressTown}}

The job's address (town). Falls back to the customer's address if the job doesn't have its own.

{{job.code}}

The unique code of the job, for example, "XY12"

{{job.cost}}

The total cost of the job, for example, "£18.00".

{{job.costChangedAt}}

The date the job's price last changed, for example, "4th May".

{{job.dueWeek}}

The week-commencing date (Monday) of the week the job is due. You should make it clear this is the week commencing, so customers don't mistake it as the date the job will be completed.

{{job.estimatedTime}}

The time the job is scheduled for, if a time was set, for example, "02:30PM".

{{job.frequency}}

The frequency the job is to be repeated on, for example, "4 Weeks" or "3 Months".

{{job.instalments}}

Adds a line for each instalment set on the job, with its amount, percentage and when it's due.

{{job.instalmentsFormatted}}

The job's instalments on one line, for example, "£50.00 7 days after job completion, £50.00 7 days after the previous instalment".

{{job.lastDone}}

The date the job was last done, for example, "4th May".

{{job.notes}}

Any notes that have been added to the job.

{{job.occurrenceNotes}}

Notes for this specific job occurrence (for example, the notes you add when marking a job as done or skipped). Note: If there are no notes, the entire line will be removed.

{{job.plannedPrice}}

The new price you've planned for the job, for example, "£20.00". Use it with {{job.plannedPriceDate}} to tell a customer about a price change before it happens. It's blank if the job has no planned price change.

{{job.plannedPricePence}}

The same as {{job.plannedPrice}}, but as a number of pence, for example, "2000".

{{job.plannedPriceDate}}

The date a planned price change takes effect, for example, "1st Nov". It's blank if the job has no planned price change, or the change has no date.

{{job.previousScheduledDate}}

The date the job was scheduled for before it was moved or unscheduled, for example, "4th May". Use it in the "Customer Job Was Rescheduled" and "Customer Job Was Unscheduled" message templates.

{{job.purchaseOrder}}

The purchase order number for the job, if available. Note: If there is no purchase order number, the entire line will be removed.

{{job.recordedTime}}

The time recorded on the job, in hours, minutes and seconds, for example, "01:30:00". Note: If no time was recorded, the entire line will be removed.

{{job.scheduled}}

The date the job is scheduled for. The same as {{job.scheduledDate}}.

{{job.scheduledDate}}

The date the job is scheduled for, for example, "4th May".

{{job.services}}

The services the job includes, using the name of the service which you can customise. For example, "Window Cleaning, Conservatory Cleaning".

{{job.signature}}

The customer's signature, if one was collected when the job was marked as done, with "Signed by" and their name underneath.

{{job.signatureImage}}

The customer's signature on its own, without their name.

{{job.signatureName}}

The name the customer gave when they signed.

{{job.status}}

The status of the job, for example, "Scheduled" or "Today".

{{job.title}}

The title of the job, for example, "Window Cleaning".

Link merge tags

These merge tags can be added to all message templates, and the invoice, quote and itemisation document templates.

{{link}}

This link will take the customer to the customer portal and log them in. Depending on your settings, the portal could be on your own website or your free getSoapy website.

{{link.short}}

Just like {{link}}, but this link will be shortened. For example, "gspy.uk/abcdef".

Messages merge tags

These merge tags are designed to be added to your 'Customer Sent Message' and 'Quote Sent Message' templates to allow customers to read your message before following the link to the customer portal.

The message will contain all unread messages from within the last 12 hours, or the single last message if your customer has already read all your messages.

{{message.clipped}}

A snippet of any message your customer hasn't seen yet, cut to the first 140 characters or so.

{{message.full}}

The entire content of any message your customer hasn't seen yet.

Payment merge tags

These merge tags are pulled from the customer's payment and can be added to the "Customer Payment Received" message template and the payment receipt document template.

{{payment.amount}}

The amount paid for the work itself, not counting any tip. For example, "£22.00".

{{payment.code}}

A unique code for the payment, for example, "#K441KZ".

{{payment.method}}

How the payment was made, for example, "Card" or "Cash".

{{payment.name}}

The name given by the person who made the payment.

{{payment.paidAt}}

The date the payment completed, for example, "4th May". Date formats can be used, for example {{payment.paidAt.full}}.

{{payment.receiptLink}}

A link to a PDF receipt for the payment.

{{payment.receiptUrl}}

The same as {{payment.receiptLink}}.

{{payment.status}}

The status of the payment, for example, "Completed".

{{payment.tip}}

The part of the total that was allocated as a tip. For example, "£3.00". This comes out of the total rather than being added on top.

{{payment.total}}

The full amount the customer was charged, including any tip. For example, "£25.00".

Quote merge tags

These merge tags are pulled from the quote details and can be added to all quote message templates and the quote document template. The cost breakdown merge tags ({{quote.createdAt}}, {{quote.total}} and {{quote.updatedAt}}) are only filled in on the quote document.

{{quote.addressCountry}}

The address (country) entered on the quote.

{{quote.addressFirstLine}}

The address (first line) entered on the quote.

{{quote.address}}

The full address entered on the quote.

{{quote.addressPostcode}}

The address (postcode) entered on the quote.

{{quote.addressStreetName}}

The address (street name) entered on the quote.

{{quote.addressTown}}

The address (town) entered on the quote.

{{quote.createdAt}}

The date the cost breakdown for the quote was created, for example, "4th May".

{{quote.firstName}}

The first name of the potential customer.

{{quote.name}}

The full name of the potential customer.

{{quote.lastName}}

The last name of the potential customer.

{{quote.status}}

The status of the quote, for example, "Estimated" or "Rejected".

{{quote.submittedAt}}

The date the quote was submitted, for example, "4th May".

{{quote.total}}

The total cost of the cost breakdown for the quote, for example, "£18.00".

{{quote.updatedAt}}

The date the cost breakdown for the quote was last updated, for example, "4th May".

User merge tags

These merge tags are pulled from Tools > Settings > My Account > Profile and can be added to all message and document templates.

{{user.email}}

The email address of the user that sends the message or document.

{{user.firstName}}

The first name of the user that sends the message or document.

{{user.name}}

The first name of the user that sends the message or document. The same as {{user.firstName}}.

{{user.lastName}}

The last name of the user that sends the message or document.