Karbon Merge Fields for Templates

Insert these merge fields into your file or email templates to populate your templates with your organization data from Karbon

In this article:

Date fields

Any template can use the following date fields to populate dates whether SuiteFiles is connected to Karbon or not:

Date Field Value
[DATE:TODAY] 
[DATE:TODAYTEXT] 
[DATE:FULLTODAYTEXT] 
[DATE:YEAR] 
Today's date formatted DD/MM/YYYY (e.g. 21/04/2023) 
Today's date formatted DD MMM YYYY (e.g. 21 Apr 2023) 
Today's date formatted DD MMMM YYYY (e.g. 21 April 2023) 
The current year formatted YYYY (e.g. 2023) 

Organization fields

When working with document and email templates in SuiteFiles you can add merge fields to them that will pull information about the organization from Karbon and display in the finished file or email. The field syntax to use and their corresponding data in Karbon are:

Field Name Karbon Value

[CLIENT:NAME] 
[CLIENT:OWNER] 
[CLIENT:LEGALNAME] 
[CLIENT:TAXCOUNTRYCODE] 
[CLIENT:VATREGISTERED] 
[CLIENT:REVENUEMODEL] 
[CLIENT:NZBUSINESSNUMBER] [CLIENT:GSTNUMBER] 
[CLIENT:IRDNUMBER] 
[CLIENT:WEBSITE]  
[CLIENT:EMAIL]  
[CLIENT:PHONE]
[CLIENT:MOBILEPHONE]
[CLIENT:OFFICEPHONE]
[CLIENT:FAXPHONE]
[CLIENT:HOMEPHONE]
[CLIENT:OTHERPHONE]

ORG NAME
ORG OWNER
LEGAL NAME
TAX COUNTRY CODE
VAT REGISTERED
REVENUE MODEL
NZ BUSINESS NUMBER
GST NUMBER
IRD NUMBER
ORG WEBSITE
ORG EMAIL
ORG PHONE
ORG MOBILE PHONE
ORG OFFICE PHONE
ORG FAX NUMBER
ORG HOME PHONE
ORG OTHER PHONE

Address Fields

The following receives the physical address of the organization:

[CLIENT:ADDRESS]

[CLIENT:CITY]

[CLIENT:REGION]

[CLIENT:POSTCODE]

[CLIENT:COUNTRY] 

The following receives the postal address of the organization:

[CLIENT:POSTALADDRESS]

[CLIENT:POSTALCITY]

[CLIENT:POSTALREGION]

[CLIENT:POSTALPOSTCODE]

[CLIENT:POSTALCOUNTRY]


The following receives the legal address of the organization:

[CLIENT:LEGALADDRESS]

[CLIENT:LEGALCITY]

[CLIENT:LEGALREGION]

[CLIENT:LEGALPOSTCODE]

[CLIENT:LEGALCOUNTRY]


The following receives the home address of the organization:

[CLIENT:HOMEADDRESS]

[CLIENT:HOMECITY]

[CLIENT:HOMEREGION]

[CLIENT:HOMEPOSTCODE]

[CLIENT:HOMECOUNTRY]


The following receives the postal address of the organization first but if the postal address does not exist, then it defaults to the physical address:

[ADDRESS:POSTAL_OR_PHYSICAL] 

[CITY:POSTAL_OR_PHYSICAL]

[REGION:POSTAL_OR_PHYSICAL]

[POSTCODE:POSTAL_OR_PHYSICAL] 

[COUNTRY:POSTAL_OR_PHYSICAL] 

Registration Numbers

New Zealand

If the Accounting Details Country in Karbon is New Zealand, use the following merge fields to fetch the accounting information:

Field Name

Karbon Value

[CLIENT:NZBUSINESSNUMBER]
[CLIENT:GSTNUMBER]
[CLIENT:IRDNUMBER]

NZ BUSINESS NUMBER
GST NUMBER
IRD NUMBER

South Africa

If the Accounting Details Country in Karbon is South Africa, use the following merge fields to fetch the accounting information:

Field Name

Karbon Value

[CLIENT:REGISTRATIONNUMBER]
[CLIENT:INCOMETAXNUMBER]
[CLIENT:PAYENUMBER][CLIENT:DOLUIFNUMBER][CLIENT:SDLNUMBER][CLIENT:DOLWORKMANCOMPENSATION][CLIENT:VATNUMBER]

REGISTRATION NUMBER
INCOME TAX NUMBER
PAYE NUMBER
DOL UIF NUMBER
SDL NUMBER DOL
WORKMAN COMPENSATION
VAT NUMBER

United States

If the Accounting Details Country in Karbon is United States, use the following merge fields to fetch the accounting information:

Field Name

Karbon Value

[CLIENT:TAXID]
[CLIENT:SSN]

TAX ID
SOCIAL SECURITY NUMBER (SSN)

Canada

If the Accounting Details Country in Karbon is Canada, use the following merge fields to fetch the accounting information:

Field Name

Karbon Value

[CLIENT:BUSINESSNUMBER]
[CLIENT:SIN]

BUSINESS NUMBER
SOCIAL INSURANCE NUMBER (SIN)

Australia

If the Accounting Details Country in Karbon is Australia, use the following merge fields to fetch the accounting information: 

Field Name

Karbon Value

[CLIENT:ABN]
[CLIENT:ACN]
[CLIENT:TFN

AUSTRALIAN BUSINESS NUMBER (ABN)
AUSTRALIAN COMPANY NUMBER (ACN)
TAX FILE NUMBER (TFN)

Business Values

Business Values allow you to pull through your own business details onto your SuiteFiles Templates. To enter these values, an Administrator can click their user name in the top right corner of SuiteFiles Web, click Admin settings, then select Prepopulation. Click the blue Edit Values button to update the Values. Once done, click Save Business Values. The Merge Field when entered into your template must be in CAPS, the Field Name can include a space.

Field Name Value
[BUSINESS:WEBSITE]  
[BUSINESS:BUILDING]  
[BUSINESS:STREET]  
[BUSINESS:CITY]  
[BUSINESS:POSTCODE]  
[BUSINESS:COMPANYNUMBER]  
[BUSINESS:MANAGINGDIRECTOR]
WEBSITE  
BUILDING  
STREET  
CITY  
POSTCODE  
COMPANY NAME  
MANAGING DIRECTOR