---
title: 5.10 API Documentation
description: 5.10 API Documentation
---

[Skip to content](https://helpdesk.tray.sa/en/5.10-api-documentation#main-content)

English

Show submenu for translations

![TRAY logo - powered etc.. 4](https://helpdesk.tray.sa/hs-fs/hubfs/TRAY%20logo%20-%20powered%20etc..%204.png?width=92&height=48&name=TRAY%20logo%20-%20powered%20etc..%204.png)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- Contact us

 Contact us

 How can we help you?

- There are no suggestions because the search field is empty.

1. [Help Desk](https://helpdesk.tray.sa/en?hsLang=en)
2. [API Documentation](https://helpdesk.tray.sa/en/api-documentation?hsLang=en)
3. [5.10 API Documentation](https://helpdesk.tray.sa/en/api-documentation?hsLang=en#5-10-api-documentation)

March 28, 2024

# 5.10 API Documentation

#### API Documentation

| ### *Table of Contents * - *[Add the DSP ID to the response of the API method v2/Checks API](https://trayhelpdesk.zendesk.com/hc/en-us/articles/18541850302228-5-10-API-Documentation#h_01H8HFJR1K14PPCPK6VF2P4SFR)* - *[Sales Subject to Tips in Data API](https://trayhelpdesk.zendesk.com/hc/en-us/articles/18541850302228-5-10-API-Documentation#h_01H8HFK4083NGRTWBXPX86R3E1)* - *[Data API and BI Export Restrictions for Training Mode Data](https://trayhelpdesk.zendesk.com/hc/en-us/articles/18541850302228-5-10-API-Documentation#h_01H8HFKG9QDTBE6VF44D0DKA55)* - *[The fiscalStartDate field in the Sites API.](https://trayhelpdesk.zendesk.com/hc/en-us/articles/18541850302228-5-10-API-Documentation#h_01H8HFKXT1NF7KPN0P1Z1FD4QS)* - *[Olo - Custom Identifier for Tax Exempt Status](https://trayhelpdesk.zendesk.com/hc/en-us/articles/18541850302228-5-10-API-Documentation#h_01H8HFMJ96T0BD5MQ6SJARKGBA)* - *[Order Pickup Time to Checks API](https://trayhelpdesk.zendesk.com/hc/en-us/articles/18541850302228-5-10-API-Documentation#h_01H8HFN36SS6WER5KA9JPPS3ZK)* |
| --- |

#### **Add the DSP ID to the response of the API method v2/Checks API**

#### CONSR-1471

#### *Description*

We have provided an updated version of the checks API in which the 'dspId' field is displayed in v2/checks API. For orders placed via OlO, it displays the order Id. The response JSON will display dspID as null if the order Id is missing from the check.

 

![](https://trayhelpdesk.zendesk.com/hc/article_attachments/18541707145876)

#### **Sales Subject to Tips in Data API**

#### CONSR-1079 

#### *Description*

We have added a new field to show how much of each employee's sales are subject to tips. There is now a field called netSales available when using the time entries API that will display the net sales of orders during the specified employee's shift.

 

![](https://trayhelpdesk.zendesk.com/hc/article_attachments/18541666800276)

 

 

#### **Data API and BI Export Restrictions for Training Mode Dataa**

#### CONSR-1536 & CONSR-1565 

#### *Description*

To ensure more accurate reporting of sales data between TRAY reporting, the Data API, and the BI Export, the Data API and BI export will no longer transmit sales data via the API for services that are marked as "training mode."

 

 

![Screen Shot 2023-08-23 at 10.19.54 AM.png](https://trayhelpdesk.zendesk.com/hc/article_attachments/18541853202580)

 

 

#### **The fiscalStartDate field in the Sites API.**

#### CONSR-1412 

#### *Description*

A new field called “fiscalStartDate” has been introduced in the site method /v1/sites providing additional information related to the fiscal calendar that the site will observe. When the Franchisee Fiscal Start Date is configured for a particular site in TRAY HQ, the fiscalStartDate field in the v1/sites endpoint should reflect that date for that site.

 

If there is no fiscal start date configured then the value of this key will be NULL.

 

![](https://trayhelpdesk.zendesk.com/hc/article_attachments/18541721322260)

 

#### **Olo - Custom Identifier for Tax Exempt Status**

#### CONSR-1626

#### *Description*

If the custom identifier field is included in an Olo order, the system should follow the tax exempt status of the associated tender type. Otherwise, the tax exempt status should be determined by using the slug.

![Screen Shot 2023-08-23 at 10.15.41 AM.png](https://trayhelpdesk.zendesk.com/hc/article_attachments/18541839428756)

#### **Order Pickup Time to Checks API**

#### CONSR-1690 

#### *Description*

Users can retrieve the pickup time for Olo orders using this feature. As a part of this change, we have included a new field called "pickupTime" in the v2/Checks API. This field will provide the pickup date and time for Olo orders.

 

 

![Screen Shot 2023-08-23 at 10.15.05 AM.png](https://trayhelpdesk.zendesk.com/hc/article_attachments/18541869561364)

- [HQ - Sites](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#main-content)

    - [Menus](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#menus)
    - [Revenue Centers](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#revenue-centers)
    - [People](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#people)
    - [Payments](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#payments)
    - [Cash Management](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#cash-management)
    - [Discounts](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#discounts)
    - [Hardware](https://helpdesk.tray.sa/en/hq-sites?hsLang=en#hardware)
- [Offline Mode Functionality](https://helpdesk.tray.sa/en/offline-mode-functionality?hsLang=en#main-content)

    - [Offline Mode](https://helpdesk.tray.sa/en/offline-mode-functionality?hsLang=en#offline-mode)
- [Getting started](https://helpdesk.tray.sa/en/getting-started?hsLang=en#main-content)

    - [Start Guides](https://helpdesk.tray.sa/en/getting-started?hsLang=en#start-guides)
- [POS](https://helpdesk.tray.sa/en/pos?hsLang=en#main-content)

    - [TRAY POS](https://helpdesk.tray.sa/en/pos?hsLang=en#tray-pos)
- [Reports](https://helpdesk.tray.sa/en/reports?hsLang=en#main-content)

    - [Sales Reports](https://helpdesk.tray.sa/en/reports?hsLang=en#sales-reports)
    - [Orders Reports](https://helpdesk.tray.sa/en/reports?hsLang=en#orders-reports)
    - [Labor Reports](https://helpdesk.tray.sa/en/reports?hsLang=en#labor-reports)
    - [Cash Reports](https://helpdesk.tray.sa/en/reports?hsLang=en#cash-reports)
- [API Documentation](https://helpdesk.tray.sa/en/api-documentation?hsLang=en#main-content)

    - [5.10 API Documentation](https://helpdesk.tray.sa/en/api-documentation?hsLang=en#5-10-api-documentation)
- [Release Notes](https://helpdesk.tray.sa/en/release-notes?hsLang=en#main-content)

    - [Release Notes](https://helpdesk.tray.sa/en/release-notes?hsLang=en#release-notes)

[![TRAY logo - powered etc.. 4-2](https://helpdesk.tray.sa/hs-fs/hubfs/TRAY%20logo%20-%20powered%20etc..%204-2.png?width=92&height=48&name=TRAY%20logo%20-%20powered%20etc..%204-2.png "TRAY logo - powered etc.. 4-2")](https://tray.sa)

Riyadh - Al-Sulaimania District, Eng. Musa'ed Al-Angari Street, Building No. 7965

TRAY © 2024. All Rights Reserved.