Difference between revisions of "Purchase Invoice Configuration - Vehicle Sales Document"

From Catalyst
Jump to: navigation, search
(Updated from revision control)
 
(New redirection changes)
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
+
#REDIRECT [[Purchase Invoice Configuration - Unit Sales Document]]
The Platinum System "Vehicle Sales" allows the layout of your Purchase Invoice 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.
 
 
 
== Token File Names ==
 
=== Purchase Invoice ===
 
;{{FilePath|SXVS030.EPL}}
 
:Purchase Invoice (Pro-Forma)
 
== Layout Tokens ==
 
Tokens are indicated by the character {{DataValue|~}} 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: {{DataPrompt|Headings}}, {{DataPrompt|Body}} & {{DataPrompt|Footings}}.
 
 
 
== 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>'''Supplier Name'''
 
|- valign="baseline"
 
| '''~2'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Supplier Address Line 1'''
 
|- valign="baseline"
 
| '''~3'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Supplier Address Line 2'''
 
|- valign="baseline"
 
| '''~4'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Supplier Address Line 3'''
 
|- valign="baseline"
 
| '''~5'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Supplier Address Line 5'''
 
|- valign="baseline"
 
| '''~7'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Document Number'''
 
|- valign="baseline"
 
| '''~8'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>'''Document Date (long)'''
 
|- valign="baseline"
 
| '''~9'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Document Date (short)'''
 
|- valign="baseline"
 
| '''~73''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Company Name'''
 
;n = 1 -> 2
 
:Name index
 
|- valign="baseline"
 
| '''~77''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Company Address'''
 
;n = 1 -> 2
 
:Address index
 
|- valign="baseline"
 
| '''~78''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Standard Headings'''
 
Used from the Print record.
 
 
 
{{Warning|iconsize=small|text=
 
This token must be on a line of its own.
 
}}
 
 
 
;n = 1 -> 2
 
:Heading index
 
|- valign="baseline"
 
| '''~89''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Standard Footings'''
 
Used from the Print record.
 
 
 
{{Warning|iconsize=small|text=
 
This token must be on a line of its own.
 
}}
 
 
 
;n = 1 -> 2
 
:Footing index
 
|}
 
=== Supplier Tokens ===
 
{| cellspacing="5" width="95%" valign="baseline"
 
!width="15%"|
 
!|
 
!|
 
 
 
|- valign="baseline"
 
| '''~13'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Supplier Account Code'''
 
|- valign="baseline"
 
| '''~207''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Supplier Contact Name'''
 
;n = 1 -> 10
 
:Name index
 
|- valign="baseline"
 
| '''~208''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Supplier Phone Number'''
 
;n = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number.
 
;n = 2
 
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number.
 
|- valign="baseline"
 
| '''~209''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Supplier Fax Number'''
 
|- valign="baseline"
 
| '''~210''',n,m
 
| '''Supplier Notes'''
 
;n = 1 -> 5
 
:Notes index
 
;m = 0
 
:<div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>Notes information.
 
;m = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Notes prompt.
 
|- valign="baseline"
 
| '''~211'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Supplier Reference'''
 
|- valign="baseline"
 
| '''~212'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Supplier Account Group'''
 
|- valign="baseline"
 
| '''~213''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Supplier Analysis Code'''
 
;n = 1 -> 3
 
:Analysis Code index.
 
|- valign="baseline"
 
| '''~214''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Supplier Analysis Description'''
 
;n = 1 -> 3
 
:Analysis Description index.
 
|- valign="baseline"
 
| '''~215''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Supplier Extra Notes'''
 
;n = 1 -> 999
 
:Supplier Extra Note line index.
 
|- valign="baseline"
 
| '''~234''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Supplier V.A.T Registration Number'''
 
|}
 
=== Payment & Total Tokens ===
 
{| cellspacing="5" width="95%" valign="baseline"
 
!width="15%"|
 
!|
 
!|
 
 
 
|- valign="baseline"
 
| '''~15'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Amount of Payment Made'''
 
|- valign="baseline"
 
| '''~16'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Balance of Invoice after Payment & Settlement'''
 
|- valign="baseline"
 
| '''~45'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Payment Amount'''
 
|}
 
=== Part Exchange Tokens ===
 
