Document Configuration - Unit Workshop Document

From Catalyst
Revision as of 09:51, 22 December 2020 by Dave Laundon (talk | contribs) (Undo revision 42422 by ThrashBot (talk))
Jump to: navigation, search

The Platinum System " Unit Workshop" allows the layout of your Invoices, Credits, Quotations and Payment Receipts to be configured to print the details you require. This is done using a system of "tokens" which represent the items you wish to print, and their positions on the document..

Layout Data File Names

The layout files are stored in the 'SXCo1\Docs' folder, (or 'SXCo2', 'SXCo3', etc).

Invoice

'WS_PLAWN.INV'
Plain Paper (Windows Version)
'WS_PLA.INV'
Plain Paper
'WS_LET.INV'
Letter Head

Credit Note

'WS_PLAWN.CRE'
Plain Paper (Windows Version)
'WS_PLA.CRE'
Plain Paper
'WS_LET.CRE'
Letter Head

Quotations

'WS_PLA.QUO'
Plain Paper
'WS_LET.CNF'
Letter Head

Receipts

'WS_PLA.REC'
Plain Paper

Token File Names

These are copied down into the main data directory when they are needed for the first time by Platinum, and from that point the layouts are as follows:

'SXWS017.EPL'
Invoice
'SXWS018.EPL'
Credit Note
'SXWS019.EPL'
Quotation
'SXWS020.EPL'
Payment Receipt
'SXWS023.EPL'
Invoice (Warranty)
'SXWS024.EPL'
Credit Note (Warranty)

Layout Tokens

Tokens are indicated by the character '~' followed by a number (the token identifier).

These identifiers may be up to 3 digits in length in the range 1 to 999. Tokens each have specific uses, which are listed below.

Parameters

Some tokens may also be given parameters. The number of parameters vary for each token. To specify a token with parameters the token must be followed by a comma then parameter. Each parameter is similarly divided from the next by a comma (no terminating comma is required).

Document Areas

For the purposes of configuration, the invoice/credit/quotation/receipts layouts are divided into 3 main areas: "Headings", "Body" & "Footings".

Area Tokens

~100 Configuration Section Start
~199 Configuration Section End
~200 Heading Block (First Page) Start
~299 Heading Block (First Page) End
~300 Heading Block (Continuation) Start
~399 Heading Block (Continuation) End
~400 Footing Block (Continuation) Start
~499 Footing Block (Continuation) End
~500 Footing Block (Last Page) Start
~599 Footing Block (Last Page) End
~600 Body Block Start
~699 Body Block End
~700 Totals Configuration Block Start
~799 Totals Configuration Block End
~800 Tax Configuration Block Start
~899 Tax Configuration Block End

Tokens

General Tokens

These can appear in either Headers or Footers.

~1,n
(30 characters)
Account Name
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
~2,n,m
(30 characters)
Account Address
n = 1 -> 5
The line of the address.
m = 0
Owner (Invoice Account)
m = 1
Insurer
m = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
m = 3
Keeper
~3,n
(30 characters)
Account Code
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
~4,n,m Telephone Number / Email Address
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
m = 0
(15 characters)
Telephone Number.
m = 1
(20 characters)
Mobile Number.
m = 2
(60 characters)
Email Address.
~5,n
(15 characters)
Fax Number
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
~6,n,m,l Account Notes Line
n = 1 -> 5
The line of the notes.
m = 0
Owner (Invoice Account)
m = 1
Insurer
m = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
m = 3
Keeper
l = 0
(40 characters)
Print Notes information.
l = 1
(10 characters)
Print Notes prompt.
~7
(3 characters)
Page Number
~9,n
(8 characters)
Document Number
n = 0
Print in all cases.
n = 1
Blank if not in Heading.
~10,n Document Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~11,n
(40 characters)
Company Name
n = 1 -> 2
The line of the name.
~12,n
(50 characters)
Company Address
n = 1 -> 5
The line of the address.
~13,n
(one line)
Heading Line
n = 1 -> 2
Heading text.
n = 1 -> 6
Heading text (receipts).
~14,n
(one line)
Footing Line
n = 1 -> 3
Footing text.
n = 1 -> 2
Footing text (receipts).
~15
(11 characters)
Heading Document Type
~16 Skip block until next ~16

