Functional description
Difficulty level:
Order line variables
An order is built from blocks, and each block contains detail rows. That is two nested loops: orderblocks for the blocks and, inside it, detail for the rows. Variables of the block itself and of the total row are written as {orderblocks.…}, variables of a detail row as {orderblocks.detail.…}.
Note: using these variables requires knowledge of how detail rows work. See the example at the bottom of this article.
Start code: <!-- BEGIN orderblocks -->
End code: <!-- END orderblocks -->
| Variable | Description | Example |
|---|---|---|
| {orderblocks.detail.BLOCK_ID} | Order block ID | |
| {orderblocks.BLOCK_PRIO} | Block-prio | |
| {orderblocks.BLOCK_DESCRIPTION} | Order block description | |
| {orderblocks.BLOCK_MEMO} | Block-memo | |
| {orderblocks.detail.TYPE} | Type | |
| {orderblocks.detail.UNIT} | Unit | |
| {orderblocks.detail.MEMO} | Memo | |
| {orderblocks.detail.DESCRIPTION} | Description | |
| {orderblocks.detail.FROM} | From | |
| {orderblocks.detail.FROMTIME} | Timefrom | |
| {orderblocks.detail.TILLTIME} | Till time | |
| {orderblocks.detail.TILL} | Till | |
| {orderblocks.detail.CURRENCY} | Currency | |
| {orderblocks.detail.NUMBER_OF_PLACES} | Number of places | |
| {orderblocks.detail.PARTICIPANTS} | Participants | |
| {orderblocks.detail.SUBTOTAL} | Subtotal | |
| {orderblocks.detail.DISCOUNT} | Discount description | |
| {orderblocks.detail.DISCOUNT_TOTAL} | Total discount | |
| {orderblocks.detail.PRICE} | Price | |
| {orderblocks.detail.PERIOD_PRICE} | Period Price | |
| {orderblocks.detail.VAT} | VAT | |
| {orderblocks.detail.VAT_EXCLUSIVE} | Exclusive | |
| {orderblocks.detail.VAT_DESCRIPTION} | VAT description | |
| {orderblocks.detail.NIGHTS} | Nights | |
| {orderblocks.detail.DAYS} | Days | |
| {orderblocks.detail.MONTHS} | Number of months | |
| {orderblocks.detail.PROD_DESC} | Alias of OBJ_DESC | |
| {orderblocks.detail.COM_DESC} | Description | |
| {orderblocks.detail.EXT_DESC} | Extra-description | |
| {orderblocks.detail.PER_DESC} | Period-Description | |
| {orderblocks.detail.PART_DESC} | Participant description | |
| {orderblocks.detail.ACCOUNT_CODE} | Ledger | |
| {orderblocks.detail.ACCOUNT_SIGN} | Account sign | |
| {orderblocks.TOTAL_TYPE} | Total line: type | |
| {orderblocks.TOTAL_BLOCK_ID} | Total line: order block ID | |
| {orderblocks.TOTAL_UNIT} | Total line: unit | |
| {orderblocks.TOTAL_MEMO} | Total line: memo | |
| {orderblocks.TOTAL_DESCRIPTION} | Total line: description | |
| {orderblocks.TOTAL_FROM} | Total line: date from | |
| {orderblocks.TOTAL_FROMTIME} | Total line: time from | |
| {orderblocks.TOTAL_TILLTIME} | Total line: time till | |
| {orderblocks.TOTAL_TILL} | Total line: date till | |
| {orderblocks.TOTAL_CURRENCY} | Total line: currency | |
| {orderblocks.TOTAL_NUMBER_OF_PLACES} | Total line: number of places | |
| {orderblocks.TOTAL_PARTICIPANTS} | Total line: mumber of participants | |
| {orderblocks.TOTAL_TOTAL} | Total line: grand total | |
| {orderblocks.TOTAL_DISCOUNT} | Total line: discount description | |
| {orderblocks.TOTAL_DISCOUNT_TOTAL} | Total line: discount | |
| {orderblocks.TOTAL_PERIOD_PRICE} | Total price for all periods | |
| {orderblocks.TOTAL_VAT} | Total line: VAT | |
| {orderblocks.TOTAL_VAT_EXCLUSIVE} | Total line: VAT exclusive | |
| {orderblocks.TOTAL_VAT_DESCRIPTION} | Total line: VAT description | |
| {orderblocks.TOTAL_NIGHTS} | Total line: number of nights | |
| {orderblocks.TOTAL_DAYS} | Total line: number of days | |
| {orderblocks.TOTAL_MONTHS} | Total number of months | |
| {orderblocks.TOTAL_PROD_DESC} | Total line: product description | |
| {orderblocks.TOTAL_COM_DESC} | Total line: combi description | |
| {orderblocks.TOTAL_EXT_DESC} | Total line: option description | |
| {orderblocks.TOTAL_PER_DESC} | Total line: period description | |
| {orderblocks.TOTAL_PART_DESC} | Total line: participant description | |
| {orderblocks.TOTAL_ACCOUNT_CODE} | Ledger account code of the total | |
| {orderblocks.TOTAL_ACCOUNT_SIGN} | Debit or credit sign of the total |
An example of a table with rows:
<!-- BEGIN orderblocks -->
<h3>{orderblocks.BLOCK_DESCRIPTION}</h3>
<table align="center" border="1" cellpadding="0" cellspacing="1" style="width:100%">
<tbody>
<tr>
<td>Omschrijving</td>
<td>Aantal</td>
<td>Vanaf</td>
<td>Tot</td>
<td>Prijs</td>
</tr>
<!-- BEGIN detail -->
<tr>
<td>{orderblocks.detail.DESCRIPTION}</td>
<td>{orderblocks.detail.NUMBER_OF_PLACES}</td>
<td>{orderblocks.detail.FROM}</td>
<td>{orderblocks.detail.TILL}</td>
<td>{orderblocks.detail.PRICE}</td>
</tr>
<!-- END detail -->
<tr>
<td>{orderblocks.TOTAL_DESCRIPTION}</td>
<td>{orderblocks.TOTAL_NUMBER_OF_PLACES}</td>
<td> </td>
<td> </td>
<td>{orderblocks.TOTAL_TOTAL}</td>
</tr>
</tbody>
</table>
<!-- END orderblocks -->
