Invoice/Credit Configuration - Logistics Management Document

From Catalyst
Revision as of 11:00, 13 September 2012 by ThrashBot (talk | contribs) (Updated from revision control)
Jump to: navigation, search

The Platinum System "Logistics Management" 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"

Layout Data File Names

The default layout files are stored in the 'sxco1\docs' folder, (or 'sxco2', 'sxco3', etc).

Invoice

'TI_PLA.INV'
Plain Paper
'TI_PRE.INV'
Pre-Printed
'TI_OWN.INV'
Own Brand
'TI_LET.INV'
Letter Head

Credit Note

'TI_PLA.CRE'
Plain Paper
'TI_PRE.CRE'
Pre-Printed
'TI_OWN.CRE'
Own Brand
'TI_LET.CRE'
Letter Head

Confirmation Note

'TI_PLA.CNF'
Plain Paper
'TI_PRE.CNF'
Pre-Printed
'TI_OWN.CNF'
Own Brand
'TI_LET.CNF'
Letter Head

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:

'SXTI018.EPL'
Invoice
'SXTI019.EPL'
Credit Note
'SXTI025.EPL'
Confirmation Note

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
n = 1 -> 5
The line of the address.
~3
(6 characters)
Account Code
~4,n Telephone Number
n = 0
(15 characters)
Telephone Number.
n = 1
(20 characters)
Mobile Number.
~5
(15 characters)
Fax Number
~6,n,m Account Notes Line
n = 1 -> 5
The line of the notes.
m = 0
(40 characters)
Print Notes information.
m = 1
(10 characters)
Print Notes prompt.
~7
(3 characters)
Page Number
~9,n
(8 characters)
Document Number
n = 0
Print in all cases.
n = 1
Blank if not in Heading.
~10,n Document Date
n = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
n = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~11,n
(40 characters)
Company Name
n = 1 -> 2
The line of the name.
~12,n
(50 characters)
Company Address
n = 1 -> 5
The line of the address.
~13,n
(one line)
Heading Line
n = 1 -> 2
Heading text.
~14,n
(one line)
Footing Line
n = 1 -> 3
Heading text.
~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 in self configuring block. See below.

~19
(10 characters)
Total: Amount Before Tax or Blanket Discount
~20
(10 characters)
Total: Blanket Discount Amount
~21
(10 characters)
Total: Pre Tax After Applied Blanket Discount
~22
(10 characters)
Total: Tax Amount
~23
(10 characters)
Total: Amount after Tax and Blanket Discounts
~24
(6 characters)
Blanket Discount Percentage
~27,n
(5 characters)
Percentage Charged at Tax Rate
n = 1 -> 4
The Tax Rate.
~28,n
(10 characters)
Description for Tax Rate
n = 1 -> 4
The Tax Rate.
~29,n
(10 characters)
Amount Taxed at Tax Rate
n = 1 -> 4
The Tax Rate.
~30,n
(10 characters)
Amount of Tax Charged at Tax Rate
n = 1 -> 4
The Tax Rate.
~31,n
(10 characters)
Amount after Tax at Tax Rate
n = 1 -> 4
The Tax Rate.
~32
(3 characters)
Total Number of Pages
~33
(6 characters)
Account Group
~35,n,"x" Settlement Discount Layout
n
The column number about which the text will be centered.
"x"
A line of descriptive text which may contain the following tokens (without padding spaces):
~36
(6 characters)
Settlement Discount Percentage
~37
(10 characters)
Settlement Discount Amount
~38
(3 characters)
Settlement Discount Period in Days
~39
(10 characters)
Prints the "Text Block 1" Prompt
~40
(10 characters)
Prints the "Text Block 2" Prompt
~41
(10 characters)
Prints the "Text Block 3" Prompt
~42
(10 characters)
Prints the "Quantity" Prompt
~43
(10 characters)
Prints the "Rate" Prompt
~44
(10 characters)
Prints the "Ticket Number" Prompt
~45,n
(5 characters)
Current Time
n = 0
(5 characters)
24 Hour format. e.g. 'HH:MM'.
n = 1
(7 characters)
am/pm format. e.g. 'HH:MMpm'.
~211
(10 characters)
Account Reference
~234
(30 characters)
Account V.A.T. Registration Number

Configuration Tokens

These affect the overall layout of the invoice/credit , and should be grouped together at the head of the layout file.

Document Blocks

The block information can either be supplied by you, in which case you should leave the parameters blank to begin with, and fill the values in when you are happy with the rest of the file; or the compiler can track the values down itself, which will marginally slow down the compilation process.

~101,n,m 1st Page Heading Block
n
Start Line (i.e. Line for '~200').
m
End Line (i.e. Line for '~299').
~102,n,m Continuation Page Heading Block
n
Start Line (i.e. Line for '~300').
m
End Line (i.e. Line for '~399').
~103,n,m Continued Page Footing Block
n
Start Line (i.e. Line for '~400').
m
End Line (i.e. Line for '~499').
~104,n,m Final Page Footing Block
n
Start Line (i.e. Line for '~500').
m
End Line (i.e. Line for '~599').

Document Configuration

~108,n,m,"x" Body Item Separator

This will print in the "Body Print Style".

n = 0 -> 512
Length of separator line.
m = 0 -> 512
Character offset from the left margin.
"x" = 0 -> 512
Separator Character. If given will override System Body Item Seperator. In any case will follow rules for System Separator.
~109,n Normal and Slip Body Style
n = 0
Standard.
n = 1
Condensed.
~112,n Heading Block
n => 1
The line to start printing.
~113,n,m Body Block
n
The line to start printing.
m
Depth (Number of lines to print).
~114,n Footing Block
n
The line to start printing.
~115,n Form Length
n
Number of Lines per Page.
~198 Currency conversion configuration
  • See Currency Conversions at the end of this article for more details.

Body Block

General Information

'~6nn,1,2,3,"4"' where '~6nn' represents an item, described below, which you wish to be printed in the invoice/credit body.

All have up to four parameters :-

Parm 1 - 'n'
Column Position across from the left of the page.
Parm 2 - 'm'
Not used.
Parm 3 - 'l'
Varies by Token.
Generally, for numeric tokens, which print by default to two decimal places.
  • '0' - Quantity : Trailing Zeroes are Stripped off. Currency : Zero figures are not printed.
  • '1' - Quantity : Trailing Zeroes are NOT Stripped. Currency : Zero figures are printed.
  • '2' - As '0', but allow 3 decimal places.
  • '3' - As '1', but allow 3 decimal places.
Parm 4 - 'x'
Optional. Varies by token. If used should be contained in quotes.

Body Tokens