Print Spaces if "Document" is intended for both the Owner and Insurer. i.e. They both have something to contribute to the total.

~17 Top Left hand corner of Totals Block

Use if totals are to be printed in self configuring block. See below.

~18 Top Left hand corner of Tax Details Block

Use if tax is to be printed in self configuring block. See below.

~19
(10 characters)
Total: Amount Before Tax or Blanket Discount
~22
(10 characters)
Total: Tax Amount
~23
(10 characters)
Total: Amount after Tax and Blanket Discounts
~25
(10 characters)
Total: Amount Paid
~117
(10 characters)
Total: Amount Paid (including change)
~118
(10 characters)
Change Given
~120,n,"x",m Payments Tendered Layout
n
The column number about which the text will be centered.
"x"
A line of descriptive text which may contain the following tokens (without padding spaces):
~121
(10 characters)
Amount Paid
~122
(6 characters)
Payment Code
~123
(30 characters)
Payment Description
m
The maximum number of payment methods to print (1-12). Defaults to 1.
You can limit the amount of space taken up by choosing to go into detail only if there are a limited number of payment methods used. If there are more than the specified number of payment methods used, instead of being listed individually they will be summarised as "Multiple Payment Methods".
~26
(10 characters)
Total: Amount Outstanding after Payment
~27,n
(5 characters)
Percentage Charged at Tax Rate
n = 1 -> 4
The Tax Rate.
~28,n
(10 characters)
Description for Tax Rate
n = 1 -> 4
The Tax Rate.
~29,n
(10 characters)
Amount Taxed at Tax Rate
n = 1 -> 4
The Tax Rate.
~30,n
(10 characters)
Amount of Tax Charged at Tax Rate
n = 1 -> 4
The Tax Rate.
~31,n
(10 characters)
Amount after Tax at Tax Rate
n = 1 -> 4
The Tax Rate.
~32,n
(25 characters)
Unit Image Path
n = 0
Default Image
n = 1 -> 999
Image Number
~33,n
(30 characters)
Account Name
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
~34
(10 characters)
System Parameters word for distance.

e.g. "Mileage" or "Kilometers"

~35
(10 characters)
Unit Key Number
~36
(8 characters)
Unit Engine Size
~37
(3 characters)
Unit Manufacturer Code
~38
(10 characters)
Unit Registration Date
~39,n,m Sale Unit Model
n = 0
(20 characters)
Model Code.
n = 1
Model Description.
m = 0
(30 characters)
First 30 Characters of Description (Legacy Layouts).
m = 1-4
(40 characters)
The Line of Model Description to print.
~40
(10 characters)
Unit MOT Expiry Date
~41
(30 characters)
Unit Manufacturer Name
~42,n Sale Unit Location
n = 0
(3 characters)
Location Code.
n = 1
(30 characters)
Location Description.
~43
(10 characters)
Unit Purchase Date
~44,n
(10 characters)
Unit Sales Date
n = 0
If the unit has been sold, prints the date the sales order was originated, if set, else prints the invoice date.
If the unit has not been sold, prints the date the latest sales order was originated, if set, else prints the date the last sales order was printed.
n = 1
If the unit has been sold, always prints the invoice date.
If the unit has not been sold, prints the date the latest sales order was originated, if set, else prints the date the last sales order was printed.
~45,n
(5 characters)
Current Time
n = 0
(5 characters)
24 Hour format. e.g. 'HH:MM'.
n = 1
(7 characters)
am/pm format. e.g. 'HH:MMpm'.
~46
(20 characters)
Job Reference
~47,n Unit Description
n = 0
(20 characters)
The first 20 characters of the first line of description (legacy layouts).
n = 1-4
(40 characters)
The indicated line of the unit description.
~48
(10 characters)
Unit Registration Number
~49
(30 characters)
Unit V.I.N. Number
~50
(30 characters)
Unit Engine Number
~51
(8 characters)
Job Number
~52,n
(8 characters)
Unit Distance
n = 0
Print spaces when zero.
n = 1
Print '0' when zero.
~53 Skip line unless Insurance Document
~54 Skip line unless Owner Document
~55
(6 characters)
Prints the (Country Determined) word for Tax
~56
(3 characters)
Do not print this line if blank
As this token is used to control 'style' and doesn't actually output anything other than 3 spaces to cover the size of token (i.e. '~##') it should be placed at the end of the format line, to avoid interfering with the flow of the text.
~57 Skip block until next ~57

