Skip to main content

FocusLink - Data Models

Brandon Wermes
Updated

Check Object Data Model:

  • venueKey
    • Required
    • Number/integer
    • The venue identifier
  •  employeeId
    • Required 
    • Number/integer 
    • The Record ID of the employee performing the function
    • Employee Record IDs can be obtained via the Employee List endpoint
  • table
    • String
    • Max 10 characters
    • The table number, or integrator identifier for this check.
  • numberOfGuests
    • Number/integer
    • The number of guests being serviced by this check
  • total
    • Number/double
    • Read only
    • The total amount/value of the check
  • remainingBalance
    • Number/double
    • Read only
    • The remaining balance of the check after all payments have been applied.
  • businessDate
    • Datetime
    • Read only
    • The Business Date (checkDate) that the check is assigned to
  • timeOpened
    • Datetime
    • Read only
    • The date/time that the check was opened
  • owner
    • String
    • Read only
    • The Nickname of the employee who owns the check.
  • seats
    • Array of seat object

 

Seat Object Data Model:

  • seatKey
    • Required
    • Number/integer
    • The seat number
  • open
    • Boolean
    • Read only
    • Status of the seat. If a seat has been paid in full, and thus closed, this value will be false
  • subtotal
    • Number/double
    • Read only
    • The subtotal (i.e. total excluding tax, gratuity and subtotal-level discounts). 
    • Can be viewed as the sum of all items on the seat
  • discountTotal
    • Number/double
    • Read only
    • The total of all discounts on the seat.
    • Sum of all item-level discounts and subtotal-level discounts.
  • orderTypeChargeTotal
    • Number/double
    • Read only
    • The Order Type Total for a check.
  • gratuityTotal
    • Number/double
    • Read only
    • The value of any added gratuities to on a seat.
    • This is for POS added gratuities only and does not include customer added tips.
  • total
    • Number/double
    • Read only
    • The total amount/value of the seat
  • remainingBalance
    • Number/double
    • Read only
    • The remaining balance of the seat after all payments have been applied.
  • payments
    • Array of payment objects
  • items
    • Array of item objects
  • discounts
    • Array of discount objects

Item Object Data Model:

  • menuItemKey
    • Number/integer
    • Required
    • Menu Item Record ID of the item. For a list of menu items, you may call the Menu Item List endpoint.
  • price
    • Number/double
    • Required
    • Note: You must use a valid price configured for the applicable menu item. To obtain a list of prices for a specific menu item, call the Menu Item - Specific Record endpoint
  • quantity
    • Number/integer
    • Quantity of items being ordered.
    • Defaults to 1 if not provided
  • priceNumber
    • Number/integer
    • If using a price other than price 1 of a menu item (see Menu Item Model), you must provide the priceNumber being used. PriceNumbers can be obtained from the Menu Item - Specific Record call
  • priceNumberName
    • String
    • Max 15 characters
    • A prefix for the menu item being rang. 
  • courseId
    • Number/integer
    • The course number corresponding to this item.
    • Note: venue must be using Focus Coursing function to support this property.
  • positionId
    • Number/integer
    • The seating position corresponding to this item.
    • Note: venue must be using Focus Position Seating to support this property.
  • name
    • String
    • Read only
    • The Guest Check (display name) of the Menu Item.
  • discounted
    • Boolean
    • Read only
    • Identifies if the item has been discounted
  • discountAmount
    • Number/double
    • Read only
    • The value that has been discounted from the item
  • discountAmountOrderType
    • Number/double
    • Read only
    • When an item-based Order Type Fee is being used, this is the amount that is being discount from the seat's orderTypeFee as a result of this item's discount.
  • discountInternalId
    • Number/double
    • Read only
    • The unique ID record of the discount.
  • modifiers
    • Array of item records modifying the item
    • Note: for modifier item records, the price property can be omitted and the POS MOD (price 10) will be used.

Payment Object Data Model:

  • type
    • Number/integer
    • Read only
    • The payment type ID representing the payment used
      • 0 - Cash
      • 1 - Credit Card
      • 2 - Account
  • paymentName
    • String
    • The name corresponding to the POS payment being transacted.
    • Note: each integrator has a specific paymentName property that they are assigned. This paymentName is configured in POS to correspond to payment actions from this integrator. Providing an incorrect or invalid paymentName may result in POS errors.
  • paymentType
    • String
    • Read only
    • The Payment Type corresponding to the payment in question
  • amount
    • Number/double
    • Amount of the payment
  • tip
    • Number/double
    • Amount of the tip added by the guest
  • name
    • String
    • Read only
    • Name of the payment applied to the check

Discount Object Data Model:

  • id
  • amount:
    • Number/double
    • Amount to discount from each item.
  • itemKeys:
    • Array of Number
    • Array of itemKeys from the seat > items object which should have this discount applied.

 

Configuration/Discount Object Model:

  • venueKey
    • Number/integer
    • Read only
    • Venue identifier
  • ID
    • Number/integer
    • Read only
    • Record ID of the Discount
  • Name
    • String
    • Read only
    • Discount name as configured for POS
  • Type
    • Number/integer
    • Read only
    • Discount Type ID
    • IDExplicit
      • String
      • Read only
      • Integrator ID for discount
  • GuestCheckName
    • String
    • Read only 
    • Configured Guest Receipt name for a discount.

Configuration/Order Type Object Model

  • venueKey
    • Number/integer
    • Read only
    • Venue identifier
  • ID
    • Number/integer
    • Read only
    • Record ID of the Order TYpe
  • Name
    • String
    • Read only
    • Order Type name as configured for POS
  • FlagTipped
    • Boolean
    • Read only
    • Indicates whether the Order Type is considered Tippable or not.
      • Tippable order types are order types where a guest may leave a tip.

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk