Difference between revisions of "Receipts Configuration - Accounts Document"

From Catalyst
Jump to: navigation, search
(Updated from revision control)
 
(Updated from revision control)
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
−
The Platinum System allows the layout of Receipts to be configured to print the details you require. This is done using a system of "tokens" whichrepresent the items you wish to print, and their positions on the Invoice.
+
The Platinum System allows the layout of 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 Invoice.
  
 
*Where a System does not have its own unique receipt layout, the default is used.
 
*Where a System does not have its own unique receipt layout, the default is used.
 
*All Systems use a standard Credit Card Transaction Receipt.
 
*All Systems use a standard Credit Card Transaction Receipt.
 
== Layout Data File Names ==
 
== Layout Data File Names ==
−
The default layout files are stored in the {{FilePath|sxco1\docs}} folder, (or {{FilePath|sxco2}}, {{FilePath|sxco3}}, etc).
+
The layout files are stored in the {{FilePath|SXCo1\Docs}} folder, (or {{FilePath|SXCo2}}, {{FilePath|SXCo3}}, etc).
  
−
=== Invoice ===
+
=== Receipts ===
 
;{{FilePath|GR_PLA.REC}}
 
;{{FilePath|GR_PLA.REC}}
 
:Plain Paper Receipt
 
:Plain Paper Receipt
 
;{{FilePath|GR_PLA.CCR}}
 
;{{FilePath|GR_PLA.CCR}}
 
:Plain Paper Credit Card Receipt
 
:Plain Paper Credit Card Receipt
−
These are copied down into the main data directory when they are needed for the first time, and from that point the Receipt layout used is named {{FilePath|SXLD082.EPL}}, and the Credit Card Receipt layout {{FilePath|SXLD083.EPL}}.
+
== 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:
  
 +
;{{FilePath|SXLD082.EPL}}
 +
:Receipts
 +
;{{FilePath|SXLD083.EPL}}
 +
:Credit Card Receipts
 
== Layout Tokens ==
 
== Layout Tokens ==
−
Tokens are indicated by the character {{DataValue|~}} followed by a number (the token identifier).
+
Tokens are indicated by the character {{DataValue|<nowiki>~</nowiki>}} 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.
 
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 ===
 
=== Parameters ===
−
Some tokens may also be given parameters. Up to 3 parameters may be given to each token. These parameters are also numeric and in the range 1 to 999. 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.
+
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 ==
 
== Document Areas ==
 
For the purposes of configuration, the document layouts are divided into 3 main areas: {{DataPrompt|Headings}}, {{DataPrompt|Body}} & {{DataPrompt|Footings}}.
 
For the purposes of configuration, the document layouts are divided into 3 main areas: {{DataPrompt|Headings}}, {{DataPrompt|Body}} & {{DataPrompt|Footings}}.
  
−
To speed up access to the information on the layout file, some information is stored away on a separate file for quick reference. This information will need to be gathered when a particular layout is used for the first time. The short delay this entails can be minimised by placing the Configuration, Body, Totals & Tax blocks together at the top of the layout file, as can be seen in the Standard Layouts. This will apply even if no details are present in the block, as they are checked off during compilation.
+
=== Area Tokens ===
 +
{| cellspacing="5" width="95%" valign="baseline"
 +
!width="15%"|
 +
!|
 +
!|
  
 +
|- valign="baseline"
 +
| '''~100'''
 +
| '''Configuration Section Start'''
 +
|- valign="baseline"
 +
| '''~199'''
 +
| '''Configuration Section End'''
 +
|- valign="baseline"
 +
| '''~200'''
 +
| '''Heading Block (First Page) Start'''
 +
|- valign="baseline"
 +
| '''~299'''
 +
| '''Heading Block (First Page) End'''
 +
|- valign="baseline"
 +
| '''~300'''
 +
| '''Heading Block (Continuation) Start'''
 +
|- valign="baseline"
 +
| '''~399'''
 +
| '''Heading Block (Continuation) End'''
 +
|- valign="baseline"
 +
| '''~400'''
 +
| '''Footing Block (Continuation) Start'''
 +
|- valign="baseline"
 +
| '''~499'''
 +
| '''Footing Block (Continuation) End'''
 +
|- valign="baseline"
 +
| '''~500'''
 +
| '''Footing Block (Last Page) Start'''
 +
|- valign="baseline"
 +
| '''~599'''
 +
| '''Footing Block (Last Page) End'''
 +
|- valign="baseline"
 +
| '''~600'''
 +
| '''Body Block Start'''
 +
|- valign="baseline"
 +
| '''~699'''
 +
| '''Body Block End'''
 +
|- valign="baseline"
 +
| '''~700'''
 +
| '''Totals Configuration Block Start'''
 +
|- valign="baseline"
 +
| '''~799'''
 +
| '''Totals Configuration Block End'''
 +
|- valign="baseline"
 +
| '''~800'''
 +
| '''Tax Configuration Block Start'''
 +
|- valign="baseline"
 +
| '''~899'''
 +
| '''Tax Configuration Block End'''
 +
|}
 
