Order Object

The Online Ordering API stores the information for each online order within a unique order object. Users generate an order object with the Create Order operation, and can then modify the order with other operations that add or remove information from the order object. See below for an example order object and a description of the fields it can contain:Xenial Online Ordering

{
    "order": {
        "contributors": [
            {
                "time": "20YY-03-14T16:57:41.714Z",
                "terminal": {
                    "terminal_number": "9",
                    "id": "9"
                }
            }
        ],
        "creator": {
            "time": "20YY-03-14T16:57:41.714Z",
            "terminal": {
                "terminal_number": "9",
                "id": "9"
            }
        },
        "origin": "mobile",
        "order_source": "mobile",
        "_id": "9999999999999999",
        "business_date": "20YY-03-14T00:00:00.000Z",
        "company_id": "9999999999999999",
        "notification_status": "open",
        "order_number": "9999999999999999",
        "order_type": "order",
        "order_status": {
            "status": "pending"
        },
        "payment_status": "open",
        "payment_info": {
            "change": 0,
            "payments": [],
            "tips": 0,
            "total": 0,
            "change_info": [],
            "hash_code": "9999999999999999"
        },
        "sequential_order_number": "2",
        "segments": [],
        "site_info": {
            "id": "9999999999999999",
            "timezone": "America/Los_Angeles",
            "store_number": "9999",
            "name": "99999",
            "apps": [
                {
                    "app_code": "XPOS",
                    "preferred_version": {
                        "version": "3.6.X",
                        "uri": "https://s3.amazonaws.com/com.xenial.shell/99/",
                    },
                    "installed_version": {
                        "version": "3.6.X",
                        "uri": "https://s3.amazonaws.com/com.xenial.shell/99/",
                    }
                }
            ]
        },
        "state": "open",
        "time": {
            "created": "20YY-03-14T16:57:41.714Z",
            "last_modified": "20YY-03-14T16:57:41.720Z",
            "first_item_added": "20YY-03-14T16:57:41.717Z"
        },
        "version": "99",
        "guest_count": 1,
        "destination": {
            "id": "carry-out",
            "name": "Carry Out",
            "consumption_type": "OffPremises"
        },
        "customer": {
            "id": "9999999999999999",
            "first_name": "test",
            "last_name": "test",
            "phone_cell": "9999999999999999",
            "loyalty_customer": false,
            "vehicle_type": "Van",
            "vehicle_color": "White",
            "vehicle_comment": "Nice whip"
        },
        "additional_properties": {},
        "items": [
            {
                "product_id": "9999999999999999",
                "order_item_id": "9999999999999999",
                "quantity": 1,
                "unit_price_source": "xenial",
                "entity_id": "9999999999999999",
                "item_type": "standard",
                "reporting_category": {
                    "minor_reporting_category_entity_id": "9999999999999999",
                    "major_reporting_category_entity_id": "9999999999999999",
                    "9999999999999999": {
                        "_id": "9999999999999999",
                        "name": "Drinks",
                        "is_major": true,
                        "minor_reporting_category_entity_ids": [
                            "9999999999999999",
                            "9999999999999999",
                            "9999999999999999",
                        ],
                        "entity_id": "9999999999999999",
                        "external_category_id": "",
                        "transaction_id": "9999999999999999"
                    },
                    "9999999999999999": {
                        "_id": "9999999999999999",
                        "name": "Americano",
                        "is_major": false,
                        "major_reporting_category_entity_id": "9999999999999999",
                        "entity_id": "9999999999999999"
                    }
                },
                "name": "Medium Hot Americano",
                "tags": [
                    "9999999999999999",
                    "9999999999999999",
                    "9999999999999999",
                ],
                "tax_group": {
                    "entity_id": "9999999999999999"
                },
                "kitchen_routing_categories": [],
                "tax_inclusive": false,
                "unit_price": 3.25,
                "roll_up_price": "do_not_roll_up",
                "time": {
                    "added": "20YY-03-14T16:57:41.717Z",
                    "last_modified": "20YY-03-14T16:57:41.720Z"
                },
                "state": "pending",
                "payment_status": "open",
                "child_items": [],
                "hash_code": "9999999999999999",
                "rollup_after_tax_amount": 0,
                "9999999999999999": 0,
                "taxable_price": 3.25,
                "price": 3.25,
                "tax_info": {
                    "taxes": [
                        {
                            "tax_definition_id": "9999999999999999",
                            "name": "Sales Tax 8.2%",
                            "tax_inclusive": true,
                            "amount_unrounded": 0.2463,
                            "amount": 0.25,
                            "marketplace_liable": false
                        }
                    ],
                    "total_marketplace_liable_unrounded": 0,
                    "9999999999999999": 0,
                    "total_inclusive_unrounded": 0.2463,
                    "total_inclusive": 0.25,
                    "total_exclusive_unrounded": 0,
                    "total_exclusive": 0,
                    "total_unrounded": 0.2463,
                    "total": 0.25
                },
                "tax_inclusive_price": 3.25
            }
        ],
        "subtotal": 3.25,
        "tax_inclusive_subtotal": 3.25,
        "discount_info": {
            "discounts": [],
            "total": 0,
            "total_unrounded": 0,
            "discount_map": []
        },
        "discount_total": 0,
        "tax_info": {
            "taxes": [
                {
                    "tax_definition_id": "9999999999999999",
                    "name": "Sales Tax 8.2%",
                    "tax_inclusive": true,
                    "amount_unrounded": 0.2463,
                    "amount": 0.25,
                    "marketplace_liable": false
                }
            ],
            "total_marketplace_liable_unrounded": 0,
            "9999999999999999": 0,
            "total_inclusive_unrounded": 0.2463,
            "total_inclusive": 0.25,
            "total_exclusive_unrounded": 0,
            "total_exclusive": 0,
            "total_unrounded": 0.2463,
            "total": 0.25
        },
        "total": 3.25
    },
    "extended_info": {}
}

