Difference between revisions of "Document Configuration - Stock Control Document"
(Updated from revision control) |
(Updated from revision control) |
||
(25 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | The Platinum System | + | The Platinum System {{Menu|Stock Control}} allows the layout of your Invoices and Credits, Quotations and Advice Notes 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. |
In addition, Receipts printed for Deposits received are configurable in the same fashion. Some tokens are obviously not applicable, such as delivery address, which is not entered as a detail of a deposit, while any Customer Details are applicable and may be printed if desired. | In addition, Receipts printed for Deposits received are configurable in the same fashion. Some tokens are obviously not applicable, such as delivery address, which is not entered as a detail of a deposit, while any Customer Details are applicable and may be printed if desired. | ||
== Layout Data File Names == | == Layout Data File Names == | ||
− | The | + | The layout files are stored in the {{FilePath|SXCo1\Docs}} folder, (or {{FilePath|SXCo2}}, {{FilePath|SXCo3}}, etc). |
=== Invoice === | === Invoice === | ||
Line 56: | Line 56: | ||
=== Deposit Receipt === | === Deposit Receipt === | ||
;{{FilePath|ST_PLA.REC}} | ;{{FilePath|ST_PLA.REC}} | ||
+ | :Plain Paper | ||
+ | === Picking List === | ||
+ | ;{{FilePath|ST_PLA.PCK}} | ||
:Plain Paper | :Plain Paper | ||
== Token File Names == | == Token File Names == | ||
Line 72: | Line 75: | ||
;{{FilePath|SXST049.EPL}} | ;{{FilePath|SXST049.EPL}} | ||
:Deposit Receipt | :Deposit Receipt | ||
+ | ;{{FilePath|SXST050.EPL}} | ||
+ | :Picking List | ||
== Layout Tokens == | == Layout Tokens == | ||
− | Tokens are indicated by the character {{DataValue|~}} followed by a number (the token identifier). | + | Tokens are indicated by the character {{DataValue|<nowiki>~</nowiki>}} 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. | 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. | ||
Line 170: | Line 175: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~4''',n | | '''~4''',n | ||
− | | '''Telephone Number''' | + | | '''Telephone Number/Email Address''' |
;n = 0 | ;n = 0 | ||
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number. | :<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number. | ||
;n = 1 | ;n = 1 | ||
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number. | :<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number. | ||
+ | ;n = 2 | ||
+ | :<div style="float:right; margin-left:1em; font-style:italic;">(60 characters)</div>Email Address. | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~5''' | | '''~5''' | ||
Line 264: | Line 271: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total: Amount Outstanding after Payment''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total: Amount Outstanding after Payment''' | ||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~27''' | + | | '''~27''' |
| <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Percentage Charged at Tax Rate''' | | <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Percentage Charged at Tax Rate''' | ||
− | |||
− | |||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~28''' | + | | '''~28''' |
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Description for Tax Rate''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Description for Tax Rate''' | ||
− | |||
− | |||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~29''' | + | | '''~29''' |
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount Taxed at Tax Rate''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount Taxed at Tax Rate''' | ||
− | |||
− | |||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~30''' | + | | '''~30''' |
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount of Tax Charged at Tax Rate''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount of Tax Charged at Tax Rate''' | ||
− | |||
− | |||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~31''' | + | | '''~31''' |
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount after Tax at Tax Rate''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount after Tax at Tax Rate''' | ||
− | |||
− | |||
|- valign="baseline" | |- valign="baseline" | ||
| '''~32''' | | '''~32''' | ||
Line 343: | Line 340: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~44''',n | | '''~44''',n | ||
− | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Delivery | + | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Delivery Addresses''' |
− | ;n = 1 -> | + | ;n = 1 -> 5 |
:The line of the address. | :The line of the address. | ||
|- valign="baseline" | |- valign="baseline" | ||
Line 461: | Line 458: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Deposit Reference''' | | <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Deposit Reference''' | ||
{{Information|iconsize=small|text= | {{Information|iconsize=small|text= | ||
− | Requires | + | Requires {{Menu|Order Processing}}. |
}} | }} | ||
Line 468: | Line 465: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Order No''' | | <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Order No''' | ||
{{Information|iconsize=small|text= | {{Information|iconsize=small|text= | ||
− | Requires | + | Requires {{Menu|Order Processing}}. |
}} | }} | ||
Line 478: | Line 475: | ||
| '''~69''' | | '''~69''' | ||
| '''Skip block until next ~69''' | | '''Skip block until next ~69''' | ||
− | Print Spaces if the Platinum | + | Print Spaces if the Platinum {{Menu|Order Processing}} Module is not installed. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~70''',n | | '''~70''',n | ||
Line 502: | Line 499: | ||
| '''~213''',n | | '''~213''',n | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Account Analysis Code''' | | <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Account Analysis Code''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 9 |
:Analysis Code index. | :Analysis Code index. | ||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~214''',n | + | | '''~214''',n,m |
− | | | + | | '''Account Analysis Description''' |
− | ;n = 1 -> | + | ;n = 1 -> 9 |
:Analysis Description index. | :Analysis Description index. | ||
+ | ;m = 0 | ||
+ | :<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>First 15 characters of description. | ||
+ | ;m = >0 | ||
+ | :<div style="float:right; margin-left:1em; font-style:italic;">(Up to 30)</div>The full description. | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~215''',n | | '''~215''',n | ||
Line 551: | Line 552: | ||
| '''~238''' | | '''~238''' | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Status Description''' | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Status Description''' | ||
+ | |- valign="baseline" | ||
+ | | '''~241''' | ||
+ | | '''Skip block until next ~241''' | ||
+ | Print Spaces if there has been no loyalty card used for the document. | ||
+ | |- valign="baseline" | ||
+ | | '''~242''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Loyalty Points Earned''' | ||
+ | The number of loyalty points that have been earned from this document. | ||
+ | |- valign="baseline" | ||
+ | | '''~243''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Loyalty Points Currently On Card''' | ||
+ | The number of points that were on the loyalty card before this document. | ||
+ | |- valign="baseline" | ||
+ | | '''~244''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Loyalty Points Projected On Card''' | ||
+ | The number of points that will be on the loyalty card when the points earned from this document become available to be redemmed. | ||
+ | |- valign="baseline" | ||
+ | | '''~245''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(24 characters)</div>'''Loyalty Card Reference (with leading characters)''' | ||
+ | |- valign="baseline" | ||
+ | | '''~246''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>'''Loyalty Card Reference (without leading characters)''' | ||
+ | |- valign="baseline" | ||
+ | | '''~248''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Incoterm''' | ||
+ | |- valign="baseline" | ||
+ | | '''~249''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(17 characters)</div>'''EORI Number''' | ||
+ | |- valign="baseline" | ||
+ | | '''~255''',"x" | ||
+ | | '''Skip block until next ~255''' | ||
+ | Print spaces if the account does not have the given account attribute set. | ||
+ | ;"x" | ||
+ | :The code of the account attribute which must be set in order to print content. | ||
+ | |- valign="baseline" | ||
+ | | '''~256''',n,"x",m | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Attribute''' | ||
+ | Print an account attribute code or description. | ||
+ | ;n | ||
+ | :The index of the account attribute category to print. For example, entering {{DataValue|1}} here would print the first attribute from the given category. | ||
+ | ;"x" | ||
+ | :The attribute category from which the acccount attribute to print is located. | ||
+ | ;m = 0 | ||
+ | :Print the attribute code | ||
+ | ;m = 1 -> 30 | ||
+ | :The number of characters to print from the attribute description. | ||
+ | |- valign="baseline" | ||
+ | | '''~401''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(80 characters)</div>'''Top Left hand corner of Credit Charge Text Block''' | ||
+ | The Credit Charge Text Block is defined in {{Menu|Reports & Settings|Maintenance Options|System Administrator|Credit Charge Settings}} and configures itself according to the details of the current document. | ||
+ | |- valign="baseline" | ||
+ | | '''~402''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total: Amount of any Credit Charge Applicable to the Current Document.''' | ||
+ | |- valign="baseline" | ||
+ | | '''~403''' | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total: Gross total for the current document, plus any applicable Credit Charge.''' | ||
|} | |} | ||
=== Configuration Tokens === | === Configuration Tokens === | ||
Line 680: | Line 737: | ||
{{Information|iconsize=small|text= | {{Information|iconsize=small|text= | ||
− | Requires | + | Requires {{Menu|Order Processing}}. |
}} | }} | ||
Line 689: | Line 746: | ||
;m | ;m | ||
:Column position for "Following Items on Backorder :-" text. | :Column position for "Following Items on Backorder :-" text. | ||
+ | |- valign="baseline" | ||
+ | | '''~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. | ||
+ | |||
+ | {{Note|text= | ||
+ | This depends on having the {{Menu|Sales Ledger}} module issued. | ||
+ | }} | ||
+ | |||
|- valign="baseline" | |- valign="baseline" | ||
| '''~119''',n | | '''~119''',n | ||
− | | ''' | + | | '''V.A.T. Inclusive document configuration''' |
;n = 0 | ;n = 0 | ||
− | :Stops {{DataValue| | + | :Stops {{DataValue|V.A.T. Inclusive}} Invoices printing Tax & Grand Total items in the {{DataValue|~700}} -> {{DataValue|~799}} Totals Block, as these can look confusing. |
− | :If a Blanket Discount applies, Grand Total will still be printed to reflect | + | :If a Blanket Discount applies, Grand Total will still be printed to reflect this. |
;n = 1 | ;n = 1 | ||
− | :Splits {{DataValue| | + | :Splits {{DataValue|V.A.T. Inclusive}} documents into Nett and V.A.T. values, to emulate the appearance of a non {{DataValue|V.A.T. Inclusive}} document. |
{{Note|text= | {{Note|text= | ||
− | The | + | The {{Menu|Point of Sale}} presents values as {{DataValue|V.A.T. Inclusive}} so this directive may be of use when configuring a full invoice format to appear the same from either {{Menu|Point of Sale}} or {{Menu|Invoicing & Customer Orders}}, for example. |
}} | }} | ||
Line 708: | Line 776: | ||
=== Body Block === | === Body Block === | ||
==== General Information ==== | ==== General Information ==== | ||
− | {{DataValue|~6nn,1,2,3,"4",5}} where {{DataValue|~6nn}} represents an item, described below, which you wish to be printed in the document body. | + | {{DataValue|~6nn,1,2,3,"4",5,6,"7"}} where {{DataValue|~6nn}} represents an item, described below, which you wish to be printed in the document body. |
− | All have up to | + | All have up to seven parameters :- |
;Parm 1 - 'n' | ;Parm 1 - 'n' | ||
Line 717: | Line 785: | ||
:Unused. (Used by other Systems, but should be set to {{DataValue|0}} here if a third parameter is used). | :Unused. (Used by other Systems, but should be set to {{DataValue|0}} here if a third parameter is used). | ||
;Parm 3 - 'l' | ;Parm 3 - 'l' | ||
− | :Varies by Token. If not used, and | + | :Varies by Token. If not used, and parm 4 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,,"4",5. |
:Generally, for numeric tokens, which print by default to two decimal places. | :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. | :*'0' - Quantity : Trailing Zeroes are Stripped off. Currency : Zero figures are not printed. | ||
Line 727: | Line 795: | ||
;Parm 5 - 'k' | ;Parm 5 - 'k' | ||
:Column, when {{DataValue|~105}} is used. See above. Up to 10 columns are allowed, limited by the "col" parameter after {{DataValue|~105}}. If the body token is to refer to the line total, or main text item, then this parameter should be {{DataValue|0}} (the default). If it is to refer to the value for a specific column then it should be given the value 1 - 10. | :Column, when {{DataValue|~105}} is used. See above. Up to 10 columns are allowed, limited by the "col" parameter after {{DataValue|~105}}. If the body token is to refer to the line total, or main text item, then this parameter should be {{DataValue|0}} (the default). If it is to refer to the value for a specific column then it should be given the value 1 - 10. | ||
+ | ;Parm 6 - 'j' | ||
+ | :Varies by Token. If not used, and parms 7 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,3,"4",5,,"7". | ||
+ | ;Parm 7 - 'w' | ||
+ | :Optional. Varies by token. If used should be contained in quotes. | ||
==== Body Tokens ==== | ==== Body Tokens ==== | ||
{| cellspacing="5" width="95%" valign="baseline" | {| cellspacing="5" width="95%" valign="baseline" | ||
Line 734: | Line 806: | ||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~601''',n | + | | '''~601''',n,m,l,k,j |
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Item Quantity''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Item Quantity''' | ||
|- valign="baseline" | |- valign="baseline" | ||
Line 756: | Line 828: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Tax Band''' | | <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Tax Band''' | ||
;l = 0 | ;l = 0 | ||
− | :Prints A - | + | :Prints A - I. |
;l = 1 | ;l = 1 | ||
− | :Prints 1 - | + | :Prints 1 - 9. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~607''',n,m,l | | '''~607''',n,m,l | ||
Line 830: | Line 902: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Quantity on Backorder''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Quantity on Backorder''' | ||
{{Information|iconsize=small|text= | {{Information|iconsize=small|text= | ||
− | Requires | + | Requires {{Menu|Order Processing}}. |
}} | }} | ||
Line 859: | Line 931: | ||
;l = 1 | ;l = 1 | ||
:Does not print if set to not print on Slip Printouts. | :Does not print if set to not print on Slip Printouts. | ||
+ | |- valign="baseline" | ||
+ | | '''~630''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Stock Analysis Description''' | ||
+ | ;l = 1 -> 3 | ||
+ | :Analysis Description index. | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~639''',n,m,l | | '''~639''',n,m,l | ||
Line 887: | Line 964: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Quantity on Purchase Order''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Quantity on Purchase Order''' | ||
{{Information|iconsize=small|text= | {{Information|iconsize=small|text= | ||
− | Requires | + | Requires {{Menu|Order Processing}}. |
}} | }} | ||
Line 894: | Line 971: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Quantity on Sales Order''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Quantity on Sales Order''' | ||
{{Information|iconsize=small|text= | {{Information|iconsize=small|text= | ||
− | Requires | + | Requires {{Menu|Order Processing}}. |
}} | }} | ||
+ | |- valign="baseline" | ||
+ | | '''~656''',n,m,l,"x",k,j,"y" | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Stock Attribute''' | ||
+ | Print a stock attribute code or description. | ||
+ | ;l | ||
+ | :The index of the stock attribute category to print. For example, entering {{DataValue|1}} here would print the first attribute from the given category. | ||
+ | ;"x" | ||
+ | :The attribute category from which the stock attribute to print is located. | ||
+ | ;j = 0 | ||
+ | :Print the attribute code | ||
+ | ;j = 1 -> 30 | ||
+ | :The number of characters to print from the attribute description. | ||
+ | ;"y" | ||
+ | :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" | ||
+ | | '''~657''',n,m,l,"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. | ||
+ | ;l = 0 | ||
+ | :Print the country code | ||
+ | ;l = 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,m,l,"x" | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Commodity Code''' | ||
+ | Print a commodity code. | ||
+ | ;l | ||
+ | :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. | ||
|} | |} | ||
+ | ==== Batch Information in Item Descriptions ==== | ||
+ | When a "Batched" stock item is booked out of stock, and batch information assigned, either manually or automatically if the system can identify the batch without prompting, the assigned "Batch No:" will be inserted into the first blank line of the item's description for this document. This information will then be printed as part of the item's description on printouts produced subsequently such as any advice note or invoice. | ||
+ | |||
+ | This depends on the item having at least one blank line of description, and on the document being printed ''after'' the item is booked out of stock. | ||
+ | |||
=== Totals Block === | === Totals Block === | ||
==== General Information ==== | ==== General Information ==== | ||
Line 948: | Line 1,062: | ||
| '''~704''',n,m,l | | '''~704''',n,m,l | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Total Tax Amount''' | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Total Tax Amount''' | ||
− | + | Superseded on Tax Inclusive documents (see above). | |
|- valign="baseline" | |- valign="baseline" | ||
| '''~705''',n,m,l | | '''~705''',n,m,l | ||
Line 964: | Line 1,078: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~709''',n,m,l,k,j | | '''~709''',n,m,l,k,j | ||
− | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at Tax Rate | + | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at 1st Tax Rate''' |
If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | ||
− | + | Superseded on Tax Inclusive documents (see above). | |
;j = 0 | ;j = 0 | ||
Line 977: | Line 1,091: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~710''',n,m,l,k,j | | '''~710''',n,m,l,k,j | ||
− | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at Tax Rate | + | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at 2nd Tax Rate''' |
If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | ||
− | + | Superseded on Tax Inclusive documents (see above). | |
;j = 0 | ;j = 0 | ||
Line 990: | Line 1,104: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~711''',n,m,l,k,j | | '''~711''',n,m,l,k,j | ||
− | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at Tax Rate | + | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at 3rd Tax Rate''' |
If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | ||
− | + | Superseded on Tax Inclusive documents (see above). | |
;j = 0 | ;j = 0 | ||
Line 1,003: | Line 1,117: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~712''',n,m,l,k,j | | '''~712''',n,m,l,k,j | ||
− | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at Tax Rate | + | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Amount Charged at 4th Tax Rate''' |
If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | If {{DataValue|99.99}} is included in the description it will be substituted with the percentage Tax applied. | ||
− | + | Superseded on Tax Inclusive documents (see above). | |
;j = 0 | ;j = 0 | ||
Line 1,017: | Line 1,131: | ||
| '''~713''',n,m,"x",l,k | | '''~713''',n,m,"x",l,k | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Tendered Amounts Breakdown''' | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Tendered Amounts Breakdown''' | ||
− | Prints a line for each | + | Prints a line for each sales centre with a payment posted to it. |
;"x" | ;"x" | ||
− | :When left blank, and the | + | :When left blank, and the centre description will be printed trimmed to the first 13 characters. |
− | ;k = | + | ;k = 1 -> 12 |
− | : | + | :The payment number. |
− | ;k = | + | ;k = 12 |
− | : | + | :Prepaid deposits. |
− | ;k = | + | ;k = 13 |
− | : | + | :Payment from redeemed loyalty points. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~714''',n,m,l,k,j | | '''~714''',n,m,l,k,j | ||
Line 1,051: | Line 1,165: | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~717''',n,m,l | | '''~717''',n,m,l | ||
− | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Total Amount | + | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Total Amount Tendered''' |
|- valign="baseline" | |- valign="baseline" | ||
| '''~718''',n,m,l | | '''~718''',n,m,l | ||
Line 1,058: | Line 1,172: | ||
| '''~719''',n,m,l | | '''~719''',n,m,l | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Account Balance including current Document''' | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Account Balance including current Document''' | ||
+ | |- valign="baseline" | ||
+ | | '''~720''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Credit Charge applicable to the current Document, if the Credit Charge is calculated on the Nett.''' | ||
+ | |- valign="baseline" | ||
+ | | '''~721''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Credit Charge applicable to the current Document, if the Credit Charge is calculated on the Gross.''' | ||
+ | |- valign="baseline" | ||
+ | | '''~722''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Gross total for the current Document plus any applicable Credit Charge.''' | ||
+ | |- valign="baseline" | ||
+ | | '''~723''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Nett Total after Settlement Discount, if a Settlement Discount applies.''' | ||
+ | |- valign="baseline" | ||
+ | | '''~724''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''V.A.T. Total after Settlement Discount, if a Settlement Discount applies.''' | ||
+ | |- valign="baseline" | ||
+ | | '''~725''',n,m,l | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Gross Total after Settlement Discount, if a Settlement Discount applies.''' | ||
|} | |} | ||
=== Tax Block === | === Tax Block === | ||
Line 1,074: | Line 1,206: | ||
:Column from Block Left. | :Column from Block Left. | ||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~ | + | | '''~802''',n,m |
| '''Details for 2nd Tax Band''' | | '''Details for 2nd Tax Band''' | ||
;n | ;n | ||
Line 1,081: | Line 1,213: | ||
:Column from Block Left. | :Column from Block Left. | ||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~ | + | | '''~803''',n,m |
| '''Details for 3rd Tax Band''' | | '''Details for 3rd Tax Band''' | ||
;n | ;n | ||
Line 1,088: | Line 1,220: | ||
:Column from Block Left. | :Column from Block Left. | ||
|- valign="baseline" | |- valign="baseline" | ||
− | | '''~ | + | | '''~804''',n,m |
| '''Details for 4th Tax Band''' | | '''Details for 4th Tax Band''' | ||
;n | ;n | ||
Line 1,098: | Line 1,230: | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(up to 160 characters)</div>'''Layout String''' | | <div style="float:right; margin-left:1em; font-style:italic;">(up to 160 characters)</div>'''Layout String''' | ||
;"x" | ;"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, | + | :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, with their positions in the string given by each token's first parameter as detailed below. |
|} | |} | ||
==== Tax Tokens ==== | ==== Tax Tokens ==== | ||
Line 1,109: | Line 1,241: | ||
| '''~806''',n,m | | '''~806''',n,m | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Tax Band Indicator''' | | <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Tax Band Indicator''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 160 |
− | : | + | :Position across from left of layout string ~805 at which to insert. |
;m = 0 | ;m = 0 | ||
− | : | + | :Prints A - I. |
;m = 1 | ;m = 1 | ||
− | : | + | :Prints 1 - 9. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~807''',n | | '''~807''',n | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Tax Percentage''' | | <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Tax Percentage''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 160 |
− | : | + | :Position across from left of layout string ~805 at which to insert. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~808''',n | | '''~808''',n | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Tax Band description''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Tax Band description''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 160 |
− | : | + | :Position across from left of layout string ~805 at which to insert. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~809''',n | | '''~809''',n | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount Rated in this Tax Band''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount Rated in this Tax Band''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 160 |
− | : | + | :Position across from left of layout string ~805 at which to insert. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~810''',n | | '''~810''',n | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount of Tax Charged on the Amount Rated''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Amount of Tax Charged on the Amount Rated''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 160 |
− | : | + | :Position across from left of layout string ~805 at which to insert. |
|- valign="baseline" | |- valign="baseline" | ||
| '''~811''',n | | '''~811''',n | ||
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total Amount After Tax in this Band''' | | <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total Amount After Tax in this Band''' | ||
− | ;n = 1 -> | + | ;n = 1 -> 160 |
− | : | + | :Position across from left of layout string ~805 at which to insert. |
|} | |} | ||
=== Print Style Tokens === | === Print Style Tokens === | ||
Line 1,181: | Line 1,313: | ||
=== Currency Conversions === | === Currency Conversions === | ||
{{Information|text= | {{Information|text= | ||
− | ''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 | + | ''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 [https://www.catalyst-uk.com/sales website] sales contact page for your upgrade path. |
}} | }} | ||
Line 1,195: | Line 1,327: | ||
{{Example|text= | {{Example|text= | ||
− | Some examples using {{DataValue|~29,1}} amount taxed at tax rate | + | Some examples using {{DataValue|~29,1}} amount taxed at first tax rate. Note that {{DataValue|~29}} may not represent an amount in all document formats. This is just an example. |
;~29,1 | ;~29,1 | ||
Line 1,208: | Line 1,340: | ||
;~29$USD,1 | ;~29$USD,1 | ||
:convert to currency USD (US Dollar) | :convert to currency USD (US Dollar) | ||
− | :{{DataValue|$234. | + | :{{DataValue|$234.02}} |
+ | ;~29$USD(02),1 | ||
+ | :convert to currency USD (US Dollar) and target to whole dollar units if within 2 cents. This feature is useful if you want to display values with the cents/pennies rounded away. For example if displaying in dollars then the number in brackets represents the maximum number of cents over or under a dollar within which the conversion will target to a whole dollar. For 02 within the brackets then $1.98, $1.99, $2.00, $2.01, $2.02 will all display as $2.00. | ||
+ | :{{DataValue|$234.00}} | ||
;~29#12USD,1 | ;~29#12USD,1 | ||
:same, but suppress the symbol and print to a width of 12 | :same, but suppress the symbol and print to a width of 12 | ||
Line 1,226: | Line 1,361: | ||
| '''x = Default currency modifier (optional)''' | | '''x = Default currency modifier (optional)''' | ||
|} | |} | ||
− | ==== Currency Tokens ==== | + | ==== Country/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. | + | 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. |
{| cellspacing="5" width="95%" valign="baseline" | {| cellspacing="5" width="95%" valign="baseline" | ||
Line 1,234: | Line 1,369: | ||
!| | !| | ||
+ | |- valign="baseline" | ||
+ | | '''~292''',n | ||
+ | | <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''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. | ||
+ | ;n = 0 | ||
+ | :Output the country code. | ||
+ | ;n = 1 | ||
+ | :<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Output the country description. | ||
|- valign="baseline" | |- valign="baseline" | ||
| '''~293''' | | '''~293''' | ||
Line 1,254: | Line 1,397: | ||
Should be used in pairs on a line. Everything between them is blanked out if there is no currency set for this account | Should be used in pairs on a line. Everything between them is blanked out if there is no currency set for this account | ||
|} | |} | ||
− | {{KB_Tags|Layout, Token, Format, Document, Setup, Config, Configuration, Invoice, Credit, Currency, Deposits, Slip, Receipt}}[[Category:Stock Control Documents]] | + | {{KB_Tags|Layout, Token, Format, Document, Setup, Config, Configuration, Invoice, Credit, Currency, Deposits, Slip, Receipt}}[[Category:Documents]][[Category:Stock Control Documents]] |
Latest revision as of 14:05, 8 July 2024
The Platinum System " Stock Control" allows the layout of your Invoices and Credits, Quotations and Advice Notes 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.
In addition, Receipts printed for Deposits received are configurable in the same fashion. Some tokens are obviously not applicable, such as delivery address, which is not entered as a detail of a deposit, while any Customer Details are applicable and may be printed if desired.
Contents
Layout Data File Names
The layout files are stored in the 'SXCo1\Docs' folder, (or 'SXCo2', 'SXCo3', etc).
Invoice
- 'ST_PLAWN.INV'
- Plain Paper (Windows Version)
- 'ST_PLA.INV'
- Plain Paper
- 'ST_PRE.INV'
- Pre-Printed
- 'ST_OWN.INV'
- Own Brand
- 'ST_LET.INV'
- Letter Head
Credit Note
- 'ST_PLAWN.CRE'
- Plain Paper (Windows Version)
- 'ST_PLA.CRE'
- Plain Paper
- 'ST_PRE.CRE'
- Pre-Printed
- 'ST_OWN.CRE'
- Own Brand
- 'ST_LET.CRE'
- Letter Head
Slip Printout
- 'ST_PLA.SLI'
- Plain Paper
Quotation
- 'ST_PLAWN.QUO'
- Plain Paper (Windows Version)
- 'ST_PLA.QUO'
- Plain Paper
- 'ST_PRE.QUO'
- Pre-Printed
- 'ST_OWN.QUO'
- Own Brand
- 'ST_LET.QUO'
- Letter Head
Advice Note
- 'ST_PLAWN.ADV'
- Plain Paper (Windows Version)
- 'ST_PLA.ADV'
- Plain Paper
- 'ST_PRE.ADV'
- Pre-Printed
- 'ST_OWN.ADV'
- Own Brand
- 'ST_LET.ADV'
- Letter Head
Deposit Receipt
- 'ST_PLA.REC'
- Plain Paper
Picking List
- 'ST_PLA.PCK'
- Plain Paper
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:
- 'SXST040.EPL'
- Invoice
- 'SXST041.EPL'
- Credit Note
- 'SXST042.EPL'
- Slip Printout
- 'SXST043.EPL'
- Quotation/Pro-Forma
- 'SXST044.EPL'
- Advice Note
- 'SXST049.EPL'
- Deposit Receipt
- 'SXST050.EPL'
- Picking List
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".
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,n | (30 characters) Account Name
| |||||||||
~2,n | (30 characters) Account Address Line
| |||||||||
~3,n | (6 characters) Account Code
| |||||||||
~4,n | Telephone Number/Email Address
| |||||||||
~5 | (15 characters) Fax Number
| |||||||||
~6,n,m | Account Notes Line
| |||||||||
~7 | (3 characters) Page Number
| |||||||||
~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 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
| |||||||||
~25 | (10 characters) Total: Amount Paid
| |||||||||
~26 | (10 characters) Total: Amount Outstanding after Payment
| |||||||||
~27 | (5 characters) Percentage Charged at Tax Rate
| |||||||||
~28 | (10 characters) Description for Tax Rate
| |||||||||
~29 | (10 characters) Amount Taxed at Tax Rate
| |||||||||
~30 | (10 characters) Amount of Tax Charged at Tax Rate
| |||||||||
~31 | (10 characters) Amount after Tax at Tax Rate
| |||||||||
~32 | (3 characters) Total Number of Pages
| |||||||||
~33 | (6 characters) Account Group
| |||||||||
~34 | (10 characters) Account Balance (including current document)
| |||||||||
~35,n,"x" | Settlement Discount Layout
| |||||||||
~39,n,"x" | Payments Tendered Layout
| |||||||||
~44,n | (30 characters) Delivery Addresses
| |||||||||
~45,n | (5 characters) Current Time
| |||||||||
~46,n | (15 characters) Additional Invoice Prompt
| |||||||||
~47,n | (30 characters) Additional Invoice Text
| |||||||||
~48 | (3 characters) Print Line in Slip Print Account Style
| |||||||||
~49 | (3 characters) Print Line in Slip Print Document & Date Style
| |||||||||
~50 | (3 characters) Print Line in Slip Print Body Separator Style
| |||||||||
~51 | (3 characters) Print Line in Slip Print Totals Style
| |||||||||
~52 | (3 characters) Print Line in Slip Print Grand Total Style
| |||||||||
~53 | (3 characters) Print Line in Slip Print Column Description Style
| |||||||||
~54 | (3 characters) Slip Print "Form Feed"
| |||||||||
~55,n | (6 characters) Prints the (Country Determined) word for Tax
| |||||||||
~56 | (3 characters) Do not print this line if blank
| |||||||||
~57 | Skip block until next ~57
Print Spaces if all Items have a date equal to the User Date (e.g. headings.). | |||||||||
~58 | Skip block until next ~58
Print Spaces if no Items have an individual discount applied (e.g. headings.). | |||||||||
~59 | Skip block until next ~59
Print Spaces if "Advice Note" and "Prices/Totals" not required. | |||||||||
~61 | (8 characters) User/Group Name
| |||||||||
~62 | (10 characters) Total Weight
Excludes Backorder Items. Requires '~118' in the Configuration Section. | |||||||||
~63 | (10 characters) Total Volume
Excludes Backorder Items. Requires '~118' in the Configuration Section. | |||||||||
~64 | (10 characters) Carriage Amount
| |||||||||
~65,n,m | (30 characters) Deposit Description
| |||||||||
~66 | (8 characters) Deposit Reference
| |||||||||
~66 | (8 characters) Order No
| |||||||||
~68 | Skip block until next ~68
Print Spaces if there are no items to print in the document body. e.g. Deposit not attached to any specific order items. | |||||||||
~69 | Skip block until next ~69
Print Spaces if the Platinum " Order Processing" Module is not installed. | |||||||||
~70,n | ~70,n
| |||||||||
~71 | (10 characters) Total Amount Paid (including change)
| |||||||||
~72 | (10 characters) Change Given
| |||||||||
~211 | (10 characters) Account Reference
| |||||||||
~213,n | (1 character) Account Analysis Code
| |||||||||
~214,n,m | Account Analysis Description
| |||||||||
~215,n | (60 characters) Account Extra Notes
| |||||||||
~216 | Skip block until next ~216
Print Spaces if a Credit Card Transaction is not involved. | |||||||||
~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
| |||||||||
~224 | (15 characters) Transaction Comment
| |||||||||
~234 | (30 characters) Account V.A.T. Registration Number
| |||||||||
~237 | (3 characters) Account Status
| |||||||||
~238 | (30 characters) Account Status Description
| |||||||||
~241 | Skip block until next ~241
Print Spaces if there has been no loyalty card used for the document. | |||||||||
~242 | (8 characters) Loyalty Points Earned
The number of loyalty points that have been earned from this document. | |||||||||
~243 | (8 characters) Loyalty Points Currently On Card
The number of points that were on the loyalty card before this document. | |||||||||
~244 | (8 characters) Loyalty Points Projected On Card
The number of points that will be on the loyalty card when the points earned from this document become available to be redemmed. | |||||||||
~245 | (24 characters) Loyalty Card Reference (with leading characters)
| |||||||||
~246 | (20 characters) Loyalty Card Reference (without leading characters)
| |||||||||
~248 | (3 characters) Incoterm
| |||||||||
~249 | (17 characters) EORI Number
| |||||||||
~255,"x" | Skip block until next ~255
Print spaces if the account does not have the given account attribute set.
| |||||||||
~256,n,"x",m | (30 characters) Account Attribute
Print an account attribute code or description.
| |||||||||
~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.
|
Configuration Tokens
These affect the overall layout of the Invoice, 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
| |
~102,n,m | Continuation Page Heading Block
| |
~103,n,m | Continued Page Footing Block
| |
~104,n,m | Final Page Footing Block
|
Document Configuration
~105,n,m,l | Enables grouping of multiple Stock Codes
Enables grouping of multiple Stock Codes into single lines on the document. The parameter 'n' is the number of characters at the start of the code which must be identical for the codes to be grouped. parameter 'm' is the number of characters following these parameter 'n' characters which must be identical in order for the items to occupy one "column". parameter 'l' is the number of "columns" allowed per line.. | ||||
~109,n | Normal and Slip Body Style
| ||||
~110,n | Freetype Text Print Style
| ||||
~111,n | Line Skip
| ||||
~112,n | Heading Block
| ||||
~113,n,m | Body Block
| ||||
~114,n | Footing Block
| ||||
~115,n | Form Length
| ||||
~116,n | Carriage Amount
| ||||
~117,n,m | Backorder Printing
Prints a section after the Invoice Items consisting of Items on backorder for the current account, using the same line layout as for the Invoice Items.
| ||||
~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.
| ||||
~119,n | V.A.T. Inclusive document configuration
| ||||
~198 | Currency conversion configuration
|
Body Block
General Information
'~6nn,1,2,3,"4",5,6,"7"' where '~6nn' represents an item, described below, which you wish to be printed in the document body.
All have up to seven parameters :-
- Parm 1 - 'n'
- Column Position across from the left of the page.
- Parm 2 - 'm'
- Unused. (Used by other Systems, but should be set to '0' here if a third parameter is used).
- Parm 3 - 'l'
- Varies by Token. If not used, and parm 4 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,,"4",5.
- 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. If not used and parm 5 or above required, should be skipped in the same way as parm 3. i.e. ~6nn,1,2,3,,5
- Parm 5 - 'k'
- Column, when '~105' is used. See above. Up to 10 columns are allowed, limited by the "col" parameter after '~105'. If the body token is to refer to the line total, or main text item, then this parameter should be '0' (the default). If it is to refer to the value for a specific column then it should be given the value 1 - 10.
- Parm 6 - 'j'
- Varies by Token. If not used, and parms 7 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,3,"4",5,,"7".
- Parm 7 - 'w'
- Optional. Varies by token. If used should be contained in quotes.
Body Tokens
~601,n,m,l,k,j | (10 characters) Item Quantity
| ||
~602,n,m,l,"x" | Nett Amount
| ||
~603,n,m,l | (10 characters) Unit Price
| ||
~604,n | (10 characters) Tax Amount
| ||
~605,n | (10 characters) Amount after Tax
| ||
~606,n,m,l | (1 character) Tax Band
| ||
~607,n,m,l | Item Date
| ||
~608 | (15 characters) Stock Code
| ||
~609,n,m,l | (30 characters) Stock Description
| ||
~610,n | (20 characters) Remarks
| ||
~611,n | (10 characters) Units
| ||
~612,n | (6 characters) Percentage Discount
| ||
~613,n | (75 characters) Freetype Text
| ||
~614,n | (3 characters) Stock Group
| ||
~615,n | (10 characters) Weight
| ||
~616,n | (10 characters) Volume
| ||
~617,n,m,l | (1 character) Stock Analysis Code
| ||
~618,n | (10 characters) Price List Over-ride
| ||
~619,n,m,l | (15 characters) Short Description
| ||
~620,n | (6 characters) Depot Code
| ||
~621,n | (10 characters) Quantity in Stock
| ||
~622,n | (10 characters) Quantity on Backorder
| ||
~623,n | (8 characters) Advice Note Number
| ||
~624,n | (12 characters) Location
| ||
~625,n,m,l,"x" | (10 characters) Sales Price
| ||
~626,n,m,l | (5 characters) Percentage Tax Charged
| ||
~630,n,m,l | (15 characters) Stock Analysis Description
| ||
~639,n,m,l | (60 characters) Description/Detailed Notes
Prints usual Stock Description for up to three lines, then all Detailed Notes.
| ||
~642,n | (30 characters) Stock Group Description
| ||
~643,n,m,l | (10 characters) Stock Barcode Number
| ||
~644,n | (10 characters) Account Fixed Stock Price
| ||
~645,n | (30 characters) Account Fixed Stock Price Notes
| ||
~646,n | (10 characters) Quantity on Purchase Order
| ||
~647,n | (10 characters) Quantity on Sales Order
| ||
~656,n,m,l,"x",k,j,"y" | (30 characters) Stock Attribute
Print a stock attribute code or description.
| ||
~657,n,m,l,"x" | (30 characters) Country of Origin
Print a country code or a country name.
| ||
~658,n,m,l,"x" | (10 characters) Commodity Code
Print a commodity code.
|
Batch Information in Item Descriptions
When a "Batched" stock item is booked out of stock, and batch information assigned, either manually or automatically if the system can identify the batch without prompting, the assigned "Batch No:" will be inserted into the first blank line of the item's description for this document. This information will then be printed as part of the item's description on printouts produced subsequently such as any advice note or invoice.
This depends on the item having at least one blank line of description, and on the document being printed after the item is booked out of stock.
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.
| |
~703,n,m,l,k,j | (25 characters) Pre Tax Amount after Blanket Discount
| |
~704,n,m,l | (25 characters) Total Tax Amount
Superseded on Tax Inclusive documents (see above). | |
~705,n,m,l | (25 characters) Total Amount after Tax and Blanket Discount
| |
~706,n,m,l | (25 characters) Total Amount Paid
| |
~707,n,m,l | (25 characters) Total Amount Outstanding after Payment
| |
~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 1st Tax Rate
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Superseded on Tax Inclusive documents (see above).
| |
~710,n,m,l,k,j | (25 characters) Amount Charged at 2nd Tax Rate
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Superseded on Tax Inclusive documents (see above).
| |
~711,n,m,l,k,j | (25 characters) Amount Charged at 3rd Tax Rate
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Superseded on Tax Inclusive documents (see above).
| |
~712,n,m,l,k,j | (25 characters) Amount Charged at 4th Tax Rate
If '99.99' is included in the description it will be substituted with the percentage Tax applied. Superseded on Tax Inclusive documents (see above).
| |
~713,n,m,"x",l,k | (25 characters) Tendered Amounts Breakdown
Prints a line for each sales 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 Tendered
| |
~718,n,m,l | (25 characters) Change Given
| |
~719,n,m,l | (25 characters) Account Balance including current Document
| |
~720,n,m,l | (25 characters) Credit Charge applicable to the current Document, if the Credit Charge is calculated on the Nett.
| |
~721,n,m,l | (25 characters) Credit Charge applicable to the current Document, if the Credit Charge is calculated on the Gross.
| |
~722,n,m,l | (25 characters) Gross total for the current Document plus any applicable Credit Charge.
| |
~723,n,m,l | (25 characters) Nett Total after Settlement Discount, if a Settlement Discount applies.
| |
~724,n,m,l | (25 characters) V.A.T. Total after Settlement Discount, if a Settlement Discount applies.
| |
~725,n,m,l | (25 characters) Gross Total after Settlement Discount, if a Settlement Discount applies.
|
Tax Block
General Information
~801,n,m | Details for 1st Tax Band
| |
~802,n,m | Details for 2nd Tax Band
| |
~803,n,m | Details for 3rd Tax Band
| |
~804,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 first tax rate. Note that '~29' may not represent an amount in all document formats. This is just an example.
|
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) |
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 |