View source for Statement Configuration - Accounts 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 ==
The layout files are stored in the {{FilePath|SXCo1\Docs}} folder, (or {{FilePath|SXCo2}}, {{FilePath|SXCo3}}, etc).

=== Customer Statement ===
;{{FilePath|SETSTAT}}
:Statement to show Settlement Discount
;{{FilePath|FAXSTAT}}
:Statement pre-set up for Faxing
;{{FilePath|WINSTAT}}
:Statement pre-set up for Windows Printing, on Plain Paper
;{{FilePath|PLASTAT}}
:Plain Paper Statement
;{{FilePath|PRESTAT}}
:Statement for Paper with all column divisions etc pre-printed.
;{{FilePath|OWNSTAT}}
:"Own Brand" Paper Statement
;{{FilePath|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:

;{{FilePath|SXLD041.EPL}}
:Customer Statement (no settlement discount)
;{{FilePath|SXLD042.EPL}}
:Customer Statement (settlement discounts)
== Layout Tokens ==
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.

=== 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: {{DataPrompt|Headings}}, {{DataPrompt|Body}} & {{DataPrompt|Footings}}.

=== 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'''
|}
== Tokens ==
=== General Tokens ===
These can appear in either Headers or Footers.

{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~1'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 1'''
|- valign="baseline"
| '''~2'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 2'''
|- valign="baseline"
| '''~3'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 3'''
|- valign="baseline"
| '''~4'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 4'''
|- valign="baseline"
| '''~5'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 5'''
|- valign="baseline"
| '''~6'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Company Name'''
|- valign="baseline"
| '''~7''',n
| '''Telephone Number'''
;n = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number.
;n = 1
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number.
|- valign="baseline"
| '''~8'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Fax Number'''
|- valign="baseline"
| '''~9'''
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Account Balance'''
|- valign="baseline"
| '''~10'''
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Credit Limit'''
|- valign="baseline"
| '''~11'''
| <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Discount Percentage'''
|- valign="baseline"
| '''~12'''
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Settlement Period'''
|- valign="baseline"
| '''~13'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Customer Code'''
|- valign="baseline"
| '''~14'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Today's Date'''
|- valign="baseline"
| '''~15'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Notes 1'''
|- valign="baseline"
| '''~16'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Notes 2'''
|- valign="baseline"
| '''~17'''
| <div style="float:right; margin-left:1em; font-style:italic;">(7 characters)</div>'''Month Selected'''
|- valign="baseline"
| '''~18'''
| <div style="float:right; margin-left:1em; font-style:italic;">(60 characters)</div>'''Message Of the Day Line 1'''
|- valign="baseline"
| '''~19'''
| <div style="float:right; margin-left:1em; font-style:italic;">(60 characters)</div>'''Message Of the Day Line 2'''
|- valign="baseline"
| '''~20'''
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Company Name 1'''
|- valign="baseline"
| '''~21'''
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Company Name 2'''
|- valign="baseline"
| '''~22'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Company Address Line 1'''
|- valign="baseline"
| '''~23'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Company Address Line 2'''
|- valign="baseline"
| '''~24'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Company Address Line 3'''
|- valign="baseline"
| '''~25'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Company Address Line 4'''
|- valign="baseline"
| '''~26'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Company Address Line 5'''
|- valign="baseline"
| '''~27'''
| '''Heading Line 1'''
{{Warning|iconsize=small|text=
This token must be on a line of its own.
}}

|- valign="baseline"
| '''~28'''
| '''Heading Line 2'''
{{Warning|iconsize=small|text=
This token must be on a line of its own.
}}

|- valign="baseline"
| '''~29'''
| '''Footing Line 1'''
{{Warning|iconsize=small|text=
This token must be on a line of its own.
}}

|- valign="baseline"
| '''~30'''
| '''Footing Line 2'''
{{Warning|iconsize=small|text=
This token must be on a line of its own.
}}

|- valign="baseline"
| '''~31'''
| '''Footing Line 3'''
{{Warning|iconsize=small|text=
This token must be on a line of its own.
}}

|- valign="baseline"
| '''~32'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Account Reference'''
|- valign="baseline"
| '''~33'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Account Group'''
|- valign="baseline"
| '''~234'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''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 ====
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~110''',n
| '''Document Type'''
;n = 0
:One line per document number.
;n = 1
:Full document detail.
|- valign="baseline"
| '''~111''',n
| '''Line Skip'''
;n = 0
:No Line Skip.
;n = 1
:Line Skip between Items.
|- valign="baseline"
| '''~112''',n
| '''Heading Block'''
;n => 1
:The line to start printing.
|- valign="baseline"
| '''~113''',n,m
| '''Body Block'''
;n
:The line to start printing.
;m
:Depth (Number of lines to print).
|- valign="baseline"
| '''~114''',n
| '''Footing Block'''
;n
:The line to start printing.
|- valign="baseline"
| '''~115''',n
| '''Form Length'''
;n
:Number of Lines per Page.
|- valign="baseline"
| '''~198'''
| '''Currency conversion configuration'''
*See Currency Conversions at the end of this article for more details.
|}
=== Body Block ===
==== General Information ====
{{DataValue|~6nn,1,2,3}} where {{DataValue|~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 {{DataValue|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.
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~601''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Document Number'''
|- valign="baseline"
| '''~602''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Document Type'''
|- valign="baseline"
| '''~603''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Document Date'''
|- valign="baseline"
| '''~604''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Settlement Discount Percentage'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~605''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Settlement Discount Amount'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~606''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Discounted Amount'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~607''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Document Comment'''
|- valign="baseline"
| '''~608''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount if Debit'''
|- valign="baseline"
| '''~609''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount if Credit'''
|- valign="baseline"
| '''~610''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount Signed'''
|- valign="baseline"
| '''~611''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Document Balance'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~612''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Discount Expiry Date'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~613''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Rolling Balance'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~614''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Invoice Age in Days'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~615''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount on Hold'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~616''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Document Balance - Held'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~617'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Credit Charge Due Date'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~618''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Credit Charge that may be charged after the due date'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~619''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Credit Charge due at the time of printing'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|- valign="baseline"
| '''~620''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Document Balance - Held + Credit Charge due at the time of printing'''
{{Note|iconsize=small|text=
This will print on the last document item only.
}}

|}
=== Totals Block ===
==== General Information ====
{{DataValue|~5nn,1,2,3}} where {{DataValue|~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 {{DataValue|0.00}} instead of spaces.
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~510'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total Settlement Discount'''
|- valign="baseline"
| '''~511''',n
| '''Discounts'''
;n = 0
:Total Amount before Discount
;n = 1
:Total Discount applied
|- valign="baseline"
| '''~514'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total Amount'''
|- valign="baseline"
| '''~517'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Period 1 Total'''
|- valign="baseline"
| '''~518'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Period 2 Total'''
|- valign="baseline"
| '''~519'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Period 3 Total'''
|- valign="baseline"
| '''~520'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Period 4 Total'''
|- valign="baseline"
| '''~521'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Description for period 1'''
|- valign="baseline"
| '''~522'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Description for period 2'''
|- valign="baseline"
| '''~523'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Description for period 3'''
|- valign="baseline"
| '''~524'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Description for period 4'''
|- valign="baseline"
| '''~525'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Unallocated Total'''
|- valign="baseline"
| '''~526'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''On Hold Total'''
|- valign="baseline"
| '''~527'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Rolling Balance - Total Held'''
|- valign="baseline"
| '''~528'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total of Credit Charges Due'''
|- valign="baseline"
| '''~529'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''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.
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~79'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Expand'''
|- valign="baseline"
| '''~80'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Unexpand'''
|- valign="baseline"
| '''~81'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Compact'''
|- valign="baseline"
| '''~82'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Uncompact'''
|- valign="baseline"
| '''~83'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Double Strike On'''
|- valign="baseline"
| '''~84'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Double Strike Off'''
|- valign="baseline"
| '''~86'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Paper Forward'''
|- valign="baseline"
| '''~87'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Paper Backward'''
|- valign="baseline"
| '''~88''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(up to 32 characters)</div>'''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 ===
{{Information|text=
''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.

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

{{Example|text=
Some examples using {{DataValue|~29,1}} amount taxed at tax rate 1. Note that {{DataValue|~29}} may not represent an amount in all document formats. This is just an example.

;~29,1
:no conversion
:{{DataValue|*100.00}} - (where * is your usual currency symbol).
;~29$,1
:convert to the account currency (if there is one)
:{{DataValue|1005.18F}} - (e.g. French Francs.)
;~29$12,1
:convert to account currency and print to a width of 12
:{{DataValue|1005.18F}}
;~29$USD,1
:convert to currency USD (US Dollar)
:{{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
:same, but suppress the symbol and print to a width of 12
:{{DataValue|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.

{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~198x''',n
| '''x = Default currency modifier (optional)'''
;n = 0
:Use exchange rate as at the user date for all currency conversions.
;n = 1
:Use exchange rate as at the transaction date for all currency conversions.
|}
==== 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.

{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~293'''
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Exchange rate from base currency to account currency'''
|- valign="baseline"
| '''~294'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Sub-units of the currency set for this account'''
|- valign="baseline"
| '''~295'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Units of the currency set for this account'''
|- valign="baseline"
| '''~296'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Name of the currency set for this account'''
|- valign="baseline"
| '''~297'''
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Code of the currency set for this account'''
|- valign="baseline"
| '''~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
|}
{{KB_Tags|Layout, Token, Format, Document, Setup, Config, Configuration, Statement}}
{{KB_Ref|SL11}}[[Category:Documents]][[Category:Accounts Documents]]