Receipts Configuration - Accounts Document

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.

• 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 default layout files are stored in the 'sxco1\docs' folder, (or 'sxco2', 'sxco3', etc).

Invoice

'GR_PLA.REC'

Plain Paper Receipt

'GR_PLA.CCR'

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 'SXLD082.EPL', and the Credit Card Receipt layout 'SXLD083.EPL'.

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".

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.

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 n = 0 (15 characters) Telephone Number. n = 1 (20 characters) Mobile Number.
~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 (8 characters) Short format. e.g. 'DD/MM/CCYY'. n = 1 (30 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 (8 characters) Short format. e.g. 'DD/MM/CCYY'. n = 1 (30 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 For Standard Print. n = 1 -> 6 For Slip Printout.
~14,n	(one line) Footing Line n = 1 -> 3 For Standard Print. n = 1 -> 2 For Slip Printout.
~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) Tax Word e.g 'V.A.T.'
~56	Omit this line if all spaces
~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 -> 3 Analysis Code index.
~213,n	(15 characters) Account Analysis Description n = 1 -> 3 Analysis Description index.
~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 inevitably slow downthe 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. n = 2 Slip Printout Body Style.
~112,n	Heading Block n => 1 The line to start printing.
~113,n,m	Body Block n = 0 Body follows directly on from heads e.g. Slip Printout. n => 1 The line to start printing. m = 0 Unlimited number of items in body. e.g. Slip Printout. m => 1 Depth (Number of lines to print).
~114,n	Footing Block n = 0 If you have set Body Depth to '0', then Footings will appear immediately after the last item on the document. e.g. Slip Printout. n => 1 The line to start printing.
~115,n	Form Length n = 0 Unlimited number of lines per page. e.g. Slip Printout. n => 1 Number of Lines per Page.
~198	Currency conversion configuration See Currency Conversions at the end of this document 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".

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

Currency Conversions

Platinum "Elite" systems only. "Solo" systems will need to be upgraded to "Elite", contact the Catalyst sales team (0116) 230 1500 or your Platinum dealer 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.

The special symbols are currently '$' and '#' (hash symbol, but may have been misprinted as a pound sign). Both of these will cause a conversion to take place; the difference being '#' will suppress the printing of a currency symbol. This can be useful when printers don't have relevant symbols for some currencies.

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 tax rate 1. ~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.56' ~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)

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.

~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