Client properties

The client group of properties contains information related to your customer.

Client Information

The client properties contain information for the document section that contains the customer details.

client.company_name

string node

The company name of the customer. If the customer has no company name, client.full_name is used.

Code
{{ client.company_name }}
Output
Smith Ltd.

client.first_name

string node

The first name of the customer.

Code
{{ client.first_name }}
Output
George

client.full_name

string node

The full name of the customer; the values of client.first_name and client.last_name combined.

Code
{{ client.full_name }}
Output
George Smith

client.heading

string node

The heading of the document section that contains the customer details.

You can edit the text on the Design → Client Details page in your Sufio account.

Code
{{ client.heading }}
Output
Client

client.last_name

string node

The last name of the customer.

Code
{{ client.last_name }}
Output
Smith

client.notes

string node

A note related to the customer you can add in Sufio.

Code
{{ client.notes }}
Output
Loyalty card 1760

Client Address

The client.address property contains the complete address of your customer, formatted in the country-specific format. Use the individual client.addres.X properties to return specific values.

client.address

address node

The address of the customer, generated from the client.address properties.

Code
{{ client.address }}
Output
42 Oxford Street
London
W1D 1AX
United Kingdom

Use the text attribute to render the property formatted in a country-specific address format.

Code
{{ client.address.text }}
Output
<div class="address" itemprop="address" itemscope itemtype="http://data-vocabulary.org/Address"><div class="ls-comma"><span itemprop="street-address" class="street">42 Oxford Street</span><span></span></div><div class="ls-comma"><span itemprop="locality" class="city">London</span><span></span></div><div class="ls-comma"><span itemprop="postal-code" class="postal-code">W1D 1AX</span><span></span></div><div class="ls-last"><span itemprop="country-name" class="country">United Kingdom</span><span></span></div></div>

client.address.city

string

The city of the customer address.

Code
{{ client.address.city }}
Output
London

client.address.country

string

The country of the customer address.

Code
{{ client.address.country }}
Output
United Kingdom

client.address.country_code

string

The country code (ISO 3166-1 alpha-2 format) of the customer address.

Code
{{ client.address.country_code }}
Output
GB

client.address.postal_code

string

The postal or ZIP code of the customer address.

Code
{{ client.address.postal_code }}
Output
W1D 1AX

client.address.region

string

The region of the customer address.

Code
{{ client.address.region }}
Output
England

client.address.region_code

string

The region code (ISO 3166-2 alpha-2 format) of the customer address.

Code
{{ client.address.region_code }}
Output
ENG

client.address.street

string

The street of the customer address, including the street number.

Code
{{ client.address.street }}
Output
42 Oxford Street

Client Contacts

The client.contacts group of properties covers properties that contain the contact information of your client. You can return them as strings or formatted as clickable hyperlinks.

client.contacts

node

The contact information of your client.

Use the following for loop to iterate through all the properties of the group that are supposed to be shown in the document. This depends on the document type, your settings on the Design page, and whether the properties have a value.

{% for contact in client.contacts %}
    <div id="{{ contact.id }}" class="{{ contact.css_classes }}">
        {{ contact.title }}: {{ contact.text }}
    </div>
{% endfor %}

client.contacts.email

string node

The contact email address of the customer.

Code
{{ client.contacts.email }}
Output
george.smith@smithltd.co.uk

Use the text attribute to render the value as a clickable link formatted in HTML.

Code
{{ client.contacts.email.text }}
Output
<a href="mailto:george.smith@smithltd.co.uk">george.smith@smithltd.co.uk</a>

client.contacts.phone

string node

The contact phone of the customer.

Code
{{ client.contacts.phone }}
Output
+44789456123

Use the text attribute to render the value as a clickable link formatted in HTML.

Code
{{ client.contacts.phone.text }}
Output
<a href="tel:+44789456123">+44789456123</a>

Client Details

The client.details group covers properties that contain the company information of your customer.

client.details

node

The company information of your customer.

Use the following for loop to iterate through all the properties of the group that are supposed to be shown in the document. This depends on the document type, your settings on the Design page, and whether the properties have a value.

{% for detail in client.details %}
    <div id="{{ detil.id }}" class="{{ detail.css_classes }}">
        {{ detail.title }}: {{ detail.text }}
    </div>
{% endfor %}

client.details.company_no

string node

The company registration or identification number of the customer.

Code
{{ client.details.company_no }}
Output
12345678

client.details.vat_no

string node

The VAT or GST number of the customer.

Code
{{ client.details.vat_no }}
Output
UK123456789

Client Shipping Address

The client.shipping.address property contains the complete shipping address of your customer, formatted in the country-specific format. Use the individual client.shipping.address.X properties to return the specific values.

client.shipping.address

address node

The shipping address of the customer, taken from the client.shipping.address properties.

Code
{{ client.shipping.address }}
Output
62 Trafalgar Square
London
WC2H 7HA
United Kingdom

Use the text attribute to render the property formatted in country-specific address format.