~601,n
(10 characters)
Item Quantity
~602,n,m,l,k
(12 characters)
Nett Amount
k = 0
Total Nett
k = 1 -> 6
Nett for the corresponding cost centre (The '1' to '6' must be enclosed in Quotes).
~603,n
(12 characters)
Rate
~604,n,m,l,k
(12 characters)
Tax Amount
k = 0
Total Nett
k = 1 -> 6
Nett for the corresponding cost centre (The '1' to '6' must be enclosed in Quotes).
~605,n,m,l,k
(12 characters)
Amount after Tax
k = 0
Total Nett
k = 1 -> 6
Nett for the corresponding cost centre (The '1' to '6' must be enclosed in Quotes).
~606,n,m,l
(1 character)
Tax Band
l = 0
Prints A - D.
l = 1
Prints 1 - 4.
~607,n,m,l Item Date
l = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
l = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~608,n,m,l,k
(15 characters)
Ticket Number
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 3
The starting line to print from (The '1' to '3' must be enclosed in Quotes).
~609,n,m,l,k
(30 characters)
Text Block 1
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 5
The starting line to print from (The '1' to '5' must be enclosed in Quotes).
~610,n,m,l,k
(30 characters)
Text Block 2
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 5
The starting line to print from (The '1' to '5' must be enclosed in Quotes).
~611,n,m,l,k
(30 characters)
Text Block 3
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 5
The starting line to print from (The '1' to '5' must be enclosed in Quotes).
~612,n
(8 characters)
Driver
~613,n
(30 characters)
Driver Description
~614,n
(8 characters)
Vehicle
~615,n
(30 characters)
Vehicle Description
~616,n,m,l
(30 characters)
Text Block 1 Line
l = 1 -> 5
Line index.
~617,n,m,l
(30 characters)
Text Block 2 Line
l = 1 -> 5
Line index.
~618,n,m,l
(30 characters)
Text Block 3 Line
l = 1 -> 5
Line index.
~619,n,m,l
(3 characters)
Cost Centre
l = 0
Cost centre, blank for multiple.
l = 1 -> 6
Centre for the corresponding cost centre (The '1' to '6' must be enclosed in Quotes).
l = 9
List all centres used.
~620,n,m,l
(30 characters)
Cost Centre Description
l = 0
Cost centre description, blank for multiple.
l = 1 -> 6
Centre for the corresponding cost centre (The '1' to '6' must be enclosed in Quotes).
l = 9
List all centres used.
~621,n,m,l
(1 character)
Ticket Analysis Code
l = 0
The First Three Analysis Codes.
l = 1 -> 9
Analysis Code index.
~622,n,m,l
(15 characters)
Ticket Analysis Description
l = 1 -> 9
Analysis Description index.
~623,n
(2 characters)
Pallets
~624,n
(12 characters)
Weight
~625,n
(12 characters)
Volume
~626,n,m,l
(5 characters)
Percentage Tax Charged
l = 0
Prints in all cases.
l = 1
Does not print if set to not print on Slip Printouts.
~627,n,m,l
(15 characters)
Ticket Block Item
l = 1 -> 3
Line number.
~628,n,m,l,k
(30 characters)
Ticket Block Item
l = 1 -> 3
Block number.
k = 1 -> 5
Line number.
~629,n
(8 characters)
Trailer Reference
~630,n
(30 characters)
Trailer Description
~631,n
(10 characters)
Quantity Units
~632,n
(8 characters)
Load Reference
~633,n
(3 characters)
Area Reference
~634,n
(30 characters)
Area Description
~635,n
(8 characters)
Distance
~636,n
(2 characters)
Days
~637,n
(2 characters)
Half Pallets
~638,n
(2 characters)
Quarter Pallets
~639,n
(2 characters)
Blue Pallets
~640,n
(2 characters)
Over Size Pallets
~641,n
(3 characters)
Consignment Type
~642,n
(30 characters)
Consignment Type Description
~643,n
(3 characters)
Service
~644,n
(30 characters)
Service Description
~645,n
(3 characters)
Input Period
~646,n
(30 characters)
Input Period Description
~647,n,m,l,k Ticket Block Date
l = 1 -> 3
Block number.
k = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
k = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~648,n,m,l
(5 characters)
Text Block Time
l = 1 -> 3
Block number.
~649,n,m,l
(30 characters)
Text Block Contact
l = 1 -> 3
Block number.
~650,n
(20 characters)
Text Block Phone
~651,n
(5 characters)
Text Block Open
~652,n
(5 characters)
Text Block Close
~653,n
(10 characters)
Cost centre value
This token is only of use when listing centre information, this feature is best used when tokens '619' & '620' are used with parmameter 3 set to 9 to indicate that a list is required.
~654,n
(40 characters)
Cost centre detailed breakdown
This token is only of use when listing centre information, this feature is best used when tokens '619' & '620' are used with parmameter 3 set to 9 to indicate that a list is required.
~655,n
(12 characters)
Work Total
~656,n
(12 characters)
Extra Amount

Totals Block

General Information

