> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hotglue.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Toast
# Connector Details
| Name | Value |
| :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Platform | [Toast](https://toasttab.com) |
| Auth Type | API Keys |
| Direction | Read |
| Tap Repo | [https://github.com/singer-io/tap-toast](https://github.com/singer-io/tap-toast) |
| Tap Metrics | Usage:
Success Rate:
|
# Integration methods
There are two supported ways to integrate with Toast:
* using Toast APIs (there are restrictions here)
* using SFTP exports
## Using APIs
Toast has two types of API access:
* integration partner access -> requires going through a lengthy partnership and approval process
* standard API access -> only available on RMS Essentials plan or higher. Full requirements listed on the [Toast docs](https://doc.toasttab.com/doc/devguide/devApiAccessRequirements.html)
Standard API access is read only and is only available on the RMS Essentials plan or higher.
### Configuration
To generate standard API access credentials, you can follow the guide in the [Toast docs](https://doc.toasttab.com/doc/devguide/devApiAccessCredentials.html#devApiAccessCreatingCredentials).
You will be given the following:
* API access URL
* client id
* client secret
### Supported data
You can review Toast's [official Postman collection](https://doc.toasttab.com/doc/media/Toast_Postman_Collection.zip) to review what their APIs support.
Our connector currently supports the following data:
* Alternate Payment Types
* Break Types
* Cash Drawers
* Cash Management Deposits
* Cash Management Entries
* Dining Options
* Discounts
* Employees
* Menu Groups
* Menu Items
* Menu Option Groups
* Menus
* No Sale Reasons
* Orders
* Payments
* Payout Reasons
* Pre Modifier Groups
* Pre Modifiers
* Premodifier Groups
* Premodifiers
* Price Groups
* Printers
* Restaurant Services
* Restaurants
* Revenue Centers
* Sales Categories
* Service Areas
* Tables
* Tax Rates
* Tip Withholding
* Void Reasons
## SFTP exports
Alternatively, Toast does offer the ability to create [data exports](https://doc.toasttab.com/doc/platformguide/adminDataExportOverview.html) and access them via SFTP.
### Configuration
Configuring SFTP exports in Toast can be cumbersome on the user side. If possible to use the API approach (based on their subscription), that may be simpler.
Generally, the steps are as follows:
* The Toast user will need to request SFTP access from Toast (it is typically not enabled by default)
* Once Toast provisions the SFTP connection, the user can configure the data exports they want. This is the most tedious part of the configuration.
This is managed directly in the Toast UI under [Reports -> Settings -> Data Exports](https://doc.toasttab.com/doc/platformguide/configuringExports.html).
* Configure the SFTP credentials in Hotglue
From there, Toast will generate the files on a schedule and upload them to SFTP. From there, Hotglue will pick them up and process.
### Supported data
Currently, our `toast-sftp` connector supports importing the following data from the data exports:
| Stream Name | File Name | Format | Description |
| ----------------------------- | ------------------------------- | ------ | ------------------------------------------------------------ |
| accounting\_report | `AccountingReport.xls` | Excel | Accounting data export with revenue amounts for each GL code |
| all\_items\_report | `AllItemsReport.csv` | CSV | Information about all menu items |
| cash\_entries | `CashEntries.csv` | CSV | Information about cash payments |
| check\_details | `CheckDetails.csv` | CSV | Information about checks in orders |
| house\_account\_export | `HouseAccountExport.csv` | CSV | Information about house accounts |
| item\_selection\_details | `ItemSelectionDetails.csv` | CSV | Information about items ordered |
| kitchen\_timings | `KitchenTimings.csv` | CSV | Information about kitchen tickets |
| menu\_export | `MenuExport_*.json` | JSON | Information about menus |
| menu\_export\_v2 | `MenuExportV2_*.json` | JSON | Enhanced information about menus |
| menu\_menus | `MenuExport*.json` | JSON | Toast menu objects (flat, one per menu) |
| menu\_groups | `MenuExport*.json` | JSON | Toast menu group objects with parent menu context |
| menu\_items | `MenuExport*.json` | JSON | Toast menu item objects with full parent context |
| menu\_option\_groups | `MenuExport*.json` | JSON | Toast menu option group objects with full parent context |
| menu\_option\_items | `MenuExport*.json` | JSON | Toast menu option item objects with full parent context |
| menu\_prices | `MenuExport*.json` | JSON | Toast menu item price objects with full parent context |
| modifiers\_selection\_details | `ModifiersSelectionDetails.csv` | CSV | Information about modifiers applied to items |
| order\_details | `OrderDetails.csv` | CSV | Information about orders |
| payment\_details | `PaymentDetails.csv` | CSV | Information about payments |
| time\_entries | `TimeEntries.csv` | CSV | Information about employee shifts |