{| cellspacing="5" width="95%" valign="baseline"
 
!width="15%"|
 
!|
 
!|
 
 
 
|- valign="baseline"
 
| '''~60''',n
 
| '''Suppresses Printing If not Commercial Vehicle'''
 
;n = 1
 
:Printing off (If not Commercial Vehicle).
 
;n = 2
 
:Printing on.
 
|- valign="baseline"
 
| '''~46'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Part Exchange Balance'''
 
Amount - Finance Settlement = Part Exchange Balance
 
|- valign="baseline"
 
| '''~47'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Part Exchange Finance Settlement'''
 
|- valign="baseline"
 
| '''~48'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(2 characters)</div>'''Part Exchange Prev Owners'''
 
|- valign="baseline"
 
| '''~49''',n
 
| '''Part Exchange M.O.T. Expiry Date'''
 
;n = 0
 
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
 
;n = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
 
|- valign="baseline"
 
| '''~50'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Part Exchange Vehicle Stock Number'''
 
|- valign="baseline"
 
| '''~51'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>'''Part Exchange Vehicle Description'''
 
|- valign="baseline"
 
| '''~52'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Part Exchange Registration Number'''
 
|- valign="baseline"
 
| '''~53''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Part Exchange Vehicle Colour'''
 
;n = 0
 
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Colour
 
;n = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Technical Colour
 
;n = 2
 
:<div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>Technical Colour Code
 
|- valign="baseline"
 
| '''~54''',n
 
| '''Part Exchange Registration Date'''
 
;n = 0
 
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
 
;n = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
 
|- valign="baseline"
 
| '''~55'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Part Exchange Vehicle Mileage'''
 
|- valign="baseline"
 
| '''~56'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Part Exchange Vehicle Chassis Number'''
 
|- valign="baseline"
 
| '''~57'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Part Exchange Vehicle V.I.N. Number'''
 
|- valign="baseline"
 
| '''~58'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Part Exchange Vehicle Engine Number'''
 
|- valign="baseline"
 
| '''~59'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Part Exchange Vehicle Amount Allowed'''
 
|- valign="baseline"
 
| '''~61'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Nett Portion of Amount Paid on a Commercial Vehicle'''
 
|- valign="baseline"
 
| '''~62'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''V.A.T. Portion of Amount Paid on a Commercial Vehicle'''
 
|- valign="baseline"
 
| '''~139''',n
 
| '''Part Exchange Vehicle Location'''
 
;n = 0
 
:<div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>Location Code.
 
;n = 1
 
:<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Location Description.
 
|- valign="baseline"
 
| '''~147'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Part Exchange Vehicle Manufacturer Name'''
 
|- valign="baseline"
 
| '''~150''',n
 
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Part Exchange Vehicle Model'''
 
;n = 0
 
:Model Code.
 
;n = 1
 
:Model Description.
 
|- valign="baseline"
 
| '''~151'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Part Exchange Vehicle Technical Model Code'''
 
|- valign="baseline"
 
| '''~152'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Part Exchange Vehicle Key Number'''
 
|- valign="baseline"
 
| '''~153'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Part Exchange Vehicle Fresh Import'''
 
|- valign="baseline"
 
| '''~154'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Part Exchange Vehicle Distance Counter'''
 
|- valign="baseline"
 
| '''~157'''
 
| <div style="float:right; margin-left:1em; font-style:italic;">(4 characters)</div>'''Part Exchange Vehicle Build Year'''
 
Format {{DataValue|CCYY}}.
 
|}
 
=== Output Control Tokens ===
 
{| cellspacing="5" width="95%" valign="baseline"
 
!width="15%"|
 
!|
 
!|
 
 
 
|- valign="baseline"
 
| '''~74''',"x"
 
| '''Copy specifed file to output'''
 
Will copy the filename given after the token to the printer.
 
 
 
{{Warning|iconsize=small|text=
 
This token must be on a line of its own.
 
}}
 
 
 
;"x"
 
:Filename to output.
 
|- valign="baseline"
 
| '''~75''',n,m,l
 
| '''Form Length'''
 
{{Note|iconsize=small|text=
 
This code must be on it's own line, as everything elese on a line that has this token will be ignored.
 
}}
 
 
 
;n
 
:Current line number.
 
;m
 
:Form Length.
 
;l
 
:Form Break.
 
|- valign="baseline"
 
| '''~76'''
 
| '''Form Feed'''
 
{{Note|iconsize=small|text=
 
This code must be on it's own line, as everything elese on a line that has this token will be ignored.
 
}}
 
 
 
|- valign="baseline"
 
| '''~99'''
 
| '''Pad Markers with Spaces'''
 
|}
 
=== 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 the [http://www.catalyst-uk.com ''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 {{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.
 
 
 
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=
 
Some examples using {{DataValue|~29,1}} amount taxed at tax rate 1.
 
 
 
;~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.56}}
 
;~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'''
 
| '''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.
 
 
 
{| 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
 
|}[[Category:Vehicle Sales Documents]]
 

Latest revision as of 10:15, 11 December 2018