Invoice/Credit Configuration - Order Processing Document
The Platinum System "Order Processing" allows the layout of your Invoices and Credits 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.
This article is for the following documents :-
- "Invoice"
- "Credit Note"
Contents
Layout Data Formats
Formats are stored in a special file, which must be accessed through the format amendments programs. It cannot be edited from outside the Platinum System.
A library of "Standard Formats" is available. These are automatically copied to the "User Format" the first time a document is printed, and may be copied manually if, for instance, you wish to start using pre-printed stationary where before you were using plain paper.
If required, you may assign special formats to certain Accounts, and/or assign these formats to different print records from the default. A format name may be up to 11 characters in length, and contain any combination of typeable characters.
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 invoice/credit 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 | |
| ~700 | Totals Configuration Block Start | |
| ~799 | Totals Configuration Block End | |
| ~800 | Tax Configuration Block Start | |
| ~899 | Tax Configuration Block End |
Tokens
General Tokens
These can appear in either Headers or Footers.
| ~1 | (30 characters) Account Name
| |
| ~2,n | (30 characters) Account Address Line
| |
| ~3 | (6 characters) Account Code
| |
| ~4,n | Telephone Number
| |
| ~5 | (15 characters) Fax Number
| |
| ~6,n,m | Account Notes Line
| |
| ~7 | (3 characters) Page Number
| |
| ~8 | (3 characters) Total Pages on Invoice/Credit
| |
| ~9,n | (8 characters) Document Number
| |
| ~10,n | Document Date
| |
| ~11,n | (40 characters) Company Name
| |
| ~12,n | (50 characters) Company Address
| |
| ~13,n | (one line) Heading Line
| |
| ~14,n | (one line) Footing Line
| |
| ~15 | (11 characters) Heading Document Type
| |
| ~17 | Top Left hand corner of Totals Block
Use if totals are to be printed in self configuring block. See below. | |
| ~18 | Top Left hand corner of Tax Details Block
Use if tax is to be printed Supressed on Tax Inclusive documents (see above).
| |
| ~710,n,m,l,k,j | (25 characters) Amount Charged at Tax Rate 2
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Supressed on Tax Inclusive documents (see above).
| |
| ~711,n,m,l,k,j | (25 characters) Amount Charged at Tax Rate 3
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Supressed on Tax Inclusive documents (see above).
| |
| ~712,n,m,l,k,j | (25 characters) Amount Charged at Tax Rate 4
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Supressed on Tax Inclusive documents (see above).
| |
| ~713,n,m,"x",l,k | (25 characters) Tendered Amounts Breakdown
Prints a line for each cost centre with a payment posted to it.
| |
| ~714,n,m,l,k,j | (25 characters) Carriage Amount
| |
| ~715,n,m,l | (25 characters) Total Amount Before Tax or Blanket Discounts
An alternative for '~701' for Tax Inclusive documents. While both should be supplied, only one will print. This is intended to enable an alternative description. See also '~119' in the Configuration Tokens section. | |
| ~716,n,m,l | (25 characters) Blanket Discount Amount
An alternative for '~702' for Negative Discounts. (i.e. Surcharges.). If the Discount is '0%' or greater '~702' will be used; if the Discount is less than '0%' then '~716' is used. If '~716' is not supplied, '~702' will be used. | |
| ~717,n,m,l | (25 characters) Total Amount Paid
| |
| ~718,n,m,l | (25 characters) Change Given
| |
| ~719,n,m,l | (25 characters) Account Balance including current Document
|
Tax Block
General Information
| ~801,n,m | Details for 1st Tax Band
| |
| ~801,n,m | Details for 2nd Tax Band
| |
| ~801,n,m | Details for 3rd Tax Band
| |
| ~801,n,m | Details for 4th Tax Band
| |
| ~805,"x" | (up to 160 characters) Layout String
|
Tax Tokens
| ~806,n,m | (1 character) Tax Band Indicator
| |
| ~807,n | (5 characters) Tax Percentage
| |
| ~808,n | (10 characters) Tax Band description
| |
| ~809,n | (10 characters) Amount Rated in this Tax Band
| |
| ~810,n | (10 characters) Amount of Tax Charged on the Amount Rated
| |
| ~811,n | (10 characters) Total Amount After Tax in this Band
|
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.
|
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 | 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 |
<<BOT-1