The order object can contain the following fields, divided by category or code object:

CompanyInfo fields - Our Portal provides this basic company information.CompanyInfo
Contributor fields - This information designates the origin of the order.
Customer fields - These fields comprise all customer-related information, which is either provided by the customers in-store or on third-party client user interfaces (UI) or delivery service applications.
DayPartInfo fields - These fields describe the Day Part during which the order was sent.
DefaultProducts fields - This section of the Order Object lists all default products included in the order.
Destination fields - This information describes the Order Destination, which is the "point of issue" of the order. For example, Drive-thru, Dine-in, and To Go.
Discount fields - This information describes a specific discount that applies to the order.
DiscountInfo fields - This object contains information for all discounts applied to the order.
Employee fields - This object contains employee information, populated in-store.
FeeConfig fields - This information defines the configuration of a fee applied to the order.
FractionalQuantity fields - These fields define a factional modifier quantity.
ItemRule fields - This information defines item-specific rules. For example, availability per destination and default content.
KitchenTime fields - This object contains information regarding a kitchen event connected to the order.
OrderItem fields - This object contains information for an individual item within the order.
OrderItemReportingCategory fields - These fields describe the reporting categories of an order item.
OrderObject fields - These fields comprise the order object itself.
OrderSegment fields - Users can divide orders into segments, defined in these fields.
OrderSourceInfo fields - Order Source fields define the specific source where this order has been created.
Payment fields - These fields store information for an individual payment on an order.
PaymentInfo fields - These fields provide information for all payments on an order.
PrintRecord fields - These fields provide information for an individual print record.
ReasonCode fields - These fields provide context information for a refunded order.
RefundReference fields - These fields provide reference information for a refund.
ReportingCategory fields - These fields describe a reporting category.
SiteInfo fields - These fields contain details for an order site or location.
Tax fields - These fields provide information for an individual tax.
TaxExemptInfo fields - These fields provide information about tax exemptions.
TaxGroup fields - These fields describe a specific tax group.
TaxInclusiveInfo fields - These fields define the inclusive taxes applied to an order, item, or tax.
TaxInfo fields - These fields contain information for all taxes applied to an order, item, or tax.
TaxJurisdiction fields - These fields identify the jurisdiction that imposes a particular tax.
Terminal fields - These fields define the information for the terminal associated with a particular order or event.
TimeInfo fields - These fields record the time at which a particular event occurred.