Print Spaces if all Items have a date equal to the User Date (e.g. headings.).

~58 Skip block until next ~58

Print Spaces if no Items have an individual discount applied (e.g. headings.).

~59 Skip block until next ~59

Print Spaces if there is no insurance information on this document (owner only document).

~60 Skip block until next ~60

Print Spaces if there is no owner information on this document (insurance only document).

~61
(8 characters)
User/Group Name
~62
(15 characters)
Unit Colour
~63
(30 characters)
Unit Chassis Number
~64
(4 characters)
Unit Build Year
~65,n
(8 characters)
Job Due Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~65,n
(8 characters)
Job Received Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~65,n
(8 characters)
Job Start Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~68,n,m
(50 characters)
Job Brief Description
n = 1
Notes index
m = 0
Prints from the right side of the document, disregarding where it is placed.
m = 1
Prints at the position on the print line where the token is placed.
~69,n,m
(65 characters)
Job Detailed / General Notes
Heading section only! Will print in this column until no more lines are left to print or until the Footings Start line. Then Footings will print, followed by the Continuation Headings, and the remainder of the notes will commence once the Continuation token is encountered.
n = 0
Start notes
n = 1
Continue notes
m = 0
Print Job Details (from the "Description" tab), according to which are configured to print on the Invoice or Quotation.
m = 1
Print Job General Notes (from the "Notes" tab).
m = 2
Print Job Details, followed by Job General Notes.
~70,n
(25 characters)
Output Control
n = 0
(Receipts) - Skip block until next '~70,0' if document total is zero or greater.
n = 1
(Receipts) - Skip block until next '~70,1' if document total is less than zero.
n = 1
(Invoice/Credit) - Skip this line if there are no brief Notes on the job.
n = 2
(Invoice/Credit) - Skip this line if there are no detailed Notes on the job.
n = 3
(Invoice/Credit) - Skip this line if there brief notes are blank and job detailed notes are disabled for the current document type.
~71
(25 characters)
Job Status
~72
(25 characters)
Job Status Description
~73
(25 characters)
Insurance or Warranty Claim Number
~74
(25 characters)
Insurance Policy Type
~75
(25 characters)
Insurance Excess
~76
(25 characters)
Insurance Broker
~77,n
(25 characters)
Insurance Notes Line
n = 1 -> 3
The line of the notes.
~78
(25 characters)
Insurance Policy/Warranty Contract Number
~201,n
(10 characters)
Owner Nett
n = 0
Total Owner Nett
n = 1 -> 4
Nett for that Tax Band
~202,n
(10 characters)
Owner V.A.T.
n = 0
Total Owner V.A.T.
n = 1 -> 4
V.A.T. for that Tax Band
~202,n
(10 characters)
Owner Gross
n = 0
Total Owner Gross
n = 1 -> 4
Gross for that Tax Band
~204
(10 characters)
Owner Payments
~205
(10 characters)
Owner Outstanding

Gross - Payments = Outstanding.

~206,n
(10 characters)
Insurer Nett
n = 0
Total Insurer Nett
n = 1 -> 4
Nett for that Tax Band
~207,n
(10 characters)
Insurer V.A.T.
n = 0
Total Insurer V.A.T.
n = 1 -> 4
V.A.T. for that Tax Band
~208,n
(10 characters)
Insurer Gross
n = 0
Total Insurer Gross
n = 1 -> 4
Gross for that Tax Band
~209
(10 characters)
Insurer Payments
~210
(10 characters)
Insurer Outstanding

Gross - Payments = Outstanding.