Code
{{ client.shipping.address.text }}
Output
<div class="address" itemprop="address" itemscope itemtype="http://data-vocabulary.org/Address"><div class="ls-comma"><span itemprop="street-address" class="street">62 Trafalgar Square</span><span></span></div><div class="ls-comma"><span itemprop="locality" class="city">London</span><span></span></div><div class="ls-comma"><span itemprop="postal-code" class="postal-code">WC2H 7HA</span><span></span></div><div class="ls-last"><span itemprop="country-name" class="country">United Kingdom</span><span></span></div></div>

client.shipping.address.city

string

The city of the customer’s shipping address.

Code
{{ client.shipping.address.city }}
Output
London

client.shipping.address.country

string

The country of the customer’s shipping address.

Code
{{ client.shipping.address.country }}
Output
United Kingdom

client.shipping.address.country_code

string

The country code (ISO 3166-1 alpha-2 format) of the customer’s shipping address.

Code
{{ client.shipping.address.country_code }}
Output
GB

client.shipping.address.postal_code

string

The postal or ZIP code of the customer’s shipping address.

Code
{{ client.shipping.address.postal_code }}
Output
WC2H 7HA

client.shipping.address.region

string

The region of the customer’s shipping address.

Code
{{ client.shipping.address.region }}
Output
England

client.shipping.address.region_code

string

The region code (ISO 3166-2 alpha-2 format) of the customer’s shipping address.

Code
{{ client.shipping.address.region_code }}
Output
ENG

client.shipping.address.street

string

The street of the customer’s shipping address.

Code
{{ client.shipping.address.street }}
Output
62 Trafalgar Square

client.shipping.company_name

string node

The company name of the customer’s shipping address.

Code
{{ client.shipping.company_name }}
Output
Black Ltd.

client.shipping.first_name

string node

The first name of the customer’s shipping address.

Code
{{ client.shipping.first_name }}
Output
Susan

client.shipping.full_name

string node

The values of client.shipping.first_name and client.shipping.last_name of the customer’s shipping address, combined.

Code
{{ client.shipping.full_name }}
Output
Susan Black

client.shipping.heading

string node

The heading of the document section that contains the customer’s shipping address details.

You can edit the text on the Design → Client Details page in your Sufio account.

Code
{{ client.shipping.heading }}
Output
Shipping Address

client.shipping.last_name

string node

The last name of the customer’s shipping address.

Code
{{ client.shipping.last_name }}
Output
Black

Client Shipping Contacts

The client.shipping.contacts group of properties covers properties that contain the shipping contact information of your client. You can return them as strings or formatted as clickable hyperlinks.

client.shipping.contacts

node

The shipping contact information of your client.

Use the following for loop to iterate through all the properties of the group that are supposed to be shown in the document. This depends on the document type, your settings on the Design page, and whether the properties have a value.

{% for contact in client.shipping.contacts %}
    <div id="{{ contact.id }}" class="{{ contact.css_classes }}">
        {{ contact.title }}: {{ contact.text }}
    </div>
{% endfor %}

client.shipping.contacts.email

string node

The shipping contact email address of the customer.

Code
{{ client.shipping.contacts.email }}
Output
susan.black@blackltd.com

Use the text attribute to render the value as a clickable link in HTML.

Code
{{ client.shipping.contacts.email.text }}
Output
<a href="susan.black@blackltd.com">susan.black@blackltd.com</a>

client.shipping.contacts.phone

string node

The shipping contact phone number of the customer.

Code
{{ client.shipping.contacts.phone }}
Output
+44789456321

Use the text attribute to render the value as a clickable link formatted in HTML.

Code
{{ client.shipping.contacts.phone.text }}
Output
<a href="tel:+44789456321">+44789456321</a>

Client Statuses

The client.statuses group of properties contains various checks you can use as conditions in your document templates.

client.address.is_eu_country

boolean

If True, the customer’s address country is in the EU.

Code
{{ client.address.is_eu_country }}
Output
True

client.address.is_foreign_country

boolean

If True, the customer’s address country is different to your account’s country.

Code
{{ client.address.is_foreign_country }}
Output
False

client.has_company_no

boolean

If True, the customer has a company number.

Code
{{ client.has_company_no }}
Output
False

client.has_vat_no

boolean

If True, the customer has a VAT number.

Code
{{ client.has_vat_no }}
Output
True

client.is_eu_tax_exempt

boolean

True if the properties client.has_vat_no and client.address.is_eu_country are both True and the property document.has_tax is False at the same time. False for all other combinations.

Code
{{ client.is_eu_tax_exempt }}
Output
False

client.shipping.is_foreign_country

boolean

If True, the customer’s shipping address country is different to your account’s country.

Code
{{ client.shipping.is_foreign_country }}
Output
False

client.shipping.is_eu_country

boolean

If True, the customer’s shipping address country is in the EU.

Code
{{ client.shipping.is_eu_country }}
Output
True