Data Models

CompanyInfo

The Portal provides this basic company information.

Field Name	Type	Description
`id`	string	The company identifier stored in the Portal
`name`	string	The company name stored in the Portal

Contributors

This information designates the origin of the order.

Field Name	Type	Description
`employee`	Employee Object	An object containing the information of the employee who created or modified the order
`terminal`	Terminal Object	An object containing the information of the terminal at which the order was created or modified
`time`	string	The time at which the order was created or modified in ISO8601 format
`action`	string	The override permission name of the action taken. Example: `Order.Item.add`.

Customer

These fields comprise all customer-related information, which is either provided by the customers in-store or on third-party client user interfaces (UI) or delivery service applications. Users can update some of these fields after an order has already been committed to Online Ordering API.Xenial Online Ordering

Field Name	Type	Description
`address1`	string	The first address line of the customer
`address2`	string	The second address line of the customer
`city`	string	The city of the customer
`country`	string	The country of the customer
`delivery_date_time`	string	The date and time of the delivery
`email`	string	The email address of the customer
`first_name`	string	The customer's first name
`last_name`	string	The customer's last name
`id`	string	The customer identifier
`phone_cell`	string	The customer's cell phone number
`phone_home`	string	The customer's home phone number
`phone_work`	string	The customer's work phone number
`pickup_date_time`	string	The date and time of the pickup
`state`	string	The customer's state
`table_tent`	string	The tent number
`zip_code`	string	The customer's zip code

DayPartInfo

These fields describe the Day Part during which the order was sent. Day parts are time periods during the day, each belonging to a particular day part type and assigned to a specific day of the week. Day parts allow users to track orders or restrict menus by time of day.

Field Name	Type	Description
`day_part_type_id`	string	The unique identifier (UID) of the Day Part Type. This field matches the `entity_id` of the Day Part Type stored in Data Management.
`day_part_type_name`	string	The name of the Day Part Type. For example, Morning, Afternoon, or Evening.
`external_id`	string	The external identifier used to reference the Day Part Type

DefaultProducts

This section of the Order Object lists all default products included in the order.

Field Name	Type	Description
`default_quantity`	numeric	The default quantity of the product
`product_entity_id`	string	The default product identifier

Destination

This information describes the Order Destination, which is the "point of issue" of the order. For example, Drive-thru, Dine-in, or To Go. The Order Destination can alter what menu content is available and what pricing rules apply to the order.

Field Name	Type	Description
`entity_id`	string	The destination identifier
`id`	string	Describes whether the order is for "eat-in" or "drive thru"
`name`	string	The destination's name
`tags`	string[]	The destination's tags

Discount

This information describes a specific discount that applies to the order. Our system offers many type of discount configurations, including order-level and item-level discounts, manual and automatic, percentage and fixed amount, and quantity-based.

Field Name	Type	Description
`amount`	numeric	The amount of discount applied rounded to a number of decimal digits based on the currency setting
`amount_unrounded`	numeric	The amount of discount applied (to 5-digit decimal precision value)
`apply_type`	string	How the discount is applied
`distributed`	boolean	True - The distributed discount amount. False/Null - The full discount amount.
`id`	string	The discount identifier
`ignore`	boolean	True - Ignore the discount amount in all calculations, such as order total, or discount recalculation. False - Include the discount amount in all calculations.
`order_discount_id`	string	The unique identifier (UID) for this instance of the discount
`quantity`	numeric	The quantity of the discount applied

DiscountInfo

This object contains information for all discounts applied to the order.

Field Name	Type	Description
`discounts`	array of Discount objects	A list of discounts applied to the item or order
`total_unrounded`	numeric	The total discount amount applied to the item or order without rounding (5-digit decimal precision value)
`total`	numeric	The total discount amount rounded to a number of decimal digits based the currency setting