~211,n
(10 characters)
Account Reference
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
~212
(8 characters)
Unit Stock Number
~213,n,m
(1 character)
Account Analysis Code
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
m = 1 -> 9
Analysis Code index.
~214,n,m,l Account Analysis Description
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
m = 1 -> 9
Analysis Description index.
l = 0
(15 characters)
First 15 characters of description.
l = >0
(Up to 30)
The full description.
~215,n,m
(60 characters)
Account Extra Notes
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
m = 1 -> 999
Account Extra Note line index.
~216 Skip block until next ~216

Print Spaces if a Credit Card Transaction is not involved.

~217
(30 characters)
Credit Card Holder Name
~218
(20 characters)
Credit Card Number
~219
(5 characters)
Credit Card Expiry Date, as MM/YY
~220
(10 characters)
Credit Card Authorisation Code
~221
(2 characters)
Credit Card Issue Number
~222
(5 characters)
Credit Card Valid From Date, as MM/YY
~223
(15 characters)
System Merchant Number
~224
(15 characters)
Transaction Comment
~234,n
(30 characters)
Account V.A.T. Registration Number
n = 0
Owner (Invoice Account)
n = 1
Insurer
n = 2
Owner/Insurer. Owner if Owner document, Insurer if Insurer document
n = 3
Keeper
~235,n
(6 characters)
Job Depot Code
n = 0
Code
n = 1
Description
~236 Skip block until next ~236

Print Spaces if there is no "betterment" information on this document.

~237
(15 characters)
Buying Group Reference
~401
(80 characters)
Top Left hand corner of Credit Charge Text Block

The Credit Charge Text Block is defined in " Reports & Settings Maintenance Options System Administrator Credit Charge Settings" and configures itself according to the details of the current document.

~402
(10 characters)
Total: Amount of any Credit Charge Applicable to the Current Document.
~403
(10 characters)
Total: Gross total for the current document, plus any applicable Credit Charge.

Configuration Tokens

These affect the overall layout of the invoice/credit/quotation/receipts , and should be grouped together at the head of the layout file.

Document Blocks

The block information can either be supplied by you, in which case you should leave the parameters blank to begin with, and fill the values in when you are happy with the rest of the file; or the compiler can track the values down itself, which will marginally slow down the compilation process.

~101,n,m 1st Page Heading Block
n
Start Line (i.e. Line for '~200').
m
End Line (i.e. Line for '~299').
~102,n,m Continuation Page Heading Block
n
Start Line (i.e. Line for '~300').
m
End Line (i.e. Line for '~399').
~103,n,m Continued Page Footing Block
n
Start Line (i.e. Line for '~400').
m
End Line (i.e. Line for '~499').
~104,n,m Final Page Footing Block
n
Start Line (i.e. Line for '~500').
m
End Line (i.e. Line for '~599').

Document Configuration

~109,n Normal and Slip Body Style
n = 0
Standard.
n = 1
Condensed.
~111,n Line Skip
n = 0
No Line Skip.
n = 1
Line Skip between Items.
~112,n Heading Block
n => 1
The line to start printing.
~113,n,m Body Block
n
The line to start printing.
m
Depth (Number of lines to print).
~114,n Footing Block
n
The line to start printing.
~115,n Form Length
n
Number of Lines per Page.
~119 Stops "V.A.T. Inclusive" Invoices printing Tax & Grand Total.

This is for items in the '~700' -> '~799' Totals Block, as these can look confusing.

~124 Print a Customer Statement

Automatically prints a customer statement to follow the invoice.

No statement will be printed if the customer's account balance is zero following this invoice and any payments made along with it.

This depends on having the " Sales Ledger" module issued.
~198 Currency conversion configuration
  • See Currency Conversions at the end of this article for more details.

Body Block

General Information

'~6nn,1,2,3,"4",5' where '~6nn' represents an item, described below, which you wish to be printed in the invoice/credit/quotation/receipts body.

All have up to five parameters :-

