Difference between revisions of "Document Configuration - Unit Sales Document"
(Updated from revision control) |
(Updated from revision control) |
||
Line 221: | Line 221: | ||
| '''~236''' | | '''~236''' | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Document Reference''' | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Document Reference''' | ||
+ | |- valign="baseline" | ||
+ | | '''~255''',n,"x" | ||
+ | | '''Suppresses Printing if account attribute not set''' | ||
+ | Print spaces if the customer account does not have the given account attribute set. | ||
+ | ;n = 1 | ||
+ | :Printing off (if attribute not set). | ||
+ | ;n = 2 | ||
+ | :Printing on. | ||
+ | ;"x" | ||
+ | :The code of the account attribute which must be set in order to print content. | ||
|} | |} | ||
=== Finance Company Tokens === | === Finance Company Tokens === | ||
Line 1,051: | Line 1,061: | ||
;n = 1 | ;n = 1 | ||
:Part Exchange Build Year | :Part Exchange Build Year | ||
+ | |- valign="baseline" | ||
+ | | '''~170''',n,"x" | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Country of Origin''' | ||
+ | Print a country code or a country name. | ||
+ | ;n = 0 | ||
+ | :Print the country code | ||
+ | ;n = 1 -> 30 | ||
+ | :The number of characters to print from the country name. | ||
+ | ;"x" | ||
+ | :An optional account attribute code which must be set in order to print anything for this token. It can be left blank if printed output is always required. | ||
+ | |- valign="baseline" | ||
+ | | '''~171''',n,"x" | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Commodity Code''' | ||
+ | Print a commodity code. | ||
+ | ;n | ||
+ | :The number of characters to print from the commodity code. | ||
+ | ;"x" | ||
+ | :An optional account attribute code which must be set in order to print anything for this token. It can be left blank if printed output is always required. | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~247''' | | '''~247''' | ||
Line 1,231: | Line 1,259: | ||
;n = 1 | ;n = 1 | ||
:Stock Code | :Stock Code | ||
+ | |- valign="baseline" | ||
+ | | '''~657''',n,"x" | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Column position for Country of Origin''' | ||
+ | Print a country code or a country name. | ||
+ | ;n = 0 | ||
+ | :Print the country code | ||
+ | ;n = 1 -> 30 | ||
+ | :The number of characters to print from the country name. | ||
+ | ;"x" | ||
+ | :An optional account attribute code which must be set in order to print anything for this token. It can be left blank if printed output is always required. | ||
+ | |- valign="baseline" | ||
+ | | '''~658''',n,"x" | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Column position for Commodity Code''' | ||
+ | Print a commodity code. | ||
+ | ;n | ||
+ | :The number of characters to print from the commodity code. | ||
+ | ;"x" | ||
+ | :An optional account attribute code which must be set in order to print anything for this token. It can be left blank if printed output is always required. | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~64''',n | | '''~64''',n |
Revision as of 06:37, 23 December 2020
The Platinum System " Unit Sales" allows the layout of your Invoices (credits use the original format of the invoice), Quotations and Sales Orders 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.
Contents
- 1 Token File Names
- 2 Layout Tokens
- 3 Document Areas
- 4 Tokens
- 4.1 General Tokens
- 4.2 Finance Company Tokens
- 4.3 Client Tokens
- 4.4 Payment & Total Tokens
- 4.5 Discount Tokens
- 4.6 Cashback Tokens
- 4.7 Finance Tokens
- 4.8 Sale Unit Tokens
- 4.9 Part Exchange Tokens
- 4.10 Extras/Accessories Tokens
- 4.11 Credit Card Tokens
- 4.12 Output Control Tokens
- 4.13 Print Style Tokens
- 4.14 Currency Conversions
Token File Names
Invoice
- 'SXVS017.EPL'
- New Unit Invoice Format
- 'SXVS018.EPL'
- Used Unit Invoice Format
- 'SXVS019.EPL'
- New Unit Commercial Invoice
- 'SXVS020.EPL'
- Used Unit Commercial Invoice
Quotation
- 'SXVS025.EPL'
- New Unit Quotation Format
- 'SXVS026.EPL'
- Used Unit Quotation Format
- 'SXVS027.EPL'
- New Unit Commercial Quotation
- 'SXVS028.EPL'
- Used Unit Commercial Quotation
Sales Order
- 'SXVS049.EPL'
- New Unit Sales Order
- 'SXVS050.EPL'
- Used Unit Sales Order
- 'SXVS051.EPL'
- New Commercial Sales Order
- 'SXVS052.EPL'
- Used Commercial Sales Order
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".
The printing program goes to some lengths to work out where the "headers", "footers" and "part exchange" sections lie, but you may explicitly tell it the following tokens.
~901,1 | Header Section start | |
~901,2 | Header Section end | |
~902,1 | Footer Section start | |
~902,2 | Footer Section end | |
~903,1 | Totals Section start | |
~903,2 | Totals Section end | |
~904,1 | Part Exchange Section start | |
~904,2 | Part Exchange Section end | |
~905,1 | Sale Unit Section start | |
~905,2 | Sale Unit Section end |
The main purpose of these are to set out what details will be printed for multiple sale units, or multiple part exchanges, where these occur. In such cases, additional pages will be printed. These consist of the detected "Header Section", as many "Sale Unit" or "Part Exchange" sections as can be on between the headers and footers, and a "Footer" section.
The only purpose of the "Totals Section" at the time of writing is to avoid the program getting sidetracked by what is otherwise a "part exchange" token included in the document totals.
Tokens
General Tokens
These can appear in either Headers or Footers.
~1,n,m | (30 characters) Client Name
| ||
~2,n,m | (30 characters) Client Address Line 1
| ||
~3,n,m | (30 characters) Client Address Line 2
| ||
~4,n,m | (30 characters) Client Address Line 3
| ||
~5,n,m | (30 characters) Client Address Line 4
| ||
~6,n,m | (30 characters) Client Address Line 5
| ||
~7 | (25 characters) Document Number
| ||
~8 | (32 characters) Document Date - Long Format
| ||
~9 | (10 characters) Document Date - Short Format
| ||
~10 | (70 characters) Notes Entered
| ||
~118 | Suppresses Printing of V.A.T. Information and associated prompts | ||
~124 | Print a Customer Statement
Automatically prints a customer statement to follow the invoice. No statement will be printed if the customer's account balance is zero following this invoice and any payments made along with it.
| ||
~73,n | (25 characters) Company Name
| ||
~77,n | (50 characters) Company Address
| ||
~78,n | (25 characters) Standard Headings
Used from the Print record.
| ||
~89,n | (25 characters) Standard Footings
Used from the Print record.
| ||
~92,n | Delivery Due Date
| ||
~195,n | (10 characters) Sales Person
| ||
~236 | (30 characters) Document Reference
| ||
~255,n,"x" | Suppresses Printing if account attribute not set
Print spaces if the customer account does not have the given account attribute set.
|
Finance Company Tokens
~206,n | Suppresses Printing if no Finance
| |
~11 | (30 characters) Name of Finance Company
| |
~12,n | (30 characters) Finance Company Address
| |
~196 | (6 characters) Finance Company Account Code
| |
~197,n | (25 characters) Finance Company Contact Name
| |
~198,n | Finance Company Phone Number / Email
| |
~199 | (15 characters) Finance Company Fax Number
| |
~200,n | (40 characters) Finance Company Brief Notes
| |
~201 | (10 characters) Finance Company Reference
| |
~202 | (6 characters) Finance Company Account Group
| |
~203,n | (1 character) Finance Company Analysis Code
| |
~204,n,m | (15 characters) Finance Company Analysis Description
| |
~205,n | (60 characters) Finance Company Extra Notes
| |
~244 | (30 characters) Finance Company V.A.T. Registration Number
| |
~245 | (20 characters) Finance Agreement Number
|
Client Tokens
~13,n,m | (30 characters) Client Account Code
| |
~207,n,m | (25 characters) Client Contact Name
| |
~208,n,m | Client Phone Number / Email
| |
~209,n,m | (15 characters) Client Fax Number
| |
~210,n,m,l | Client Notes
| |
~211,n,m | (10 characters) Client Reference
| |
~212,n,m | (6 characters) Client Account Group
| |
~213,n,m | (1 character) Client Analysis Code
| |
~214,n,m,l | Client Analysis Description
| |
~215,n,m | (1 character) Client Extra Notes
| |
~234,n,m | (30 characters) Client V.A.T Registration Number
| |
~235,n,m | Client Date of Birth
|
Payment & Total Tokens
~14,n | (12 characters) Pre-Paid Deposit
| |||||||||
~15,n | (12 characters) Payment Taken at the time of this Document
| |||||||||
~93,n | (12 characters) Total Payment
Deposit + Document Payment = Total Payment
| |||||||||
~189,n,"x" | Payments Tendered Layout
| |||||||||
~107,n | (12 characters) Gross Total, Nett of Accessories
Includes Delivery if priced "On the Road".
| |||||||||
~101,n,m | (12 characters) Nett Amount due from Client (Split Invoice)
| |||||||||
~102,n,m | (12 characters) Nett Amount due from Finance Company (Split Invoice)
| |||||||||
~16,n,m | (12 characters) Nett Amount Due
| |||||||||
~103,n,m | (12 characters) V.A.T Amount due from Client (Split Invoice)
| |||||||||
~104,n,m | (12 characters) V.A.T Amount due from Finance Company (Split Invoice)
| |||||||||
~17,n,m | (12 characters) Total V.A.T.
| |||||||||
~105,n,m | (12 characters) Gross Amount due from Client (Split Invoice)
| |||||||||
~106,n,m | (12 characters) Gross Amount due from Finance Company (Split Invoice)
| |||||||||
~18,n,m | (12 characters) Gross Amount
| |||||||||
~19,n | (12 characters) Balance due on Invoice
| |||||||||
~90,n | (12 characters) Balance Due On Invoice (Includes deduction for Amount Financed)
| |||||||||
~20,n | (12 characters) Invoice Total excluding Part Exchange
| |||||||||
~21,n | (12 characters) Nett Part Exchange Value (Value Less Settlement)
| |||||||||
~193,n | (12 characters) Outstanding Balance
This takes into account the Cashback, Part Exchange, Deposits/Payments and Finance.
| |||||||||
~246,n,m | (10 characters) System Tax Rate(s)
| |||||||||
~401 | (80 characters) Top Left hand corner of Credit Charge Text Block
The Credit Charge Text Block is defined in " Reports & Settings Maintenance Options System Administrator Credit Charge Settings" and configures itself according to the details of the current document. | |||||||||
~402 | (10 characters) Total: Amount of any Credit Charge Applicable to the Current Document.
| |||||||||
~403 | (10 characters) Total: Gross total for the current document, plus any applicable Credit Charge.
|
Discount Tokens
~140,n | Suppresses Printing if no Discount
| |
~141,n,m | (12 characters) Unit Price Before Discount
| |
~142,n | (12 characters) Discount Amount
| |
~143,n | (7 characters) Discount Percentage
|
Cashback Tokens
~160,n | Suppresses Printing if no Cashback
| |
~161 | (20 characters) Cashback Prompt/Description
| |
~162,n | (12 characters) Cashback Amount Gross
| |
~163,n | (12 characters) Cashback Amount Nett
| |
~164,n | (12 characters) Cashback Amount V.A.T.
| |
~165,n | (7 characters) Cashback Percentage
| |
~166,n | (12 characters) Balance Due on Invoice
Includes deduction for Cashback Credit.
| |
~167,n | (12 characters) Total of Unit plus Accessories, less Cashback
| |
~168,n | (12 characters) Total of Unit plus Accessories, less Cashback, less Part Exchange
|
Finance Tokens
~22 | (12 characters) Amount Financed
| |
~23 | (6 characters) Finance Period in Years
| |
~24 | (3 characters) Finance Number of Payments
| |
~25 | (6 characters) Finance Basic Percentage Rate
| |
~26 | (12 characters) Finance Documentation Fee
| |
~94 | (12 characters) Finance Termination Fee
| |
~27 | (12 characters) Finance Amount of Each Installment
| |
~28 | (12 characters) Finance Total of Repayments
(Number of Payments * Payment Amount) + Deposit + Part Exchange Asking + Balloon = Repayments total. | |
~194 | (12 characters) Finance Total to Pay
Number of Payments * Payment Amount = Total to Pay | |
~29 | (6 characters) A.P.R. of Finance
| |
~95 | (12 characters) Finance Balloon Amount
| |
~96 | (12 characters) Finance Balloon Percentage Rate
| |
~97 | (12 characters) Finance Final Payment Amount
| |
~98 | (12 characters) Finance Subsidy Amount
|
Sale Unit Tokens
~110,n | Suppresses Printing if Sales Unit is New
| |
~111,n | Suppresses Printing if Sales Unit is Used
| |
~112,n | Suppresses Printing if Sales Unit is Commercial
| |
~113,n | Suppresses Printing if Sales Unit is non-Commercial
| |
~115 | Suppresses Printing Additional Pages for Multiple Sale Units | |
~159,n | Maximum number of Sale Units per Page
May be required when printing multiple sale units using Windows printer control codes, as calculating the safe number to print between the headers and footers becomes more difficult.
| |
~30 | (8 characters) Sale Unit Stock Number
| |
~31,n | (20 characters) Sale Unit Description
| |
~32 | (10 characters) Sale Unit Registration Number
| |
~33,n | Sale Unit Colour
| |
~34,n | Sale Unit Registration Date
| |
~35 | (8 characters) Sale Unit Mileage
| |
~36 | (25 characters) Sale Unit Chassis Number
| |
~37 | (25 characters) Sale Unit V.I.N.
| |
~38 | (25 characters) Sale Unit Engine Number
| |
~39 | (12 characters) Total Sale Unit Price
Includes Delivery if priced "On the Road". | |
~40 | (12 characters) Total Sale Unit Nett Amount
Includes Delivery if priced "On the Road". | |
~41 | (12 characters) Total Sale Unit V.A.T. Amount
| |
~42,n | (12 characters) Delivery Charge
| |
~43,n,m,l | Sale Unit Notes or Sales Text, or Notes Prompts
| |
~44,n | (15 characters) Sale Unit Price
Excludes Delivery (if priced "On the Road").
| |
~45 | (25 characters) Sale Unit Warranty Number
| |
~46 | (10 characters) Sale Unit Key Number
| |
~108,n | Unit Consignment
| |
~109,n,m | Unit Funding
| |
~114,n | (4 characters) New/Used Flag
Used within the "Sale Unit" block this will check the "current" unit; otherwise will check the main/first unit.
| |
~130,n,m | Sale Unit Model
| |
~131 | (5 characters) Sale Unit Cubic Capacity
| |
~132,n | Sale Unit M.O.T. Expiry Date
| |
~133 | (30 characters) Sale Unit Manufacturer Name
| |
~134 | (1 character) Sale Unit Tax Code
| |
~135,n | (6 characters) Sale Unit Tax Percentage
| |
~136 | (15 characters) Sale Unit Technical Model Code
| |
~137 | (1 character) Sale Unit Fresh Import
| |
~138 | (10 characters) Sale Unit Distance Counter
| |
~139,n | Sale Unit Location
| |
~144,n | (10 characters) Warranty Start Date
| |
~145,n | Warranty End Date
| |
~146,n | (40 characters) Warranty Notes
| |
~155,n,m,l | Sale Unit / Document Analysis Code / Description
| |
~156,n | (25 characters) Sale Unit Image Path
| |
~157,n | (4 characters) Unit Build Year
Format 'CCYY'.
| |
~170,n,"x" | (30 characters) Country of Origin
Print a country code or a country name.
| |
~171,n,"x" | (10 characters) Commodity Code
Print a commodity code.
| |
~247 | (8 characters) Total Number of Sale Units
|
Part Exchange Tokens
~60,n | Suppresses Printing If no Part Exchange
| |
~62,n | Suppresses Printing If Part Exchange is Non-Commercial
| |
~116 | Suppresses Printing Additional Pages for Multiple Part Exchange Units | |
~158,n | Maximum number of Part Exchange Units per Page
May be required when printing using Windows printer control codes, as calculating the safe number to print between the headers and footers becomes more difficult.
| |
~43,n,m,l | Part Exchange Unit Notes or Sales Text, or Notes Prompts
| |
~47 | (12 characters) Part Exchange Finance Settlement
| |
~48 | (2 characters) Part Exchange Prev Owners
| |
~49,n | Part Exchange M.O.T. Expiry Date
| |
~50 | (8 characters) Part Exchange Unit Stock Number
| |
~51,n | (20 characters) Part Exchange Unit Description
| |
~52 | (10 characters) Part Exchange Registration Number
| |
~53,n | (15 characters) Part Exchange Unit Colour
| |
~54,n | Part Exchange Registration Date
| |
~55 | (8 characters) Part Exchange Unit Mileage
| |
~56 | (25 characters) Part Exchange Unit Chassis Number
| |
~57 | (25 characters) Part Exchange Unit V.I.N.
| |
~58 | (25 characters) Part Exchange Unit Engine Number
| |
~59 | (12 characters) Part Exchange Unit Amount Allowed
| |
~147 | (30 characters) Part Exchange Unit Manufacturer Name
| |
~148,n | (12 characters) Nett portion of Amount Paid for Commercial Part Exchange Unit
| |
~149,n | (12 characters) V.A.T. portion of Amount Paid for Commercial Part Exchange Unit
| |
~150,n,m | Part Exchange Unit Model
| |
~151 | (30 characters) Part Exchange Unit Technical Model Code
| |
~152 | (10 characters) Part Exchange Unit Key Number
| |
~153 | (1 character) Part Exchange Unit Fresh Import
| |
~154 | (10 characters) Part Exchange Unit Distance Counter
| |
~157,n | (4 characters) Unit Build Year
Format 'CCYY'.
| |
~248 | (8 characters) Total Number of Part Exchange Units
|
Extras/Accessories Tokens
~61,n | Suppresses Printing if no Extras and Accessories
| ||
~117 | Suppresses Printing Overflow Sheet for more than 10 Extras and Accessories | ||
~63,n | (30 characters) Column position for Accessory Description
| ||
~657,n,"x" | (30 characters) Column position for Country of Origin
Print a country code or a country name.
| ||
~658,n,"x" | (10 characters) Column position for Commodity Code
Print a commodity code.
| ||
~64,n | (12 characters) Column position for Accessory Quantity
| ||
~65,n | (12 characters) Column position for Accessory Unit Price
| ||
~66 | (1 character) Column position for Accessory V.A.T. Code
| ||
~67,n,m | (12 characters) Column position for Accessory Total
| ||
~68,n | (6 characters) Accessories Discount
| ||
~69,n,m | (12 characters) Accessories Total Nett
| ||
~70,n,m | (12 characters) Accessories Total V.A.T.
| ||
~71,n,m | (12 characters) Accessories Grand Total
| ||
~72,n | (25 characters) Accessories Starting Line
| ||
~91,"x" | (80 characters) Accessory Heading
If the Accessories overflow to an additional sheet, this heading will also appear as the headings there.
|
Credit Card Tokens
~216,n | Suppresses Printing If no Credit Card Payment
| |
~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
|
Output Control Tokens
~74,"x" | Copy specified file to output
Will copy the filename given after the token to the printer.
| ||
~75,n,m,l | Form Length
| ||
~76 | Form Feed
| ||
~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.
|
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. Note that '~29' may not represent an amount in all document formats. This is just an example.
|
Country/Currency Tokens
There is a group of tokens that may be used in headers and footers to print details about the country and currency set up for the account associated with the document.
~292,n | (3 characters) Country code/description for the document.
If the account in use has a specific country associated with it this will be used, otherwise the system default country will be output.
| |
~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 |