Path parameters

• businessLocationId integer(int64) Required

  Unique identifier for a business location.

• from string(date-time) Required

  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) Required

  End of requested results, in ISO 8601 format.

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

Query parameters

• include string

  Objects to be included in the response.

  The allowed values are: staff, table, consumer, payments, revenue_center, account_profile, payment_authorization.

  Default value is empty.

• pageSize integer(int32)

  Number of entries to return.

  Default value is 1000.

• nextPageToken string

  The accountId where the results should begin.

  Example: A65315.18

Responses

• 200 application/json

  Financials returned

  Hide response attributes Show response attributes object

  • businessName string

    Name of the business

  • nextStartOfDayAsIso8601 string

    Start of next business day, in the merchant's local time.

  • businessLocationId number

    The unique identifier of the business location.

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

    • accountReference string

      Unique reference code for the account.

    • accountFiscId string

      The account identifier

    • receiptId string

      The unique identifier of the receipt associated with this account.

    • source object
      Hide source attributes Show source attributes

      • initialAccountId string

        The accountFiscId of the initial transaction associated with the current account, if applicable. For example, in the case of a refund.

        This will match the accountFiscId of the sale if there is no associated account.

      • previousAccountId string

        The accountFiscId of the previous transaction associated with the current account, if applicable. For example, in the case of a refund.

        This may be different from initialAccountId if there is more than one associated account.

        It will not be displayed if there is no associated account.

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

      • id string

        The sale line identifier

      • parentLineId string

        The sale line this item is associated with, if applicable.

      • totalNetAmountWithTax string

        Total amount of sale line, including tax. Important Note: This field is for use with tax inclusive businesses. For tax exclusive businesses, see taxAmount and taxLines for tax calculations.

      • totalNetAmountWithoutTax string

        Total amount of the sale line, before tax.

      • menuListPrice string

        The price listed on the menu.

      • unitCostPrice string

        The unit cost price.

      • serviceCharge string

        The service charge amount.

      • serviceChargeRate string

        The service charge rate, as a percentage.

      • discountAmount string

        The discount amount.

      • taxCode string

        The system code for the tax rate.

      • taxAmount string

        The tax total.

      • taxRatePercentage string

        The tax rate, as a percentage.

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

        • taxId string

          The unique identifier for the tax.

        • taxCode string

          The system code for the tax rate.

        • taxRate string

          The tax rate, as a multiplier.

        • taxAmount string

          The tax total.

        • taxIncluded boolean

          Whether or not the business is tax inclusive.

      • discountType string

        The type of discount.

      • discountCode string

        The discount code.

      • discountName string

        The name of the discount.

      • accountDiscountAmount string

        The account discount amount.

      • totalDiscountAmount string

        The total discount amount.

      • sku string

        The item SKU

      • name string

        The item name.

      • statisticGroup string

        The item's statistic group.

      • quantity string

        The item quantity.

      • accountingGroup object
        Hide accountingGroup attributes Show accountingGroup attributes

        • accountingGroupId number

          The unique identifier of the item's accounting group.

        • name string

          The name of the accounting group.

        • statisticGroup string

          The accounting group's statistic group.

        • code string

          The code assigned to the accounting group.

      • currency string

        The currency for the sale line.

      • tags array[string]

        The tags attached to the line item.

      • revenueCenter string

        The name of the revenue center where the sale line was created.

      • revenueCenterId number

        The unique identifier of the revenue center where the sale line was created.

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

        • category string

          The line item's category.

        • value string

          The category value.

      • timeofSale string

        The timestamp of when the line item was created.

      • staffId number

        The unique identifier of the user who created the line item.

      • staffName string

        The name of the user who created the line item.

      • deviceId number

        The unique identifier of the device where the sale line was created.

      • deviceName string

        The name of the device where the sale line was created.

      • voidReason string

        The void reason, if applicable.

        Values are Broken, Cooking, Other, Taste, Unhappy Client, User Mistake, or Waited too long.

      • accountProfileCode string

        The code of the account profile used.

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

      • code string

        The code of the payment method.

      • description string

        The name of the payment method.

      • paymentMethodId number

        The unique identifier of the payment method.

      • netAmountWithTax string

        The net payment amount, including tax.

      • currency string

        The payment currency.

      • tip string

        The tip amount.

      • consumer object
        Hide consumer attributes Show consumer attributes

        • id string

          The UUID of the customer associated with the payment, if applicable.

        • customerId number

          The unique identifier for the customer.

        • title string

          The title of the customer.

        • firstName string

          The first name of the customer.

        • lastName string

          The last name of the customer.

        • phoneNumber1 string

          The primary phone number of the customer.

        • phoneNumber2 string

          The secondary phone number of the customer.

        • companyName string

          The company name of the customer.

        • addressLine1 string

          The first line of the customer's address.

        • addressLine2 string

          The second line of the customer's address.

        • zipCode string

          The postal code of the customer's address.

        • city string

          The city of the customer's address.

        • state string

          The state of the customer's address.

        • email string

          The email address of the customer.

        • taxIdentifier string

          The tax identifier of the customer.

        • fiscalCode string

          The fiscal code of the customer.

        • destinationCode string

          The destination code of the customer.

      • type string

        The type of payment.

        Values are NORMAL or ACCOUNTS_RECEIVABLE.

      • deviceId string

        The unique identifier of the device where the payment was processed.

      • deviceName string

        The name of the device where the payment was processed.

      • staffId number

        The unique identifier of the user who processed the payment.

      • staffName string

        The name of the user who processed the payment.

      • authorization string

        The authorization code for the payment.

      • externalReference string

        The external reference code for the payment.

      • revenueCenter string

        The name of the revenue center where the payment was processed.

      • revenueCenterId number

        The unique identifier of the revenue center where the payment was processed.

      • fiscId string

        The unique identifier of the payment.

      • uuid string

        The base64url encoded UUID of the payment.

      • fiscDate string

        The time stamp of the payment.

      • surcharge string

        The surcharge amount.

    • timeofOpening string

      The account creation timestamp.

    • timeofCloseAndPaid string

      The account close timestamp.

    • cancelled boolean
    • externalFiscalNumber string
    • tableNumber string

      The table number.

    • tableName string

      The name of the table.

    • accountProfileCode string

      The account profile associated with the account.

    • ownerName string

      The name of the user associated with the account.

    • ownerId number

      The unique identifier of the user associated with the account.

    • type string

      The sale type.

      Values are SALE, VOID, RECALL, REFUND, SPLIT, UPDATE, TRANSFER, FLOAT, TRANSITORY, CROSS_BL, or CANCEL.

    • externalReferences array[string]

      List of external references for online orders. Includes the TASK prefix, businessLocationId, and the unique reference code provided in the thirdPartyReference field of an online order.

    • nbCovers number

      The number of covers.

    • dineIn boolean

      Whether the order is dine-in.

    • deviceId number

      The unique identifier of the device where the account was created.

    • deviceName string

      The name of the device where the account was created.

    • voidReason string

      The void reason, if applicable.

      Values are Broken, Cooking, Other, Taste, Unhappy Client, User Mistake, or Waited too long.

  • dataComplete boolean
  • _links object
    Hide _links attributes Show _links attributes

    • self object
      Hide self attributes Show self attributes

      • href string
      • templated boolean
    • nextPage object
      Hide nextPage attributes Show nextPage attributes

      • href string

        The URL for the next set of results.

      • templated boolean
• 400 */*

  Bad Request

  Hide response attributes Show response attributes object

  • Additional properties
  • key object