Parm 1 - 'n'
Column Position across from the left of the page.
Parm 2 - 'm'
Unused. (Used by other Systems, but should be set to '0' here if a third parameter is used).
Parm 3 - 'l'
Varies by Token. If not used, and parms 4 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,,"4",5.
Generally, for numeric tokens, which print by default to two decimal places.
  • '0' - Quantity : Trailing Zeroes are Stripped off. Currency : Zero figures are not printed.
  • '1' - Quantity : Trailing Zeroes are NOT Stripped. Currency : Zero figures are printed.
  • '2' - As '0', but allow 3 decimal places.
  • '3' - As '1', but allow 3 decimal places.
Parm 4 - 'x'
Optional. Varies by token. If used should be contained in quotes. If not used and parm 5 or above required, should be skipped in the same way as parm 3. i.e. ~6nn,1,2,3,,5

Body Tokens

~601,n
(10 characters)
Item Quantity
~602,n,m,l Nett Amount
~603,n,m,l
(10 characters)
Unit Price
~604,n
(10 characters)
Tax Amount
~605,n
(10 characters)
Amount after Tax
~606,n,m,l
(1 character)
Tax Band
l = 0
Prints A - D.
l = 1
Prints 1 - 4.
~607,n,m,l Item Date
l = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
l = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~608
(15 characters)
Stock Code
~609,n,m,l
(30 characters)
Stock Description
l = 0
Prints all required lines.
l = 1 -> 3
The line of the description.
~610,n
(20 characters)
Remarks
~611,n
(10 characters)
Units
~612,n
(6 characters)
Percentage Discount
~613,n
(10 characters)
Betterment Amount
~614,n
(3 characters)
Stock Group
~615,n
(10 characters)
Weight
~616,n
(10 characters)
Volume
~617,n,m,l
(1 character)
Stock Analysis Code
l = 1 -> 3
Analysis code position.
~618,n
(10 characters)
Price List Over-ride
~619,n,m,l
(15 characters)
Short Description
l = 0
Always print the description.
l = 1
If this is blank, Print the "Stock Code", and if that is blank (freetype stock) print the first line of the stock description.
~620,n
(6 characters)
Depot Code
~621,n
(10 characters)
Quantity in Stock
~622,n
(10 characters)
Quantity on Back Order
Requires " Order Processing".
~624,n
(20 characters)
Location
~625,n,m,l,"x"
(10 characters)
Sales Price
"x" = blank
Sales Price Code. If left blank will give Standard Sales Price.
~626,n,m,l
(5 characters)
Percentage Tax Charged
l = 0
Prints in all cases.
l = 1
Does not print if set to not print on Slip Printouts.
~627,n
(10 characters)
System Tax band description
~630,n,m,l
(15 characters)
Stock Analysis Description
l = 1 -> 3
Analysis Description index.
~635,n
(3 characters)
Item Price Group
~636,n
(30 characters)
Item Price Group Description
~637,n
(3 characters)
Item Category
~638,n
(30 characters)
Item Category Description
~639,n,m,l
(60 characters)
Description/Detailed Notes

Prints usual Stock Description for up to three lines, then all Detailed Notes.

l = 0
Stock Code Notes.
l = 1
Order Item Notes.
~642,n
(30 characters)
Stock Group Description
~643,n,m,l
(10 characters)
Stock Barcode Number
l = 0
Stock Code Notes only.
l = 1 -> 10
Number of digits to print.

Totals Block

General Information

'~7nn,1,2,"x",4,5' where '~7nn' = token number.

All have up to five parameters :-

Parm 1 - 'o'
Line from Top of Block to print on.
Parm 2 - 'n'
Column from Left of Block to print.
Parm 3 - 'x'
Up to 15 Character Description.
Parm 4 - 'm'
  • '0' - Description precedes Figures (default).
  • '1' - Description follows on from totals.
Parm 5 - 'l'
'0, 1 or 2' - Printing conditions.
In general, if items are configured to print one line after another, and "blanket discount" does not apply, then if Parm 5 for blanket discount amount is set to '0' then Blanket discount details will not be printed at all and the next line will shuffle up. If Parm 5 is set to '1' and no blanket discount applies then zeroes will be printed, and if it is set to 2 then a blank line will be printed.

Totals Tokens

