Document Template Codes
Here you can find all the available codes to add to document templates that will inject data from CocoonOPS into the documents that are produced. It is important that you use your training area to test your documents before uploading them to your live instance.
Best Practice for Consignor/Collection and Consignee/Delivery Details
The following table show how the different codes that can be used to include the collection and delivery address in a document:
Start of code | Description |
j.consignor. | This reference is for the consignor attached to the instructions ONLY |
j.origin. | This reference is for the collection party attached to the instructions ONLY. If no collection party is attached to the instructions, these codes will return blank. |
j.demarcOrigin. | The origin demarcation of a shipment instruction shows where your responsibility of the shipment begins. This will show either, the collection party information if set, or if no collection is set, the consignor party information will be used. This is the best sets of codes to use for the collection location of a shipment. |
j.consignee. | This reference is for the consignee attached to the instructions ONLY |
j.dest. | This reference is for the delivery party attached to the instructions ONLY. If no delivery party is attached to the instructions, these codes will return blank. |
j.demarcDestination. | The destination demarcation of a shipment instruction shows where your responsibility of the shipment ends. This will show either, the delivery party information if set, or if no delivery is set, the consignee party information will be used. This is the best sets of codes to use for the delivery location of a shipment. |
Date & Time Formats
All dates inserted into documents are in the international standardised date format to prevent miss interpretation. E.g: 01 JAN 2025.
All times are formatted using a 24-hour clock with leading zeroes. E.g: 09:30.
Tables Within Documents
There are several tables that can be set up in documents:
- Collections
- Deliveries
- Rates
- Invoice Rates
- Containers
- Freight
- Goods
These tables have triggering codes that are used to identify that a row need to be created. A column within the table must include this code for the table to be built.
Codes that are used to generate tables can only be used in a table together. Codes from different tables cannot be mixed.
You can use codes that are not part of a table within a table. These will be cloned for each row in the table.
Addresses
Most addresses in the system can be formatted in different ways.
This applied to any address where a code ends with .address.print}
The following table shows how you can use different codes to transform the address or display part of the addres.
Code | Description |
| .address.print} | Print the entire address on multiple lines |
| .address.print1} | Print the entire address on 1 line |
| .address.premise} | This will output the property address without the postcode and country code |
| .address.postal} | Outputs the postcode and country code part of the address |
| .address.fao} | FOA attribute of the address |
| .address.co} | Company name |
| .address.l1} | Line of the address |
| .address.l2} | Line 2 of the address |
| .address.l3} | Linen 3 of the address |
| .address.city} | City of the address |
| .address.county} | County of the address |
| .address.zip} | Postcode of the address |
| .address.country} | 2 Character UN Country |
Multidrop Specific Codes
The following codes are available for use in a document for a multidrop road consignment.
An example of a single document set up to produce a driver's itinerary, collection notes and delivery notes for a multidrop consignment. This document template can be found as an attachement at the bottom of the page and is called multidrop-driver-runsheet.docx
Collection Notes
This code is only available to documents generated from the consignment module.
You can create a section in your document per collection.
This is done by adding the following code at the beginning of the section to be duplicated: ${pickupSection}
You will also have to add the following code to the end of the section you want to be duplicated for each pickup: ${/pickupSection}
This can be applied to sections of a page or whole pages.
To ensure a new page is created, insert a page break before the ${/pickupSection} code.
With this section you can use any of the codes that begin ${j.
Additional codes are provided that are specific to each collection location.
These codes can only be used between the ${pickupSection} and ${/pickupSection} codes.
The following table show the codes that are available:
Code | Example | Description |
| ${collection.origin.print1} | OCEAN HOUSE, MARSTON PARK, TAMWORTH, BIRMINGHAM, B78 3HU, GB | Origin address for the collection movement |
| ${collection.dep} | 22 JUN 2024 15:00 | Latest version of the date and time the freight was collected If on the date is available the time is automatically hidden. |
| ${collection.departDate} | 22 JUN 2024 | Latest version of the date the freight was collected |
| ${collection.departTime} | 09:00 | Latest version of the time the freight was collected |
| ${collection.reg} | ABC 123D | The registration plate number of the vehicle |
| ${collection.trailer} | ABC 123D | Trailer registration plate number |
| ${collection.supplier.name} | KEEP ON TRUCKING | The name of the carrier |
| ${collection.supplier.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | The address for the carrier completing the collection. |
| ${collection.supplier.address.print1} | THE TRUCK YARD, LONDON, SE18 9JK, GB | The address for the carrier completing the collection. |
| ${collection.supplier.contact.name} | JANE WILLIAMS | The name of the contact at the carrier |
| ${collection.supplier.contact.email} | JANE.WILLIAMS@tok.co.uk | The email address of the contact at the carrier |
| ${collection.supplier.contact.tel} | +44 7253469245 | The phone number of the contact at the carrier |
| ${collection.bkg} | KOT1422345461113-256 | Carrier Booking Reference |
| $.collection.wb} | KOTC-01234545677 | Carrier issued waybill for the movement |
| ${collection.refC} | 12345679-ABCDE | External reference for the movement |
${collection.ref} | 12345679-ABCDE | Reference for the movement |
| ${collection.colI} | Free text | Collection instructions for the movement |
Within the collection note you can create a horizontal table that show what freight is being collected.
The table row must include the code ${collection.freight.pcs} in order to be built.
The row containing the ${collection.freight.pcs} code will be duplicated for each piece of freight due to be collected at the location.
Code | Example | Description |
| ${collection.freight.eqNum} | Equipment number on standardized freight units | |
| ${collection.freight.pcs} | 3 | Number of pieces of identical freight |
| ${collection.freight.pkg} | PALLET | Freight equipment type |
| ${collection.freight.pkgShort} | 20Ft GP | Freight equipment type shorthand version |
| ${collection.freight.desc} | ELECTRICAL WIRING, COPPER | Goods summary at the freight level |
| ${collection.freight.haz-info} | NON HAZARDOUS | Show hazardous information about the freight |
| ${collection.freight.dims} | 100 x 100 x 100CM | Freight dimensions |
| ${collection.freight.tWgtG} | 1253.125 | Total gross weight for the freight items |
| ${collection.freight.tWgtV} | 1253.125 | Total volumetric weight for the freight items |
| ${collection.freight.tWgtC} | 1253.125 | Total chargeable weight for the freight items |
| ${collection.freight.tCbm} | 123.253 | Total CBM for the freight items |
| ${collection.freight.stack} | Y / N | Is each freight item stackable |
| ${collection.freight.wgtG} | 1253.12 | Gross weight for each of the freight items |
| ${collection.freight.wgtN} | 1253.12 | Net weight for each of the freight items |
| ${collection.freight.wgtV} | 1253.12 | Volumetric weight for each of the freight items |
| ${collection.freight.wgtC} | 1253.12 | Chargeable weight for each of the freight items |
| ${collection.freight.cbm} | 123.125 | CBM for each of the freight items |
| ${collection.freight.vgm} | 125.25 | The VGM value in the consignment weight unit |
| ${collection.freight.vgmSource} | CUSTOMS | The party responsible for the VGM value |
| ${collection.freight.vgmMethod} | METHOD 1 | The method used to calculate the VGM value |
| ${collection.freight.marks} | ADDRESS | Marks attached to the freight items |
| ${collection.freight.value} | GBP 100.00 | Total value of the freight |
| ${collection.freight.goods} | WIRE, COPPER 12x PALLETS, CC: 123456789, COO: CN | Freight goods information |
| ${collection.freight.env} | ENVIRONMENTAL REQUIREMENTS! MIN TEMP: 1 DEGREES CELSIUS MAX TEMP: 4 DEGREES CELSIUS | Environmental Requirements |
| ${collection.freight.pkgCount} | 100 | Number of packages inside the container |
EXAMPLE - Freight Table for Multidrops
| Freight Type | Description | CBM | Weight, Gross (Kgs) | Weight, Chargeable (Kgs) |
| ${collection.freight.pkgShort} | ${collection.freight.pcs} x ${collection.freight.pkg} ${collection.freight.haz-info} | ${collection.freight.tCbm} | ${collection.freight.tWgtG} | ${collection.freight.tWgtC} |
Delivery Notes
This code is only available to documents generated from the consignment module.
You can create a section in your document per drop of/delivery.
This is done by adding the following code at the beginning of the section to be duplicated: ${dopSection}
You will also have to add the following code to the end of the section you want to be duplicated for each pickup: ${/dopSection}
This can be applied to sections of a page or whole pages.
To ensure a new page is created, insert a page break before the ${/dropSection} code.
With this section you can use any of the codes that begin ${j.
Additional codes are provided that are specific to each delivery location.
These codes can only be used between the ${dopSection} and ${/dopSection} codes.
The following table show the codes that are available:
| Code | Example | Description |
| ${delivery.dest.print1} | OCEAN HOUSE, MARSTON PARK, TAMWORTH, BIRMINGHAM, B78 3HU, GB | Destination address for the delivery movement |
| ${delivery.arr} | 22 JUN 2024 15:00 | Latest version of the date and time the freight was delivered If on the date is available the time is automatically hidden. |
| ${delivery.arrivalDate} | 22 JUN 2024 | Latest version of the date the freight was delivered |
| ${delivery.arrivalTime} | 09:00 | Latest version of the time the freight was delivered |
| ${delivery.reg} | ABC 123D | The registration plate number of the vehicle |
| ${delivery.trailer} | ABC 123D | Trailer registration plate number |
| ${delivery.supplier.name} | KEEP ON TRUCKING | The name of the carrier |
| ${delivery.supplier.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | The address for the carrier completing the delivery. |
| ${delivery.supplier.address.print1} | THE TRUCK YARD, LONDON, SE18 9JK, GB | The address for the carrier completing the delivery. |
| ${delivery.supplier.contact.name} | JANE WILLIAMS | The name of the contact at the carrier |
| ${delivery.supplier.contact.email} | JANE.WILLIAMS@tok.co.uk | The email address of the contact at the carrier |
| ${delivery.supplier.contact.tel} | +44 7253469245 | The phone number of the contact at the carrier |
| ${delivery.bkg} | KOT1422345461113-256 | Carrier Booking Reference |
| $.delivery.wb} | KOTC-01234545677 | Carrier issued waybill for the movement |
| ${delivery.refC} | 12345679-ABCDE | External reference for the movement |
| ${delivery.ref} | 12345679-ABCDE | Reference for the movement |
| ${delivery.delI} | Free text | Delivery instructions for the movement |
Within the delivery note you can create a horizontal table that show what freight is being delivered.
The table row must include the code ${delivery.freight.pcs} in order to be built.
The row containing the ${delivery.freight.pcs} code will be duplicated for each piece of freight due to be delivered to the location.
| Code | Example | Description |
| ${delivery.freight.eqNum} | Equipment number on standardized freight units | |
| ${delivery.freight.pcs} | 3 | Number of pieces of identical freight |
| ${delivery.freight.pkg} | PALLET | Freight equipment type |
| ${delivery.reight.pkgShort} | 20Ft GP | Freight equipment type shorthand version |
| ${delivery.freight.desc} | ELECTRICAL WIRING, COPPER | Goods summary at the freight level |
| ${delivery.freight.haz-info} | NON HAZARDOUS | Show hazardous information about the freight |
| ${delivery.freight.dims} | 100 x 100 x 100CM | Freight dimensions |
| ${delivery.freight.tWgtG} | 1253.125 | Total gross weight for the freight items |
| ${delivery.freight.tWgtV} | 1253.125 | Total volumetric weight for the freight items |
| ${delivery.freight.tWgtC} | 1253.125 | Total chargeable weight for the freight items |
| ${delivery.freight.tCbm} | 123.253 | Total CBM for the freight items |
| ${delivery.freight.stack} | Y / N | Is each freight item stackable |
| ${delivery.freight.wgtG} | 1253.12 | Gross weight for each of the freight items |
| ${delivery.freight.wgtN} | 1253.12 | Net weight for each of the freight items |
| ${delivery.freight.wgtV} | 1253.12 | Volumetric weight for each of the freight items |
| ${delivery.freight.wgtC} | 1253.12 | Chargeable weight for each of the freight items |
| ${delivery.freight.cbm} | 123.125 | CBM for each of the freight items |
| ${delivery.freight.vgm} | 125.25 | The VGM value in the consignment weight unit |
| ${delivery.freight.vgmSource} | CUSTOMS | The party responsible for the VGM value |
| ${delivery.freight.vgmMethod} | METHOD 1 | The method used to calculate the VGM value |
| ${delivery.freight.marks} | ADDRESS | Marks attached to the freight items |
| ${delivery.freight.value} | GBP 100.00 | Total value of the freight |
| ${delivery.freight.goods} | WIRE, COPPER 12x PALLETS, CC: 123456789, COO: CN | Freight goods information |
| ${delivery.freight.env} | ENVIRONMENTAL REQUIREMENTS! MIN TEMP: 1 DEGREES CELSIUS MAX TEMP: 4 DEGREES CELSIUS | Environmental Requirements |
| ${delivery.freight.pkgCount} | 100 | Number of packages inside the container |
EXAMPLE - Freight Table for Multidrops
| Freight Type | Description | CBM | Weight, Gross (Kgs) | Weight, Chargeable (Kgs) |
| ${delivery.freight.pkgShort} | ${delivery.freight.pcs} x ${delivery.freight.pkg} ${delivery.freight.haz-info} | ${delivery.freight.tCbm} | ${delivery.freight.tWgtG} | ${delivery.freight.tWgtC} |
Locations Table
You can create a table showing all of the locations on your movement plan and a summary of the freight to be picked up and dropped off.
This will pull in information from the movements and freight tabs for multidrop consignments.
These codes can only be used in a table and not interdependently in a document.
For the table to be built, one of the columns in the table data row must contain the code ${j.locations.address.print1}
| Code | Example | Description |
| ${j.locations.name} | Customer A | The name of the customer set in the label field in the address book |
| ${j.locations.address.print1} | 1 Bay Vies, St Thomas, Swansea, West Glamorgan, SA1 8BB, GB | The address of the location printed on a single line |
${j.locations.freight} | DROP OF 1 x BAG @ 100KG PICKUP 2 x PALLET, FULL @ 100KG | Summary of the freight to be picked up/dropped off. This includes the quantity and type of freight, the weight per item. |
${j.locations.arr} | 20 JUL 2026 09:30 | The date and time (if provided) that the vehicle is scheduled to arrive at this location. |
${locations.refC} | AAA9999 | Collection reference |
${locations.refD} | AAA9999 | Delivery Reference |
${locations.colI} | Collection instructions | |
${locations.delI} | Delivery instructions |
Duplicate Section/Pages for Containers
For some documents such as collection or delivery notes, you may want to have a single section for each shipping container. This is done by adding the following code at the beginning of the section to be duplicated: ${containerPage}
You will also have to add the following code to the end of the section you want to be duplicated for each container: ${/containerPage}
This can be applied to sections of a page or whole pages.
To ensure a new page is created, insert a page break before the ${/containerPage} code.
Example Document
Information on the collection and delivery movements as well as the freight table that are between the tags are replaced with the specific information for each container.
Quotes
The following codes are specific to quotation documents
Code | Example | Description |
${j.valid} | 02 JUN 2024 | Date the quote is valid from |
${j.exp} | 02 JUN 2024 | Date the quote is valid until |
${j.note} | Additional Info attached to the quote issued to the customer |
Computed Freight Summary For A Consignment
These values are automatically calculated from the information entered on the FREIGHT tab.
| Code | Example | Description |
| ${j.sum} | 40" HIGH CUBE DRY CONTAINER x 1 | Compiled freight summary |
| ${j.wgt} | 120.25 | Calculated Total Weight from freight tab |
| ${j.wgtV} | 120.25 | Calculated Total Volumetric Weight |
| ${j.wgtC} | 120.25 | Calculated Total Chargeable Weight |
| ${j.cbm} | 2.235 | Calculated Total Volume (M3) |
| ${j.ldm} | 12.25 | Calculated loading metres |
| ${j.wgtU} | Kgs | Weight unit used for the consignment |
| ${j.pcs} | 3 | Total number of pieces of freight to be moved |
| ${j.sumPcs} | 2 | Number of goods packages that are contained in the freight |
Financial Summary For A Consignment
The following codes allow you to add information from the RATES tab to a document
Code | Example | Description |
| ${j.cur} | GBP | Currency the consignment is billed in |
| ${j.tr} | 1200.00 | Total revenue on a consignment |
| ${j.tc} | 1200.00 | Total costs of a consignment to you |
| ${j.payTermsLbl} | PREPAID | Payment terms for the consignment |
| ${j.primeCustoms.ucr} | 9GB000000000000-12345 | UCR reference for the GB customs consignment |
Emissions Estimates
The following codes allow you to add Green House Gas (GHG) emissions estimates to documents:
Code | Example | Description |
| ${j.dist} | 1292.00 | Total distance traveled by the consignment in Km |
| ${j.ghgCO2} | 38.00 | Estimated CO2 emissions in Kg |
| ${j.ghgNOx} | 1200.00 | Estimated NOx emissions in grams |
| ${j.ghgPM} | 2.99 | Estimated particulate matter emissions in grams |
| ${j.ghgCert} | 9GB000000000000-12345 | Offsetting certificate reference |
| ${j.ghgCertDoi} | 18 Jun 2024 | Date certificate was issued |
| ${j.ghgCer} | 10 | Number of units cancelled (CER) |
| ${j.ghgSerialStart} | 12314546545649879 | Serial number of first CER |
| ${j.ghgSerialEnd} | 12314546545649889 | Serial Number of last CER |
| ${j.ghgTrees} | 25 | The number of trees used to offset the emissions |
| ${j.ghgOffset} | 250 | Total CO2 that was offset by the planing of the trees |
| ${j.ghgProjectName} | Project 2012 | The remediation project name |
| ${j.ghgProjectDesc} | Plantation of 2000 trees | The remediation project description |
| ${j.ghgProjectLoc} | AMAZON RAIN FOREST | The remediation project location |
| ${j.ghgProjectSpecies} | OAK | The species of tree planted |
Principal Carrier Information
This table shows the codes that can be used to import the information from the carrier tab into documents.
| Code | Example | Description |
|---|---|---|
| ${j.carrier.name} | KEEP ON TRUCKING LTD | Name of the principal carrier for the consignment |
| ${j.carrier.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the principal carrier |
| ${j.carrier.address.print1} | UNIT 4, ATLANTIC TRADING EST, LONDON, SE11 4LB, GB | Address of the principal carrier |
| ${j.carrier.contact.name} | JANE THOMAS | Name of the selected contact at the carrier |
| ${j.carrier.contact.tel} | 02081231234 | Telephone number for the selected cotact at the carrier |
| ${j.carrier.contact.email} | BOOKINGS@KOT.COM | Email address for the selected contact at the carrier |
| ${j.carrierInco} | DAP | Carrier's INCO terms |
| ${j.carrierRates} | CON00290937 | Reference rates agreement with the principal carrier |
| ${j.carrierQ} | KOT-2024-099083 | Reference for quote supplied by principal carrier |
| ${j.carrierB} | KOT-2024-099083 | Booking reference for the principal carrier for the consignment |
| ${j.carrierIns} | Instructions for the principal carrier | |
| ${j.wbIns} | Waybill instructions for the principal carrier | |
| ${j.marks} | Marks & Numbers for the consignment | |
| ${j.transitT} | 30 | The number of days to transit the scheduled international service provided by the principal carrier |
| ${j.transitF} | 2 | The number of times a week the scheduled international service provided by the principal carrier departs |
| ${j.demFT} | 30 | The number of days that are not charged for demurrage at the destination port |
| ${j.retRT} | 30 | The number of days that are not charged for retention of the container in the destination country |
| ${j.contNo} | MEAU3938388 | The container number attached to LCL sea freight shipments on the carrier tab |
| ${j.carrierCostCurrency} | GBP | Currency the carrier isi billing in |
| ${j.carrierCostGross} | £1,000.00 | Gross total charged by the carrier |
| ${j.carrierCostNet} | £1,000.00 | Net total charged by the carrier |
| ${j.carrierCostTax} | £1,000.00 | The total tax charged by the carrier |
| ${j.cwb} | 1246578901 | Reference for the waybill issued by the primary carrier |
| ${j.cwbType} | MASTER BOL | Type of waybill issued by the primary carrier |
Carrier Rates Table
The following codes are used to build a horizontal table of the cost rates that are attached to the quote or consignment where the supplier is the carrier that is set on the carrier tab.
For the table to be built, one of the columns in the table must contain the code ${c.rates.lbl}
Each row that contains the ${c.rates.lbl} will be duplicated for each rate that is applicable.
These codes can only be used in a table and not interdependently in a document.
| Code | Example | Description |
|---|---|---|
| ${c.rates.lbl} | BOOKING FEE | Rate name |
| ${c.rates.sku} | BOOK | Rate code |
| ${c.rates.q} | 12.253 | The quantity applied |
| ${c.rates.uc} | 10.00 | Cost per unit |
| ${c.rates.taxPercent} | 20 | Percentage applied to the subtotal as tax |
| ${c.rates.tax} | 2.00 | Tax payable |
| ${c.rates.st} | 12.00 | Subtotal for the line item |
| ${c.rates.tc} | 12.00 | Total for the line item |
| ${c.rates.basedOn} | FIXED | How the ratable value is calculated |
| ${c.rates.cur} | EUR | Currency the rate is billed in |
| ${c.rates.baseCur} | GBP | Currency the rate is recorded in |
| ${c.rates.xr} | 1.2787 | This is the exchange rate from the entered currency to the billing cuurrency |
| ${c.rates.bst} | 1,000.00 | Subtotal of the line item in the original currency |
| ${c.rates.btc} | 1,000.00 | Total of the line item in the original currency |
| ${c.rates.buc} | 1,000.00 | Unit cost in the original currency |
| ${c.rates.basis} | Based on €100 x 1 Tax rate applied: 0% Converted: GBP 140.27 Exchange rate applied: 1.4027 GBP / 1 EUR | Information on how the ratable value was derived |
| ${c.rates.comment} | OVERAGE AGREED WITH CUSTOMER | The comment entered against the rate |
EXAMPLE - Carrier Rates Table
Charge Code | Description | Comment | Info | Subtotal |
${c.rates.sku} | ${c.rates.lbl} | ${c.rates.comment} | ${c.rates.q} x ${c.rates.uc} | ${c.rates.st} |
Containers Table
The following codes can be used to produce a horizontal table in your document that will show the containers attached to a consignment.
The container row must contain ${cont.eqNum} code.
The row containing the ${cont.eqNum} code will be duplicated for each container attached to the consignment.
These codes can only be used in a table and not interdependently in a document.
Freight that does not use a container equipment type will not be included in the table that is produced using these codes
| Code | Example | Description |
|---|---|---|
| ${cont.eq} | 25GP | Container Type |
| ${cont.eqShort} | 20ft GP | Container Type, short name |
| ${cont.eqLabel} | 20" DRY CONTAINER | Container Type, long name |
| ${cont.eqNum} | CMAU1234567 | Container Number |
| ${cont.wgtG} | 1253.12 | Gross weight for each of the freight items |
| ${cont.wgtN} | 1253.12 | Net weight for each of the freight items |
| ${cont.cbm} | 123.125 | CBM for each of the freight items |
| ${cont.seal} | G2382564 | Container Seal Number |
| ${cont.desc} | WIRE, COPPER, ELECTRICAL 0 GAUGE | Contents of the container |
| ${cont.stack} | Y / N | Is each freight item stackable |
| ${cont.vgm} | 125.25 | The VGM value in the consignment weight unit |
| ${cont.vgmSource} | CUSTOMS | The party responsible for the VGM value |
| ${cont.vgmMethod} | METHOD 1 | The method used to calculate the VGM value |
| ${cont.haz-info} | NON HAZARDOUS | Show hazardous information about the contents of the container |
| ${cont.contents} | 3 x PALLETS | Summary of the container contents |
| ${cont.env} | ENVIRONMENTAL REQUIREMENTS! MIN TEMP: 1 DEGREES CELSIUS MAX TEMP: 4 DEGREES CELSIUS | Environmental Requirements |
| ${cont.pkgCount} | 100 | Number of packages inside the container |
EXAMPLE - Container Table
| Container Type | Container Number | Description | CBM | Weight, Gross (Kgs) |
| ${cont.eqShort} | ${cont.eqNum} | ${cont.desc} | ${cont.cbm} | ${cont.wgtG} |
Freight Table
The following codes can be used to produce a horizontal table in your document that will show all the freight items attached to a consignment.
Freight must be attached to the consignment.
The table in your template must include a row with the ${freight.pcs} code in.
The row with ${freight.pcs} will be duplicated for each piece of freight to build the table.
These codes can only be used in a table and not interdependently in a document.
| Code | Example | Description |
|---|---|---|
| ${freight.eqNum} | Equipment number on standardized freight units | |
| ${freight.pcs} | 3 | Number of pieces of identical freight |
| ${freight.pkg} | PALLET | Freight equipment type |
| ${freight.pkgShort} | 20Ft GP | Freight equipment type shorthand version |
| ${freight.desc} | ELECTRICAL WIRING, COPPER | Goods summary at the freight level |
| ${freight.haz-info} | NON HAZARDOUS | Show hazardous information about the freight |
| ${freight.dims} | 100 x 100 x 100CM | Freight dimensions |
| ${freight.tWgtG} | 1253.125 | Total gross weight for the freight items |
| ${freight.tWgtV} | 1253.125 | Total volumetric weight for the freight items |
| ${freight.tWgtC} | 1253.125 | Total chargeable weight for the freight items |
| ${freight.tCbm} | 123.253 | Total CBM for the freight items |
| ${freight.stack} | Y / N | Is each freight item stackable |
| ${freight.wgtG} | 1253.12 | Gross weight for each of the freight items |
| ${freight.wgtN} | 1253.12 | Net weight for each of the freight items |
| ${freight.wgtV} | 1253.12 | Volumetric weight for each of the freight items |
| ${freight.wgtC} | 1253.12 | Chargeable weight for each of the freight items |
| ${freight.cbm} | 123.125 | CBM for each of the freight items |
| ${freight.vgm} | 125.25 | The VGM value in the consignment weight unit |
| ${freight.vgmSource} | CUSTOMS | The party responsible for the VGM value |
| ${freight.vgmMethod} | METHOD 1 | The method used to calculate the VGM value |
| ${freight.marks} | ADDRESS | Marks attached to the freight items |
| ${freight.value} | GBP 100.00 | Total value of the freight |
| ${freight.goods} | WIRE, COPPER 12x PALLETS, CC: 123456789, COO: CN | Freight goods information |
| ${freight.env} | ENVIRONMENTAL REQUIREMENTS! MIN TEMP: 1 DEGREES CELSIUS MAX TEMP: 4 DEGREES CELSIUS | Environmental Requirements |
| ${freight.pkgCount} | 100 | Number of packages inside the container |
EXAMPLE - Freight Table
| Freight Type | Description | CBM | Weight, Gross (Kgs) | Weight, Chargeable (Kgs) |
| ${freight.pkgShort} | ${freight.desc} ${freight.haz-info} | ${freight.tCbm} | ${freight.tWgtG} | ${freight.tWgtC} |
Goods Table
The following table show the codes that can be used in a template to produce a horizontal table of all the goods that are contained in the freight for a consignment.
Your table must include the code ${goods.pcs} in the row.
The row containing the code ${goods.pcs} will be duplicated for each line of goods that are included in all the freight items attached to a consignment.
These codes can only be used in a table and not interdependently in a document.
| Code | Example | Description |
|---|---|---|
| ${goods.pcs} | 3 | Number of pieces of identical packages of goods in the freight |
| ${goods.pkg} | PALLET | Type of packaging |
| ${goods.tWgtG} | 100.00 | Total gross weight |
| ${goods.tWgtN} | 123.25 | Total net weight |
| ${goods.tCbm} | 123.253 | Total CBM |
| ${goods.desc} | ELECTRICAL WIRING, COPPER | Description of goods |
| ${goods.dims} | 100 x 100 x 100CM | Dimensions of each package |
| ${goods.cc} | 19022091 | Commodity Code |
| ${goods.cpc} | 68 | Customs Procedure Code |
| ${goods.coo} | GB | Country Of Origin |
| ${goods.sku} | 12345679AB | Goods Items SKU code |
| ${goods.marks} | Marks on goods packaging |
EXAMPLE - Goods Table
| Package | Description | Weight, Gross (Kgs) |
| ${goods.pcs} x ${goods.pkg} | ${goods.desc} | ${freight.tWgtG} |
Single Collection Movement Information
Usage - Use these codes to insert the collection information where there will only be ONE collection attached to the consignment
Collection movement information is not available on documents generated using the quotes module.
| Code | Example | Description |
|---|---|---|
| ${collection.ref} | 123456 | Internal reference for the collection movement |
| ${j.collection.origin.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Origin address for the collection movement |
| ${j.collection.origin.print1} | OCEAN HOUSE, MARSTON PARK, TAMWORTH, BIRMINGHAM, B78 3HU, GB | Origin address for the collection movement |
| ${j.collection.dep} | 22 JUN 2024 15:00 | Latest version of the date and time the freight was collected If on the date is available the time is automatically hidden. |
| ${j.collection.departureDate} | 22 JUN 2024 | Latest version of the date the freight was collected |
| ${j.collection.departureTime} | 09:00 | Latest version of the time the freight was collected |
| ${j.collection.arrivalDate} | 22 JUN 2024 | Latest version of the date the freight arrive from the collection movement |
| ${j.collection.arrivalTime} | 09:00 | Latest version of the time the freight arrived from the collection movement |
| ${j.collection.depP} | 01 JAN 2024 09:00 | Planned date and time of collection |
| ${j.collection.depPDate} | 01 JAN 2024 | Planned date of collection |
| ${j.collection.depPTime} | 09:00 | Planned time of collection |
| ${j.collection.depA} | 01 JAN 2024 09:34 | Actual date and time of collection |
| ${j.collection.trans.vrm} | ABC 123D | The registration plate number of the vehicle |
| ${j.collection.trans.trailer} | ABC 123D | Trailer registration plate number |
| ${j.collection.trans.flag} | GB | The UN country code for the registration country for the vehicle |
| ${j.collection.supplier.name} | KEEP ON TRUCKING | The name of the carrier |
| ${j.collection.supplier.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | The address for the carrier completing the collection. |
| ${j.collection.supplier.address.print1} | THE TRUCK YARD, LONDON, SE18 9JK, GB | The address for the carrier completing the collection. |
| ${j.collection.supplier.contact.name} | JANE WILLIAMS | The name of the contact at the carrier |
| ${j.collection.supplier.contact.email} | JANE.WILLIAMS@tok.co.uk | The email address of the contact at the carrier |
| ${j.collection.supplier.contact.tel} | +44 7253469245 | The phone number of the contact at the carrier |
| ${j.collection.supplier.getIdentity('XXX')} | Replace XXX with the identity reference. | |
| ${j.collection.bkg} | KOT1422345461113-256 | Carrier Booking Reference |
| ${j.collection.wb} | KOTC-01234545677 | Carrier issued waybill for the movement |
| ${j.collection.refC} | 12345679-ABCDE | External reference for the movement |
| ${j.collection.colI} | Collection instructions for the movement | |
| ${j.collection.delI} | Collection instructions for arrival at the destination |
International Movement Information
International movement information is not available on documents generated using the quotes module.
| Code | Example | Description |
|---|---|---|
| ${j.pol.origin.lid} | GBLIV | UN LOCODE or IATA airport code for the port of origin |
| ${j.pol.origin.lbl} | LIVERPOOL | Name of the port of origin |
| ${j.pol.origin.country} | GB | UN Country code for the country the port of origin is in |
| ${j.pol.docCO} | 01 Jan 2025 09:00 | Document cut off for the trnsport from port of origin |
| ${j.pol.loadCO} | 01 Jan 2025 15:00 | Loading cut off gor the transport from the port of origin |
| ${j.pol.wb} | BIL-12345678910 | Waybill associated with transport leaving the port of origin |
| ${j.pol.depP} | 21 JUL 2024 15:00 | Planned date and time of departure from the port of origin |
| ${j.pol.depPDate} | 21 JUL 2024 | Planned date of departure from the port of origin |
| ${j.pol.depPTime} | 15:00 | Planned time of departure from the port of origin |
| ${j.pol.dep} | 21 JUL 2024 15:00 | Latest date and time of departure from the port of origin |
| ${j.pol.departureDate} | 21 JUL 2024 | Latest date of departure from the port of origin |
| ${j.pol.departureTime} | 15:00 | Latest time of departure from the port of origin |
| ${j.pol.depA} | 21 JUL 2024 15:00 | Actual date and time of departure from the port of origin |
| ${j.pol.trans.vessel} | EVER GIVEN | Name of the vessel departing port of origin |
| ${j.pol.trans.voyage} | ER42 | Voyage number departing port of origin |
| ${j.pol.trans.fltNo} | BA125 | Flight number departing port of origin |
| ${j.pol.supplier.getIdentity('XXX')} | Replace XXX with the identity reference. See here for reference codes | |
| ${j.pod.dest.lid} | LHR | UN LOCODE or IATA airport code for the final destination port/td> |
| ${j.pod.dest.lbl} | HEATHROW | Name of the final destination port |
| ${j.pod.dest.country} | GB | UN Country code for the country the final destination port |
| ${j.pod.arrP} | 21 JUL 2024 15:00 | Planned date and time of arrival at the final destination port |
| ${j.pod.arrPDate} | 21 JUL 2024 | Planned date of arrival at the final destination port |
| ${j.pod.arrPTime} | 15:00 | Planned time of arrival at the final destination port |
| ${j.pod.arr} | 21 JUL 2024 15:00 | Latest version of the date and time of arrival at the final destination port |
| ${j.pod.arrivalDate} | 22 JUN 2024 | Latest version of the date of arrival at the final destination port |
| ${j.pod.arrivalTime} | 15:00 | Latest version of the time of arrival at the final destination port |
| ${j.pod.arrA} | 21 JUL 2024 15:00 | Actual date and time of arrival at the final destination port |
| ${j.pod.supplier.getIdentity('XXX')} | Replace XXX with the identity reference. |
Single Delivery Movement Information
Usage - Use these codes to insert the delivery information where there will only be ONE delivery attached to the consignment
Delivery movement information is not available on documents generated using the quotes module.
| Code | Example | Description |
|---|---|---|
| ${j.delivery.ref} | 12345679 | Internal reference for the delivery movement |
| ${j.delivery.dest.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Destination address for the delivery movement |
| ${j.delivery.dest.print1} | OCEAN HOUSE, MARSTON PARK, TAMWORTH, BIRMINGHAM, B78 3HU, GB | Destination address for the delivery movement |
| ${j.delivery.arr} | 22 JUN 2024 15:00 | Latest version of the date and time the freight was delivered. If on the date is available the time is automatically hidden. |
| ${j.delivery.arrivalDate} | 22 JUN 2024 | Latest version of the date the freight was delivered |
| ${j.delivery.arrivalTime} | 15:00 | Latest version of the time the freight was delivered |
| ${j.delivery.arrP} | 01 JAN 2024 09:00 | Planned date and time of delivery |
| ${j.delivery.arrPDate} | 01 JAN 2024 | Planned date of delivery |
| ${j.delivery.arrPTime} | 09:00 | Planned time of delivery |
| ${j.delivery.arrA} | 01 JAN 2024 09:34 | Actual date and time of delivery |
| ${j.delivery.trans.vrm} | ABC 123D | The registration plate number of the vehicle |
| ${j.delivery.trans.trailer} | ABC 123D | Trailer registration plate number |
| ${j.delivery.trans.flag} | GB | The UN country code for the registration country for the vehicle |
| ${j.delivery.supplier.name} | KEEP ON TRUCKING | The name of the carrier |
| ${j.delivery.supplier.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | The address for the carrier completing the collection. |
| ${j.delivery.supplier.address.print1} | THE TRUCK YARD, LONDON, SE18 9JK, GB | The address for the carrier completing the collection. |
| ${j.delivery.supplier.contact.name} | JANE WILLIAMS | The name of the contact at the carrier |
| ${j.delivery.supplier.contact.email} | JANE.WILLIAMS@tok.co.uk | The email address of the contact at the carrier |
| ${j.delivery.supplier.contact.tel} | +44 7253469245 | The phone number of the contact at the carrier |
| ${j.delivery.supplier.getIdentity('XXX')} | Replace XXX with the identity reference. | |
| ${j.delivery.bkg} | KOT1422345461113-256 | Carrier Booking Reference |
| ${j.delivery.wb} | KOTC-01234545677 | Carrier issued waybill for the movement |
| ${j.delivery.delI} | 12345679-ABCDE | Delivery instructions from the delivery movement |
| ${j.delivery.delI} | External reference for the movement |
It is possible for the collection and delivery movement to be the same movement on the movements tab.
Multiple Collections Table
The following table shows the codes that can be used to produce a horizontal table of all the collection movements on a consignment.
Your table must include the code ${collections.date} in the row.
The row containing the code ${collections.date} will be duplicated for each collection movement attached to the consignment movement plan.
The first container haulage movement before an international sea freight movement is considered a collection movement.
These codes can only be used in a table and not interdependently in a document.
Usage - Use these codes to insert the collection information where there will be ONE OR MORE collection movements attached to the consignment and you want to display them in a table
Code | Example | Description |
| ${collections.ref} | 123456798 | Reference for the collection movement |
| ${collections.date} | 01 JUL 2024 | Latest date for the collection |
| ${collections.time} | 09:30 | Latest time for the collection |
| ${collections.address} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | The origin address of the collection movement |
| ${collections.address1Line} | OCEAN HOUSE, MARSTON PARK, TAMWORTH, BIRMINGHAM, B78 3HU, GB | The origin address of the collection movement |
| ${collections.ins} | Collection Instructions | |
| ${collections.bkg} | AA-123456798 | Collection booking reference |
| ${collections.wb} | AA-123456798 | Collections waybill number |
EXAMPLE - Multiple Collection Table
| Reference | Address | Date | Time |
| ${collections.ref} | ${collections.address1Line} | ${collections.date} | ${collections.time} |
Multiple Deliveries Table
The following tables shows the codes that can be used to produce a horizontal table of all the delivery movements on a consignment.
Your table must include the code ${deliveries.date} in the row.
The row containing the code ${deliveries.date} will be duplicated for each delivery movement attached to the consignment movement plan.
The first container haulage movement after an international sea freight movement is considered a delivery movement.
These codes can only be used in a table and not interdependently in a document.
Usage - Use these codes to insert the delivery information where there will be ONE OR MORE delivery movements attached to the consignment and you want to display them in a table
Code | Example | Description |
| ${deliveries.ref} | 123456798 | Reference for the collection movement |
| ${deliveries.date} | 01 JUL 2024 | Latest date for the collection |
| ${deliveries.time} | 09:30 | Latest time for the collection |
| ${deliveries.address} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | The origin address of the collection movement |
| ${deliveries.address1Line} | OCEAN HOUSE, MARSTON PARK, TAMWORTH, BIRMINGHAM, B78 3HU, GB | The origin address of the collection movement |
| ${deliveries.ins} | Delivery instructions on the movement | |
${deliveries.bkg} | AA-123456798 | Delivery booking reference |
${deliveries.wb} | AA-123456798 | Delivery waybill number |
EXAMPLE - Multiple Deliveries Table
| Reference | Address | Date | Time |
| ${deliveries.ref} | ${deliveries.address1Line} | ${deliveeries.date} | ${deliveries.time} |
Rates Table
The table below contains the codes that allow you to build a horizontal table of the rates that are attached to a consignment.
One of the columns in the table must include the code ${rate.lbl}
The row containing the ${rate.lbl} code will be replicated for each rate that is attached to the consignment.
For rates that are attached to a specific invoice, use the Invoice Rates Table
These codes can only be used in a table and not interdependently in a document.
| Code | Example | Description |
|---|---|---|
| ${rate.lbl} | BOOKING FEE | Rate name |
| ${rate.sku} | BOOK | Rate code |
| ${rate.q} | 12.253 | The quantity applied |
| ${rate.uc} | 10.00 | Cost per unit |
| ${rate.tax} | 2.00 | Tax payable |
| ${rate.taxPercent} | 20 | Percentage tax applied to the rate |
| ${rate.st} | 12.00 | Subtotal for the line item |
| ${rate.tc} | 12.00 | Total for the line item |
| ${rate.basedOn} | FIXED | How the ratable value is calculated |
| ${rate.cur} | EUR | Currency the rate is billed in |
| ${rate.baseCur} | GBP | Currency the rate is recorded in |
| ${rate.xr} | 0.97838 | This is the exchange rate from the entered currency to the billing cuurrency |
| ${rate.bst} | 1,000.00 | Subtotal of the line item in the original currency |
| ${rate.btc} | 1,000.00 | Total of the line item in the original currency |
| ${rate.buc} | 1,000.00 | Unit cost in the original currency |
| ${rate.basis} | Based on €100 x 1 Tax rate applied: 0% Converted: GBP 140.27 Exchange rate applied: 1.4027 GBP / 1 EUR | Information on how the ratable value was derived |
| ${rate.comment} | OVERAGE AGREED WITH CUSTOMER | The comment entered against the rate |
The following codes can be used to summarize the tax and revenue attached to a consignment when the rates table is used
| Code | Example | Description |
|---|---|---|
| ${j.tax} | 1,200.00 | Total tax payable on the consignment |
| ${j.stRevenue} | 2,500.00 | Total revenue payable on the consignment excluding tax |
| ${j.tRevenue} | 2,500.00 | Total revenue payable on the consignment |
EXAMPLE - Rates Table
| Code | Description | Subtotal |
| ${rate.sku} | ${rate.lbl} | ${rate.st} |
Subtotal | ${j.stRevenue} | |
Tax | ${j.tax} | |
| Total | ${j.tRevenue} |
Invoice Codes
These codes can be used on the following types of document template:
- Invoice
- Duty Invoice
- Credit Note
These codes will not work on documents generated for quotes or consignments
Code | Example | Description |
| ${i.ref} | INV-2024-12345678 | Invoice reference |
| ${i.raisedOn} | 05 JUL 2024 | Invoice date |
| ${i.dueOn} | 05 JUL 2024 | Date the invoice is payable by |
| ${i.dueOnBasis} | 30 days after invoice date | How the due date for the invoice was calculated |
| ${j.so.print} | COCOONFMS LICHFIELD DCH FROG LANE LICHFIELD WS13 6YY | Billing address for the invoice |
| ${j.so.print1} | COCOONFMS, LICHFIELD DCH, FROG LANE, LICHFIELD, WS13 6YY | Billing address for the invoice |
| ${i.cur} | GBP | Currency the invoice is billed in |
${i.curSymbol} | £ | Symbol or the invoice currency |
| ${i.subtotal} | 1,200.00 | Total payable on the invoice, not including tax |
| ${i.totalTax} | 1,200.00 | Total tax payable on the invoice |
| ${i.total} | 2,500.00 | Total payable on the invoice |
| ${i.bank.an} | 123456 | Account Number |
| ${i.bank.sc} | 99-99-99 | Sort Code / Routing Number |
| ${i.bank.bic} | HBUKGB4B | Branch Identification Code (BIC) |
| ${i.bank.iban} | GB29NWBK60161331926819 | IBAN Number |
| ${i.bank.name} | Natwest PLC | Bank Name |
| ${i.bank.addr} | 169 Victoria St, Pimlico, London SW1E 5NA, United Kingdom | Bank Address |
| ${i.bank.note} | Note for use with the account name |
Invoice Rates Table
The following codes are used to build a horizontal table of the rates that are attached to the invoice.
For the table to be built, one of the columns in the table must contain the code ${i.rates.lbl} or ${i.rates.stc}
Each row that contains the ${i.rates.lbl} or ${i.rates.src} will be duplicated for each rate that is attached to the invoice.
These codes can only be used in a table and not interdependently in a document.
These codes can only be used in templates for an invoice and will not work in documents generated for quotes or consignments.
Code | Example | Description |
| ${i.rates.lbl} | BOOKING FEE | Rate name |
| ${i.rates.sku} | BOOK | Rate code |
| ${i.rates.q} | 12.253 | The quantity applied |
| ${i.rates.uc} | 10.00 | Cost per unit |
| ${i.rates.taxPercent} | 20 | Percentage applied to the subtotal as tax |
| ${i.rates.tax} | 2.00 | Tax payable |
| ${i.rates.st} | 12.00 | Subtotal for the line item |
| ${i.rates.tc} | 12.00 | Total for the line item |
| ${i.rates.basedOn} | FIXED | How the rateable value is calculated |
| ${i.rates.cur} | EUR | Currency the rate is billed in |
| ${i.rates.baseCur} | GBP | Currency the rate is recorded in |
| ${i.rates.xr} | 1.2787 | This is the exchange rate from the entered currency to the billing currency |
| ${i.rates.bst} | 1,000.00 | Subtotal of the line item in the original currency |
| ${i.rates.btc} | 1,000.00 | Total of the line item in the original currency |
| ${i.rates.buc} | 1,000.00 | Unit cost in the original currency |
| ${i.rates.basis} | Based on €100 x 1 Tax rate applied: 0% Converted: GBP 140.27 Exchange rate applied: 1.4027 GBP / 1 EUR | Information on how the rateable value was derived |
| ${i.rates.comment} | OVERAGE AGREED WITH CUSTOMER | The comment entered against the rate |
| ${i.rates.customerRef} | AA-00001 | The customer reference attached to the consignment |
| $[i.rates.consignmentRef} | CON-99999 | The consignment reference the rate is linked to |
| ${i.rates.consignmentDate} | 01 JAN 2000 | The requested at date on the consignment instructions |
| ${i.rates.eqNums} | MAEU9269240, MAEU9269241 | List of container numbers attached to the containment the rate is attached to |
| ${i.rates.freightSum} | 1 X PALLET 2 X PALLET, EURO | List of the freight equipment |
${i.rates.origin.ref} | GNLIV | Abbreviated version of the consignment instructed origin location |
${i.rates.dest.ref} | LONDON, GB | Abbreviated version of the consignment instructed destination location |
${i.rates.load} | FCL | Load type from the consignment instructions |
${i.rates.carrier.name} | TRUCKING R US | The name of the carrier party from the consignment carrier tab |
EXAMPLE - Invoice Rates Table
| Code | Description | Subtotal |
| ${i.rates.sku} | ${i.rates.lbl} | ${i.rates.st} |
Subtotal | ${i.subtotal} | |
Tax | ${i.rates.tax} | |
| Total | ${i.rates.tc} |
Consolidated Summary Rates Table
The consolidated rates table is a horizontal table that summarises the total revenue for each consignment attached to an invoice.
Each line item in the invoice will be for a single consignment.
These codes are most useful for bulk invoicing templates.
One of the columns in the table must include the code ${i.consolRates.ref}
These codes can only be used in a table and not interdependently in a document.
| Code | Example | Description |
| ${i.consolRates.ref} | JOB-S1004-2025 | Consignment reference |
${i.consolRates.custRef} | AA99999999 | Customer reference attached to the consignment |
${i.consolRates.date} | 05 JUL 2024 | Consignment requested at (reporting) date |
${i.consolRates.st} | 999.00 | The subtotal of all rates for the consignment attached to the invoice |
${i.consolRates.tax} | 999.00 | Total tax for all rates for the consignment attached to the |
${i.consolRates.tc} | 999.00 | Total value, including tax for all the rates for the consignment that are attached to the invoice. |
EXAMPLE - consolidated rates table
| Our Ref | Your Ref | Subtotal |
| ${i.consolRates.ref} | ${i.consolRates.custRef} | ${i.consolRates.st} |
Subtotal | ${i.subtotal} | |
Tax | ${i.rates.tax} | |
| Total | ${i.rates.tc} |
Identity References
The following codes can be used with parties and the getIdentity('XXXX') method to fetch an identity from the address book for an organisation.
XXXX is replaced the code from the table below.
EXAMPLE: ${j.customer.getIdentity('vatGB')} will inset the customer’s GB VAT number.
| Code | Identity |
|---|---|
| avetta | Avetta account no. |
| biffa | BIFA membership No. |
| cb | Customs Badge |
| ecologi | Ecologi Account Number |
| eoriGB | EORI Number, GB |
| eoriEU | EORI Number, EU |
| gla | GLA membership No. |
| IATA | IATA Airline Code |
| ign | IGN membership No. |
| cn | Registered Company No. |
| SCAC | SCAC Operator No. |
| sequoiaID | Sequoia ID |
| vatGB | VAT Number, GB |
| vatEU | VAT Number, EU |
| vgm | VGM Badge No. |
| dutyDefGB | Customs Duty Deferment Account No., GB |
| website | Website |
Utility Codes
The following codes provide some functions that may be of use.
Code | Example | Description |
${util.date} | 01 JAN 2025 | The date at the time the document is generated |
${util.time} | 09:00 | The time when the document is created in UTC. |
Setting Codes
The following codes allow you to import elements from the settings screens
Code | Description |
${docLogo:40mm:40mm} | Import the image from the documents screen in the settings. The numbers are the size of the image in mm. |
${conf.docAddr} | Import the Your Address text from the documents screen in settings. |
${conf.docFooter} | Import the Document footer text from the documents screen in settings. |
Customer Instructions
Service selected
Parties
| Code | Example | Description |
|---|---|---|
| ${j.ref} | JOB-S1004-2025 | Reference |
| ${j.inco} | DAP | Incoterms |
| ${j.modeLbl} | SEA | Mode of transport |
| ${j.routeLbl} | EXPORT | Route |
| ${j.loadLbl} | FCL | Load Type |
| ${j.fRouteLbl} | DIRECT / INDIRECT | Freight Routing preference |
| ${j.portO} | GBLIV | UN Locode or IATA airport code for Port of Origin |
| ${j.portOLbl} | Liverpool, GB | Name of the Port of Origin |
| ${j.portT} | GBLIV | UN Locode or IATA airport code for 1st Transit Port |
| ${j.portTLbl} | Liverpool, GB | Name of the 1st Transit port |
| ${j.portT2} | GBLIV | UN Locode or IATA airport code for 2nd Transit Port |
| ${j.portT2Lbl} | Liverpool, GB | Name of the 2nd Transit port |
| ${j.portT3} | GBLIV | UN Locode or IATA airport code for 3rd Transit Port |
| ${j.port3Lbl} | Liverpool, GB | Name of the 3rd Transit port |
| ${j.portD} | GBLIV | UN Locode or IATA airport code for Final Destination Port |
| ${j.portDLbl} | Liverpool, GB | Name of the Final Destination Port |
| ${j.contract} | CON001A2 | Contract reference for the consignment |
| ${j.srvLbl} | Door to Door | |
Customer | ||
| ${j.customer.acc} | EASBY001 | Customer billing account code |
| ${j.customer.name} | EASY SUPPLIER LTD | Name of the customer |
| ${j.customer.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the customer |
| ${j.customer.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the customer |
| ${j.customer.contact.name} | JIM SMITH | Name of the contact at the customer |
| ${j.customer.contact.tel} | 01792132123 | Telephone number of the contact at the customer |
| ${j.customer.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the customer |
| ${j.customer.ref} | 2024AB454 | Customer reference |
| ${j.customer.po} | PO3214 | Customer PO Number |
| ${j.customer.getIdentity('XXX')} | Replace XXX with the identity reference. | |
Consignor | ||
| ${j.consignor.name} | EASY SUPPLIER LTD | Name of the Consignor |
| ${j.consignor.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the Consignor |
| ${j.consignor.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the Consignor |
| ${j.consignor.contact.name} | JIM SMITH | Name of the contact at the Consignor |
| ${j.consignor.contact.tel} | 01792132123 | Telephone number of the contact at the Consignor |
| ${j.consignor.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the Consignor |
| ${j.consignor.ref} | 2024AB454 | Consignor reference |
| ${j.consignor.po} | PO3214 | Consignor PO Number |
| ${j.consignor.getIdentity('XXX')} | Replace XXX with the identity reference. | |
Consignee | ||
| ${j.consignee.name} | EASY SUPPLIER LTD | Name of the Consignee |
| ${j.consignee.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the Consignee |
| ${j.consignee.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the Consignee |
| ${j.consignee.contact.name} | JIM SMITH | Name of the contact at the Consignee |
| ${j.consignee.contact.tel} | 01792132123 | Telephone number of the contact at the Consignee |
| ${j.consignee.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the Consignee |
| ${j.consignee.ref} | 2024AB454 | Consignee reference |
| ${j.consignee.po} | PO3214 | Consignee PO Number |
| ${j.consignee.getIdentity('XXX')} | Replace XXX with the identity reference. | |
Agent | ||
| ${j.agent.name} | EASY SUPPLIER LTD | Name of the Agent |
| ${j.agent.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the Agent |
| ${j.agent.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the Agent |
| ${j.agent.contact.name} | JIM SMITH | Name of the contact at the Agent |
| ${j.agent.contact.tel} | 01792132123 | Telephone number of the contact at the Agent |
| ${j.agent.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the Agent |
| ${j.agent.ref} | 2024AB454 | Agent reference |
| ${j.agent.po} | PO3214 | Agent PO Number |
| ${j.agent.getIdentity('XXX')} | Replace XXX with the identity reference. | |
Notify Party | ||
| ${j.notice.name} | EASY SUPPLIER LTD | Name of the notify party |
| ${j.notice.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the notify party |
| ${j.notice.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the notify party |
| ${j.notice.contact.name} | JIM SMITH | Name of the contact at the notify party |
| ${j.notice.contact.tel} | 01792132123 | Telephone number of the contact at the notify party |
| ${j.notice.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the notify party |
| ${j.notice.ref} | 2024AB454 | Notify party reference |
| ${j.notice.po} | PO3214 | Notify party PO Number |
Notify Party 2 | ||
| ${j.notice2.name} | EASY SUPPLIER LTD | Name of the 2nd notify party |
| ${j.notice2.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the 2nd notify party |
| ${j.notice2.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the 2nd notify party |
| ${j.notice2.contact.name} | JIM SMITH | Name of the contact at the 2nd notify party |
| ${j.notice2.contact.tel} | 01792132123 | Telephone number of the contact at the 2nd notify party |
| ${j.notice2.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the 2nd notify party |
| ${j.notice2.ref} | 2024AB454 | 2nd notify party reference |
| ${j.notice2.po} | PO3214 | 2nd notify party PO Number |
Instructed Collection (Specifically the collection party on quote/consignment instructions, does not use the consignor) | ||
| ${j.origin.name} | EASY SUPPLIER LTD | Name of the party the consignment is to be collected from |
| ${j.origin.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the collection |
| ${j.origin.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the collection |
| ${j.origin.contact.name} | JIM SMITH | Name of the contact at the collection location |
| ${j.origin.contact.tel} | 01792132123 | Telephone number of the contact at the collection location |
| ${j.origin.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the collection location |
| ${j.origin.ref} | 2024AB454 | Collection reference |
| ${j.origin.po} | PO3214 | Collection PO Number |
Instructed Delivery (Specifically the delivery party on the quote/consignment instructions, does not include the consignee) | ||
| ${j.dest.name} | EASY SUPPLIER LTD | Name of the party the consignment is to be delivered to |
| ${j.dest.address.print} | OCEAN HOUSE MARSTON PARK TAMWORTH BIRMINGHAM B78 3HU GB | Address of the delivery |
| ${j.dest.address.print1} | OFFICE 238, THE BUSINESS PARK, SUNDERLAND, SU1 5SL, GB | Address of the delivery |
| ${j.dest.contact.name} | JIM SMITH | Name of the contact at at the delivery location |
| ${j.dest.contact.tel} | 01792132123 | Telephone number of the contact at the delivery location |
| ${j.dest.contact.email} | JIM.SMITH@EASY-SUPPLIER.COM | Contact email address at the delivery location |
| ${j.dest.ref} | 2024AB454 | Delivery reference |
| ${j.dest.po} | PO3214 | Delivery PO Number |
Instructed DEMARCs for the consignment (Start and end points of your responsibility for a shipment) | ||
| ${j.demarcOrigin.name} | DEMO SUPPLIER | Instructed collection or consignor name for the consignment |
| ${j.demarcOrigin.address.print} | UNIT 4 ATLANTIC TRADING EST LONDON SE11 4LB GB | Instructed collection or consignor address for the consignment |
| ${j.demarcOrigin.address.print1} | UNIT 4, ATLANTIC TRADING EST, LONDON, SE11 4LB, GB | Instructed collection or consignor address for the consignment |
| ${j.demarcOrigin.ref} | 12S54235 | Instructed reference for the collection or consignor for the consignment |
| ${j.demarcOrigin.po} | 2025-4524BG | Instructed PO reference for the collection or consignor for the consignment |
| ${j.demarcDestination.name} | CUSTOMER A | Instructed delivery or consignee name for the consignment |
| ${j.demarcDestination.address.print} | UNIT 4 ATLANTIC TRADING EST LONDON SE11 4LB GB | Instructed delivery or consignee address for the consignment |
| ${j.demarcDestination.address.print1} | WAREHOUSE 23B, NORTHOLT INDUSTRIAL ESTATE, ESSEX, CB41, 1LD, GB | Instructed delivery or consignee address for the consignment |
| ${j.demarcDestination.ref} | 4521HJDHJY-JHJDHJ | Instructed delivery or consignee reference for the consignment |
| ${j.demarcDestination.po} | 2025-4524BG | Instructed PO reference for the delivery or consignee for the consignment |
| ${j.placeOfReceipt} | London, GB | Place of collection/receipt of freight |
| ${j.placeOfDelivery} | London Gateway, GB | Place of delivery/surrender of the freight |
Instructed Collection | ||
| ${j.gr} | 10 Jul 2024 09:30 | Goods ready date and time |
| ${j.colR} | 10 Jul 2024 09:30 | Collection required date and time |
| ${j.colI} | CHECK IN WITH GOODS INWARDS! | Collection instructions |
| Instructed Delivery | ||
| ${j.delR} | 10 Jul 2024 09:30 | Delivery required date and time |
| ${j.delI} | DELIVERY VEHICLE MUST HAVE TAIL LIFT | Delivery instructions |
Instructed Freight Summary Information | ||
| ${j.insSum} | 40" HIGH CUBE DRY CONTAINER x 1 | Instructed freight summary |
| ${j.insWgt} | 120.25 | Instructed Total Weight |
| ${j.insCbm} | 2.235 | Instructed Total Volume (M3) |
| ${j.insLdm} | 12.25 | Instructed loading metres |
| ${j.wgtU} | Kgs | Weight unit used for the consignment |
Waybill Information | ||
| ${j.wbType} | HOUSE WAYBILL | The type of waybill issued to the customer |
| ${j.wb} | BL-12312313223 | Waybill reference number |
| ${j.wbO} | 3 | Number of original bills to issue |
| ${j.wbC} | 3 | Number of bill copies to issue |
Related Articles
Documents Templates
he document settings allow you to configure the documents that are generated by the system. Firstly, configure the common components for all documents: Logo Your Address Common Footer If you are using the default document templates, the ideal size ...Proforma Invoice
Summary Proforma invoices are be issued in two ways: As advice of charges for a consignment As a prepaid invoice Advice of charges for a consignment This approach is to create a document template for consignments which can be generated. How to: Go to ...Default Settings
Set the home country for you organisation, this is used as the default country for pick lists. Here you can set the default units of measurement used in the system. You can also turn on audit logging here. Here you can configure how the references ...Documents Tab
Documents Document can both be attached to and generated for quotes. Attaching a document to a quote. Select the quote the document should be attached to Drag the document onto the page in your browser Select the document type in the dialog box that ...Address Book Documents
You can attach documents to an organization. You attach a document to an organization by selecting the organization the document should be attached to, then drag the document onto the page. You will then be presented with a dialog box to select the ...