== Tokens ==
 
== Tokens ==
 
=== General Tokens ===
 
=== General Tokens ===
Line 49: Line 107:
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~4''',n
 
| '''~4''',n
−
| '''Telephone Number'''
+
| '''Telephone Number/Email Address'''
 
;n = 0
 
;n = 0
 
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number.
 
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number.
 
;n = 1
 
;n = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number.
 
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number.
 +
;n = 2
 +
:<div style="float:right; margin-left:1em; font-style:italic;">(60 characters)</div>Email Address.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~5'''
 
| '''~5'''
Line 73: Line 133:
 
| '''User Date'''
 
| '''User Date'''
 
;n = 0
 
;n = 0
−
:<div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
+
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
 
;n = 1
 
;n = 1
−
:<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
+
:<div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~9''',n
 
| '''~9''',n
Line 87: Line 147:
 
| '''Document Date'''
 
| '''Document Date'''
 
;n = 0
 
;n = 0
−
:<div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
+
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
 
;n = 1
 
;n = 1
−
:<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
+
:<div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~11''',n
 
| '''~11''',n
Line 104: Line 164:
 
| <div style="float:right; margin-left:1em; font-style:italic;">(one line)</div>'''Heading Line'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(one line)</div>'''Heading Line'''
 
;n = 1 -> 2
 
;n = 1 -> 2
−
:For Standard Print.
+
:Heading text.
−
;n = 1 -> 6
 
−
:For Slip Printout.
 
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~14''',n
 
| '''~14''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(one line)</div>'''Footing Line'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(one line)</div>'''Footing Line'''
 
;n = 1 -> 3
 
;n = 1 -> 3
−
:For Standard Print.
+
:Footing text.
−
;n = 1 -> 2
 
−
:For Slip Printout.
 
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~15'''
 
| '''~15'''
Line 140: Line 196:
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~55'''
 
| '''~55'''
−
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Tax Word'''
+
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Prints the (Country Determined) word for Tax'''
−
e.g {{DataValue|V.A.T.}}
 
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~56'''
 
| '''~56'''
−
| '''Omit this line if all spaces'''
+
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Do not print this line if blank'''
 +
{{Note|text=
 +
As this token is used to control {{DataValue|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.
 +
}}
 +
 
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~61'''
 
| '''~61'''
Line 165: Line 224:
 
| '''~213''',n
 
| '''~213''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Account Analysis Code'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Account Analysis Code'''
−
;n = 1 -> 3
+
;n = 1 -> 9
 
:Analysis Code index.
 
:Analysis Code index.
 
|- valign="baseline"
 
|- valign="baseline"
−
| '''~213''',n
+
| '''~214''',n,m
−
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Account Analysis Description'''
+
| '''Account Analysis Description'''
−
;n = 1 -> 3
+
;n = 1 -> 9
 
:Analysis Description index.
 
:Analysis Description index.
 +
;m = 0
 +
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>First 15 characters of description.
 +
;m = >0
 +
:<div style="float:right; margin-left:1em; font-style:italic;">(Up to 30)</div>The full description.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~215''',n
 
| '''~215''',n
Line 213: Line 276:
  
 
==== Document Blocks ====
 
