Overview
If you need to do perform some bespoke reporting then we provide an advanced export report which allows access to the raw data we hold for your account. All the reports within VestiPOS are built on top of this data, so any advanced reporting requirements should be possible.
Run Report
- Navigate to: Reporting -> Advanced
- Select the Location you wish to export the data for.
- Select the date range you wish to extract the data for.
- Click the 'Queue Report' button.
- Depending on the date range, number of sales and server activity it may take between 1 to 30 minutes to export your data. Periodically refresh the page. Once your report export has completed click on the "Download" button.
Report Data
Sales
A line for each processed sale.
| Field Name | Description |
|---|
| ID | Unique reference for the sale. |
| Sale Number | Customer friendly reference number for the sale. |
| Completed | The date & time that the sale was completed. Also known as the sale date time. |
| Created | The date & time that the sale was first created. |
| Status | The status of the sale. See Sale Status below for possible values. |
| Location ID | The location identifier. |
| Location Name | The location name. |
| Register ID | The register identifier. |
| Register Name | The register name. |
| Staff Identifier | The identifier of the staff member that started the sale. |
| Staff Name | The name of the staff member that started the sale. |
| Customer Identifier | The customer identifier. Optional. |
| Customer Title | The customer title. Optional. |
| Customer Forename | The customer forename. Optional. |
| Customer Surname | The customer surname. Optional. |
| Customer Email | The customer email. Optional. |
| DiscountApportioned_TotalWithoutTax | The sale total without tax once discount has been applied. |
| DiscountApportioned_TotalTax | The sale total tax once discount has been applied. |
| DiscountApportioned_TotalWithTax | The sale total with tax once discount has been applied. |
| Gratuity Total | The total gratuity (service charge) on the sale. |
| Table | The table the sale was on. Optional. |
| Covers | The number of covers for the sale. Optional. |
| Max Table Batch | The last batch number used in the sale. |
| Food Ordered | The time food was first ordered. Optional. |
| Mains Away | The time "Mains Away" was last processed. Optional. |
| Mains Delivered | The time "Mains Served" was last processed. Optional. |
Sale Items
A line for each sale item logged against a sale.
| Field Name | Description |
|---|
| Sale ID | See "Sales -> ID" field. Use to create join with sales. |
| Sale Status | See "Sales -> Status" field. |
| Sale Completed | See "Sales -> Completed" field. |
| Sale Item ID | Unique ID for the sale item line. |
| Processed | The date & time the sale line was created. |
| Added By Identifier | The identifier of the staff member that added the item to the sale. |
| Batch | The batch the item was added to the sale. A batch is increased by 1 each time a table order is saved. |
| Refund Status | The refund status of the item. See "Refund Status" below for possible values. Optional. |
| Refund Record Id | If the line is a return record then this will be the "Sale Item ID" of the record which is being returned. Optional. |
| Category Group | The category group name the item belong to. |
| Category | The category name the item belong to. |
| Item | The item name for this sale item line. |
| Option | The item option name for this sale item line. |
| SKU | The SKU for the selected option. Optional. |
| List Without Tax | The list price (without tax) of the item option when it was added to the sale. Note: If the option is repriced at a future date, this field will retain it's value. |
| List Tax | The list price (tax amount) of the item option when it was added to the sale. Note: If the option is repriced at a future date, this field will retain it's value. |
| List With Tax | The list price (with tax) of the item option when it was added to the sale. Note: If the option is repriced at a future date, this field will retain it's value. |
| Sold Without Tax | The price (without tax) that the item was sold at. If the item has been repriced this would differ from the list price. |
| Sold Tax | The price (tax amount) that the item was sold at. If the item has been repriced this would differ from the list price. |
| Sold With Tax | The price (with tax) that the item was sold at. If the item has been repriced this would differ from the list price. |
| Discount Apportioned Sold Without Tax | The "Sold Without Tax" value with any sale discounts correctly apportioned to the sale line. |
| Discount Apportioned Sold Tax | The "Sold Tax" value with any sale discounts correctly apportioned to the sale line. |
| Discount Apportioned Sold With Tax | The "Sold With Tax" value with any sale discounts correctly apportioned to the sale line. |
| Cost | The cost of the item when it was sold. Note, this will not be updated if the cost prices change at a future date. |
| Notes | Any notes added to the item. Optional. |
| Printed on Order Slip | Indicates if the item was sent to an order slip printer (if configured). |
| Voided Batch | The batch number the sale line was voided on. Optional. |
| Voided At | The date & time the sale line was voided on. Optional. |
| Voided By Identifier | The staff identifier whom voided the sale line. Optional. |
| Voided By Name | The staff name whom voided the sale line. Optional. |
Sale Discounts
A line for each discount logged against a sale.
| Field Name | Description |
|---|
| Sale ID | See "Sales -> ID" field. Use to create join with sales. |
| Sale Status | See "Sales -> Status" field. |
| Sale Completed | See "Sales -> Completed" field. |
| Discount ID | Unique ID for the sale discount line. |
| Processed | The date & time the discount line was created. |
| Amount | The discount line amount. |
| Reason | The discount category. |
| Description | System generated description of the discount. |
| Notes | Any notes added to the discount. Optional. |
| Voided Batch | The batch number the discount line was voided on. Optional. |
| Voided At | The date & time the discount line was voided on. Optional. |
| Voided By Identifier | The staff identifier whom voided the discount line. Optional. |
| Voided By Name | The staff name whom voided the discount line. Optional. |
Sale Payments
A line for each payment logged against a sale.
| Field Name | Description |
|---|
| Sale ID | See "Sales -> ID" field. Use to create join with sales. |
| Sale Status | See "Sales -> Status" field. |
| Sale Completed | See "Sales -> Completed" field. |
| Sale Payment ID | Unique ID for the sale payment line. |
| Processed | The date & time the sale line was created. |
| Payment Type | The payment type name for the line. |
| Amount | The payment amount. |
| Voided Batch | The batch number the payment line was voided on. Optional. |
| Voided At | The date & time the payment line was voided on. Optional. |
| Voided By Identifier | The staff identifier whom voided the payment line. Optional. |
| Voided By Name | The staff name whom voided the payment line. Optional. |
Reconciliation Lines
A line for each payment type within each reconciliation within the date parameters.
| Field Name | Description |
|---|
| Created | The date & time that the reconciliation was created. |
| Completed | The date & time that the reconciliation was completed. Optional. |
| Status | The status of the reconciliation. See Reconciliation Status below for possible values. |
| Payment Type | The payment type name for the reconciliation line. |
| Expected | The expected amount calculated by the system. |
| Actual | The actual figure entered by the user. |
| Variance | The actual amount - the expected amount. |
Petty Cash
A line for each petty cash transaction within the date parameters.
| Field Name | Description |
|---|
| Processed | The date and time the petty cash transaction was processed. |
| Category | The selected category for the petty cash transaction. |
| Staff Identifier | The identifier of the staff member whom posted the transaction. |
| Staff Name | The name of the staff member whom posted the transaction. |
| Amount | The total amount for the petty cash transaction. |
Enum Values
Sale Status
| Value | Description |
|---|
| Completed | A sale where full payment has been taken. |
| AccountTopup | A customer account top-up. |
| Voided | A sale which has been voided. |
| OpenTableServer | A table which is currently open on a table. Note: sales will only show here if your terminals are in the "Server" multi terminal mode. |
| Voided |
|
| Wastage | A sale which has been recorded as wastage. |
Sale Item Refund Status
| Value | Description |
|---|
| None | A normal sale item. |
| Refunded | A sale item which has been refunded. It will have a matching sale item line with the status "RefundRecord". Linked by the "Refund Record ID" field. |
| RefundRecord | The refund record for a returned sale item. It will have a matching sale item line with the status "Refunded". Linked by the "Refund Record ID" field on the refunded line. |
Reconciliation Status
| Value | Description |
|---|
| Pending | Reconciliation not marked as completed by the user. |
| Complete | Completed reconciliation. |