Some tokens below are suppressed on Tax Inclusive documents if '~119' is included in the Configuration section.

~701,n,m,l
(25 characters)
Total Amount Before Tax or Blanket Discounts
~704,n,m,l
(25 characters)
Total Tax Amount

Superseded on Tax Inclusive documents (see above).

~705,n,m,l
(25 characters)
Total Amount after Tax and Blanket Discount
~706,n,m,l
(25 characters)
Total Amount Paid
~707,n,m,l
(25 characters)
Total Amount Outstanding after Payment
~708,n,m
(25 characters)
"Equals" Lines

A line of '=' signs where the figures would go in the other cases.

~709,n,m,l,k,j
(25 characters)
Amount Charged at Tax Rate 1

If '99.99' is included in the description it will be substituted with the percentage Tax applied.

Superseded on Tax Inclusive documents (see above).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print blank if no Tax incurred.
~710,n,m,l,k,j
(25 characters)
Amount Charged at Tax Rate 2

If '99.99' is included in the description it will be substituted with the percentage Tax applied.

Superseded on Tax Inclusive documents (see above).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print blank if no Tax incurred.
~711,n,m,l,k,j
(25 characters)
Amount Charged at Tax Rate 3

If '99.99' is included in the description it will be substituted with the percentage Tax applied.

Superseded on Tax Inclusive documents (see above).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print Blank if no Tax incurred.
~712,n,m,l,k,j
(25 characters)
Amount Charged at Tax Rate 4

If '99.99' is included in the description it will be substituted with the percentage Tax applied.

Superseded on Tax Inclusive documents (see above).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print blank if no Tax incurred.
~713,n,m,"x",l,k
(25 characters)
Tendered Amounts Breakdown

Prints a line for each sales centre with a payment posted to it.

"x"
When left blank, and the centre description will be printed trimmed to the first 13 characters.
k = 0
Do not print when no Tax incurred at this rate.
k = 1
Print even if no Tax incurred.
k = 2
Print blank if no Tax incurred.
~715,n,m,l
(25 characters)
Total Amount Before Tax or Blanket Discounts

An alternative for '~701' for Tax Inclusive documents.

While both should be supplied, only one will print. This is intended to enable an alternative description. See also '~119' in the Configuration Tokens section.

~717,n,m,l
(25 characters)
Total Amount Paid
~718,n,m,l
(25 characters)
Change Given
~720,n,m,l
(25 characters)
Credit Charge applicable to the current Document, if the Credit Charge is calculated on the Nett.
~721,n,m,l
(25 characters)
Credit Charge applicable to the current Document, if the Credit Charge is calculated on the Gross.
~722,n,m,l
(25 characters)
Gross total for the current Document plus any applicable Credit Charge.

Tax Block

General Information

~801,n,m Details for 1st Tax Band
n
Line from Block Top.
m
Column from Block Left.
~801,n,m Details for 2nd Tax Band
n
Line from Block Top.
m
Column from Block Left.
~801,n,m Details for 3rd Tax Band
n
Line from Block Top.
m
Column from Block Left.
~801,n,m Details for 4th Tax Band
n
Line from Block Top.
m
Column from Block Left.
~805,"x"
(up to 160 characters)
Layout String
"x"
Up to 160 characters in length, defines how the text for each of the Four Tax bands will appear. Into this will be inserted variables appropriate to each Tax Band, with their positions in the string given by the parameter.

Tax Tokens

~806,n,m
(1 character)
Tax Band Indicator
n = 1 -> 4
Tax Index
m = 0
'A' to 'D'.
m = 1
'1' to '4'.
~807,n
(5 characters)
Tax Percentage
n = 1 -> 4
Tax Index
~808,n
(10 characters)
Tax Band description
n = 1 -> 4
Tax Index
~809,n
(10 characters)
Amount Rated in this Tax Band
n = 1 -> 4
Tax Index
~810,n
(10 characters)
Amount of Tax Charged on the Amount Rated
n = 1 -> 4
Tax Index
~811,n
(10 characters)
Total Amount After Tax in this Band
n = 1 -> 4
Tax Index

