Invoice Attributes
| Attribute | Type | Description |
|---|---|---|
| CompanyLogo | Image | Company logo uploaded in Settings → Company |
| Id | Number | Invoice ID |
| ManualNumber | String | Manual invoice number |
| Number | String | Manual number or Invoice ID |
| CreateDate | Date | Invoice creation date |
| InvoiceDate | Date | Invoice date |
| StartDate | Date | Start date |
| EndDate | Date | End date |
| DueDate | Date | Due date |
| Client | Organization | Client info |
| Office | Office | Invoice office info |
| Currency.Name | String | Invoice currency name |
| Currency.Code | String | Invoice currency code |
| Items | List of Invoice items | List of invoice items |
| Total | Number | Invoice total |
| Vessels | string | Vessel names commas separated |
| ItemsByVessel | List of Groupped invoice items | List of invoice items by vessel |
| ItemsByDesignation | List of Groupped invoice items | List of invoice items by items names |
| ItemsByPaymentAndRate | List of Payment and rate groups | Invoice items grouped by payment name and exact rate |
Example:
[[Client.Name]] - returns the name of the client organization.
[[Office.Name]] - returns the name of the invoice office.
[[Currency.Name]] - returns the name of the invoice currency.
[[Currency.Code]] - returns the code of the invoice currency.
[[ItemsByVessel.Name]] - returns a vessel name for each item in the group.
[[ItemsByDesignation.Items.Payment.Name]] - returns names of each payments for each item in the group. [[ItemsByDesignation.Items.Rate]] - returns rates of each payments for each item in the group.
Payment and rate groups
Use ItemsByPaymentAndRate to keep payments with the same name but different rates in separate summary rows. Each group provides Name, Rate, Items, and Total.
For example, [[ItemsByPaymentAndRate.Name]] inserts the payment name, [[ItemsByPaymentAndRate.Rate]] inserts that group's rate, and [[ItemsByPaymentAndRate.Total]] inserts its total.
Groupped invoice items
| Attribute | Type | Description |
|---|---|---|
| Name | String | Group name |
| Items | List of Invoice items | List of invoice items |
| Total | Number | Group total |
Example:
[[ItemsByVessel.Name]] - returns a vessel name for each group.
[[ItemsByDesignation.Items.Payment.Name]] - returns names of each payments for each item in the group.
[[ItemsByVessel.Items.StartDate]] - returns a start date for each payment item for each item in the group.
[[ItemsByVessel.Items.EndDate]] - returns an end date for each payment item for each item in the group.
[[ItemsByVessel.Items.Rate]] - returns a rate for each payment item for each item in the group.
[[ItemsByVessel.Items.Quantity]] - returns a quantity for each payment item for each item in the group.
[[ItemsByVessel.Items.Rank.Name]] - returns a rank name for each payment item for each item in the group.
[[ItemsByVessel.Items.Rank.Code]] - returns a rank code for each payment item for each item in the group.
[[ItemsByVessel.Items.Vessel.Name]] - returns a vessel name for each payment item for each item in the group.
[[ItemsByVessel.Total]] - returns a total amount for each group.
[[ItemsByDesignation.Total]] - returns a total amount for each group.
Invoice Items
| Attribute | Type | Description |
|---|---|---|
| Name | String | Item name |
| Payment.Name | String | Payment name |
| StartDate | Date | Start date |
| EndDate | Date | End date |
| Quantity | Number | Quantity |
| Rate | Number | Rate |
| Rank.Name | String | Rank name |
| Rank.Code | String | Rank code |
| Vessel.Name | String | Vessel name |
| Total | Number | Item total |
Example:
[[Items.Payment.Name]] - returns a payment name for each item.
[[Items.StartDate]] - returns a start date for each item.
[[Items.EndDate]] - returns an end date for each item.
[[Items.Rate]] - returns a rate for each item.
[[Items.Quantity]] - returns a quantity for each item.
[[Items.Rank.Name]] - returns a rank name for each item.
[[Items.Rank.Code]] - returns a rank code for each item.
[[Items.Vessel.Name]] - returns a vessel name for each item.
[[Items.Total]] - returns a total amount for each item.
Office
| Attribute | Type | Description |
|---|---|---|
| Name | String | Office name |
| RegisteredName | String | Registered name |
| Address | String | Office address |
| BankDetails | String | Bank details |
| Phone | String | Office phone |
| String | Office email | |
| Fax | String | Office fax |
| WebSiteUrl | String | Office website URL |
Example:
[[Office.Name]] - returns the name of the invoice office.
[[Office.RegisteredName]] - returns the registered name of the invoice office.
[[Office.Address]] - returns the address of the invoice office.
[[Office.BankDetails]] - returns the bank details of the invoice office.
[[Office.Phone]] - returns the phone number of the invoice office.\