Employee

This object contains employee information, populated in-store.

Field Name	Type	Description
`id`	string	The employee identifier
`name`	string	The employee's first and last name
`title`	string	The employee's job title. For example, cashier or manager.
`code`	string	The employee's corporate code

FeeConfig

This information defines the configuration of a fee applied to the order.

Field Name	Type	Description
`amount`	numeric	The amount of the fee. For percentage fees, this is the percentage to use when calculating the fee, written as a decimal number. For example, 0.20 for 20%.
`apply_as`	string	How the "amount" value should be applied to the order. The valid values are as follows: fixed: The amount is added as a fixed currency value. percentage: The amount is calculated as a percentage of the total of the order.
`apply_pre_tax`	boolean	When set to true, the fee is calculated on the subtotal, without discounts, before taxes are added. When false, the fee is calculated on the full total (subtotal + taxes - discounts).
`fee_type`	string	Specifies what type of fee the object represents. The valid values are as follows: gratuity: The fee is a gratuity calculation. It could be automatic or manual. service: The fee is an arbitrary service fee.
`precision`	numeric	(Optional) Specifies the decimal precision for the fee calculation. The default value is two (2) decimal places of precision.

FractionalQuantity

These fields define a factional modifier quantity.

Field Name	Type	Description
`numerator`	number	The numerator of the fractional quantity
`denominator`	number	The denominator of the fractional quantity

ItemRule

This information defines item-specific rules. For example, availability per destination or default content.

Field Name	Type	Description
`_id`	string	The Mongo Database identifier
`allowed_destination_entity_ids`	array of strings	A list of destination identifiers
`component_type`	string	The component's type: group or item
`default_products`	array of DefaultProduct objects	A list of default products
`default_quantity`	numberic	The default quantity
`entity_id`	string	The item rule identifier
`is_enabled`	boolean	A flag that indicates whether to enable or disable the value for the item rule
`maximum_quantity`	numeric	The maximum quantity
`minimum_quantity`	numeric	The minimum quantity
`name`	string	The component label of the item rule
`pricing_change_action`	string	Deprecated
`product_choices_entity_ids`	array of strings	A list of identifiers for available product choices
`sort_order`	numeric	The position in the tab order

KitchenTime

This object contains information regarding a kitchen event connected to the order.

Field Name	Type	Description
`screen`	string	The kitchen screen name where the event occurred
`screen_entity_id`	string	The screen entity identifier for the kitchen screen where the event occurred
`type`	string	The type of action performed by the kitchen. The valid values are as follows: ready claimed unclaimed bump recall arrival
`time`	string	The time when the kitchen event occurred in ISO-8601 format
`trigger`	boolean	For bump events only. A flag that indicates the bump type, either "auto" or "manual."

OrderItem

This object contains information for an individual item within the order.