==== 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 inevitably slow downthe compilation process.
+
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.
  
 
{| cellspacing="5" width="95%" valign="baseline"
 
{| cellspacing="5" width="95%" valign="baseline"
Line 262: Line 325:
 
;n = 1
 
;n = 1
 
:Condensed.
 
:Condensed.
−
;n = 2
 
−
:Slip Printout Body Style.
 
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~112''',n
 
| '''~112''',n
Line 272: Line 333:
 
| '''~113''',n,m
 
| '''~113''',n,m
 
| '''Body Block'''
 
| '''Body Block'''
−
;n = 0
+
;n
−
:Body follows directly on from heads e.g. Slip Printout.
 
−
;n => 1
 
 
:The line to start printing.
 
:The line to start printing.
−
;m = 0
+
;m
−
:Unlimited number of items in body. e.g. Slip Printout.
 
−
;m => 1
 
 
:Depth (Number of lines to print).
 
:Depth (Number of lines to print).
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~114''',n
 
| '''~114''',n
 
| '''Footing Block'''
 
| '''Footing Block'''
−
;n = 0
+
;n
−
:If you have set Body Depth to {{DataValue|0}}, then Footings will appear immediately after the last item on the document. e.g. Slip Printout.
 
−
;n => 1
 
 
:The line to start printing.
 
:The line to start printing.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~115''',n
 
| '''~115''',n
 
| '''Form Length'''
 
| '''Form Length'''
−
;n = 0
+
;n
−
:Unlimited number of lines per page. e.g. Slip Printout.
 
−
;n => 1
 
 
:Number of Lines per Page.
 
:Number of Lines per Page.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~198'''
 
| '''~198'''
 
| '''Currency conversion configuration'''
 
| '''Currency conversion configuration'''
−
*See Currency Conversions at the end of this document for more details.
+
*See Currency Conversions at the end of this article for more details.
 
|}
 
|}
 
=== Body Block ===
 
=== Body Block ===
Line 342: Line 395:
 
;n = 1 -> 999
 
;n = 1 -> 999
 
:Corresponds to the print code ID in the "Print Code Amendments".
 
:Corresponds to the print code ID in the "Print Code Amendments".
−
|}
 
−
=== Area Tokens ===
 
−
{| cellspacing="5" width="95%" valign="baseline"
 
−
!width="15%"|
 
−
!|
 
−
!|
 
−
 
−
|- valign="baseline"
 
−
| '''~100'''
 
−
| '''Configuration Section Start'''
 
−
|- valign="baseline"
 
−
| '''~199'''
 
−
| '''Configuration Section End'''
 
−
|- valign="baseline"
 
−
| '''~200'''
 
−
| '''Heading Block (First Page) Start'''
 
−
|- valign="baseline"
 
−
| '''~299'''
 
−
| '''Heading Block (First Page) End'''
 
−
|- valign="baseline"
 
−
| '''~300'''
 
−
| '''Heading Block (Continuation) Start'''
 
−
|- valign="baseline"
 
−
| '''~399'''
 
−
| '''Heading Block (Continuation) End'''
 
−
|- valign="baseline"
 
−
| '''~400'''
 
−
| '''Footing Block (Continuation) Start'''
 
−
|- valign="baseline"
 
−
| '''~499'''
 
−
| '''Footing Block (Continuation) End'''
 
−
|- valign="baseline"
 
−
| '''~500'''
 
−
| '''Footing Block (Last Page) Start'''
 
−
|- valign="baseline"
 
−
| '''~599'''
 
−
| '''Footing Block (Last Page) End'''
 
−
|- valign="baseline"
 
−
| '''~600'''
 
−
| '''Body Block Start'''
 
−
|- valign="baseline"
 
−
| '''~699'''
 
−
| '''Body Block End'''
 
−
|- valign="baseline"
 
−
| '''~700'''
 
−
| '''Totals Configuration Block Start'''
 
−
|- valign="baseline"
 
−
| '''~799'''
 
−
| '''Totals Configuration Block End'''
 
−
|- valign="baseline"
 
−
| '''~800'''
 
−
| '''Tax Configuration Block Start'''
 
−
|- valign="baseline"
 
−
| '''~899'''
 
−
| '''Tax Configuration Block End'''
 
 
|}
 
|}
 
=== Currency Conversions ===
 
=== Currency Conversions ===
 
{{Information|text=
 
{{Information|text=
−
''Platinum'' "Elite" systems only. "Solo" systems will need to be upgraded to "Elite", contact the [http://www.catalyst-uk.com ''Catalyst''] sales team (0116) 230 1500 or your ''Platinum'' dealer for your upgrade path.
+
''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 [https://www.catalyst-uk.com/sales 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.
 
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.
  
−
The special symbols are currently {{DataValue|$}} and {{DataValue|#}} (hash symbol, but may have been misprinted as a pound sign). Both of these will cause a conversion to take place; the difference being {{DataValue|#}} will suppress the printing of a currency symbol. This can be useful when printers don't have relevant symbols for some currencies.
+
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.
 +
 
 +
{{Note|text=
 +
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 document being printed will be used, if there is one.
 
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 document being printed will be used, if there is one.
  
 
{{Example|text=
 
{{Example|text=
−
Some examples using {{DataValue|~29,1}} amount taxed at tax rate 1.
+
Some examples using {{DataValue|~29,1}} amount taxed at first tax rate. Note that {{DataValue|~29}} may not represent an amount in all document formats. This is just an example.
  
 
;~29,1
 
;~29,1
Line 423: Line 425:
 
;~29$USD,1
 
;~29$USD,1
 
:convert to currency USD (US Dollar)
 
:convert to currency USD (US Dollar)
−
:{{DataValue|$234.56}}
+
:{{DataValue|$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.
 +
:{{DataValue|$234.00}}
 
;~29#12USD,1
 
;~29#12USD,1
 
:same, but suppress the symbol and print to a width of 12
 
:same, but suppress the symbol and print to a width of 12
Line 441: Line 446:
 
| '''x = Default currency modifier (optional)'''
 
| '''x = Default currency modifier (optional)'''
 
|}
 
|}
−
==== Currency Tokens ====
+
==== Country/Currency Tokens ====
−
There is a group of tokens that may be used in headers and footers to print details about the currency set up for the account associated with the document.
+
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.
  
 
{| cellspacing="5" width="95%" valign="baseline"
 
{| cellspacing="5" width="95%" valign="baseline"
Line 449: Line 454:
 
!|
 
!|
  
 +
|- valign="baseline"
 +
| '''~292''',n
 +
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''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
 +
:<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Output the country description.
 
|- valign="baseline"
 
|- valign="baseline"
 
| '''~293'''
 
| '''~293'''
Line 468: Line 481:
 
| '''Skip block until next ~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
 
Should be used in pairs on a line. Everything between them is blanked out if there is no currency set for this account
−
|}[[Category:Accounts Documents]]
+
|}
 +
{{KB_Tags|Layout, Token, Format, Document, Setup, Config, Configuration, Currency, Receipts}}[[Category:Documents]][[Category:Accounts Documents]]

Latest revision as of 05:30, 28 October 2021

The Platinum System allows the layout of 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 Invoice.

  • Where a System does not have its own unique receipt layout, the default is used.
  • All Systems use a standard Credit Card Transaction Receipt.

Layout Data File Names

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

Receipts

'GR_PLA.REC'
Plain Paper Receipt
'GR_PLA.CCR'
Plain Paper Credit Card Receipt

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:

'SXLD082.EPL'
Receipts
'SXLD083.EPL'
Credit Card Receipts

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 document 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
(30 characters)
Account Name
~2,n
(30 characters)
Account Address Line
n = 1 -> 5
The line of the address.
~3
(6 characters)
Account Code
~4,n Telephone Number/Email Address
n = 0
(15 characters)
Telephone Number.
n = 1
(20 characters)
Mobile Number.
n = 2
(60 characters)
Email Address.
~5
(15 characters)
Fax Number
~6,n,m Account Notes Line
n = 1 -> 5
The line of the notes.
m = 0
(40 characters)
Print Notes information.
m = 1
(10 characters)
Print Notes prompt.
~7
(3 characters)
Page Number
~8,n User Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~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.
~14,n
(one line)
Footing Line
n = 1 -> 3
Footing text.
~15
(11 characters)
Heading Document Type
~16,n
(9 Characters + Length + Offset)
Freetype Prompt and Text
n = 1 -> 6
~25
(10 characters)
Total : Amount Paid
~33
(6 characters)
Account Group
~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'.
~54 Slip Print "Form Feed"
~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.
~61
(8 characters)
User/Group Name
~70,n ~70,n
As this token is used to control 'style' and doesn't actually output anything other than 5 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.
n = 0
Print Spaces until next '~70,0' if document total is Zero or greater.
n = 1
Print Spaces until next '~70,1' if document total is less then Zero. i.e. a credit or refund.
~211
(10 characters)
Account Reference
~213,n
(1 character)
Account Analysis Code
n = 1 -> 9
Analysis Code index.
~214,n,m Account Analysis Description
n = 1 -> 9
Analysis Description index.
m = 0
(15 characters)
First 15 characters of description.
m = >0
(Up to 30)
The full description.
~215,n
(60 characters)
Account Extra Notes
n = 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
(30 characters)
Account V.A.T. Registration Number

Configuration Tokens

These affect the overall layout of the Invoice, 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.
~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.
~198 Currency conversion configuration
  • See Currency Conversions at the end of this article for more details.

Body Block

Not Applicable. '~600' & '~699' should still be included for compilation however.

Totals Block

Not Applicable. '~700' & '~799' should still be included for compilation however.

Tax Block

Not Applicable. '~800' & '~899' should still be included for compilation however.

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 document being printed will be used, if there is one.

Some examples using '~29,1' amount taxed at first tax rate. 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, Currency, Receipts
Retrieved from "https://www.catalyst-uk-support.com/kb/index.php?title=Receipts_Configuration_-_Accounts_Document&oldid=43173"