The following table shows the fields of an item from an invoice. An item cannot be accessed directly. You can either access it from the list of items of an invoice (invoice.items) or from the list of items of a project (project.items).
Table 6.5. Item Properties
| Property | Version | Meaning |
|---|---|---|
|
1. General The general fields are used to describe an item. |
||
| item.name | 1.0 | self-explained |
| item.description | 1.0 | self-explained |
|
2. Billing The billing fields are used to show billing information (rate, units, amount) about the item. If an item is discounted, you may also want to use the fields that show the regular (before any discount is applied) values. More information about discounts and when they are available is provided in the discount section below. |
||
| item.rate | 1.0 |
The rate used to bill the item. If the item is discounted, it indicates the rate after the discount. |
| item.cost | 1.11 | How much the item costs. If you subcontract or resell some services, this fields represents how much you are paying for the item. |
| item.units | 1.0 |
The number of units used to bill the item. If the item is discounted, it indicates the number of units after the discount. If the item is billed hourly, this field indicates the number of hours in decimal format. |
| item.profit | 1.11 | self-explained |
| item.amount | 1.0 | The amount of money that is charged for the item. If the item is discounted, it indicates the amount after all discounts. |
| item.regularRate | 1.8 |
If the rate of an item is discounted, this field indicates the rate before the discount. You may want to use this field like this: <#if item.rateDiscounted == true>
${item.regularRate}
</#if>The regular rate is accessed only when the rate is discounted. |
| item.regularUnits | 1.8 |
If the number of units of an item are discounted, this field indicates the number of units before the discount. You may want to use this field like this: <#if item.unitsDiscounted == true>
${item.regularUnits}
</#if>The regular number of units are accessed only when they are discounted. |
| item.regularAmount | 1.8 |
If an item is discounted, this field indicates the total amount for the item before any discount is applied to it. You may want to use this field like this: <#if item.discounted == true>
${item.regularAmount}
</#if>The regular amount is accessed only when it is discounted. |
|
3. Discount The discount fields can be used to determine the discounts for the rate or units of an item. There are also a few fields that can be used to determine if a discount has been applied to an item or not. |
||
| item.rateDiscount | 1.8 | If an item is discounted by rate, this field indicates the discount. It can be used to display the actual discount. |
| item.unitsDiscount | 1.8 | If an item is discounted by the number of units, this field indicates the discount. It can be used to display the actual discount. |
| item.rateDiscounted | 1.8 | Indicates if the rate of an item is discounted. See the item.regularRate field above. |
| item.unitsDiscounted | 1.8 | Indicates if the number of units of an item is discounted. See the item.regularUnits field above. |
| item.discounted | 1.8 | Indicates if an item is discounted (either by rate or number of units). See the item.regularAmount field above. |
|
4. Time The time fields can be used to get more detailed information about the time recorded for an item. |
||
| item.timeEntries | 1.5 |
A list with all the time entries recorded for a project item. This list is useful if you want to create a very detailed invoice that shows a breakdown for each invoiced item. To access a time entry from the list use the following Freemarker code: <#list item.timeEntries as timeEntry> ... </#list> |
| item.elapsedTimeAsHour | 1.5 | The total time recorded for a project item in hour format. For instance 1 hour and 30 minutes is represented as 1:30. |
| item.elapsedTimeAsDecimal | 1.5 | The total time recorded for a project item in decimal format. For instance 1 hour and 30 minutes is represented as 1.50. |
| item.billableTimeAsHour | 1.5 |
The total billed time for a project item in hour format. For instance 1 hour and 30 minutes is represented as 1:30. The billed time may be slightly different than the elapsed time because of the time rounding that is applied to hourly-rated items. |
| item.billableTimeAsDecimal | 1.5 |
The total time recorded for a project item in decimal format. For instance 1 hour and 30 minutes is represented as 1.50. The billed time may be slightly different than the elapsed time because of the time rounding that is applied to hourly-rated items. |
|
Copyright © 2006-2008 Atelier Software SRL |