Field Name	Type	Description
`bundle_entity_id`	string	The entity identifier of the bundle
`child_items`	array of item objects	An array of child items
`comment`	string	The user comment
`discount_info`	DiscountInfo Object	The item discount information
`entity_id`	string	The unique identifier (UID) relating to the product identifier
`fee_config`	FeeConfig Object	(Optional) Defines the configuration for a "fee" type order item
`fulfilment_status`	string	(Optional) The fulfillment status of the item
`fractional_quantity`	FractionalQuantity	The fractional quantity of the item ordered
`fractional_quantity_before_sharing`	FractionalQuantity	The fractional quantity of the item ordered before sharing
`hash_code`	string	The hash code order
`item_type`	string	The type of the item such as product, modifier.
`kitchen_routing_categories`	string	A list of strings that tells us which kitchen printer an item should be sent to on "send to kitchen"
`kitchen_timing`	array of KitchenTime objects	A list of KitchenTime objects which hold timing information for kitchen events
`liability_type`	string	Set to either "gift_card" or "gift_certificate"
`master`	string	The identifier of the base item, if the current item is a modifier
`modifiers`	array of OrderItem objects	A list of OrderItem objects for all attached modifiers
`name`	string	The name of the item
`order_item_id`	string	The unique item instance identifier (differentiates between several instances of one product on the order such as taco1, taco2, taco3). The `order_item_id` should be able to "live" out of the order.
`order_reference_id`	string	The order reference identifier for the order that is used for sharing
`payment_status`	string	The payment transaction status type such as paid, refunded
`price`	numeric	The price of the item
`price_adjustment`	numeric	The price remainder of the division after sharing
`print_emphasized`	boolean	(Optional) Defines whether to print the order item emphasized on receipts
`product_id`	string	The unique product identifier from the menu, uses the same value for multiple instances of one product
`quantity`	numeric	The quantity of the item ordered
`reason_code`	ReasonCode Object	The order item reason code
`reference_id`	string	The order item reference identifier that was used for sharing
`removed_by_employee_id`	string	(Optional) Defines the employee identifier who removed the order item or approved the removal operation
`removed_by_employee_name`	string	(Optional) Defines the employee name who removed the order item or approved the removal operation
`removed_by_employee_code`	string	(Optional) Defines the employee corporate code who removed the order item or approved the removal operation
`reporting_category`	OrderItemReportingCategory Object	The order item reporting category
`required_position`	boolean	Involved in placeholder manipulation
`revenue_class`	array of strings	A reporting field. This should be set from product data.
`rules`	array of ItemRule objects	Defines the rules for bundle components
`segment_id`	numeric	The order segments are separations in the order such as seats or trays. This is the identifier for the segment associated with the item.
`sort_order`	numeric	This value provides the ability to manually sort the items in an order
`state`	string	The state of the item such as open, saved, deleted, or voided
`tags`	array of strings	An array of identifiers or names for the tags that item belongs to
`tax_group`	TaxGroup Object	The item tax group
`tax_inclusive_info`	TaxInclusiveInfo Object	The item tax inclusive information
`tax_info`	TaxInfo Object	The item tax information
`time`	TimeInfo Object	The item time information
`unit_price`	numeric	The unit price of the item ordered

OrderItemReportingCategory

These fields describe the reporting categories of an order item.

Field Name	Type	Description
`major_reporting_category`	ReportingCategory Object	The major reporting category information
`minor_reporting_category`	ReportingCategory Object	The minor reporting category information

OrderObject

These fields comprise the order object itself.

