Path parameters

• businessLocationId integer(int64) Required

  The unique identifier for the business location.

Query parameters

• date string(date)

  The date in YYYY-MM-DD format.

• from string(date-time)

  Start of requested results, in ISO 8601 format.

  Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00

• to string(date-time)

  End of requested results, in ISO 8601 format.

  Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00

• flattened boolean

  Default value is false.

• groupBy string Required

  Comma-separated list of parameters to group the results by. The allowed values are: staff, device, deviceId, tag, accountingGroup, and statisticGroup. For example, groupBy can be set to staff,device.

  Minimum length is 3, maximum length is 2147483647.

Responses

• 200 application/json

  Aggregated sales returned

  Hide response attributes Show response attributes object

  • groupByKey string

    The groupBy parameter provided.

  • groupByValue string

    The value that corresponds to the groupBy parameter.

  • totalAmount string

    The aggregated total of sales for this data set (ex. staff: manager).

  • serviceCharge string

    The aggregated total of service charges for this data set (ex. staff: manager).

  • totalDiscountedAmount string

    The aggregated total of discounts for this data set (ex. staff: manager).

  • totalTaxAmount string

    The aggregated tax total for this data set (ex. staff: manager).

  • numberOfSales number

    The total number of sale lines for this data set (ex. staff: manager).

  • children array[object]
    Hide children attributes Show children attributes object

    • groupByKey string

      The second groupBy parameter provided, if applicable. The parameters will be nested based on the order provided. For example, staff,device will show totals for each staff value, and then those totals broken down by device.

    • children array[object]
      Hide children attributes Show children attributes object

      • groupByValue string

        The value that corresponds to the second groupBy parameter provided.

      • totalAmount string

        The aggregated total of sales for this nested data set (ex. staff:manager -> device: iPad7).

      • serviceCharge string

        The aggregated total of service charges for this nested data set (ex. staff:manager -> device: iPad7).

      • totalDiscountedAmount string

        The aggregated total of discounts for this nested data set (ex. staff:manager -> device: iPad7).

      • totalTaxAmount string

        The aggregated tax total for this nested data set (ex. staff:manager -> device: iPad7).

      • numberOfSales number

        The total number of sales for this nested data set (ex. staff:manager -> device: iPad7).

      • children array[object]
        Hide children attributes Show children attributes object

        • groupByKey string
        • children array[object]

          This would continue with as many nested data sets as specified by the groupBy parameters.

          Additional properties are allowed.

  • nextStartOfDayAsIso8601 string
  • dataComplete boolean
  • businessName string
• 400 */*

  Bad Request

  Hide response attribute Show response attribute object

  • * object Additional properties

    Additional properties are allowed.