Operation Definitions
The operation definitions include the endpoints, data models, and sample code used in the Reporting API.
Endpoints
GET /api/reporting/active-sites
Summary
The Active Sites resource returns an array of sales information for active sites.
Request Parameters
In | Field Name | Type | Required | Descriptions |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company identifier (ID) which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| boolean | No | Include sites with zero sales. The default value is false. |
Responses
Code | Description | Schema |
|---|---|---|
200 | A list of active sites sales | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/calculations
Summary
The Calculations resource returns an array of aggregated metrics for the requested business days.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | Orders aggregated totals | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/cash-drawer-summary
The Drawer Summary resource returns an array of objects per drawer session, displaying summarized sales totals.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | No | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| string | No | The session ID filter value |
query |
| integer | No | The session number filter value |
query |
| string | No | The session status filter value |
query |
| integer | No | The maximum number of records to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer | No | The page number of the output data. The default value is 0. |
Responses
Code | Description | Schema |
|---|---|---|
200 | Cash drawer summary totals | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/discounts/by-type
Summary
The Discounts by Type resource returns an array of discount objects that summarize associated discount totals by type.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| string | No | The discount type filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | Aggregated data for discounts by type | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/discounts
Summary
The Discounts resource returns an array of discount objects that summarize associated discount totals, including quantity and sum for orders and items discounted.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| string | No | The discount code filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | Aggregated data for discount totals | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/drawer-transactions
Summary
The Drawer Transactions resource returns an array of objects per drawer transaction, displaying detailed records.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | No | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| string | No | The session ID filter value |
query |
| integer | No | The session number filter value |
query |
| string | No | The order ID filter value |
query |
| string | No | The type of the event filter value |
query |
| integer | No | The maximum number of records to return. The maximum page size is 50. All values greater then 50 are reset to 50. |
query |
| integer | No | The page number of the output data. The default value is 0. |
Responses
Code | Description | Schema |
|---|---|---|
200 | Drawer transactions | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/item-summary
Summary
The Item Summary resource returns an array of objects per product, displaying summarized sales totals.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| string | No | The entity ID filter value |
query |
| string | No | The product ID filter value |
query |
| string | No | The item type ID filter value |
query |
| string | No | The sort by condition. If set, the sort is performed in descending order. |
query |
| integer | No | The maximum number of records to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer | No | The page number of the output data. The default value is 0. |
Responses
Code | Description | Schema |
|---|---|---|
200 | Item summary data | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/named-calculations
Summary
The Named Calculations resource returns an array of metrics from Named Calculations formulas.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
Responses
Code | Description | Schemas |
|---|---|---|
200 | A list of orders | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/order-items
Summary
The Order Items resource returns an array of items associated with the order identifier (ID) included in the query string.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The order ID filter value |
query |
| string | Yes | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| boolean | No | When “true”, the response includes items that have been deleted from an order |
query |
| boolean | No | When “true”, the response includes items that have been voided from an order |
Responses
Code | Description | Schema |
|---|---|---|
200 | Order items | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
404 | Not Found | |
Default | Unexpected Error |
GET /api/reporting/order-items/batch
Summary
The Order Items Batch resource returns an array of objects, which contains information on order items by business date.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| integer | No | The maximum number of records to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer | No | The page number of the output data. The default value is 0. |
query |
| string | No | When present, the response is filtered to show objects related to orders that have been updated past the provided date/time value. This timestamp should be provided in the following format: YYYY-MM-DDTMM:SS and represent a Coordinated Universal Time (UTC) value instead of the store's local time. |
query |
| boolean | No | When “true”, the response includes items that have been deleted from an order |
query |
| boolean | No | When “true”, the response includes items that have been voided from an order |
Responses
Code | Description | Schema |
|---|---|---|
200 | Order items | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/order-payments
Summary
The Order Payments resource returns an array of payments associated with a business date or a specific order.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | No | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| string | No | The order number filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | A list of orders payments | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/orders
Summary
The Orders resource returns an array of order objects, which contain details about orders that meet the filter criteria in the query.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | No | Sort output results. Currently, the sort is performed by the business date field only. The default sort order is descending. Possible values are "asc" and "desc." |
query |
| integer | No | The maximum number of records to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer | No | The page number of the output data. The default value is 0. |
query |
| string | No | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| string | No | The order state filter value |
query |
| string | No | The order number filter value |
query |
| string | No | The employee code filter value |
query |
| string | No | The event name filter value |
query |
| string | No | The updated at date filter value. A last modified date must be in the ISO-8601 format. |
Responses
Code | Description | Schema |
|---|---|---|
200 | A list of orders | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/sales-by-time
Summary
The Calculations resource returns an array of sales objects that include summarized Net Sales, Gross Sales, and Guest Count values for a requested business day. Net/Gross Sales Calculations are summarized based on formulas configured within Data Management → Named Calculations.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | No | The business date filter value. A business date must be in the ISO-8601 format. |
query |
| integer | No | The time interval code. The default value is 1. The valid values are:
|
Responses
Code | Description | Schema |
|---|---|---|
200 | Sales By Time totals | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/statistic-by-daypart
Summary
The Statistics by Day Part resource returns an array of objects, which contain totals aggregated by Day Parts.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| string | No | The order source filter value |
query |
| string | No | The destination filter value |
query |
| string | No | The daypart filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | Orders aggregated totals by Day Parts | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/statistic-by-destination
Summary
The Statistics by Destination resource returns an array of objects, which contain totals aggregated by Destinations.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| string | No | The order source filter value |
query |
| string | No | The destination filter value |
query |
| string | No | The daypart filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | Orders aggregated totals by Day Parts | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/statistic-by-order-source
Summary
The Statistics by Order Source resource returns an array of objects, which contain totals aggregated by Order Source.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| string | No | The order source filter value |
query |
| string | No | The destination filter value |
query |
| string | No | The daypart filter value |
Responses
Code | Description | Schema |
|---|---|---|
200 | Orders aggregated totals by Order Source | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/deposits
Summary
The Deposits resource returns an array of deposit information for the requested business days.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company ID which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | No | Filters the response to show only objects related to the provided business date. A business date must be in YYYY-MM-DD format. |
query |
| integer | No | The maximum number of records to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer | No | The page number of the output data. The default value is 0. |
Responses
Code | Description | Schema |
|---|---|---|
200 | A list of deposits | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied |
GET /api/reporting/labors/payroll-details
Summary
The Payroll Details resource returns payroll transaction information.
Request Parameters
In | Field Name | Type | Required | Descriptions |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company identifier (ID) which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| integer (int32) | No | The maximum records amount to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer (int32) | No | The page number of the output data. The default value is |
Responses
Code | Description | Schema |
|---|---|---|
200 | Payroll transactions | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
GET /api/reporting/labors/payroll-summary
Summary
The Payroll Summary resource returns payroll summary information.
Request Parameters
In | Field Name | Type | Required | Descriptions |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | An integrator or access token |
header |
| string | Yes | The company identifier (ID) which is set in the header must be the same as the company ID set in the token, if available |
header |
| string | Yes | The comma separated list of site IDs. A user can access all the sites related to a company at the moment. |
query |
| string | Yes | The start business date filter value |
query |
| string | Yes | The end business date filter value |
query |
| integer (int32) | No | The maximum records amount to return. The maximum page size is 50. All values greater than 50 are reset to 50. |
query |
| integer (int32) | No | The page number of the output data. The default value is |
query |
| boolean | No | A flag that indicates whether to the include minimum wage adjustment. The default value is |
query |
| boolean | No | A flag that indicates whether to include missed breaks. The default value is |
Responses
Code | Description | Schema |
|---|---|---|
200 | Payroll summary | |
400 | Bad Request | |
401 | Unauthorized | |
403 | Permission Denied | |
Default | Unexpected Error |
Data Models
company_info
Field Name | Type | Description |
|---|---|---|
| string | The company identifier for the request |
| string | The company name for the request |
site_info
Field Name | Type | Description |
|---|---|---|
| string | The unique identifier of the specified site |
| string | The unique name of the specified site |
| string | The store number of the specified site |
| string | The time zone for the specified site |
terminal_info
Field Name | Type | Description |
|---|---|---|
| string | The terminal where the payment was processed |
| string | The terminal name |
| string | The terminal number |
tax_exempt_info
Field Name | Type | Description |
|---|---|---|
| string | The tax exempt identifier |
| string | The tax exempt total |
tax_exempt_total
Field Name | Type | Description |
|---|---|---|
| string | The tax exempt total |
gl_account_info
Field Name | Type | Description |
|---|---|---|
| string | The general ledger account name |
| string | The general ledger account number |
destination_info
Field Name | Type | Description |
|---|---|---|
| string | The destination identifier |
| string | The destination name |
drawer_info
Field Name | Type | Description |
|---|---|---|
| string | The session identifier |
| string | The session number |
drawer_info_drawer_transactions
Field Name | Type | Description |
|---|---|---|
| string | The employee's identifier |
| string | The employee's name |
| string | The employee's job type |
| string | The employee's corporate code |
| string | The employee's job code |
actor_info
Field Name | Type | Description |
|---|---|---|
| string | The session identifier |
| string | The session number |
| string |
orders_info
Field Name | Type | Description |
|---|---|---|
| string | The order identifier |
| string | The order number |
owner_employee_info
Field Name | Type | Description |
|---|---|---|
| string | The owner's employee identifier |
| string | The owner's employee number |
| string | The owner's name |
time_info
Field Name | Type | Description |
|---|---|---|
| string | The ISO-8601 formatted date and time the order was updated |
| string | The created date-time in ISO8601 format |
| string | The closed time for the item/reason |
| string | The sent date-time to kitchen in ISO8601 format |
| The time that the order was completed by the kitchen (bumped) | |
| string | The first saved (totaled, sent to kitchen) time for the order |
| string | The time that an item of any type was first added to order |
survey_info
Field Name | Type | Description |
|---|---|---|
| string | The survey code |
| string | The survey entity identifier |
| string | The survey external identifier |
| string | The survey message |
| string | The survey name |
daypart_info
Field Name | Type | Description |
|---|---|---|
| string | The unique identifier of the Day Part Type |
| string | The name of the Day Part Type |
| string | The external identifier used to reference the Day Part Type |
order_source_info
Field Name | Type | Description |
|---|---|---|
| string | The given name of the order source |
| string | The unique identifier for a particular order source |
event
Field Name | Type | Description |
|---|---|---|
| string | The unique event identifier |
| string | The event name |
| string | The event type |
time_info_cash_drawer_summary
Field Name | Type | Description |
|---|---|---|
| string | The ISO8601 formatted date and time the cash drawer opened |
| string | The ISO8601 formatted date and time the cash drawer closed |
owner_employee_info_cash_drawer
Field Name | Type | Description |
|---|---|---|
| string | The owner's employee code |
| string | The owner's name |
calculation_sections
Field Name | Type | Description |
|---|---|---|
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
calculations
Field Name | Type | Description |
|---|---|---|
| object | The |
| string | The gross sales total |
| object | The |
| string | The discount total |
| string | The discount total quantity |
| object | The |
| string | The liability items total |
| string | The liability items quantity |
| object | The |
| string | The post payment voids total |
| string | The post payment voids total quantity |
| object | The |
| string | The refunds total |
| object | The |
| string | The tax total |
| object | The |
| string | The voided orders total |
| string | The voided orders total quantity |
| object | The |
| string | The net sales total |
| string | The net sales quantity |
custom_calculations
Field Name | Type | Description |
|---|---|---|
| string | The custom calculations named code |
| string | The custom calculations result |
payments
Field Name | Type | Description |
|---|---|---|
| string | The payments total |
| string | The payments quantity |
| A list of the pay type totals information | |
| A list of the credit card totals information |
pay_type_object
Field Name | Type | Description |
|---|---|---|
| object | The |
| string | The pay type name |
| string | The pay type total |
| string | The pay type quantity |
credit_card_brand_object
Field Name | Type | Description |
|---|---|---|
| object | The |
| string | The credit card brand name |
| string | The credit card brand total |
| string | The credit card brand quantity |
pay_in_out
Field Name | Type | Description |
|---|---|---|
| object | The |
| string | The pain in total |
| string | The pain in quantity |
| object | The |
| string | The paid out total |
| string | The paid out quantity |
other_statistics
Field Name | Type | Description |
|---|---|---|
| object | The |
| string | The non-taxed item sales total |
| string | The non-taxed item sales quantity |
| object | The |
| string | The gift card cash out total |
| string | The gift card cash out quantity |
| object | The |
| string | The tax exempt orders information |
guest_count
Field Name | Type | Description |
|---|---|---|
| string | The guest count quantity |
reconciliation
Field Name | Type | Description |
|---|---|---|
| object | The |
| string | The drawers count total |
| string | The drawers expected total |
| string | The drawers pull total |
| string | The drawers variance |
| object | The |
| string | The deposits actual total |
| string | The deposits expected total |
| string | The deposits variance |
destinations
Field Name | Type | Description |
|---|---|---|
| string | The destinations total |
| string | The destinations quantity |
| A list of the |
destination_object
Field Name | Type | Description |
|---|---|---|
| string | The destination name |
| string | The destination total |
| string | The destination quantity |
| string | This field is reserved for the future use. Currently, it is set to null always. |
discounts
Field Name | Type | Description |
|---|---|---|
| string | The discounts total |
| string | The discounts quantity |
| The list of the | |
| The list of the |
discounts_object
Field Name | Type | Description |
|---|---|---|
| string | The discount name |
| string | The discount total |
| string | The discount quantity |
discounts_types_object
Field Name | Type | Description |
|---|---|---|
| string | The discount type name |
| string | The discount type total |
| string | The discount type quantity |
day_parts
Field Name | Type | Description |
|---|---|---|
| string | The day parts total |
| string | The day parts quantity |
| The list of the |
day_part_object
Field Name | Type | Description |
|---|---|---|
| string | The day part name |
| string | The day part total |
| string | The day part quantity |
order_sources
Field Name | Type | Description |
|---|---|---|
| string | The order sources total |
| string | The order sources quantity |
| The list of the |
order_source_object
Field Name | Type | Description |
|---|---|---|
| string | The name of the order source |
| string | The order source total |
| string | The order source quantity |
liability_items
Field Name | Type | Description |
|---|---|---|
| string | The liability items total |
| string | The liability items quantity |
| string | The liability items promotions total |
| string | The liability items promotions quantity |
| The list of the |
liability_item_object
Field Name | Type | Description |
|---|---|---|
| string | The liability item name |
| string | The liability item total |
| string | The liability item quantity |
donation_items
Field Name | Type | Description |
|---|---|---|
| string | The donation items total |
| string | The donation items quantity |
| The list of the |
donation_item_object
Field Name | Type | Description |
|---|---|---|
| string | The donation item name |
| string | The donation item total |
| string | The donation item quantity |
taxes
Field Name | Type | Description |
|---|---|---|
| string | The taxes total |
| The |
guests
Field Name | Type | Description |
|---|---|---|
| string | The number of guests |
tax_rate_totals
Field Name | Type | Description |
|---|---|---|
| string | The tax rate name |
| string | The tax rate total |
merchants_taxes_totals
Field Name | Type | Description |
|---|---|---|
| string | The merchant taxes name |
| string | The merchant taxes total |
tips
Field Name | Type | Description |
|---|---|---|
| string | The refunded tips |
| string | The paid tips |
| string | The collected tips |
fees
Field Name | Type | Description |
|---|---|---|
| string | The fees total |
| string | The fees quantity |
| The list of the |
fees_object
Field Name | Type | Description |
|---|---|---|
| string | The fee name |
| string | The fee total |
| string | The fee quantity |
order_item
Field Name | Type | Description |
|---|---|---|
| string | The order item unique identifier |
| string | The order item product identifier |
| array | A list of external identifiers |
| string | The order item quantity |
| string | The order item payment status |
| string | The order item price |
| string | The order item unit price |
| string | The order item type |
| string | |
| string | The order item identifier |
| string | The order item name |
| string | The order item liability type |
| string | The parent item reference identifier |
| The | |
| The | |
| object | The |
| The | |
| string | The order item tax total |
| object | The |
| The | |
| string | The order item discount total |
order_item_time
Field Name | Type | Description |
|---|---|---|
| string | The ISO-8601 formatted date and time the order item was added |
| string | The ISO-8601 formatted date and time the order item in Coordinated Universal Time (UTC) |
| string | The ISO-8601 formatted date and time the order item was last modified |
| string | The ISO-8601 formatted date and time the order item was last modified in UTC |
| string | The ISO-8601 formatted date and time the order item was voided |
| string | The ISO-8601 formatted date and time the order item was voided in UTC |
order_item_reporting_category
Field Name | Type | Description |
|---|---|---|
| string | The order item major reporting category entity identifier |
| string | The order item major reporting category name |
| string | The order item minor category entity identifier |
| string | The order item minor category name |
order_item_tax
Field Name | Type | Description |
|---|---|---|
| boolean | |
| string | The order item tax amount |
| string | The order item tax name |
| string | The order item tax definition identifier |
| string | The order item tax amount unrounded |
| string | The order item tax total inclusive |
| string | The order item tax total exclusive |
| string | The order item tax parent item reference identifier |
order_item_discount
Field Name | Type | Description |
|---|---|---|
| string | The order item discount name |
| string | The order item discount definition identifier |
| string | The order item discount type |
| boolean | |
| string | The order item discount amount |
| string | The order item discount identifier |
| string | The order item discount amount unrounded |
| string | The order item discount code |
| string | The order item discount quantity |
| string | The ISO-8601 formatted date and time the order item discount was created |
| string | The ISO-8601 formatted date and time the order item discount was created in Coordinated Universal Time (UTC) |
| string | The ISO-8601 formatted date and time the order item discount was updated |
| string | The ISO-8601 formatted date and time the order item discount was updated in UTC |
| boolean | |
| string | The order item discount parent item reference identifier |
item_summary_item
Field Name | Type | Description |
|---|---|---|
| string | The item summary item entity identifier |
| string | The item summary item product identifier |
| string | The item summary item type |
| string | The item summary item name |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
item_summary_reporting_category
Field Name | Type | Description |
|---|---|---|
| string | The item summary reporting category major reporting category entity identifier |
| string | The item summary reporting category major reporting category name |
| string | The item summary reporting category major external category identifier |
| string | The item summary reporting category minor reporting category entity identifier |
| string | The item summary reporting category minor reporting category name |
| string | The item summary reporting category minor external category identifier |
item_summary_net_sales
Field Name | Type | Description |
|---|---|---|
| string | The item summary net sales amount |
| string | The item summary net sales quantity |
item_summary_gross_sales
Field Name | Type | Description |
|---|---|---|
| string | The gross sales amount |
| string | The gross sales quantity |
item_summary_discounts
Field Name | Type | Description |
|---|---|---|
| string | The discount item amount |
| string | The discounted item quantity |
item_summary_taxes
Field Name | Type | Description |
|---|---|---|
| string | The item tax amount |
item_summary_refunds
Field Name | Type | Description |
|---|---|---|
| string | The item refund amount |
item_summary_voids
Field Name | Type | Description |
|---|---|---|
| string | The item void amount |
item_summary_post_payment_voids
Field Name | Type | Description |
|---|---|---|
| string | The item post payment void amount |
cash_drawer_summary
Field Name | Type | Description |
|---|---|---|
| string | The ISO8601 formatted current day and time for the cash drawer summary |
| string | The cash drawer page size |
| string | The cash drawer summary page number |
| number | The cash drawer summary page amount |
| drawer_sessions | The |
drawer_sessions
Field Name | Type | Description |
|---|---|---|
| string | The drawer session business date |
| string | The drawer session identifier |
| string | The drawer session number |
| string | The drawer session status |
| string | The drawer session dollar amount at the start of the session |
| string | The drawer session counted dollar amount |
| string | The amount of cash pulled during the drawer session |
| string | The drawer session expected dollar amount |
| string | |
| string | The terminals used during the drawer session |
| The | |
| The | |
| The | |
| The |
drawer_transactions
Field Name | Type | Description |
|---|---|---|
| string | The ISO-8601 formatted current date and time for the drawer transaction |
| string | The drawer transaction page size |
| string | The drawer transaction page number |
| number | The drawer transaction page amount |
| events | The |
events
Field Name | Type | Description |
|---|---|---|
| string | The business date of the event |
| string | The event type |
| string | |
| string | The event duration |
| string | The event reason |
| string | The event amount |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
sales_by_time
Field Name | Type | Description |
|---|---|---|
| string | The ISO-8601 formatted current date and time of the sale |
| string | The business date of the sale |
| string | The sales by time interval code |
| string | The sales by time interval description |
| The |
sales_data
Field Name | Type | Description |
|---|---|---|
| string | The sales data interval start of the report |
| string | The sales data interval end of the report |
| string | The net sales for the selected period |
| string | The gross sales for the selected period |
| string | The guest count for the selected period |
order_payment_item
Field Name | Type | Description |
|---|---|---|
| string | The order payment type |
| string | The order payment state |
| string | The order payment number |
| string | The order payment identifier |
| The |
payment_item
Field Name | Type | Description |
|---|---|---|
| string | The payment item status |
| string | |
| string | The payment item pay type identifier |
| string | The payment item pay type name |
| string | The payment item offline identifier |
| string | The payment item code |
| string | The payment item card acquisition |
| string | The payment item transaction type |
| string | The payment item transaction identifier |
| string | The payment item card brand name |
| string | The payment item authorization |
| string | The last four digits of the account number |
| object | The |
| number | The payment item amount of tips |
| number | The payment item payment amount |
| number | The payment item payment change |
summarized_discounts
Field Name | Type | Description |
|---|---|---|
| string | The summarized discount name |
| string | The summarized discount type |
| string | The summarized discount code |
| string | The summarized discount identifier |
| number | The summarized discount orders total |
| number | The summarized discount items total |
| integer | The summarized discount orders quantity |
| integer | The summarized discount items quantity |
| integer | The summarized discounted orders quantity |
| integer | The summarized discounted items quantity |
summarized_discounts_by_type
Field Name | Type | Description |
|---|---|---|
| string | The discount name |
| number | The order discounts total |
| number | The order item discounts total |
| integer | The order discounts quantity |
| integer | The order item discounts quantity |
| integer | The discounted orders quantity |
| integer | The discounted items quantity |
statistic_calculation_by_day_parts
Field Name | Type | Description |
|---|---|---|
| object | The |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
statistic_by_day_parts
Field Name | Type | Description |
|---|---|---|
| object | The |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
statistic_calculation_by_destination
Field Name | Type | Description |
|---|---|---|
| object | The |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
statistic_by_destination
Field Name | Type | Description |
|---|---|---|
| object | The |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
statistic_calculation_by_order_source
Field Name | Type | Description |
|---|---|---|
| object | The |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
statistic_by_order_source
Field Name | Type | Description |
|---|---|---|
| object | The |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The | |
| The |
deposits
Field Name | Type | Description |
|---|---|---|
| array | A list of deposit information |
| string | The deposit ID |
| string | The deposit name |
| string | The deposit status |
| string | The date and time the deposit was created |
| string | The date and time the deposit was updated |
| A list of the deposit items' information | |
| A list of the itemized information | |
| The | |
| The | |
| The |
deposit_items
Field Name | Type | Description |
|---|---|---|
| string | The item ID |
| string | The item type |
| string | The date for the item display |
| string | The item amount |
| string | |
| string | |
| string | |
| string | The item source ID |
| The |
itemizedCounts_items
Field Name | Type | Description |
|---|---|---|
| string | The item ID |
| string | The item payment type |
| string | The item's expected amount |
| string | |
| string | The item's counted amount |
| string | |
| string | |
| string | The item's exchange rate |
owner_info
Field Name | Type | Description |
|---|---|---|
| string | The owner ID |
| string | The owner name |
| string | The owner's employee corporate code |
Sample Code
Active Sites
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"include_zero_sales": true,
"calculations": [
{
"site_id": "string",
"store_number": "string",
"store_name": "string",
"net_sales": 0,
"gross_sales": 0
}
]
}Calculations
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"grouping_method": "string",
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"pay_in_out": {
"paid_in": {
"total": "string",
"quantity": "string"
},
"paid_out": {
"total": "string",
"quantity": "string"
}
},
"reconciliation": {
"drawers": {
"count_total": "string",
"expected_total": "string",
"pull_total": "string",
"variance": "string"
},
"deposits": {
"actual_total": "string",
"expected_total": "string",
"variance": "string"
}
},
"destinations": {
"destinations_total": "string",
"destinations_quantity": "string",
"destinations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string",
"external_identifier": "string"
}
]
},
"discounts": {
"discounts_total": "string",
"discounts_quantity": "string",
"discounts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"discounts_types": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"day_parts": {
"day_parts_total": "string",
"day_parts_quantity": "string",
"day_parts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"liability_items": {
"liability_items_total": "string",
"liability_items_quantity": "string",
"liability_items_promotions_total": "string",
"liability_items_promotions_quantity": "string",
"liability_items_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"donations": {
"donations_total": "string",
"donations_quantity": "string",
"donations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"order_sources": {
"order_sources_total": "string",
"order_sources_quantity": "string",
"order_sources_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"tips": {
"refunded_tips": "string",
"paid_tips": "string",
"collected_tips": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"other_statistics": {
"non_taxed_item_sales": {
"total": "string",
"quantity": "string"
},
"gift_card_cash_out": {
"total": "string",
"quantity": "string"
},
"tax_exempt_orders": {
"tax_exempt_orders": "string"
}
}
}
}Cash Drawer Summary
Sample Success Response Body
{
"current_date_time": "string",
"business_date": "string",
"grouping_method": "string",
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"pay_in_out": {
"paid_in": {
"total": "string",
"quantity": "string"
},
"paid_out": {
"total": "string",
"quantity": "string"
}
},
"reconciliation": {
"drawers": {
"count_total": "string",
"expected_total": "string",
"pull_total": "string",
"variance": "string"
},
"deposits": {
"actual_total": "string",
"expected_total": "string",
"variance": "string"
}
},
"destinations": {
"destinations_total": "string",
"destinations_quantity": "string",
"destinations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string",
"external_identifier": "string"
}
]
},
"discounts": {
"discounts_total": "string",
"discounts_quantity": "string",
"discounts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"discounts_types": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"day_parts": {
"day_parts_total": "string",
"day_parts_quantity": "string",
"day_parts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"liability_items": {
"liability_items_total": "string",
"liability_items_quantity": "string",
"liability_items_promotions_total": "string",
"liability_items_promotions_quantity": "string",
"liability_items_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"donations": {
"donations_total": "string",
"donations_quantity": "string",
"donations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"order_sources": {
"order_sources_total": "string",
"order_sources_quantity": "string",
"order_sources_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"tips": {
"refunded_tips": "string",
"paid_tips": "string",
"collected_tips": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"other_statistics": {
"non_taxed_item_sales": {
"total": "string",
"quantity": "string"
},
"gift_card_cash_out": {
"total": "string",
"quantity": "string"
},
"tax_exempt_orders": {
"tax_exempt_orders": "string"
}
}
}
}Discounts by Type
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"discount_types": {
"name": "string",
"orders_total": 0,
"items_total": 0,
"orders_quantity": 0,
"items_quantity": 0,
"discounted_orders_quantity": 0,
"discounted_items_quantity": 0
}
}Discounts
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"discounts": {
"discount_name": "string",
"discount_type": "string",
"discount_code": "string",
"discount_id": "string",
"orders_total": 0,
"items_total": 0,
"orders_quantity": 0,
"items_quantity": 0,
"discounted_orders_quantity": 0,
"discounted_items_quantity": 0
}
}Drawer Transactions
Sample Success Response Body
{
"current_date_time": "string",
"business_date": "string",
"grouping_method": "string",
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"pay_in_out": {
"paid_in": {
"total": "string",
"quantity": "string"
},
"paid_out": {
"total": "string",
"quantity": "string"
}
},
"reconciliation": {
"drawers": {
"count_total": "string",
"expected_total": "string",
"pull_total": "string",
"variance": "string"
},
"deposits": {
"actual_total": "string",
"expected_total": "string",
"variance": "string"
}
},
"destinations": {
"destinations_total": "string",
"destinations_quantity": "string",
"destinations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string",
"external_identifier": "string"
}
]
},
"discounts": {
"discounts_total": "string",
"discounts_quantity": "string",
"discounts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"discounts_types": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"day_parts": {
"day_parts_total": "string",
"day_parts_quantity": "string",
"day_parts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"liability_items": {
"liability_items_total": "string",
"liability_items_quantity": "string",
"liability_items_promotions_total": "string",
"liability_items_promotions_quantity": "string",
"liability_items_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"donations": {
"donations_total": "string",
"donations_quantity": "string",
"donations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"order_sources": {
"order_sources_total": "string",
"order_sources_quantity": "string",
"order_sources_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"tips": {
"refunded_tips": "string",
"paid_tips": "string",
"collected_tips": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"other_statistics": {
"non_taxed_item_sales": {
"total": "string",
"quantity": "string"
},
"gift_card_cash_out": {
"total": "string",
"quantity": "string"
},
"tax_exempt_orders": {
"tax_exempt_orders": "string"
}
}
}
}Item Summary
Sample Success Response Body
{
"company_id": "string",
"site_id": "string",
"start_business_date": "string",
"end_business_date": "string",
"page_size": 0,
"page_number": 0,
"page_amount": 0,
"items": [
{
"entity_id": "string",
"product_id": "string",
"item_type": "string",
"name": "string",
"reporting_category": {
"major_reporting_category_entity_id": "string",
"major_reporting_category_name": "string",
"major_external_category_id": "string",
"minor_reporting_category_entity_id": "string",
"minor_reporting_category_name": "string",
"minor_external_category_id": "string"
},
"net_sales": {
"amount": "string",
"quantity": "string"
},
"gross_sales": {
"amount": "string",
"quantity": "string"
},
"discounts": {
"amount": "string",
"discounted_item_quantity": "string"
},
"taxes": {
"amount": "string"
},
"refunds": {
"amount": "string"
},
"voids": {
"amount": "string"
},
"post_payment_voids": {
"amount": "string"
}
}
]
}Named Calculations
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"named_calculations": [
{
"name": "string",
"named_code": "string",
"description": "string",
"data_type": "string",
"result": 0
}
]
}Order Items
Sample Success Response Body
{
"order_id": "string",
"order_number": "string",
"business_date": "string",
"order_type": "string",
"order_state": "string",
"site_id": "string",
"timezone": "string",
"items": [
{
"entity_id": "string",
"product_id": "string",
"quantity": "string",
"payment_status": "string",
"price": "string",
"unit_price": "string",
"item_type": "string",
"state": "string",
"order_item_id": "string",
"name": "string",
"liability_type": "string",
"parent_item_reference_id": "string",
"time": {
"added": "string",
"added_utc": "string",
"last_modified": "string",
"last_modified_utc": "string",
"voided": "string",
"voided_utc": "string"
},
"reporting_category": {
"major_reporting_category_entity_id": "string",
"major_reporting_category_name": "string",
"minor_reporting_category_entity_id": "string",
"minor_reporting_category_name": "string"
},
"tax_info": {
"taxes": {
"visible": true,
"amount": "string",
"name": "string",
"tax_definition_id": "string",
"amount_unrounded": "string",
"total_inclusive": "string",
"total_exclusive": "string",
"parent_item_reference_id": "string"
},
"total": "string"
},
"discount_info": {
"discounts": {
"name": "string",
"discount_definition_id": "string",
"apply_type": "string",
"distributed": true,
"amount": "string",
"order_discount_id": "string",
"amount_unrounded": "string",
"discount_code": "string",
"discount_quantity": "string",
"created_at": "string",
"created_at_utc": "string",
"updated_at": "string",
"updated_at_utc": "string",
"use_loyalty": true,
"parent_item_reference_id": "string"
},
"total": "string"
}
}
]
}Order Items Batch
Sample Success Response Body
{
"page_size": 0,
"page_number": 0,
"page_amount": 0,
"orders": [
{
"entity_id": "string",
"product_id": "string",
"quantity": "string",
"payment_status": "string",
"price": "string",
"unit_price": "string",
"item_type": "string",
"state": "string",
"order_item_id": "string",
"name": "string",
"liability_type": "string",
"parent_item_reference_id": "string",
"time": {
"added": "string",
"added_utc": "string",
"last_modified": "string",
"last_modified_utc": "string",
"voided": "string",
"voided_utc": "string"
},
"reporting_category": {
"major_reporting_category_entity_id": "string",
"major_reporting_category_name": "string",
"minor_reporting_category_entity_id": "string",
"minor_reporting_category_name": "string"
},
"tax_info": {
"taxes": {
"visible": true,
"amount": "string",
"name": "string",
"tax_definition_id": "string",
"amount_unrounded": "string",
"total_inclusive": "string",
"total_exclusive": "string",
"parent_item_reference_id": "string"
},
"total": "string"
},
"discount_info": {
"discounts": {
"name": "string",
"discount_definition_id": "string",
"apply_type": "string",
"distributed": true,
"amount": "string",
"order_discount_id": "string",
"amount_unrounded": "string",
"discount_code": "string",
"discount_quantity": "string",
"created_at": "string",
"created_at_utc": "string",
"updated_at": "string",
"updated_at_utc": "string",
"use_loyalty": true,
"parent_item_reference_id": "string"
},
"total": "string"
}
}
]
}Order Payments
Sample Success Response Body
{
"current_date_time": "string",
"business_date": "string",
"site_id": "string",
"orders": {
"order_type": "string",
"order_state": "string",
"order_number": "string",
"order_id": "string",
"payments": {
"status": "string",
"processed_at": "string",
"pay_type_id": "string",
"pay_type_name": "string",
"offline_id": "string",
"code": "string",
"card_acquisition": "string",
"transaction_type": "string",
"transaction_id": "string",
"card_brand_name": "string",
"auth": "string",
"account_last_four": "string",
"amount_info": {
"payment_tips": 0,
"payment_amount": 0,
"change": 0
}
}
}
}Orders
Sample Success Response Body
{
"page_size": 0,
"page_number": 0,
"page_amount": 0,
"orders": [
{
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_number": "string",
"order_type": "string",
"order_state": "string",
"order_source": "string",
"business_date": "string",
"event": {
"id": "string",
"name": "string",
"event_type": "string"
},
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subtotal": 0,
"discount_total": 0,
"tax_total": 0,
"net_sales": 0,
"gross_sales": 0,
"tips_total": 0,
"guest_count": 0,
"company_info": {
"company_id": "string",
"company_name": "string"
},
"site_info": {
"site_id": "string",
"site_name": "string",
"store_number": "string",
"time_zone": "string"
},
"terminal_info": {
"terminal_id": "string",
"terminal_name": "string",
"terminal_number": "string"
},
"destination_info": {
"destination_id": "string",
"destination_name": "string"
},
"drawer_info": {
"session_id": "string",
"session_number": "string"
},
"owner_employee_info": {
"owner_employee_id": "string",
"owner_employee_num": "string",
"owner_employee_name": "string"
},
"time_info": {
"updated_at": "string",
"created": "string",
"closed": "string",
"kitchen_sent": "string",
"kitchen_bump": "string",
"first_saved": "string",
"first_item_added": "string"
},
"tax_exempt_info": {
"tax_exempt_id": "string",
"tax_exempt_total": "string"
},
"survey_info": {
"code": "string",
"entity_id": "string",
"external_id": "string",
"message": "string",
"name": "string"
},
"daypart_info": {
"id": "string",
"name": "string",
"external_id": "string"
},
"order_source_info": {
"name": "string",
"external_id": "string"
}
}
]
}Sales by Time
Sample Success Response Body
{
"current_date_time": "string",
"business_date": "string",
"grouping_method": "string",
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"pay_in_out": {
"paid_in": {
"total": "string",
"quantity": "string"
},
"paid_out": {
"total": "string",
"quantity": "string"
}
},
"reconciliation": {
"drawers": {
"count_total": "string",
"expected_total": "string",
"pull_total": "string",
"variance": "string"
},
"deposits": {
"actual_total": "string",
"expected_total": "string",
"variance": "string"
}
},
"destinations": {
"destinations_total": "string",
"destinations_quantity": "string",
"destinations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string",
"external_identifier": "string"
}
]
},
"discounts": {
"discounts_total": "string",
"discounts_quantity": "string",
"discounts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"discounts_types": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"day_parts": {
"day_parts_total": "string",
"day_parts_quantity": "string",
"day_parts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"liability_items": {
"liability_items_total": "string",
"liability_items_quantity": "string",
"liability_items_promotions_total": "string",
"liability_items_promotions_quantity": "string",
"liability_items_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"donations": {
"donations_total": "string",
"donations_quantity": "string",
"donations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"order_sources": {
"order_sources_total": "string",
"order_sources_quantity": "string",
"order_sources_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"tips": {
"refunded_tips": "string",
"paid_tips": "string",
"collected_tips": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"other_statistics": {
"non_taxed_item_sales": {
"total": "string",
"quantity": "string"
},
"gift_card_cash_out": {
"total": "string",
"quantity": "string"
},
"tax_exempt_orders": {
"tax_exempt_orders": "string"
}
}
}
}Statistic by Day Part
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"day_part": {
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"destinations": {
"destinations_total": "string",
"destinations_quantity": "string",
"destinations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string",
"external_identifier": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"guests": {
"quantity": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
}
}
}
}Statistic by Destination
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"destinations": {
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"day_parts": {
"day_parts_total": "string",
"day_parts_quantity": "string",
"day_parts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"guests": {
"quantity": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
}
}
}
}Statistic by Order Source
Sample Success Response Body
{
"current_date_time": "string",
"start_business_date": "string",
"end_business_date": "string",
"order_source": {
"sections": {
"calculations": {
"gross_sales": {
"total": "string"
},
"discount_total": {
"total": "string",
"quantity": "string"
},
"liability_items": {
"total": "string",
"quantity": "string"
},
"post_payment_voids_total": {
"total": "string",
"quantity": "string"
},
"refund_total": {
"total": "string"
},
"tax_total": {
"total": "string"
},
"voided_orders_total": {
"total": "string",
"quantity": "string"
},
"net_sales": {
"total": "string",
"quantity": "string"
}
},
"custom_calculations": {
"named_code": "string",
"result": "string"
},
"payments": {
"payments_total": "string",
"payments_quantity": "string",
"pay_type_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
],
"credit_card_brand_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"destinations": {
"destinations_total": "string",
"destinations_quantity": "string",
"destinations_totals": [
{
"name": "string",
"total": "string",
"quantity": "string",
"external_identifier": "string"
}
]
},
"day_parts": {
"day_parts_total": "string",
"day_parts_quantity": "string",
"day_parts_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
},
"taxes": {
"taxes_total": "string",
"tax_rate_totals": {
"name": "string",
"total": "string"
}
},
"guests": {
"quantity": "string"
},
"fees": {
"fees_total": "string",
"fees_quantity": "string",
"fees_totals": [
{
"name": "string",
"total": "string",
"quantity": "string"
}
]
}
}
}
}Deposits
Sample Success Response Body
{
"current_date_time": "2023-11-30T15:48:28.520Z",
"business_date": "2023-11-19",
"page_size": 200,
"page_number": 0,
"page_amount": 1,
"deposits": [
{
"deposit_id": "6893315a-cb4c-4f41-a83a-2286302864b6",
"deposit_name": "Deposit_0485_56",
"deposit_status": "finalized",
"deposit_create_date": "2023-11-20T14:09:28.505Z",
"deposit_update_date": "2023-11-20T14:09:28.505Z",
"deposit_items": [
{
"item_id": "79c2b611-6b6f-4a4d-a22b-cb64532207ad",
"item_type": "CASH",
"item_display_date": "2023-11-19T20:51:06.122Z",
"item_amount": "158.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "4b51b23c-f0d8-4fdb-ab07-85e4865696c1",
"owner_info": {
"owner_id": "621d45947153bf00018db295",
"owner_name": "Germania Pena",
"owner_employee_corporate_code": "520325"
}
},
{
"item_id": "79c2b611-6b6f-4a4d-a22b-cb64532207ad",
"item_type": "CASH",
"item_display_date": "2023-11-20T07:14:10.247Z",
"item_amount": "8.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "50364934-b85d-4e26-b13f-4c197cde1085",
"owner_info": {
"owner_id": "6458197dde684db42d3a7011",
"owner_name": "Jane Doe",
"owner_employee_corporate_code": "123"
}
},
{
"item_id": "ad4e9391-5133-4fa3-aaef-64aae1380bff",
"item_type": "CASH",
"item_display_date": "2023-11-20T03:51:07.775Z",
"item_amount": "427.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "b504f4df-eb17-43dc-9092-69af8557ccad",
"owner_info": {
"owner_id": "63d5846c461234fb296b7bc5",
"owner_name": "Jane Doe",
"owner_employee_corporate_code": "123"
}
},
{
"item_id": "ad4e9391-5133-4fa3-aaef-64aae1380bff",
"item_type": "CASH",
"item_display_date": "2023-11-19T19:00:34.326Z",
"item_amount": "102.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "dd562d57-c45f-4838-9eb5-3e22b76af0d8",
"owner_info": {
"owner_id": "62b208d1c654946044ff60c7",
"owner_name": "Yana Dee",
"owner_employee_corporate_code": "234"
}
},
{
"item_id": "ad4e9391-5133-4fa3-aaef-64aae1380bff",
"item_type": "CASH",
"item_display_date": "2023-11-20T12:00:39.255Z",
"item_amount": "321.54",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "e93ded3f-a4ef-434d-8afa-77f6267806f1",
"owner_info": {
"owner_id": "64177e32ae4d568e418c30e6",
"owner_name": "John Doe",
"owner_employee_corporate_code": "123"
}
},
{
"item_id": "be2c4b52-ce80-4114-b875-dcc116194b7f",
"item_type": "CASH",
"item_display_date": "2023-11-20T03:46:34.818Z",
"item_amount": "26.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "5acac6a5-517b-45f8-b382-92d174a8d45d",
"owner_info": {
"owner_id": "621d45799467d700016d5b29",
"owner_name": "Jane Doe",
"owner_employee_corporate_code": "123"
}
},
{
"item_id": "be2c4b52-ce80-4114-b875-dcc116194b7f",
"item_type": "CASH",
"item_display_date": "2023-11-19T20:51:27.745Z",
"item_amount": "90.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "62afb253-175d-4d0f-a955-9a13082a0a36",
"owner_info": {
"owner_id": "635bf4bb101f9974ca275e37",
"owner_name": "Jane Doe",
"owner_employee_corporate_code": "123"
}
},
{
"item_id": "f9498f7c-7970-49e0-9885-326780ff6d62",
"item_type": "CASH",
"item_display_date": "2023-11-19T19:15:21.787Z",
"item_amount": "348.00",
"item_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null,
"item_source_id": "eed8409e-3c69-40cb-b612-40ce6838d893",
"owner_info": {
"owner_id": "6341ea04db1bc1d90dee8a9c",
"owner_name": "Larry Bird",
"owner_employee_corporate_code": "345"
}
}
],
"itemizedCounts_items": [
{
"item_id": "4c6d7e65-5dbb-41a2-847f-7775170d6671",
"item_payment_type": "CHECK",
"item_expected_amount": "0.00",
"item_expected_amount_alt_currency": null,
"item_counted_amount": "0.00",
"item_counted_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null
},
{
"item_id": "6eca83cb-53f0-4c9b-9cca-d7e73d8a09a4",
"item_payment_type": "CASH",
"item_expected_amount": "1480.54",
"item_expected_amount_alt_currency": null,
"item_counted_amount": "1090.00",
"item_counted_amount_alt_currency": null,
"item_alt_currency_entity_id": null,
"item_exchange_rate": null
}
],
"site_info": {
"site_id": "620c011778da1c0008db8bac",
"site_name": "Restaurant #0485",
"store_number": "0485",
"time_zone": "US/Eastern"
},
"terminal_info": {
"terminal_id": "5a5901f0fcacfe00019a7fda",
"terminal_number": 1,
"terminal_name": "Reg 1 (Cashier)"
},
"owner_info": {
"owner_id": "621d45908fa60a0001699fb9",
"owner_name": "John Doe",
"owner_employee_corporate_code": "567"
}
}
]
}Payroll Details
Sample Success Response Body
{
"current_date_time": "string",
"page_size": 0,
"page_number": 0,
"page_amount": 0,
"payrolls": {
"site_info": {
"site_id": "string",
"site_name": "string",
"store_number": "string",
"time_zone": "string"
},
"employee_id": "string",
"employee_full_name": "string",
"emp_primary_site_number": "string",
"emp_primary_site_name": "string",
"payroll_detail_id": "string",
"employee_worktime_id": "string",
"business_date": "2025-12-15",
"clockin_utc": "string",
"clockin_name": "string",
"clockout_utc": "string",
"clockout_name": "string",
"job_code_id": "string",
"job_code_external_id": "string",
"job_code_name": "string",
"compensation_type_name": "string",
"rate_type_code_name": "string",
"rate_type_code": "string",
"work_type_id": "string",
"work_type_name": "string",
"multiplier": 0,
"hours": 0,
"total_pay": 0,
"create_date": "string",
"regular_hours": 0,
"regular_minutes": 0,
"regular_hours_rate": 0,
"overtime_hours_rate": 0,
"overtime_hours_cost": 0
}
}Payroll Summary
Sample Success Response Body
{
"current_date_time": "string",
"page_size": 0,
"page_number": 0,
"page_amount": 0,
"payrolls": {
"business_date": "2025-12-15",
"employee": "string",
"employee_code": "string",
"job": "string",
"reg_hrs": 0,
"reg_rate": 0,
"reg_amt": 0,
"ot_hrs": 0,
"ot_rate": 0,
"ot_amt": 0,
"dbl_hrs": 0,
"dbl_amt": 0,
"penalty_pay": 0,
"total_hours": 0,
"net_sales": 0,
"total_tips": 0,
"total_amt": 0
}
}