Field Name	Type	Description
`_id`	string	The unique order object identifier
`additional_properties`	AdditionalPropertiesType Object	The object which allows additional key-value pairs to be stored on an order. This field is best used to store integrator specific key-value pairs for use with external systems, as shown in the example below: { "_id": "order-object-id", "additional_properties": { "string_key": "string_value", "some_tokens": { "web_token": "token", "secret_token": 99999 } } }
`business_date`	string	The current business date
`comment`	string	The comment for the order
`company_id`	string	The unique identifier (UID) of the company
`contributors`	array of Contributors objects	A list of additional employees or terminals involved in this order
`creator`	Contributors Object	The creator of the order. Contains the terminal identifier and employee name.
`customer`	Customer Object	The customer details information
`deleted_items`	array of OrderItem objects	The deleted items
`destination`	Destination Object	The order destination. The available options are: dine-in, carry-out, drive thru, and delivery.
`discount_info`	DiscountInfo Object	Order level discount information
`discount_total`	numeric	The total of all order and item-level discounts
`drawer_id`	string	The drawer identifier
`expo_number`	string	An easily spoken representation of the order number. Usually shown on customer receipts.
`fulfillment_status`	string	Optional. A fulfillment status of the order
`items`	array of OrderItem objects	The order items
`kitchen_timing`	array of KitchenTime objects	A list of KitchenTime objects which hold timing information for kitchen events. Currently, `kitchen_timing` is saved at the order item level only.
`lifecycle`	string	The lifecycle of order from total, tender, and save
`notification_status`	string	The order object status. The available options include open, committed, committed-ack, checkedin, checkedin-ack, voided, voided-ack, and bumped.
`order_number`	string	The unique number for a particular company and particular site
`order_point`	string	The name or other identifier of the specific device that created the order such as "kiosk1", "kiosk2", "register1".
`order_source`	string	The device that the order originated from. This value is set by the client ordering application and is specific to customer requirements. It is not used for system-level management of orders. Note `order_source_ext` is the new field that should be used instead. Any new code that reads an order object should use `order_source` only if `order_source_ext` is not provided.
`order_source_ext`	OrderSourceInfo Object	The point that the order originated from
`order_type`	string	The order type. The available options include Order, Refund, or Waste.
`origin`	string	The system that the order or notification originated from. This is set to "mobile" for orders that originate from the cloud. For orders and notifications that originate from the store, this is set to the store number. Our system processes use this internally to manage synchronization of orders and notifications between the cloud and the store.
`owner`	Employee Object	The owner information
`payment_info`	PaymentInfo Object	The payment information
`payment_status`	string	The transaction type. The available options include open, paid, partial, post-adjusted, and refunded.
`print_info`	array of PrintRecord objects	A list of when this order receipt was printed and by whom
`reason_code`	ReasonCode Object	The reason code for a declined order
`reference_id`	string	The identifier of the original order in the refunded order
`refunds`	array of RefundReference objects	The refunds information. A separate object is created for each refunded item with the reference to the refunded order.
`segments`	array of OrderSegment objects	The segments information
`sequential_order_number`	string	The unformatted order number. For example, 1004.
`site_info`	SiteInfo Object	The site details such as name, phone, address, website, and email
`state`	string	The order object state. The available options include open, saved, deleted, voided, overringed, parked, split, suspended, voided-post-payment, committed, checkedin, bumped, and purged.
`subtotal`	numeric	The subtotal of the order
`tax_exempt_info`	TaxExemptInfo Object	The tax exempt information
`tax_inclusive_info`	TaxInclusiveInfo Object	The tax inclusive information
`tax_info`	TaxInfo Object	The order level tax information
`time`	TimeInfo Object	The order dates and times in ISO8601 format
`total`	numeric	The total of the order
`version`	string	The order object version
`voided_items`	array of OrderItem objects	The voided items information

OrderSegment

Users can divide orders into segments, defined in these fields. Data Management provides settings for configuring segment names.

Field Name	Type	Description
`title`	string	The name of the segment (Tray1, Tray2 or Seat1, Seat2). This name depends on how it was created as Tray or Seat, which is set on Data Management.
`num`	numeric	The number of the corresponding segment that is included in the OrderItem to determine which segment the item belongs to

OrderSourceInfo

The Order Source fields define the specific source where this order has been created. For example, "Delivery." Order sources differ from the Origin field, which is system definable, as opposed to Order Sources which are defined by integrators. For an example of usage of the two entities, "Origin: In store" could be applicable for several order sources like "drive thru" or "dine in." Order Source is heavily used in the our ecosystem to filter/restrict certain items, menus, prices, and time periods for different ordering platforms.

Field Name	Type	Description
`name`	string	The given name of the order source. For example, web or Terminal 47.
`order_source_id`	string	The unique identifier (UID) for a particular order source

Payment Object

These fields store information for an individual payment on an order. Online orders can contain payment information already or they can be committed as an unpaid order, allowing point of sale (POS) system employees to populate payment information in-store. An order can also might be updated in-store if the order content changes.