'~7nn,1,2,"x",4,5' where '~7nn' = token number.

All have up to five parameters :-

Parm 1 - 'o'
Line from Top of Block to print on.
Parm 2 - 'n'
Column from Left of Block to print.
Parm 3 - 'x'
Up to 15 Character Description.
Parm 4 - 'm'
  • '0' - Description precedes Figures (default).
  • '1' - Description follows on from totals.
Parm 5 - 'l'
'0, 1 or 2' - Printing conditions.
In general, if items are configured to print one line after another, and "blanket discount" does not apply, then if Parm 5 for blanket discount amount is set to '0' then Blanket discount details will not be printed at all and the next line will shuffle up. If Parm 5 is set to '1' and no blanket discount applies then zeroes will be printed, and if it is set to 2 then a blank line will be printed.

Totals Tokens

Some tokens below are suppressed on Tax Inclusive documents if '~119' is included in the Configuration section.

~701,n,m,l
(25 characters)
Total Amount Before Tax or Blanket Discounts
~702,n,m,l,k,j
(25 characters)
Blanket Discount Amount

If the 'S99.99' is included in parameter 'l' it will be substituted with the percentage discount applied.

j = 0
Do not print when no Discount applies.
j = 1
Print even if no Discount applies.
j = 2
Print blank if no Discount applies.
~703,n,m,l,k,j
(25 characters)
Pre Tax Amount after Blanket Discount
j = 0
Do not print when no Discount applies.
j = 1
Print even if no Discount applies.
j = 2
Print blank if no Discount applies.
~704,n,m,l
(25 characters)
Total Tax Amount

Supressed on Tax Inclusive documents (see above).

~705,n,m,l
(25 characters)
Total Amount after Tax and Blanket Discount
~708,n,m
(25 characters)
"Equals" Lines

A line of '=' signs where the figures would go in the other cases.

~709,n,m,l,k,j
(25 characters)
Amount Charged at Tax Rate 1

If '99.99' is included in the description it will be substituted with the percentage Tax applied.

Supressed on Tax Inclusive documents (see above).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print blank if no Tax incurred.
~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).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print blank if no Tax incurred.
~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).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print Blank if no Tax incurred.
~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).

j = 0
Do not print when no Tax incurred at this rate.
j = 1
Print even if no Tax incurred.
j = 2
Print blank if no Tax incurred.
~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.

Tax Block

General Information

~801,n,m Details for 1st Tax Band
n
Line from Block Top.
m
Column from Block Left.
~801,n,m Details for 2nd Tax Band
n
Line from Block Top.
m
Column from Block Left.
~801,n,m Details for 3rd Tax Band
n
Line from Block Top.
m
Column from Block Left.
~801,n,m Details for 4th Tax Band
n
Line from Block Top.
m
Column from Block Left.
~805,"x"
(up to 160 characters)
Layout String
"x"
Up to 160 characters in length, defines how the text for each of the Four Tax bands will appear. Into this will be inserted variables appropriate to each Tax Band, withtheir positions in the string given by the parameter.

Tax Tokens

~806,n,m
(1 character)
Tax Band Indicator
n = 1 -> 4
Tax Index
m = 0
'A' to 'D'.
m = 1
'1' to '4'.
~807,n
(5 characters)
Tax Percentage
n = 1 -> 4
Tax Index
~808,n
(10 characters)
Tax Band description
n = 1 -> 4
Tax Index
~809,n
(10 characters)
Amount Rated in this Tax Band
n = 1 -> 4
Tax Index
~810,n
(10 characters)
Amount of Tax Charged on the Amount Rated
n = 1 -> 4
Tax Index
~811,n
(10 characters)
Total Amount After Tax in this Band
n = 1 -> 4
Tax Index

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

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 invoice/credit 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 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,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.

~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

Retrieved from "https://www.catalyst-uk-support.com/kb/index.php?title=Invoice/Credit_Configuration_-_Logistics_Management_Document&oldid=12776"