Difference between revisions of "Statement Configuration - Accounts Document"
(Updated from revision control) |
(Updated from revision control) |
||
| Line 2: | Line 2: | ||
The Platinum System allows the layout of Customer Statements 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. | The Platinum System allows the layout of Customer Statements 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 == | == Layout Data File Names == | ||
| − | The | + | The layout files are stored in the {{FilePath|SXCo1\Docs}} folder, (or {{FilePath|SXCo2}}, {{FilePath|SXCo3}}, etc). |
=== Customer Statement === | === Customer Statement === | ||
Revision as of 10:42, 22 August 2019
The Platinum System allows the layout of Customer Statements 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).
Customer Statement
- 'SETSTAT'
- Statement to show Settlement Discount
- 'FAXSTAT'
- Statement pre-set up for Faxing
- 'WINSTAT'
- Statement pre-set up for Windows Printing, on Plain Paper
- 'PLASTAT'
- Plain Paper Statement
- 'PRESTAT'
- Statement for Paper with all column divisions etc pre-printed.
- 'OWNSTAT'
- "Own Brand" Paper Statement
- 'LETSTAT'
- Statement for Paper with a Pre-Printed Letterhead
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:
- 'SXLD041.EPL'
- Customer Statement (no settlement discount)
- 'SXLD042.EPL'
- Customer Statement (settlement discounts)
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 statement 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 |
Tokens
General Tokens
These can appear in either Headers or Footers.
| ~1 | (30 characters) Account Address Line 1
| ||
| ~2 | (30 characters) Account Address Line 2
| ||
| ~3 | (30 characters) Account Address Line 3
| ||
| ~4 | (30 characters) Account Address Line 4
| ||
| ~5 | (30 characters) Account Address Line 5
| ||
| ~6 | (30 characters) Company Name
| ||
| ~7,n | Telephone Number
| ||
| ~8 | (15 characters) Fax Number
| ||
| ~9 | (12 characters) Account Balance
| ||
| ~10 | (12 characters) Credit Limit
| ||
| ~11 | (5 characters) Discount Percentage
| ||
| ~12 | (3 characters) Settlement Period
| ||
| ~13 | (6 characters) Customer Code
| ||
| ~14 | (10 characters) Today's Date
| ||
| ~15 | (30 characters) Notes 1
| ||
| ~16 | (30 characters) Notes 2
| ||
| ~17 | (7 characters) Month Selected
| ||
| ~18 | (60 characters) Message Of the Day Line 1
| ||
| ~19 | (60 characters) Message Of the Day Line 2
| ||
| ~20 | (40 characters) Company Name 1
| ||
| ~21 | (40 characters) Company Name 2
| ||
| ~22 | (50 characters) Company Address Line 1
| ||
| ~23 | (50 characters) Company Address Line 2
| ||
| ~24 | (50 characters) Company Address Line 3
| ||
| ~25 | (50 characters) Company Address Line 4
| ||
| ~26 | (50 characters) Company Address Line 5
| ||
| ~27 | Heading Line 1
| ||
| ~27 | Heading Line 2
| ||
| ~27 | Heading Line 3
| ||
| ~27 | Heading Line 4
| ||
| ~27 | Heading Line 5
| ||
| ~32 | (10 characters) Account Reference
| ||
| ~33 | (6 characters) Account Group
| ||
| ~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 Configuration
| ~110,n | Document Type
| |
| ~111,n | Line Skip
| |
| ~112,n | Heading Block
| |
| ~113,n,m | Body Block
| |
| ~114,n | Footing Block
| |
| ~115,n | Form Length
| |
| ~198 | Currency conversion configuration
|
Body Block
General Information
'~6nn,1,2,3' where '~6nn' represents an item, described below, which you wish to be printed in the statement body.
All have up to three parameters :-
- Parm 1 - 'n'
- Column position, from 1 to 132. You may omit this parameter if you place the token in the column in which it is supposed to print.
- Parm 2 - 'm'
- When this parameter is set to 1 then this column will be totalled. (Only available on some columns).
- Parm 3 - 'l'
- When this parameter is set to 1 then this token in the case of a zero figure this will print '0.00' instead of spaces.
- A maximum of 20 tokens may be placed across the body line.
- If required a token may appear more than once per line.
| ~601,n | (8 characters) Document Number
| ||
| ~602,n | (10 characters) Document Type
| ||
| ~603,n | (10 characters) Document Date
| ||
| ~604,n | (10 characters) Settlement Discount Percentage
| ||
| ~605,n | (10 characters) Settlement Discount Amount
| ||
| ~606,n | (10 characters) Discounted Amount
| ||
| ~607,n | (15 characters) Document Comment
| ||
| ~608,n | (10 characters) Amount if Debit
| ||
| ~609,n | (10 characters) Amount if Credit
| ||
| ~610,n | (10 characters) Amount Signed
| ||
| ~611,n | (10 characters) Document Balance
| ||
| ~612,n | (10 characters) Discount Expiry Date
| ||
| ~613,n | (10 characters) Rolling Balance
| ||
| ~614,n | (3 characters) Invoice Age in Days
| ||
| ~615,n | (10 characters) Amount on Hold
| ||
| ~616,n | (10 characters) Document Balance - Held
| ||
| ~617 | (10 characters) Credit Charge Due Date
| ||
| ~618,n | (10 characters) Credit Charge that may be charged after the due date
| ||
| ~619,n | (10 characters) Credit Charge due at the time of printing
| ||
| ~620,n | (10 characters) Document Balance - Held + Credit Charge due at the time of printing
|
Totals Block
General Information
'~5nn,1,2,3' where '~5nn' represents an item, described below, which you wish to be printed in the statement totals.
All have up to three parameters :-
- Parm 1 - 'n'
- See individual token for explanation.
- Parm 2 - 'm'
- See individual token for explanation.
- Parm 3 - 'l'
- When this parameter is set to 1 then this token in the case of a zero figure this will print '0.00' instead of spaces.
| ~510 | (10 characters) Total Settlement Discount
| |
| ~511,n | Discounts
| |
| ~514 | (10 characters) Total Amount
| |
| ~517 | (10 characters) Period 1 Total
| |
| ~518 | (10 characters) Period 2 Total
| |
| ~519 | (10 characters) Period 3 Total
| |
| ~520 | (10 characters) Period 4 Total
| |
| ~521 | (10 characters) Description for period 1
| |
| ~522 | (10 characters) Description for period 2
| |
| ~523 | (10 characters) Description for period 3
| |
| ~524 | (10 characters) Description for period 4
| |
| ~525 | (10 characters) Unallocated Total
| |
| ~526 | (10 characters) On Hold Total
| |
| ~527 | (10 characters) Rolling Balance - Total Held
| |
| ~528 | (10 characters) Total of Credit Charges Due
| |
| ~529 | (10 characters) Rolling Balance - Total Held + Credit Charges Due
|
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 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 statement 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,n | 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 |
SL11
