Requirements
Transfer Configuration
The below table lists the information required to configure where automated reports will be transferred and how they will be stored. Note that we (Booxi) don’t provide hosting service.
Protocol | Select one of the supported protocols: FTP, FTPS, SFTP or GCS. For GCS, no further details are required for the transfer configuration. Contact your Booxi representative for the GCS guide. |
Storage URL | Hostname or IP of FTP site where reports will be sent.
|
Storage Port | FTP port on which to connect. |
Storage Directory | Folder on the destination FTP site in which to store reports. |
Host Key Fingerprint | If you opt for SFTP, provide a host key fingerprint. |
Storage Login User | User to log into the storage URL. |
Storage Login Password | Password to log into the storage URL. |
Report Configuration
The content of the reports will be configured per the information below.
Merchant ID or Merchant ID Template | Merchant ID or template or any store within a group for which the report will be generated. For group reports, it must be used in combination with "includeMerchantGroupLocations". |
Options | Select one of the preconfigured reports. For custom reports, a list of fields to be exported must be provided in a JSON format. |
Options JSON | For custom reports only. Fields to be exported in JSON format. |
Schedule | Time at which reports must be generated. Time must be provided in 24H format, in store local time. All reports are generated daily. |
Report Frequency | Defines the frequency of report generation (in days) Default value : 1 Maximum value: 120 If no value is specified, the report will be generated daily. 0 and negative numbers are not accepted. |
Offset Days | Defines the number of days to be included in the report, allowing negative (past) or positive (future) values. Default value : -1 Max value : 180 Min value : -180 If no value is specified, the report will cover the previous day. 0 is not accepted. |
*The report frequency value cannot be greater than the offset days value, since it will cause some days to be skipped and thus, not reported.
Report Types
Preconfigured Reports
Here are the preconfigured reports we offer; each report comes with a predetermined list of fields. Note that the preconfigured report will only export data marked as default. However, it is possible for a store to create a custom report by selecting any combination of fields. Consult your Booxi representative to make a selection.
Appointment | Export all daily appointments of a store. The report includes date, duration, service, staff, client and revenue associated with each appointment. |
Reservation | Export all daily reservations of a store. The report includes date, duration, service, staff, client and revenue associated with a reservation. |
Queue Booking | Export all queue bookings for all stores in the merchant group. Only bookings of "Completed", "Cancelled" and "No-show" are considered. |
Time Slot | Export all calendar time slots associated with a store. The report includes dates, duration, status, associated staff and store information. |
Consent Status | Export consent records. |
Packages Card Transaction report | Export all card transactions for a given merchant. |
Metric Merchant Occupancy | Export data on the number of bookings, scheduled, booked and serviced hours for a store. |
Metric Merchant Appointment | Export data on the number of bookings and their status. Additional fields are available. |
Metric Service Occupancy | Export occupancy for each service offered by a store. It includes the number of bookings, booked and serviced hours as well as revenue service. |
Metric Staff Occupancy | Export the occupancy of each staff associated with a store. It includes the number of scheduled, booked and serviced hours, time slots and #bookings. |
Metric Resource Occupancy | Export the occupancy of each resource associated with a store. It includes the number of scheduled, booked and serviced hours. |
Customizations
Field Selection
Reports can be customized by selecting any combination of fields. If you wish to customize the content of any report, consult your Booxi representative.
Field Names
Reports are generated in CSV format with each field as an individual column. If you wish to rename any or all columns appearing in a report, consult your Booxi representative.
Field Order
When providing a custom list of fields, the order in which the fields are listed will dictate the order in which they will appear in the report. If you wish to change the order in which fields appear in a report, consult your Booxi representative.
Appointment
Generate a report of all daily appointments for a store. The report includes the date, duration, service, staff, client and revenue associated with each appointment.
Filters
The following filters are provided to further customize the report’s content. Once set, all appointment reports will be generated with the selected filters.
Filter | Description | Default Value |
excludeCancelled | Exclude cancelled appointments when exporting. | FALSE |
includeMerchantGroupLocations | Include all stores in the target merchant group. | TRUE |
splitPriceAndCurrency | Strip currency symbols from all prices and display them in a distinct column. | FALSE |
splitServiceNameAndCategory | Appointment’s total duration excluding free spacing. | FALSE |
useDateFormatYMD | Display dates as “yyyy-mm-dd” instead of “dd mmm yyyy”. | TRUE |
useTimeFormat24h | Display time in 24H format instead of 12H. | TRUE |
dateFilter | Set which date field to select appointments by, start date or last modified date. | START |
quoteMode | Specify which quote mode to use, all, minimal, all none null, non numeric. Leave blank if none. | ALL |
encodingFormat | Specify which file encoding format to use, UTF-8 or UTF-16-LE. | UTF-16-LE |
Fields
The below table lists all available fields for an “Appointment” type report. For multi-service appointments, service fields will be repeated up to 5 times, once for each service assigned to the appointment.
Field | Description | Default |
Appt. ID | Appointment’s ID. | ☑ |
Event Date | Appointment’s start date. | ☑ |
Event Time | Appointment’s start time. | ☑ |
Duration | Appointment’s total duration excluding free spacing. | ☑ |
Status | Appointment’s status at the time the report is generated. | ☑ |
Booked Date | Appointment’s creation date. | ☐ |
Booked Time | Appointment’s creation time. | ☐ |
Booked By | Shows if an appointment was booked by a client or a member of staff. | ☑ |
Last Modified By | Shows if an appointment was last modified by a client or a member of staff. | ☐ |
Last Modified Date | The date on which the appointment was last modified. | ☐ |
Last Modified Time | The time at which the appointment was last modified. | ☐ |
Location | Appointment’s location. | ☐ |
Address | Client’s home address. | ☐ |
Subtotal | Invoice’s subtotal | ☐ |
Tax 1 | Amount for first tax | ☐ |
Tax 2 | Amount for second tax | ☐ |
Total | Invoice’s total price | ☐ |
Transaction Fee | Transaction fee | ☐ |
Currency | Currency ISO code | ☐ |
Staff Name | Full name of the assigned staff. | ☑ |
Customer ID | External customer ID used with a custom client module. | ☐ |
Cegid Customer ID | External customer ID used CEGID module (only if applicable). | ☐ |
Membership Number | Client’s membership ID if any. | ☐ |
Client Name | Client’s full name. | ☑ |
Client First Name | Client’s first name. | ☐ |
Client Last Name | Client’s last name. | ☐ |
Client Email | Client’s email address. | ☑ |
Client Phone | Client’s phone number (formatted per locale) | ☑ |
Client Phone International | Client’s phone (unformatted/RAW) | ☐ |
Client Mobile | Client’s mobile phone (formatted per locale) | ☑ |
Client Mobile International | Client’s mobile phone (unformatted/RAW) | ☐ |
Category Name | [repeatable for multi-service appointment] Service’s category name. | ☐ |
Service Name | [repeatable for multi-service appointment] Service’s name. | ☑ |
Service Duration | [repeatable for multi-service appointment] Service’s duration in minutes. | ☑ |
Service Spacing | [repeatable for multi-service appointment] Service’s spacing in minutes if any. | ☐ |
Pre Booking Question | [repeatable for multi-service appointment] Service’s pre-booking question (single question).If a survey is assigned to the service, this field will contain an array of answers. | ☐ |
Pre Booking Answer | [repeatable for multi-service appointment] Service’s pre-booking answer (single question). If a survey is assigned to the service, this field will contain an array of answers. | ☐ |
Service Metadata | Service metadata sub-field, where {SUB_FIELD} is any custom metadata. | ☐ |
Service Tag | The booking filter tag(s) associated with the service. | ☐ |
Client Birthdate | Client’s date of birth. | ☐ |
Client Gender | Client’s gender. | ☐ |
Client Language | Client’s preferred language. | ☐ |
Client Postal Code | Client’s postal or ZIP code. | ☐ |
Reminder | Should a reminder be sent to the client? | ☐ |
Client Request | Client request for an appointment. | ☐ |
Client Metadata | Client metadata sub-field, where {SUB_FIELD} is any custom metadata. | ☐ |
Quick Note | Quick note associated with an appointment. | ☐ |
Location Detail | Details about the appointment’s location. | ☐ |
Street | Street of a client’s home address. | ☐ |
City | City of a client’s home address. | ☐ |
Province or State | State of a client’s home address. | ☐ |
Country | Country of a client’s home address. | ☐ |
Postal Code | Postal or ZIP code of a client’s home address. | ☐ |
Paid | Has the invoice been paid or not? | ☐ |
Balance | Balance left to be paid. | ☐ |
Resource Name | Resource’s name. | ☑ |
Store ID | Store ID where the appointment is held. | ☐ |
Store Number | Store’s number. | ☑ |
Store Name | Store’s name. | ☐ |
Store City | City in which the store is located. | ☐ |
Store Province or State | Store’s state, province or territory. | ☐ |
Store Postal or Zip Code | Store’s postal or ZIP code. | ☐ |
Store Country | Store’s country. | ☐ |
Store Metadata | Store metadata sub-field, where {SUB_FIELD} is any custom metadata. | ☐ |
Client ID | Client’s unique ID. | ☐ |
Staff ID | ID of the staff assigned to the appointment. | ☑ |
Cegid Staff ID | CEGID staff ID (if applicable) | ☐ |
Staff Metadata | Staff metadata sub-field, where {SUB_FIELD} is any custom metadata. | ☐ |
Service ID | [repeatable for multi-service appointment] Service ID associated with the appointment. | ☑ |
Cegid Product ID | CEGID product ID (if applicable) | ☑ |
Resource ID | Resource ID associated with the appointment. | ☑ |
Template Service ID | The ID of the template service (applicable only if the service was created from the Head Office). | ☐ |
Acquisition Channel | The booking's acquisition channel (defined by the business) passed during booking creation. | ☐ |
Reservation
Generate a report of all daily reservations of a store. The report includes date, duration, service, staff, client and revenue associated with a reservation.
Filters
The following filters are provided to further customize the report’s content. Once set, all reservation reports will be generated with the selected filters.
Filter | Description | Default Value |
excludeCancelled | Exclude cancelled reservations when exporting. | FALSE |
includeMerchantGroupLocations | Include all stores in the target merchant group. | FALSE |
splitPriceAndCurrency | Strip currency symbols from all prices and display them in a distinct column. | FALSE |
useDateFormatYMD | Display dates as “yyyy-mm-dd” instead of “dd-mmm-yyyy”. | TRUE |
useTimeFormat24h | Display time in 24H format instead of 12H. | FALSE |
detailOptions | Determine the level of details to export with, group summary, reservations or attendees. | RESERVATIONS |
quoteMode | Specify which quote mode to use, all, minimal, all none null, non numeric. Leave blank if none. | ALL |
encodingFormat | Specify which file encoding format to use, UTF-8 or UTF-16-LE. | UTF-16-LE |
Fields
The below table lists all available fields for a “Reservation” type report. Fields marked with an asterisk (*) are exported by default. Three levels of detail are available for this report type. Consult the table to know what fields are available for each detail option.
Legend: S=Summary, R=Reservation, A=Attendee
Field | Description | S | R | A |
Group ID | Booxi merchant group ID. | ☑ | ☑ | ☑ |
Event Date | Date on which the group event starts. | ☑ | ☑ | ☑ |
Event Time | Time on which the group event starts. | ☑ | ☑ | ☑ |
Duration* | Group event’s duration excluding spacing. | ☑ | ☑ | ☑ |
Capacity | Group event’s capacity. | ☐ | ☐ | ☐ |
Attendee Count | Group event’s attendee count. | ☐ | ☐ | ☐ |
Place Left | Number of places left in the group event. | ☐ | ☐ | ☐ |
Price Per Person | Price per person. | ☐ | ☐ | ☐ |
Staff First Name* | Staff’s first name. | ☑ | ☑ | ☑ |
Staff Last Name* | Staff’s last name. | ☑ | ☑ | ☑ |
Staff Metadata | Staff metadata sub-field, where {SUB_FIELD} is any staff metadata sub-field. | ☐ | ☐ | ☐ |
Service Name* | Service’s name. | ☑ | ☑ | ☑ |
Categories Name | Service’s category. | ☐ | ☐ | ☐ |
Service Metadata | Service metadata sub-field, where {SUB_FIELD} is any service metadata sub-field. | ☐ | ☐ | ☐ |
Location | Location where the event is held. | ☐ | ☐ | ☐ |
Location Details | Details about the event’s location. | ☐ | ☐ | ☐ |
Quick Note | Quick note associated with an appointment. | ☐ | ☐ | ☐ |
Store ID | Store id (i.e. merchant id) | ☐ | ☐ | ☐ |
Store Number* | Store’s number. | ☑ | ☑ | ☑ |
Store Name | Store’s name. | ☐ | ☐ | ☐ |
Store City | City where the store is located. | ☐ | ☐ | ☐ |
Store State | State, province or territory where the store is located. | ☐ | ☐ | ☐ |
Store Postal or Zip Code | Store's postal or ZIP code. | ☐ | ☐ | ☐ |
Store Country | Country in which the store is located. | ☐ | ☐ | ☐ |
Store Metadata | Store metadata sub-field, where {SUB_FIELD} is any store metadata sub-field. | ☐ | ☐ | ☐ |
Reservation ID* | Group event’s ID | NA | ☐ | ☐ |
Client First Name | Client’s first name | NA | ☐ | ☐ |
Client Last Name | Client’s last name | NA | ☐ | ☐ |
Client Email* | Client’s email address | NA | ☐ | ☐ |
Client Phone* | Client’s phone number. | NA | ☐ | ☐ |
Client Phone International | Client’s phone (unformatted/RAW) | NA | ☐ | ☐ |
Client Mobile* | Client’s mobile phone number. | NA | ☐ | ☐ |
Client Mobile International | Client’s mobile phone (unformatted/RAW) | NA | ☐ | ☐ |
Client Birthdate | Client’s date of birth. | NA | ☐ | ☐ |
Client Gender | Client's gender. | NA | ☐ | ☐ |
Client Language | Client’s preferred language. | NA | ☐ | ☐ |
Client Postal Code | Client’s postal or ZIP code. | NA | ☐ | ☐ |
Reminder | Should a reminder be sent to the client? | NA | ☐ | ☐ |
Attendee ID | Attendee’s ID. | NA | NA | ☐ |
Attendee Full Name | Attendee’s full name. | NA | NA | ☐ |
Attendee First Name | Attendee’s first name. | NA | NA | ☐ |
Attendee Last Name | Attendee’s last name. | NA | NA | ☐ |
Attendee Email | Attendee’s email address. | NA | NA | ☐ |
Attendee Phone | Attendee’s phone. | NA | NA | ☐ |
Attendee Mobile | Attendee’s mobile phone. | NA | NA | ☐ |
Home Street | Street of a client’s home address. | NA | ☐ | ☐ |
Home City | City of a client’s home address. | NA | ☐ | ☐ |
Home State | State, province or territory of a client's home address. | NA | ☐ | ☐ |
Home Country | Country of a client’s home address. | NA | ☐ | ☐ |
Home Postal Code | Postal or ZIP code of a client’s home address. | NA | ☐ | ☐ |
Reservation Status* | Reservation’s status. | NA | ☐ | ☐ |
Booked By | Shows if an appointment was booked by a client or a member of staff. | NA | ☑ | ☑ |
Booked Date | Creation date of the reservation. | NA | ☐ | ☐ |
Booked Time | Creation time of the reservation. | NA | ☐ | ☐ |
Last Modified By | Shows if a reservation was last modified by a client or a member of staff. | NA | ☐ | ☐ |
Last Modified Date | Date a reservation was last modified on. | NA | ☐ | ☐ |
Last Modified Time | Time a reservation was last modified on. | NA | ☐ | ☐ |
Subtotal | Invoice’s subtotal. | NA | ☑ | NA |
Tax 1 | Invoice’s first tax | NA | ☐ | NA |
Tax 2 | Invoice’s second tax. | NA | ☐ | NA |
Total | Total price. | NA | ☐ | NA |
Transaction Fee | Transaction fee. | NA | ☐ | NA |
Paid | Has the invoice been paid? | NA | ☐ | NA |
Balance | Balance due on the payment. | NA | ☐ | NA |
Service Question | Service pre-booking question (single question). If a survey is assigned to the service, this field will contain an array of answers.. | NA | NA | ☐ |
Service Answer | Service pre-booking answer (single question). If a survey is assigned to the service, this field will contain an array of answers. | NA | NA | ☐ |
Client Request | Client’s request associated with a reservation. | NA | NA | ☐ |
Customer ID* | External customer ID used with a custom client module. | NA | NA | ☐ |
Membership ID | Client’s membership ID | NA | ☐ | ☐ |
Client ID* | Client’s ID | NA | ☐ | ☐ |
Longitude | Location’s longitude (geolocation) | ☐ | ☐ | ☐ |
Latitude | Location’s latitude (geolocation) | ☐ | ☐ | ☐ |
Service ID* | ID of the service provided at the event. | ☑ | ☑ | ☑ |
Attendee Language | Attendee’s language. | NA | NA | ☐ |
Event Date & Time | Date and time on which the group event starts. | ☐ | ☐ | ☐ |
Attendee Status | Attendee’s status. | NA | NA | ☐ |
Staff ID* | ID of the staff assigned to the group event. | ☑ | ☑ | ☑ |
Merchant ID | Merchant’s ID | ☐ | ☐ | ☐ |
Service Price | Service’s price. | ☐ | ☐ | ☐ |
Template Service ID | The ID of the template service (applicable only if the service was created from the Head Office). | ☐ | ☐ | ☐ |
Currency | Currency in ISO code. | NA | ☐ | NA |
Acquisition Channel | The booking's acquisition channel (defined by the business) passed during booking creation. | ☐ | ☐ | ☐ |
Queue Booking
Queue Fields
The below table lists all available fields for a “Queueing status” type report.
Field | Description | Default |
Client ID | Unique Booxi client ID | ☑ |
Client First Name | Client's first name at the time of event | ☑ |
Client Last Name | Client's last name at the time of event | ☑ |
Client Name | Client's first and last name | ☑ |
Client Mobile | Client's mobile phone number | ☑ |
Client Email | Client's email address | ☑ |
Merchant ID | Unique Booxi merchant ID | ☑ |
Merchant Address | Address of the store at which the service was offered. | ☑ |
Merchant City | City of the store at which the service was offered. | ☑ |
Merchant Postal Code | Postal code of the store at which the service was offered. | ☑ |
Merchant Country | Country of the store at which the service was offered. | ☑ |
Booking ID | Unique Booxi queue booking ID | ☑ |
Service ID | Unique Booxi service ID | ☑ |
Service Name | Name of the service | ☑ |
Service Duration | The service's scheduled duration (hours/minutes). | ☑ |
Timestamp Added | Date and timestamp at which the client joined the queue (YYYY-MM-DD, HH:MM) | ☑ |
Total Wait Time | The client's actual wait time (i.e. the amount of time elapsed from the moment the client was added to the queue and when a staff member was assigned to it). | ☑ |
Actual Duration | The actual duration of the service provided. | ☑ |
Status | The queue booking's current status. | ☑ |
Only bookings of status "Completed", "Cancelled" and "No-show" are included in this report.
Time Slot
Identify peak and downtimes by generating a report of all calendar time slots associated with a store. The report includes dates, duration, status, associated staff and store information.
Filters
The following filters are provided to further customize the report’s content. Once set, all timeslot reports will be generated in accordance with the selected filters.
Filter | Description | Default Value |
includeMerchantGroupLocations | Include all stores in the target merchant group. | FALSE |
useDateFormatYMD | Display dates as “yyyy-mm-dd” instead of “dd mmm yyyy”. | FALSE |
useTimeFormat24h | Display time in 24H format instead of 12H. | FALSE |
detailOptions | Determine what level of details to export with, available, busy, imported or all. | ALL |
quoteMode | Specify which quote mode to use, all, minimal, all none null, non numeric. Leave blank if none. | ALL |
encodingFormat | Specify which file encoding format to use, UTF-8 or UTF-16-LE. | UTF-16-LE |
Fields
The below table lists all available fields for a “Time Slots” type report.
Field | Description | Default |
Start Date | Date on which the time slot starts. | ☑ |
Start Time | Time on which the time slot starts. | ☑ |
Duration | Time slot’s duration in minutes. | ☑ |
Status | Time slot’s status: available, busy, etc. | ☑ |
Label | The custom label assigned to the time slot. | ☑ |
Description | Time slot’s description. | ☑ |
Staff ID | ID of the staff assigned to the time slot. | ☑ |
Staff Name | Name of the staff assigned to the time slot. | ☑ |
Cegid Staff ID | External staff ID used for the CEGID module. | ☐ |
Staff Metadata | Staff metadata sub-field, where {SUB_FIELD} is any staff metadata sub-field. | ☐ |
Store ID | Store’s ID. | ☑ |
Store Group ID | Store’s merchant group ID. | ☑ |
Store Filter Tag | Location filter tags assigned to the store. | ☑ |
Store Number | Store’s number. | ☑ |
Store Name | Store’s name. | ☑ |
Store City | Store’s city. | ☑ |
Store Province or State | Store’s state, province or territory. | ☑ |
Store Country | Store’s country. | ☑ |
Consent Status
Fields
The below table lists all available fields for a “Consent Status” type report.
Name | Description | Default |
Client ID | Unique Booxi generated client ID | ☐ |
Client Name | Client's first and last name | ☐ |
Client First Name | Client's first name
| ☐ |
Client Last Name | Client's last name
| ☐ |
External Client ID | Client's external ID (ex: Salesforce) | ☐ |
Client Email | Client's email address | ☐ |
Client Phone | Client's phone number | ☐ |
Client Mobile | Client's mobile number | ☐ |
Client Postal Code | Client's postal code | ☐ |
Client Address | Client's address | ☐ |
Client City | Client's city | ☐ |
Client State | Client's state/province/territory, etc. | ☐ |
Client Country | Client's country | ☐ |
Client IP Address | Client IP address
| ☐ |
Client User Agent | OS, browser, IP, etc. | ☐ |
Booking ID | Unique Booxi generated booking ID | ☐ |
Service ID | Unique Booxi generated service ID | ☐ |
Service Name | Name of the service given by the brand | ☐ |
Merchant ID | Merchant ID associated with the booking where the consent was captured. | ☐ |
Merchant Name | Name of the store. | ☐ |
Merchant Address | Store address | ☐ |
Merchant City | Store city | ☐ |
Merchant Postal Code | Store postal code | ☐ |
Merchant Country | Store country | ☐ |
Staff ID | Unique Booxi generated staff ID | ☐ |
External Staff ID | Staff’s external ID (ex: CEGID) | ☐ |
Consent Status |
| ☐ |
Consent ID | Unique Booxi generated consent ID | ☐ |
Consent Name | The consent name | ☐ |
Consent Version | The version of the consent that was displayed to the client | ☐ |
Consent Mandatory | Whether the consent is mandatory | ☐ |
Consent Language | The language of the consent text presented to the client.
| ☐ |
Consent Text | The text presented to the client when they granted or revoked their consent | ☐ |
Date and Timestamp | The date and time that the consent was granted or revoked by or on behalf of the client (based on store timezone). | ☐ |
The import of consent information is not supported.
You are responsible for storing and maintaining your client consent data. For more information, contact your Booxi representative.
We (Booxi) do not keep a copy of the generated reports.
Packages Card Transaction report
The below table lists all available fields for a "Packages Card Transaction" type report.
Name | Description | Default |
Transaction ID | The transaction ID | ☑ |
Transaction Date & Time | The transaction date/time | ☑ |
Package Card ID | The card's unique ID, generated by Booxi | ☑ |
Booxi Client ID | The client's unique ID, generated by Booxi | ☑ |
Client First Name | Client's first name | ☑ |
Client Last Name | Client's last name | ☑ |
Transaction Type | The transaction type | ☑ |
Initial Card Balance | The card's initial unit balance (i.e. prior to the transaction) | ☑ |
Units Deducted or Added | The amount of units added or deducted in the transaction (if applicable) | ☑ |
Current Card Balance | The card's current balance (i.e. after the transaction) | ☑ |
Booxi Staff ID | The ID of the staff member that performed the transaction. | ☑ |
Staff First Name | The first name of the staff member that performed the transaction. | ☑ |
Staff Last Name | The last name of the staff member that performed the transaction. | ☑ |
Booxi Merchant ID | The ID of the merchant in which the transaction was performed. | ☑ |
Merchant Address | The address of the merchant in which the transaction was performed. | ☑ |
Merchant City | The city of the merchant in which the transaction was performed. | ☑ |
Merchant Postal Code | The postal code of the merchant in which the transaction was performed. | ☑ |
Merchant Country | The country of the merchant in which the transaction was performed. | ☑ |
Booking ID | The ID of the associated booking (*Note: this only applies for card redemption) | ☑ |
Transaction Note | The transaction note | ☑ |
Metric Reports
Metric reports provide a concise and comprehensive set of metrics to analyze how your business is performing. Several report types are offered to focus on specific data. See below for a list of all metric reports.
Merchant Occupancy | Generate a comprehensive summary of all stores within a group. Examine the performance of each location by comparing the number of bookings, booked, scheduled and serviced hours as well as busy time slots. |
Merchant Appointment | Generate a detailed report of appointments booked at each store. The report includes the number of appointments, their status, the number of booked, scheduled and serviced hours as well as the revenue generated. |
Metric Group Event | Analyze how group events are performing, compare the number of bookings with the actual attendance and see how much revenue is generated per event. From these metrics, evaluate if events are financially successful and adjust capacity if attendance is lower than expected. |
Service Occupancy | Analyze how each service provided is performing by examining the number of bookings, booked and serviced hours as well as the revenue generated. Use these metrics to implement changes to your service offering, refocus resources on services generating more revenue, etc… |
Staff Occupancy | Analyze how staff are performing, from the number of bookings they were involved with to the number of scheduled, booked and serviced hours. Modify work schedule based on peak hours. |
Resource Occupancy | Survey how resources are performing, the number of bookings the resource was used for along with booked and serviced time. |
Metric Filters
The following filters are provided to further customize the report’s content. Take note that all metric report types will be generated with the selected filters.
Filter | Description | Default Value |
includeMerchantGroupLocations | Include all stores in the target merchant group. | TRUE |
splitPriceAndCurrencry | Strip currency symbols from all prices and display them in a distinct column. | FALSE |
useDateFormatYMD | Display dates as “yyyy-mm-dd” instead of “dd mmm yyyy”. | FALSE |
useTimeFormat24h | Display time in 24H format instead of 12H. | FALSE |
quoteMode | Specify which quote mode to use, all, minimal, all none null, non numeric. Leave blank if none. | ALL |
encodingFormat | Specify which file encoding format to use, UTF-8 or UTF-16-LE. | UTF-16-LE |
Merchant Occupancy
Fields
The below table lists all available fields for a “Merchant Occupancy” type report.
Field | Description | Default |
Date | The date on which the data was compiled. | ☑ |
Store ID | Booxi Merchant ID. | ☑ |
Store Group ID | Booxi Merchant Group ID. | ☐ |
Store Tag | Location tags associated with a store. | ☐ |
Store Number | Store count of the merchant group. | ☐ |
Store Name | Store’s name. | ☐ |
Store City | Store’s city. | ☐ |
Store State | Store’s state, province or territory. | ☐ |
Store Country | Store’s country. | ☐ |
Operation Minutes | Total scheduled time in minutes for all staff on the same date. | ☐ |
Operation Hours | Total scheduled time in hours for all staff on the same day. | ☑ |
Booked Minutes | Total time booked in minutes. | ☐ |
Booked Hours | Total time booked in hours. | ☑ |
Serviced Minutes | Total time serviced in minutes. | ☐ |
Serviced Hours | Total time serviced in hours. | ☑ |
Busy Timeslot Minutes | Total of all busy time slots in minutes. | ☐ |
Busy Timeslot Hours | Total busy time slots in hours. | ☑ |
Total Appointments | Number of bookings. | ☑ |
Merchant Appointment
Fields
The below table lists all available fields for a “Merchant Appointment” type report.
Field | Description | Default |
Date | Date on which the appointment started. | ☑ |
Store ID | Booxi merchant ID. | ☑ |
Store Group ID | Booxi Merchant Group ID. | ☐ |
Store Tag | Location filter tags associated with a store. | ☐ |
Store Number | Store count in the merchant group. | ☐ |
Store Name | Store’s name. | ☐ |
Store City | Store’s city. | ☐ |
Store Country | Store’s country. | ☐ |
Store State | Store’s state, province or territory. | ☐ |
Nb Appointments Confirmed | Number of bookings with the status “approved” (“pending client” and “requested” are excluded). | ☑ |
Nb Appointments Requested | Number of bookings with the status “requested. | ☑ |
Nb Appointments Rescheduled | Number of bookings with the status “rescheduled”. | ☑ |
Nb Appointments Pending Client | Number of bookings with the status “pending client”. | ☐ |
Nb Appointments Client Arrived | Number of bookings with the status “ongoing”. | ☐ |
Nb Appointments Completed | Number of bookings with the status “completed”. | ☐ |
Nb Appointments Staff Cancelled | Number of bookings with the status “canceled by staff”. | ☑ |
Nb Appointments Client Cancelled | Number of bookings with the status “canceled by client”. | ☐ |
Nb Appointments No Show | Number of bookings with the status “no show”. | ☑ |
Total Appointments | Total number of bookings (all status). | ☑ |
Nb Appointments Online | Number of bookings made online (client origin). | ☑ |
Nb Appointments Offline | Number of bookings made offline (staff origin). | ☑ |
Operation Hours | Open hours (in hours). | ☐ |
Scheduled Hours | Total scheduled time (in hours). | ☐ |
Booked Hours | Total hours booked in a day. | ☐ |
Serviced Hours | Total hours serviced in a day. | ☐ |
Operation Minutes | Open hours (in minutes). | ☐ |
Scheduled Minutes | Total scheduled time (in minutes). | ☐ |
Booked Minutes | Total minutes booked in a day. | ☐ |
Serviced Minutes | Total minutes serviced in a day. | ☐ |
Booked Revenue Subtotal | Subtotal revenue booked in a day (excluding taxes). | ☐ |
Booked Revenue Total | Total revenue booked in a day (including taxes). | ☐ |
Serviced Revenue total | Subtotal revenue serviced in a day (excluding taxes). | ☐ |
Serviced Revenue subtotal | Total revenue serviced in a day (including taxes). | ☐ |
Busy Timeslot Minutes | Total of all busy time slots in minutes. | ☐ |
Busy Timeslot Hours | Total of all busy time slots in hours. | ☐ |
Merchant Group Event
The below table lists all available fields for a “Metric Group Event” type report.
Fields
Field | Description | Default |
Store ID | Booxi merchant ID. | ☑ |
Date | Date on which the group event started. | ☑ |
Store Group ID | Booxi merchant group ID. | ☐ |
Store Tag | Location tags assigned to the store. | ☐ |
Store Number | Store’s number. | ☐ |
Store Name | Store’s name. | ☐ |
Currency | Currency ISO code. | ☐ |
Store City | Store’s city. | ☐ |
Store Country | Store’s country. | ☐ |
Store State | Store’s state, province or territory. | ☐ |
Group ID | The group event ID. | ☑ |
Time | Time at which the group event started. | ☑ |
Staff ID | ID of the staff member assigned to the group event. | ☐ |
Staff Name | Staff’s name. | ☐ |
Cegid Staff ID | Cegid Staff ID (if applicable). | ☐ |
Service ID | ID of the service provided. | ☐ |
Service Name | Service’s name. | ☑ |
Service Tags | Tags assigned to the service (see Service details > Booking filter tags). | ☐ |
Cegid Product ID | CEGID product ID (if applicable). | ☐ |
Number Reservations | Number of bookings for the event. | ☑ |
Number Attendees | Number of attendees for the event. | ☑ |
Capacity | Event’s capacity. | ☑ |
PC Booked | Booking percentage (attendees / capacity) | ☑ |
Number Present | Number of attendees with the status “arrived”. | ☑ |
Booked Revenue Subtotal | Revenue booked in a day (excluding taxes). | ☑ |
Booked Revenue Total | Revenue booked in a day (including taxes). | ☑ |
Service Metadata | Salesforce service ID (service metadata). | ☐ |
Staff Metadata | Sales staff ID (staff metadata). | ☐ |
Service Occupancy
Fields
The below table lists all available fields for a “Service Occupancy” type report.
Field | Description | Default |
Date | Date on which the appointment started. | ☑ |
Store ID | Booxi merchant ID. | ☑ |
Store Group ID | Booxi Merchant Group ID. | ☐ |
Store Tag | Location filter tags associated with a store. | ☐ |
Store Number | Store count in the merchant group. | ☐ |
Currency | Currency ISO code. | ☐ |
Store Name | Store’s name. | ☐ |
Store Code | Store’s city. | ☐ |
Store City | Store’s state, province or territory. | ☐ |
Store Country | Store’s country. | ☐ |
Store State | Booxi Service ID. | ☑ |
Service ID | Service’s name. | ☑ |
Service Name | Tags assigned to a service. | ☐ |
Service Tags | CEGID product ID (if applicable). | ☐ |
Product Cegid Id | Number of bookings made online (client origin). | ☑ |
Online Bookings | Number of bookings made offline (staff origin). | ☑ |
Offline Bookings | Total minutes booked in a day for a service. | ☐ |
Booked Hours | Total hours booked in a day for a service. | ☑ |
Serviced Hours | Total minutes serviced in a day for service. | ☐ |
Booked Minutes | Total hours serviced in a day for service. | ☑ |
Serviced Minutes | Subtotal revenue booked in a day (excluding taxes) for a service. | ☑ |
Booked Revenue Subtotal | Total revenue booked in a day (including taxes) for a service. | ☑ |
Booked Revenue total | Subtotal revenue serviced in a day (excluding taxes) for a service. | ☑ |
Serviced Revenue total | Total revenue serviced in a day (including taxes) for a service. | ☑ |
Serviced Revenue subtotal | Number of bookings made with a service. | ☑ |
Total Bookings | Salesforce service ID from metadata (if applicable). | ☐ |
Service Metadata |
|
|
Staff Occupancy
Fields
The below table lists all available fields for a “Staff Occupancy” type report.
Field | Description | Default |
Staff ID | Booxi Staff ID. | ☑ |
Store ID | Booxi merchant ID. | ☑ |
Store Name | Store’s name. | ☐ |
Staff Name | Staff’s name. | ☑ |
Date | Date on which the appointment started. | ☑ |
Operation Hours | Open hours (in hours). | ☑ |
Scheduled Hours | Total scheduled time (in hours) for a staff member. | ☑ |
Booked Hours | Total booked time (in hours) for a staff member. Only considers appointments that do NOT have the following status: Cancelled by client, Cancelled by staff, Deleted. | ☑ |
Serviced Hours | Total appointment hours that use this staff. Only considers appointments that have the following status: Approved, Ongoing or Closed.
| ☑ |
Busy Timeslot Hours | Total (in hours) of all busy time slots for a staff member. | ☑ |
Operation Minutes | Open hours (in minutes). | ☐ |
Scheduled Minutes | Total scheduled time (in minutes) for a staff member. | ☐ |
Booked Minutes | Total booked time (in minutes) for a staff member. Only considers appointments that do NOT have the following status: Cancelled by client, Cancelled by staff, Deleted. | ☐ |
Serviced Minutes | Total serviced time (in minutes) for a staff member. Only considers appointments that have the following status: Approved, Ongoing or Closed. | ☐ |
Busy timeslot Minutes | Total (in minutes) of all busy time slots for a staff member. | ☐ |
Total Bookings | Number of bookings for a staff member. | ☑ |
Assigned Services | Number of appointment-type services assigned to the staff member. | ☐ |
Merchant Group ID | Booxi Merchant Group ID. | ☐ |
Store City | Store’s city. | ☐ |
Store Country | Store’s country. | ☐ |
Store State | Store’s state, province or territory. | ☐ |
Store Tag | Location filter tags associated with a store. | ☐ |
Store Number | Store count in the merchant group. | ☐ |
Staff Metadata | Salesforce Staff ID from metadata (if applicable). | ☐ |
Resource Occupancy
Fields
The below table lists all available fields for a “Resource Occupancy” type report.
Field | Description | Default |
Store ID | Booxi merchant ID. | ☑ |
Resource ID | Booxi Resource ID. | ☑ |
Resource Name | Resource’s name. | ☑ |
Store Name | Store’s name. | ☐ |
Date | Date on which the appointment started. | ☑ |
Operation Hours | Open hours in hours. | ☑ |
Scheduled Hours | Total scheduled time in hours for a resource. | ☑ |
Booked Hours | Total booked time in hours for a resource. | ☑ |
Serviced Hours | Total serviced time in hours for a staff resource. | ☑ |
Operation Minutes | Open hours in minutes. | ☐ |
Scheduled Minutes | Total scheduled time in minutes for a resource. | ☐ |
Booked Minutes | Total booked time in minutes for a resource. | ☐ |
Serviced Minutes | Total serviced time in minutes for a resource. | ☐ |
Total Bookings | Number of appointments that were booked with the resource. | ☑ |
Merchant Group ID | Booxi Merchant Group ID. | ☐ |
Store City | Store’s city. | ☐ |
Store Country | Store’s country. | ☐ |
Store State | Location filter tags associated with a store. | ☐ |
Store Tag | Store’s state, province or territory. | ☐ |
Store Number | Store’s number. | ☐ |
Protocol Options
Here is a list of protocols supported with the automated FTP report. If you're deciding which transfer method to use between FTP, FTPS or SFTP, we highly recommend avoiding the basic FTP protocol and choosing a more secure option. Alternatively, reports can be uploaded to Google Cloud Storage by specifying GCS as a protocol.
We (Booxi) is using dedicated outbound IPs for all reports except GCS. They should be whitelisted by customers.
FTP
FTP exchanges data using two separate channels known as the command channel and data channel. With FTP, both channels are unencrypted, leaving any data sent over these channels vulnerable to being intercepted and read. It should only be used in limited cases or on networks you trust.
FTPS
Like FTP, FTPS uses two connections: a command channel and a data channel. It authenticates your connection using a user ID and password, a certificate, or both. When connecting to a trading partner's FTPS server, your FTPS client will validate if the server's certificate is trusted.
SFTP
SSH File Transfer Protocol is a separate protocol packaged with SSH that works in a similar way but over a secure connection. The advantage is the ability to leverage a secure connection to transfer files and traverse the filesystem on both the local and remote system. SFTP is preferable to FTP because of its underlying security features and ability to piggy-back on an SSH connection. Furthermore, SFTP needs only a single port number for all SFTP communications, making it easy to secure.
Public Key Fingerprint
SFTP supports server fingerprint as an optional security feature. Our implementation requires the key to be in MD5 format.
Your server’s fingerprint can be obtained with the following console command:
ssh-keygen -lf /path/to/public_key/pubkey_in_openssh_format.pub |
A remote server’s fingerprint can be obtained like so:
ssh-keyscan -t rsa ftp.host.com > key.pub |
Google Cloud Storage (GCS)
Google Cloud Storage is the object storage service offered by Google Cloud. In Cloud Storage, different objects are grouped in unique “namespaces” called buckets. A bucket can hold multiple objects yet, a single object will belong to only one bucket.
Client Configuration
The client must configure its destination storage bucket, using a Service Account. A destination folder must be created as files can’t be saved on the root. Contact your Account Manager or CS to request an account.
We recommend configuring the storage bucket with the following settings.
Region: Can either be Multi-Region or Region specific
Storage Class: Standard
Public Access: NOT Public
Access Control: Uniform
Protection: Activate one or more of the following protection options: Object Versioning Retention Policy or Default Event-Based Hold Option.
Life Cycle rules: Weekly data deletion
Requesters Pay: OFF
Permissions: storage.buckets.get and storage.objects.create
The above permissions are included into the below roles:
Storage Legacy Bucket Reader
Needed to read the metadata and the permissions on the bucket.
Storage Object Creator
Needed to write the file blob.
Storage Directory
The client can specify in what “destination folder” reports will be exported. Folders and sub-folders must be formatted as : 'level1/level2/'. Leading '/' is unnecessary unless a root '/' folder is needed.
Furthermore, the storage directory must follow the below naming guidelines as provided by Google:
Object names can contain any sequence of valid Unicode characters, of length 1-1024 bytes when UTF-8 encoded.
Object names cannot contain Carriage Return or Line Feed characters.
Object names cannot start with .well-known/acme-challenge/.
Objects cannot be named . or ...
For more information about the naming guidelines, consult this article.