Print Style Tokens

The following print style codes must have 3 spaces after them as these codes always 6 characters wide.

~79
(6 characters)
Expand
~80
(6 characters)
Unexpand
~81
(6 characters)
Compact
~82
(6 characters)
Uncompact
~83
(6 characters)
Double Strike On
~84
(6 characters)
Double Strike Off
~86
(6 characters)
Paper Forward
~87
(6 characters)
Paper Backward
~88,n
(up to 32 characters)
Insert print style

This print style code doesn't need any spaces after it as it will the width of the print code to insert.

n = 1 -> 999
Corresponds to the print code ID in the "Print Code Amendments".

Currency Conversions

Platinum "Elite" systems only. "Solo" systems will need to be upgraded to "Elite", contact your Platinum dealer or our sales team on (0116) 230 1500 or by using our website sales contact page for your upgrade path.

All tokens that return a currency amount may now be modified to convert that amount into a different currency before printing. This is done by using a currency modifier after the token number but before any parameters. This modifier begins with a special symbol and may optionally be followed by a number and/or a three character currency code.

To get the relevant currency symbol to print on a document, the symbols '$' and '#' (hash symbol, but may have been misprinted as a pound sign) are used immediately after the token that you wish the currency conversion to take place. Using the '#' will suppress the printing of the currency symbol. This can be useful when printers don't have relevant symbols for some currencies.

Unless the relevant currency required is set up against the base rate in Currency Maintenance, no conversion will take place. Also, the customer needs to be correctly flagged for the appropriate Country.

The number part of the modifier may be used to specify the maximum number of characters to print. Some currencies may involve quite large amounts and this number can be used to make sure there is enough room to print them. The three character currency code specifies which currency to convert the amount to. This may be omitted, in which case the currency specified for the account associated with the invoice/credit/quotation/receipts being printed will be used, if there is one.

Some examples using '~29,1' amount taxed at tax rate 1. Note that '~29' may not represent an amount in all document formats. This is just an example.
~29,1
no conversion
'*100.00' - (where * is your usual currency symbol).
~29$,1
convert to the account currency (if there is one)
'1005.18F' - (e.g. French Francs.)
~29$12,1
convert to account currency and print to a width of 12
'1005.18F'
~29$USD,1
convert to currency USD (US Dollar)
'$234.02'
~29$USD(02),1
convert to currency USD (US Dollar) and target to whole dollar units if within 2 cents. This feature is useful if you want to display values with the cents/pennies rounded away. For example if displaying in dollars then the number in brackets represents the maximum number of cents over or under a dollar within which the conversion will target to a whole dollar. For 02 within the brackets then $1.98, $1.99, $2.00, $2.01, $2.02 will all display as $2.00.
'$234.00'
~29#12USD,1
same, but suppress the symbol and print to a width of 12
'234.56'

Currency Configuration

There is an optional Currency Conversion configuration token which when used should be placed in the Configuration block. This token may have a currency modifier applied to it which will then be used by default throughout the document, although it can be overridden by modifiers applied to individual tokens.

~198x x = Default currency modifier (optional)

Country/Currency Tokens

There is a group of tokens that may be used in headers and footers to print details about the country and currency set up for the account associated with the document.

~292,n
(3 characters)
Country code/description for the document.

If the account in use has a specific country associated with it this will be used, otherwise the system default country will be output.

n = 0
Output the country code.
n = 1
(30 characters)
Output the country description.
~293
(12 characters)
Exchange rate from base currency to account currency
~294
(15 characters)
Sub-units of the currency set for this account
~295
(15 characters)
Units of the currency set for this account
~296
(30 characters)
Name of the currency set for this account
~297
(3 characters)
Code of the currency set for this account
~298 Skip block until next ~298

Should be used in pairs on a line. Everything between them is blanked out if there is no currency set for this account


Feedback
Thank you for using our Knowledge Base, we value your feedback. Did you find this article useful? 'Yes' or 'No'
Keywords AND Misspellings
Layout, Token, Format, Document, Setup, Config, Configuration, Invoice, Credit, Currency, Receipt, Estimate, Quotation