Field Name	Type	Description
`account`	string	The account identifier
`agreement`	string	The Portico requirement added for certification
`aid_number`	string	The authorization identifier. For Europay, Mastercard, and Visa (EMV) transactions, this is the application identifier (AID) field.
`allow_tip`	boolean	A flag that indicates whether to allow tips. The POS system does not use this field.
`amount`	numeric	The payment amount rounded to currency decimal precision
`application_name`	string	The name of card processing application such as MasterCardCredit and AMEX. For EMV transactions, this is the APL field.
`application_response_code`	string	The EMV Authorization Response Code (ARC) field.
`arqc`	string	The cryptogram field
`auth`	string	The authentication code
`balance`	numeric	The balance on the card
`card_acquisition`	string	The type of acquisition such as MANUAL, SWIPE, CONTACTLESS, SCANNER, CHIP, and CHIP_FALL_BACK_SWIPE. For EMV transactions, this is the CEM field.
`card_brand_name`	string	Card company brand such as Visa, Mastercard, or American Express.
`code`	string	The payment code. Options include CASH, DEBIT, CREDIT, or GIFT.
`e_signature`	string	The Suppress Signature line.
`emv`	boolean	The EMV format for Portico
`external_pay_type`	string	The customized gift card name
`id`	string	The unique payment identifier
`issuer_application_data`	string	The EMV AID field
`offline_id`	string	An identifier relating to a Store and Forward (SAF) action. It is used to query a payment device to update the status of a transaction after a SAF action. This has been available since OrderObject version 4.
`open_cash_drawer`	boolean	POS does not use this field
`pay_type_id`	string	The identifier value relating to pay type enums
`pay_type_name`	string	The display name of the pay type used for the payment. It was added in OrderObject version 6.
`point_balance`	numeric	The number of points left in a customer's house account. For example, a customer could have 30 points left for rewards after the order transaction.
`processed_at`	string	The transaction processing time in Coordinated Universal Time (UTC) format
`name_on_card`	string	The card name
`refund_policy`	string	The Portico requirement added for certification
`request_id`	string	The request identifier by transaction
`signature`	boolean	Any value of this field triggers a print signature line. For more information, see `e_signature` and `PIN`). Convert to string.
`status`	string	The payment status
`tc`	string	A cryptogram field
`terminal_id`	string	The terminal where payment was processed
`terminal_verification_results`	string	The EMV terminal verification results (TVR) field
`tip_amount`	number	The sum total of tips
`trace_number`	string	The transaction identifier in the batch
`transaction_id`	string	The transaction identifier
`transaction_status_indicator`	string	The EMV transaction status indicator (TSI) field
`transaction_type`	string	The available transactions types. For example, SALE or REFUND.
`verification_method`	string	For EMV transactions, this is the Cardholder Verification Method (CVM) field.

PaymentInfo

These fields provide information for all payments on an order.

Field Name	Type	Description
`change`	numeric	Only present if a change is due
`payments`	array of Payment objects	A list of payments used to pay the order
`tips`	number	The total of all tips from all payments
`total`	numeric	The total payment amount rounded to "n" decimal digits based on currency setting

PrintRecord

These fields provide information for an individual print record.

Field Name	Type	Description
`printed_by`	string	The first and last name of the person who printed the record
`user_id`	string	The employee identifier of the person who printed the record
`time`	string	The time the record was printed in ISO8601 format

ReasonCode

These fields provide context information for a refunded order.

Field Name	Data Type	Description
`_id`	string	The reason code identifier
`action`	string	One of the following actions: `void_order` `void_item` `void_order_post_payment` `paid_out` `paid_in` `order_refund` `tax_exempt` `change_item_price` `create_waste_order`
`name`	string	The name of the reason
`employee`	Employee Object	The employee information
`entity_id`	string	The entity identifier of the reason code
`prompt_reason`	boolean	This field is responsible for showing the prompt reason pop-up
`time`	TimeInfo Object	The time information

RefundReference

These fields provide reference information for a refund.

Field Name	Type	Description
`order_item_id`	string	The refunded order item identifier
`quantity`	number	The refunded item quantity
`refund_order_reference_id`	string	The refunded order identifier (reference to created refund order)

ReportingCategory

These fields describe a reporting category.

Field Name	Type	Description
`name`	string	The reporting category name
`entity_id`	string	The entity identifier of the reporting category

SiteInfo

These fields contain details for an order site or location. Typically, Online Ordering orders only populate the bare minimum of site_info in order to identify to which site the order should be sent.

