Templates: full widget reference

Widgets are like mail merge fields in Microsoft Word. They allow you to pull in data from the record you are working on into a document or QuickNote - for example, the invoice number of a sales order, a customer's first name, or their billing and delivery address. You can even include custom fields from sales, purchases, customer or vendor records, while product custom fields can be added to the product table by customizing the column layout.

You can also merge your company logo into documents by adding the logo widget. If you are using different channel brands you can have multiple company logos which will be pulled in automatically at the right time.

To add a widget to a document template, you can either type the widget's code manually, or simply place your cursor where you want the field to be placed and then select it from the list.

If you are adding widgets to a QuickNote you'll need to type the widget name into the note.

General details widgets

Any of these widgets used on a template or QuickNote will pull in your own company details from your channel brands found in Settings > Company > Company information.

The channel used on the record dictates which channel brand's details are used. Where no channel is relevant on the record (e.g. a general email sent from a customer record), the default channel brand is used.

Widget Name Widget
(entered onto template)
Description
(where required)
My company name _myCompanyName_ Displays your company name as specified on the channel brand.
My company logo %logo% Displays your company logo as uploaded on the channel brand.
My company address _myCompanyAddress_ Displays your full company address as stated on the channel brand.
My company email _myCompanyEmail_ This widget uses the email address specified on the channel brand.
My company accounts email _myCompanyAccountsEmail_ This widget uses the accounts email address specified on the channel brand.
My company telephone _myCompanyTel_ This information is pulled from the telephone field on the channel brand.
My company VAT number _myCompanyVAT_ Your company VAT or Tax number, as specified in the Financials tab of your channel brand.
My company bank account _myCompanyBank_ Your company bank account number as specified in the Financials tab of your channel brand.
My company sort code _myCompanySort_ Your bank sort code as specified in the Financials tab of your channel brand.
My company SWIFT _myCompanySWIFT_ Your company SWIFT code as specified in the Financials tab of your channel brand.
My company number _myCompanyNum_ Your company registered number as specified in the Financials tab of your channel brand.
Sender's name _staffName_ The member of staff who sent the email/added the note.
Todays' date _date_ The date the document is being emailed or printed.

Contact details widgets

Any of these widgets used on a template or QuickNote will pull in details directly from the contact record linked to the area where the note or email is being created.

Widget Name Widget
(entered onto template)
Description
(where required)
Contact salutation _contactSalutation_ Mr / Miss / Mrs etc. as listed on their contact record.
Contact name _contactName_

The contact's first and last name as on their contact record.

Also see Orders --Customers--.

Contact first name _contactFirstName_ The contact's first name as on their contact record.
Contact last name _contactLastName_ The contact's last name as on their contact record.
Contact company _contactCompany_ The contact's company name as on their contact record.
Contact telephone _contactPhone_ The contact's telephone number as on their contact record.
Contact telephone 2 _contactTel2_ The contact's alternative telephone number as per the "Telephone 2" field on their contact record.
Contact fax _contactFax_ The contact's fax number as on their contact record.
Contact email _contactEmail_ The contact's email address as on their contact record.
Contact address _contactAddress_

The contact's default address taken from the contact record.

Also see Orders --Customer--.

Contact VAT _contactVAT_ The VAT/Tax number as recorded on the contact record.
Contact Code _contactCode_ The account code assigned to the contact.
Contact Ebay alias _contactEbayAlias_  The contact's eBay username / alias as specified in the Info tab of their contact record.
Contact credit days _contactCreditDays_ The number of credit days a contact has, as stated in the Financial tab of their contact record.
Contact credit terms _contactCreditTermsType_ The credit terms a contact has, as stated in their contact record.
Contact credit limit _contactCreditLimit_ The credit limit a contact has, as stated in the Financial tab of their contact record.

Invoice reminders widgets

These widgets are relevant only when used for emails or notes created against a specific invoice record.

Widget Name Widget
(entered onto template)
Description
(where required)
Invoice total _invoiceTotal_ This is pulled from the "Total" field on the Invoice. 

Statements widgets

Use these widgets to create a statement template. Learn more about statements here.

Widget Name Widget
(entered onto template)
Description
(where required)
Statement table _statementDetail_ When used in a template this widget will display either:
  • All account activity for a customer between two dates
  • All outstanding items for a customer up to a particular date

Which to display is chosen at the time of generating the statement.

Orders widgets

Any of these widgets used on a template or QuickNote will pull in details directly from the associated order. When using these widgets the email or QuickNote must relate to a specific and individual order (i.e. created directly on the order), otherwise they will not pull in any data.

Widget Name Widget
(entered onto template)
Description
(where required)
Order ref _orderRef_ This is the Brightpearl order ID.
Parent order ref _parentOrderId_ Where the order has been cloned or created as a back order it will have a parent order.
Customer ref _orderCustomerRef_ If a customer reference has been recorded on the order it will be displayed.
Order status _orderStatusText_ This specifies which status has been used for the order.
Order date created _orderDate_ This is the date that the order was created in Brightpearl, which includes both date and time created.
Order comments _orderComments_ This will list any notes that have been emailed to the customer via the Notes and payment history tab on the order.
Table of products _productTable_ Includes a full table of the products on the order. The columns displayed are customizable.
Channel name _channelName_ This is pulled from the "Channel" field on the order.
Project name _projectName_ This will specify the "Project" that this order has been assigned to (if any).
Assigned to _assignedTo_ The name of the staff member assigned to the order.
Ship method name _shipMethodName_ The name of the shipping method assigned to the order.
Ship method code _shipMethodCode_ The code of the shipping method assigned to the order, as configured in the setup area.
Link to order in web account area _webLink_ Provides a link to view the order/invoice on the web portal.
Total weight _totalWeight_ Calculates the total weight of the items on the order. This relies on weights being recorded against individual product records.
Total items _totalItems_

Specifies the total number of stock-tracked items on the order.

Order Barcode _barcode_

Generates a 10 digit barcode comprised of the order ID with leading 0s

-- Invoicing -- widgets

Once an order has been invoiced the following widgets can be used to display invoice information taken directly from the invoice record.

Widget Name Widget
(entered onto template)
Description
(where required)
Invoice ref _invoiceRef_ The invoice reference number created by Brightpearl.
Invoice date _invoiceDate_ The invoice/tax date on the invoice record.
Invoice due date _invoiceDue_ The date the payment is due for the invoice as set on the order itself.
Settlement discount rate _settDiscRate_ The settlement discount rate specified on the order.
Settlement discount days _settDiscDays_ The settlement discount days specified on the order.

-- Customer -- widgets

The following widgets will pull data about the main contact details from the sales order / invoice. This information is applied to the order from the contact record but may have been changed within the order itself, which will take precedence.

Widget Name Widget
(entered onto template)
Description
(where required)
Customer name _customerName_ Main customer name as on the order.
Customer telephone _customerTel_ The main customer telephone number as on the order.
Customer fax _contactFax_ The main fax number for the customer from the contact record.
Customer mobile _contactMobile_ The mobile number for the customer as on the order.
Customer email address _customerEmail_ The main email as on the order.
Customer address _customerAddress_ The default customer address as on the order.
Customer Bank Name _customerBankName_ The bank name recorded on the contact record.
Customer Bank Account Number _customerBankAccount_ The bank account number recorded on the contact record.
Customer Sort Code _customerSort_ The bank sort code recorded on the contact record.

-- Billing -- widgets

These widgets will display the contact billing details taken from the order.

Widget Name Widget
(entered onto template)
Description
(where required)
Billing name _billingName_ The name of the billing contact as on the order.
Billing telephone _billingTel_ The telephone number for the billing contact as on the order.
Billing mobile _billingMobile_ The mobile number for the billing contact as on the order.
Billing fax _billingFax_ The fax number for the billing contact as on the primary contact record.
Billing email address _billingEmail_ The email address for the billing contact as on the order.
Billing address _billingAddress_ This will display the full billing address. If you wish to specify certain address fields, then please use the widgets listed below.
Billing street _billingAdd1_ This will display the street address line for the billing address.
Billing suburb _billingAdd2_ This will display the suburb address line for the billing address.
Billing city _billingCity_ This will display the city address line for the billing address
Billing state _billingState_ This will display the state address line for the billing address.
Billing postcode _billingPostCode_ This will display the postcode address line for the billing address.

-- Delivery -- widgets

These widgets will display the contact billing details taken from the order.

Widget Name Widget
(entered onto template)
Description
(where required)
Delivery method name _shipMethodName_ The name set against the shipping method on the order.
Delivery method code _shipMethodCode_ The code set against the shipping method in the setup area.
Delivery tracking reference _shipTrackingRef_ The tracking number of the goods note. Note this will only work when viewing a goods out note.
Delivery name _deliveryName_ The contact name for the delivery address as specified in the Addresses tab on the order.
Delivery telephone _deliveryTel_ This will display the delivery telephone number  as shown in the Addresses tab on the order.
Delivery fax _deliveryFax_ This will display the delivery fax number as shown on the contact record.
Delivery mobile _deliveryMobile_ This will display the delivery mobile number as shown in the Addresses tab on the order.
Delivery email address _deliveryEmail_ This will display the delivery email address as shown in the Addresses tab on the order.
Delivery address _deliveryAddress_ This will display the full Delivery address. If you wish to specify certain address fields, then please use the widgets listed below.
Delivery street _deliveryAdd1_ This will display the street delivery address line as on the order.
Delivery suburb _deliveryAdd2_ This will display the suburb delivery address line as on the order.
Delivery city _deliveryCity_ This will display the city delivery address line for the contact only.
Delivery state _deliveryState_ This will display the state delivery address line as on the order.
Delivery postcode _deliveryPostCode_ This will display the postcode delivery address line as on the order.
Delivery date _deliveryDate_ This will display the delivery date as shown on the order.

Transfer widgets

These widgets can be used to display details of a warehouse transfer.

Widget Name Widget
(entered onto template)
Description
(where required)
Transfer reference _transferRef_ Displays the transfer reference from a warehouse transfer.

Custom field widgets

Custom fields from sales, purchases, customer and supplier records can be added to templates using widgets. Custom fields always begin "_PCF_" followed by the code set on the custom field.

Product record custom fields can only be added into the _productTable_ widget by customizing the columns (see the detailed article on working with the product table on templates).

Widget Name Widget
(entered onto template)
Description
(where required)
Custom field name _PCF_CUSTOMFIELDCODE_ Pulls in the contents of the custom field.
Have more questions? Submit a request