Difference between revisions of "Receipts Configuration - Accounts Document"
(Updated from revision control) |
(Updated from revision control) |
||
Line 107: | 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''' |
Revision as of 05:31, 30 June 2016
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 default 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
| ||
~3 | (6 characters) Account Code
| ||
~4,n | Telephone Number/Email Address
| ||
~5 | (15 characters) Fax Number
| ||
~6,n,m | Account Notes Line
| ||
~7 | (3 characters) Page Number
| ||
~8,n | User Date
| ||
~9,n | (8 characters) Document Number
| ||
~10,n | Document Date
| ||
~11,n | (40 characters) Company Name
| ||
~12,n | (50 characters) Company Address
| ||
~13,n | (one line) Heading Line
| ||
~14,n | (one line) Footing Line
| ||
~15 | (11 characters) Heading Document Type
| ||
~16,n | (9 Characters + Length + Offset) Freetype Prompt and Text
| ||
~25 | (10 characters) Total : Amount Paid
| ||
~33 | (6 characters) Account Group
| ||
~45,n | (5 characters) Current Time
| ||
~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
| ||
~61 | (8 characters) User/Group Name
| ||
~70,n | ~70,n
| ||
~211 | (10 characters) Account Reference
| ||
~213,n | (1 character) Account Analysis Code
| ||
~214,n | (15 characters) Account Analysis Description
| ||
~215,n | (60 characters) Account Extra Notes
| ||
~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
| |
~102,n,m | Continuation Page Heading Block
| |
~103,n,m | Continued Page Footing Block
| |
~104,n,m | Final Page Footing Block
|
Document Configuration
~109,n | Normal and Slip Body Style
| |
~112,n | Heading Block
| |
~113,n,m | Body Block
| |
~114,n | Footing Block
| |
~115,n | Form Length
| |
~198 | Currency conversion configuration
|
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.
|
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 [[1]] 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 tax rate 1.
|
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 |