Purchase Invoice Configuration - Vehicle Sales Document

From Catalyst
Revision as of 04:56, 22 May 2014 by ThrashBot (talk | contribs) (Updated from revision control)
Jump to: navigation, search

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

'SXVS030.EPL'
Purchase Invoice (Pro-Forma)

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

Tokens

General Tokens

These can appear in either Headers or Footers.

~1
(30 characters)
Supplier Name
~2
(30 characters)
Supplier Address Line 1
~3
(30 characters)
Supplier Address Line 2
~4
(30 characters)
Supplier Address Line 3
~5
(30 characters)
Supplier Address Line 4
~6
(30 characters)
Supplier Address Line 5
~7
(25 characters)
Document Number
~8
(32 characters)
Document Date - Long Format
~9
(10 characters)
Document Date - Short Formart
~73,n
(25 characters)
Company Name
n = 1 -> 2
Name index
~77,n
(25 characters)
Company Address
n = 1 -> 2
Address index
~78,n
(25 characters)
Standard Headings

Used from the Print record.

This token must be on a line of its own.
n = 1 -> 2
Heading index
~89,n
(25 characters)
Standard Footings

Used from the Print record.

This token must be on a line of its own.
n = 1 -> 2
Footing index

Supplier Tokens

~13
(30 characters)
Supplier Account Code
~207,n
(25 characters)
Supplier Contact Name
n = 1 -> 10
Name index
~208,n
(15 characters)
Supplier Phone Number
n = 0
(15 characters)
Telephone Number.
n = 1
(20 characters)
Mobile Number.
~209
(15 characters)
Supplier Fax Number
~210,n,m Supplier Notes
n = 1 -> 5
Notes index
m = 0
(40 characters)
Notes information.
m = 1
(10 characters)
Notes prompt.
~211
(10 characters)
Supplier Reference
~212
(6 characters)
Supplier Account Group
~213,n
(1 character)
Supplier Analysis Code
n = 1 -> 3
Analysis Code index.
~214,n
(1 character)
Supplier Analysis Description
n = 1 -> 3
Analysis Description index.
~215,n
(1 character)
Supplier Extra Notes
n = 1 -> 999
Supplier Extra Note line index.
~234
(30 characters)
Supplier V.A.T Registration Number

Payment & Total Tokens

~15
(12 characters)
Amount of Payment Made
~16
(12 characters)
Balance of Invoice after Payment & Settlement
~45
(12 characters)
Payment Amount

Part Exchange Tokens

~60,n Suppresses Printing If not Commercial Vehicle
n = 1
Printing off (If not Commercial Vehicle).
n = 2
Printing on.
~46
(12 characters)
Part Exchange Balance

Amount - Finance Settlement = Part Exchange Balance

~47
(12 characters)
Part Exchange Finance Settlement
~48
(2 characters)
Part Exchange Prev Owners
~49,n Part Exchange M.O.T. Expiry Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~50
(8 characters)
Part Exchange Vehicle Stock Number
~51
(20 characters)
Part Exchange Vehicle Description
~52
(10 characters)
Part Exchange Registration Number
~53,n
(15 characters)
Part Exchange Vehicle Colour
n = 0
(15 characters)
Colour
n = 1
(30 characters)
Technical Colour
n = 2
(3 characters)
Technical Colour Code
~54,n Part Exchange Registration Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~55
(8 characters)
Part Exchange Vehicle Mileage
~56
(25 characters)
Part Exchange Vehicle Chassis Number
~57
(25 characters)
Part Exchange Vehicle V.I.N.
~58
(25 characters)
Part Exchange Vehicle Engine Number
~59
(12 characters)
Part Exchange Vehicle Amount Allowed
~61
(12 characters)
Nett Portion of Amount Paid on a Commercial Vehicle
~62
(12 characters)
V.A.T. Portion of Amount Paid on a Commercial Vehicle
~139,n Part Exchange Vehicle Location
n = 0
(3 characters)
Location Code.
n = 1
(30 characters)
Location Description.
~147
(30 characters)
Part Exchange Vehicle Manufacturer Name
~150,n
(20 characters)
Part Exchange Vehicle Model
n = 0
Model Code.
n = 1
Model Description.
~151
(30 characters)
Part Exchange Vehicle Technical Model Code
~152
(10 characters)
Part Exchange Vehicle Key Number
~153
(1 character)
Part Exchange Vehicle Fresh Import
~154
(10 characters)
Part Exchange Vehicle Distance Counter
~157
(4 characters)
Part Exchange Vehicle Build Year

Format 'CCYY'.

Output Control Tokens

~74,"x" Copy specifed file to output

Will copy the filename given after the token to the printer.

This token must be on a line of its own.
"x"
Filename to output.
~75,n,m,l Form Length
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.
~76 Form Feed
This code must be on it's own line, as everything elese on a line that has this token will be ignored.
~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.

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

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