Difference between revisions of "Invoice Module Variables"
From SmartWiki
Line 1: | Line 1: | ||
The following variables can be used when creating a [[Web Page View Field|Web Page View]] to generate an Invoice using the [[Invoice UTA|Invoicing Module]]: | The following variables can be used when creating a [[Web Page View Field|Web Page View]] to generate an Invoice using the [[Invoice UTA|Invoicing Module]]: | ||
+ | |||
+ | On the '''Application Configuration'' page you must first provide the field names of the associated Level 2 or 3 fields so they can be listed as part of the individual line items on the invoice. This is done in the ''Invoice Item Field Mapping'' section. The fields are: | ||
+ | |||
+ | *Item Detail: | ||
+ | *Item Quantity: | ||
+ | *Item Amount: | ||
+ | *Item Tax: | ||
+ | *Item Tax 2: | ||
+ | |||
+ | For example, the associated fields on the Level 2 or Level 3 entities could be named: | ||
+ | |||
+ | *Item Detail: @type@ | ||
+ | *Item Quantity: @quantity@ | ||
+ | *Item Amount: @rate@ | ||
+ | *Item Tax: @GST Amount@ | ||
+ | *Item Tax 2: @PST Amount@ | ||
+ | |||
+ | |||
+ | On the Web Page View you refer to each of these fields using special terminology which allows them to be listed in the table as described above: | ||
+ | |||
+ | *Item Detail: ~description~ | ||
+ | *Item Quantity: ~qty~ | ||
+ | *Item Amount: ~amount~ | ||
+ | *Item Tax: ~tax~ | ||
+ | *Item Tax 2: ~tax2~ | ||
+ | |||
+ | <pre> | ||
+ | <table> | ||
+ | <form name=frmsubact> | ||
+ | <tr> | ||
+ | <td>Item Description</td> | ||
+ | <td>Quantity</td> | ||
+ | <td>Unit Cost</td> | ||
+ | <td>Total Cost</td> | ||
+ | <td>GST</td> | ||
+ | <td>PST</td> | ||
+ | </tr> | ||
+ | |||
+ | [#(?object=items) | ||
+ | |||
+ | <tr> | ||
+ | <td>~description~</td> | ||
+ | <td> ~qty~ </td> | ||
+ | <td> ~amount~ </td> | ||
+ | <td> ~fullamount~ </td> | ||
+ | <td> ~tax~ </td> | ||
+ | <td> ~tax2~ </td> | ||
+ | </tr> | ||
+ | |||
+ | #] | ||
+ | |||
+ | <tr> | ||
+ | <td><b>Sub-Total:</b></td> | ||
+ | <td>@amount@</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td><b>Total GST:</b></td> | ||
+ | <td>@tax@</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td><b>Total PST:</b></td> | ||
+ | <td>@tax2@</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td><b>Total:</b></td> | ||
+ | <td>@invtotal@</td> | ||
+ | </tr> | ||
+ | </form> | ||
+ | </table> | ||
+ | </pre> | ||
+ | |||
+ | |||
Revision as of 16:30, 20 March 2009
The following variables can be used when creating a Web Page View to generate an Invoice using the Invoicing Module:
On the 'Application Configuration page you must first provide the field names of the associated Level 2 or 3 fields so they can be listed as part of the individual line items on the invoice. This is done in the Invoice Item Field Mapping section. The fields are:
- Item Detail:
- Item Quantity:
- Item Amount:
- Item Tax:
- Item Tax 2:
For example, the associated fields on the Level 2 or Level 3 entities could be named:
- Item Detail: @type@
- Item Quantity: @quantity@
- Item Amount: @rate@
- Item Tax: @GST Amount@
- Item Tax 2: @PST Amount@
On the Web Page View you refer to each of these fields using special terminology which allows them to be listed in the table as described above:
- Item Detail: ~description~
- Item Quantity: ~qty~
- Item Amount: ~amount~
- Item Tax: ~tax~
- Item Tax 2: ~tax2~
<table> <form name=frmsubact> <tr> <td>Item Description</td> <td>Quantity</td> <td>Unit Cost</td> <td>Total Cost</td> <td>GST</td> <td>PST</td> </tr> [#(?object=items) <tr> <td>~description~</td> <td> ~qty~ </td> <td> ~amount~ </td> <td> ~fullamount~ </td> <td> ~tax~ </td> <td> ~tax2~ </td> </tr> #] <tr> <td><b>Sub-Total:</b></td> <td>@amount@</td> </tr> <tr> <td><b>Total GST:</b></td> <td>@tax@</td> </tr> <tr> <td><b>Total PST:</b></td> <td>@tax2@</td> </tr> <tr> <td><b>Total:</b></td> <td>@invtotal@</td> </tr> </form> </table>
See also: Web Page View Field Variables