Body Required

• account object
  Hide account attributes Show account attributes object

  • accountNumber string

    The unique identifier of the account.

  • accountObjectId string Deprecated

    The internal identifier of the table.

  • accountProfileCode string

    The code of the account (order) profile associated with this order.
    See the order profiles definition for more details.

  • accountProfileId string

    The unique identifier of the account (order) profile associated with this order.

  • accountProfileName string

    The name of the account (order) profile associated with this order.

  • businessLocationId string

    The unique identifier of the business location.

  • closeDate integer(int64) | null

    The timestamp of when transaction was completed, in milliseconds.

  • consumerRecord object | null
    Hide consumerRecord attributes Show consumerRecord attributes object | null

    • consumer object | null
      Hide consumer attributes Show consumer attributes object | null

      • emailAddress string
      • id string
    • consumerRecordUUID string(uuid)
    • contactInformation object
      Hide contactInformation attributes Show contactInformation attributes object

      • city string
      • companyName string
      • emailReceipts boolean

        Whether or not email notifications are enabled.

      • firstName string
      • fullName string

        Combines firstName and lastName.

      • lastName string
      • taxIdentifier string
    • externalReferences array[object]

      The external reservation system's unique identifier for the consumer.

      The external reservation system's unique identifier for the consumer.

      Hide externalReferences attributes Show externalReferences attributes object

      • key string

        An identifier for the external reservation system.

      • reference string
    • id string
  • coverCount integer(int64)

    The number of covers associated with the transaction.

  • currencyCode string

    The ISO-4217 3 letter currency code.

  • currentProductionPhase integer(int32)

    The active course. Starts with 0.

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

    • code string

      The discount code.

    • description string

      The name of the discount.

    • id string

      The unique identifier of the discount.

    • rate number

      The discount rate.

    • taxFree boolean

      Indicates if the discount is considered tax free.

  • externalReferences array[object]

    The unique identifiers of this transaction provided by 3rd parties or the K-Series backend.

    The unique identifier of this transaction provided by 3rd parties or the K-Series backend.

    Hide externalReferences attributes Show externalReferences attributes object

    • prefix string
    • reference string
  • gratuityAmount number

    The tip amount.

  • id string

    Legacy account identifier created by the POS (for backwards compatibility).

  • latestExternalReferences array[object]

    The unique identifier of this transaction provided by 3rd parties or the K-Series backend.

    Hide latestExternalReferences attributes Show latestExternalReferences attributes object

    • prefix string
    • reference string
  • name string

    The name of the transaction or tab.

  • offset integer(int32)

    The UTC Offset of the location, in minutes.

  • openDate integer(int64)

    The timestamp of when transaction was started, in milliseconds.

  • originAccountId integer(int64) | null

    Legacy reference identifier of origin account created by the POS (for backwards compatibility).

  • originAccountNumber string | null

    A unique identifier of an account, used to identify sales transactions.

  • paidAmount number

    The amount paid.

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

    • accountId string

      Legacy account identifier created by the POS (supplied because older API provides it to 3rd parties).

    • amount number

      Amount given by the customer to settle the transaction.

    • currencyCode string

      An ISO-4217 3 letter currency code

    • date integer(int64)

      Timestamp in ms of the moment when the line was registered. by the user

    • gratuityAmount number

      Amount of tip given by the customer using the payment method.

    • id integer(int64)

      Legacy line identifier created by the POS (supplied because older API provides it to 3rd parties).

    • paymentMethod string

      Short code of the payment method the customer used to settle the transaction.

    • paymentMethodDescription string

      Name of the payment method used.

  • preTaxAmount number

    The amount before tax.

  • receiptNumber string

    The unique identifier of the final transaction.

  • serviceCharge number

    The sum of all surcharges applied to the transaction.

  • staffId string

    The unique identifier of staff member who created/started and owns the transaction.

  • staffName string

    The name of staff member who created/started and owns the transaction.

  • tableName string Deprecated

    The name of the table.

  • tableNumber number Deprecated

    Integer number of the table.

  • tables array[string]

    List of table names (codes) associated with this order

  • taxAmount number

    The total amount of tax.

  • totalAmount number

    The total amount of the receipt.

  • totalDiscount number

    The applied discount rate, as a percentage.

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

    • accountId string

      Legacy account identifier created by the POS (supplied because older API provides it to 3rd parties).

    • accountingGroupId string

      The unique identifier of the product group assigned to the item.

    • accountingGroupName string

      Name of the product group assigned to the item.

    • activeTax object
      Hide activeTax attributes Show activeTax attributes object

      • code string

        Code of the tax as defined in the configuration context.

      • description string

        Name of the tax as defined in the configuration context.

      • rate number(double)

        Tax percentage (e.g. 19% => '1.19').

      • taxIncluded boolean

        Indicates whether the tax is VAT or Sales Tax.

    • amount number

      The actual (final) amount the customer will be charged, ie. regularAmount with modifiers applied.

    • amountLessTax number

      Taxable amount not including any taxes.

    • amountWithTax number

      Final amount including taxes.

    • categories array[object]

      A list of the reporting categories in which the sale is to be aggregated.

      A list of the reporting categories in which the sale is to be aggregated.

      Hide categories attributes Show categories attributes object

      • category string

        The reporting category name.

      • value string

        The reporting category value.

    • date integer(int64)

      Timestamp in ms of the moment when the line was registered. by the user

    • discountedAmount number

      The line discount amount applied to the line.

    • grossUnitAmount number

      Regular price for one unit of the line item.

    • id string

      Legacy line identifier created by the POS (supplied because older API provides it to 3rd parties).

    • itemDescription string

      Name of the item sold.

    • itemId string

      The unique identifier of the item at the business location.

    • itemSku string

      SKU (stock keeping unit) of the item.

    • modifiers array[object]

      A production instruction entered for a line.

      A production instruction entered for a line.

      Hide modifiers attributes Show modifiers attributes object

      • name string

        Line text.

      • quantity integer(int64)

        Line quantity.

    • nameOverride string

      Manually entered item name

    • phase integer(int32)

      Course number assigned to the line.

    • quantity number

      Quantity

    • tags string

      Array of tags associated with the sales line.

    • unitAmount number

      Actual amount for one unit of the line item including all markup, markdowns & surcharges.

  • type string

    The sale line type.

  • updateDate integer(int64)

    The timestamp of when the complete update was finalized at the POS, in milliseconds.

• businessLocationId integer(int64)

  The unique identifier of the business location.

• notificationType string

  Values are OPEN, UPDATE, CLOSE, or CANCEL.

• platformRestaurantId string

  The external platform's unique identifier for the restaurant.

  Format should match the following pattern: [a-zA-Z0-9_-]+.

• sequenceId string