Documents
Below are documented:
- the variables for the
documents.htmlpage to show orders, quotes, and invoices to the customer - the variables for the
view.htmlpage where you can view and print a single document
In addition to these you can also use the variables common to all pages.
documents.html
Displays a customer's orders, quotes, and invoices. Initially only the latest orders, latest quotes, and latest invoices are shown. The customer, once a document type is selected, can see all documents of that type.
| Instruction | Variable | Description |
|---|---|---|
| for | invoices | Customer invoices ( those still open or canceled are not shown ) |
| for | orders | Customer orders ( canceled orders are not shown ) |
| for | quotes | Customer quotes ( canceled quotes are not shown ) |
| if | showInvoices | Indicates whether invoices should be shown |
| if | showMoreInvoices | Indicates whether there are more invoices to show |
| if | showMoreOrders | Indicates whether there are more orders to show |
| if | showMoreQuotes | Indicates whether there are more quotes to show |
| if | showOnlyInvoices | Indicates whether only invoices are shown |
| if | showOnlyOrders | Indicates whether only orders are shown |
| if | showOnlyQuotes | Indicates whether only quotes are shown |
| if | showOrders | Indicates whether orders should be shown |
| if | showQuotes | Indicates whether quotes should be shown |
| show | paging | Pagination to move through subsequent documents ( shown only if a specific document type is displayed ) |
| show | title | Page title |
for invoices
| Instruction | Variable | Description |
|---|---|---|
| show | date | Invoice date |
| show | number | Invoice number |
| show | status | Invoice status |
| show | total | Total |
| show | totalTax | Total VAT included |
| show | type | Invoice type: invoice, accompanying invoice, proforma, or credit note |
| show | view | Link to the details page |
for orders
| Instruction | Variable | Description |
|---|---|---|
| show | date | Order date |
| show | number | Order number |
| show | status | Order status |
| show | total | Total |
| show | totalTax | Total VAT included |
| show | view | Link to the details page |
for quotes
| Instruction | Variable | Description |
|---|---|---|
| show | date | Quote date |
| show | number | Quote number ( shown only for quotes sent, accepted, or expired ) |
| show | status | Order status |
| show | total | Total ( shown only for quotes sent, accepted, or expired ) |
| show | totalTax | Total VAT included ( shown only for quotes sent, accepted, or expired ) |
| show | view | Link to the details page |
view.html
Page where you can view the details of a document (order, quote, invoice, receipt, or DDT) and print it.
For quotes there is also a button that allows the customer to accept the quote and turn it into an order.
A customer can access this page either from the documents.html page after logging in, or directly via an address sent by email.
Note
The individual print pages have their own HTML page.
| Instruction | Variable | Description |
|---|---|---|
| show | acceptQuote | Button to accept the quote. Shown only for quotes sent to the customer that have not yet expired |
| show | document | Document in printable format |
| show | Button to print the document | |
| for | processings | Processings |
for processings
The processings variable shows the processings visible on the site.
| Instruction | Variable | Description |
|---|---|---|
| show | consent | Checkbox to accept consent for processing |
| show | description | Processing description |
| show | id | Unique processing identifier |
| if | isConsentRequired | Indicates whether consent is required |
| show | moreInfo | Link to the details page |
| show | title | Processing title |