Field Name	Type	Description
`address`	string	The first address line for the site
`address2`	string	The second address line for the site
`city`	string	The site city
`company`	CompanyInfo ObjectCompanyInfo	The site company information
`email`	string	The site email address
`id`	string	The site identifier
`name`	string	The site name
`phone`	string	The site phone number
`state`	string	The United States (US) state or country province string
`store_number`	string	The store number defined by the company
`website`	string	The website for the site
`zip`	string	The site zip code

Tax

These fields provide information for an individual tax.

Field Name	Type	Description
`id`	string	The tax identifier
`name`	string	The name of the tax
`amount_unrounded`	numeric	The amount of the tax applied to the order, item, or tax (5-digit decimal precision value)
`amount`	numeric	The amount of the tax applied to the order, item, or tax rounded to "n" decimal digits based on currency setting
`tax_info`	tax_Info Object	The tax applied to the tax (tax on tax)
`visible`	boolean	A flag that determines if the discount is visible
`tax_class`	string	Specifies the class of the tax
`tax_jurisdiction`	TaxJurisdiction Object	Display the jurisdiction which imposes this tax

TaxExemptInfo

These fields provide information about tax exemptions.

Field Name	Type	Description
`id`	string	The tax exemption identifier
`reason`	string	The reason text for the tax exemption
`taxes`	array of Tax objects	A list of taxes exempted
`total`	numeric	The total tax exempted rounded to "n" digits based on the currency setting

TaxGroup

These fields describe a specific tax group.

Field Name	Type	Description
`entity_id`	string	The entity identifier of the tax group
`tax_code`	string	The tax code / tax group identifier
`name`	string	The name of the tax group

TaxInclusiveInfo

These fields define the inclusive taxes applied to an order, item, or tax.

Field Name	Type	Description
`taxes`	array of Tax objects	A list of taxes applied to the item, order, or tax
`total`	numeric	A rounded total of inclusive taxes (configured decimal precision)
`total_unrounded`	numeric	An unrounded total of inclusive taxes (fixed five (5) decimal places of precision)

TaxInfo

These fields contain information for all taxes applied to an order, item, or tax.

Field Name	Type	Description
`taxes`	array of Tax objects	A list of taxes applied to the item, order, or tax
`taxes_inclusive`	array of Tax objects	A list of inclusive taxes applied to the item, order, or tax
`total_unrounded`	numeric	The total tax amount applied to the item, order, or tax (5-digit decimal precision)
`total`	numeric	The total tax applied to the item, order, or tax rounded to "n" digits based on the currency setting
`total_inclusive_unrounded`	numeric	The total inclusive taxes (five (5) decimal points)
`total_inclusive`	numeric	The total inclusive taxes rounded to configured decimal points

TaxJurisdiction

These fields identify the jurisdiction that imposes a particular tax.

Field Name	Type	Description
`entity_id`	string	The jurisdiction identifier
`name`	string	The jurisdiction name
`jurisdiction_type`	string	The level of the jurisdiction
`external_id`	string	The unique external identifier of the jurisdiction object to which the tax is associated

Terminal

These fields define the information for the terminal associated with a particular order or event.

Field Name	Type	Description
`id`	string	The terminal identifier (previously knows as register ID)
`terminal_number`	string	The terminal number
`title`	string	The terminal title, such as front counter or drive thru

TimeInfo

These fields record the time at which a particular event occurred.

Field Name	Type	Description
`added`	string	The time for last addition of an item or reason to the collection
`created`	string	The created date-time in the ISO8601 format
`checkedin`	string	The time that the customer of a mobile order has checked in at the restaurant or that the order was sent to kitchen to be prepared
`closed`	string	The closed time for the item or reason
`first_saved`	string	The first saved (totaled, sent to kitchen) time for order
`first_item_added`	string	The time that an item of any type was first added to order
`first_split`	string	The time when the first item from some other order was added during a split operation
`kitchen_sent`	string	The sent date-time to kitchen in the ISO8601 format
`kitchen_bump`	string	The time that the order was completed by the kitchen (bumped)
`last_modified`	string	The last modified date-time in the ISO8601 format