Toast Component

Use the Toast component to manage Employees, Jobs, Cash Entries, and more.

Component key: toast

Description

Connections

Toast Client Credentials

Triggers

Webhook

Receive and validate webhook requests from Toast for webhooks you configure. | key: webhook

Data Sources

Select Accessible Restaurant

Select an accessible restaurant from a list of accessible restaurants. | key: selectAccessibleRestaurant | type: picklist

Select Connected Restaurant

Select a connected restaurant from a list of connected restaurants. | key: selectConnectedRestaurant | type: picklist

Select Employee

Select an employee from a list of employees. | key: selectEmployee | type: picklist

Select Job

Select a job from a list of jobs. | key: selectJob | type: picklist

Select Shift

Select a shift from a list of shifts. | key: selectShift | type: picklist

Actions

Create Employee

Creates a restaurant employee record. | key: createEmployee

Example Payload for Create Employee

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "chosenName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "string",
    "passcode": "string",
    "externalEmployeeId": "string",
    "deleted": true,
    "jobReferences": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Create Shift

Creates a schedule shift for a restaurant employee. | key: createShift

Example Payload for Create Shift

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Delete Employee

Deletes a restaurant employee record by marking the record as deleted. | key: deleteEmployee

Example Payload for Delete Employee

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "chosenName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "string",
    "passcode": "string",
    "externalEmployeeId": "string",
    "deleted": true,
    "jobReferences": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Delete Shift

Marks an existing schedule shift record for a restaurant employee as deleted. | key: deleteShift

Example Payload for Delete Shift

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Get Employee

Returns an Employee object containing information about one restaurant employee. | key: getEmployee

Example Payload for Get Employee

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "chosenName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "string",
    "passcode": "string",
    "externalEmployeeId": "string",
    "deleted": true,
    "jobReferences": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Get One Job

Returns a Job object containing information about one employee job at a restaurant. | key: getOneJob

Example Payload for Get One Job

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "title": "string",
    "deleted": true,
    "wageFrequency": "HOURLY",
    "defaultWage": 0,
    "tipped": true,
    "code": "string",
    "excludeFromReporting": true
  }
}

Get Shift

Performs Get Shift | key: getShift

Example Payload for Get Shift

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Get Time Entry

Returns a TimeEntry object containing information about one employee shift. | key: getTimeEntry

Example Payload for Get Time Entry

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "shiftReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "autoClockedOut": true,
    "businessDate": "string",
    "regularHours": 0,
    "overtimeHours": 0,
    "hourlyWage": 0,
    "breaks": [
      {
        "guid": "string",
        "breakType": {
          "guid": "string",
          "entityType": "string"
        },
        "paid": true,
        "inDate": "2019-08-24T14:15:22Z",
        "outDate": "2019-08-24T14:15:22Z",
        "missed": true,
        "auditResponse": true
      }
    ],
    "declaredCashTips": 0,
    "nonCashTips": 0,
    "cashGratuityServiceCharges": 0,
    "nonCashGratuityServiceCharges": 0,
    "tipsWithheld": 0,
    "nonCashSales": 0,
    "cashSales": 0
  }
}

List Accessible Restaurants

Returns an array of PartnerAccessExternalRep objects that contain information about the Toast restaurants that your partner API client can access. | key: listAccessibleRestaurants

Example Payload for List Accessible Restaurants

{
  "data": [
    {
      "restaurantGuid": "e728cd53-2fa7-4e63-8f8f-93e78ea66b03",
      "managementGroupGuid": "bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79",
      "deleted": true,
      "restaurantName": "Main Street Cafe",
      "locationName": "123 Main Street",
      "createdByEmailAddress": "clefebvre@mainstreetcafe.com",
      "externalGroupRef": "string",
      "externalRestaurantRef": "string",
      "modifiedDate": 1678846869551,
      "createdDate": 1643858534451,
      "isoModifiedDate": "2023-03-12T08:32:34.008Z",
      "isoCreatedDate": "2022-05-17T10:21:38.008Z"
    }
  ]
}

List Cash Entries

Returns information about cash added to or removed from a cash drawer or other cash storage device. | key: listCashEntries

Example Payload for List Cash Entries

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "amount": 0,
      "reason": "string",
      "date": "2019-08-24T14:15:22Z",
      "type": "CASH_IN",
      "cashDrawer": {
        "guid": "string",
        "entityType": "string"
      },
      "payoutReason": {
        "guid": "string",
        "entityType": "string"
      },
      "noSaleReason": {
        "guid": "string",
        "entityType": "string"
      },
      "undoes": "string",
      "employee1": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "employee2": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "creatorOrShiftReviewSubject": {
        "guid": "string",
        "entityType": "string"
      },
      "approverOrShiftReviewSubject": {
        "guid": "string",
        "entityType": "string"
      }
    }
  ]
}

List Connected Restaurants

Returns a PaginatedResponse object that contains a paginated array of the restaurants that have connected to your integrated partner service. | key: listConnectedRestaurants

Example Payload for List Connected Restaurants

{
  "data": [
    {
      "currentPageNum": 1,
      "results": [
        {
          "restaurantGuid": "7ab295f6-8dc8-4cb6-8cdb-072b83e84184",
          "managementGroupGuid": "75063706-dd6e-4da6-8bb6-3a99e218e686",
          "restaurantName": "Main Street Cafe",
          "locationName": "123 Main Street",
          "createdByEmailAddress": "clefebvre@mainstreetcafe.com",
          "externalGroupRef": null,
          "externalRestaurantRef": null,
          "modifiedDate": 1678823073353,
          "createdDate": 1678823073353,
          "isoModifiedDate": "2023-03-14T19:44:33.353Z",
          "isoCreatedDate": "2023-03-14T19:44:33.353Z"
        }
      ],
      "totalResultCount": 3222,
      "pageSize": 1,
      "currentPageToken": "cDoxLHM6MQ==",
      "nextPageToken": "cDoyLHM6MQ==",
      "totalCount": 3222,
      "nextPageNum": 2,
      "lastPageNum": 3222,
      "previousPageNum": null
    }
  ]
}

List Deposits

Returns an array of Deposit objects containing information about cash removed from a restaurant to be deposited in a bank or other financial institution during one business day. | key: listDeposits

Example Payload for List Deposits

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "amount": 0,
      "date": "2019-08-24T14:15:22Z",
      "undoes": "string",
      "employee": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "creator": {
        "guid": "string",
        "entityType": "string"
      }
    }
  ]
}

List Employees

Returns an array of Employee objects containing information about restaurant employees. | key: listEmployees

Example Payload for List Employees

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "firstName": "string",
      "chosenName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "phoneNumberCountryCode": "string",
      "passcode": "string",
      "externalEmployeeId": "string",
      "deleted": true,
      "jobReferences": [
        {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      ],
      "wageOverrides": [
        {
          "wage": 0,
          "jobReference": {
            "guid": "string",
            "entityType": "string",
            "externalId": "string"
          }
        }
      ],
      "v2EmployeeGuid": "string"
    }
  ]
}

List Jobs

Returns an array of Job objects containing information about the employee jobs configured at a restaurant. | key: listJobs

Example Payload for List Jobs

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "title": "string",
      "deleted": true,
      "wageFrequency": "HOURLY",
      "defaultWage": 0,
      "tipped": true,
      "code": "string",
      "excludeFromReporting": true
    }
  ]
}

List Shifts

Returns an array of Shift objects that contain information about schedule shifts for restaurant employees. | key: listShifts

Example Payload for List Shifts

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "deleted": true,
      "jobReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "employeeReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "inDate": "2019-08-24T14:15:22Z",
      "outDate": "2019-08-24T14:15:22Z",
      "scheduleConfig": {
        "guid": "string",
        "minBeforeClockIn": 0,
        "minAfterClockIn": 0,
        "minBeforeClockOut": 0,
        "minAfterClockOut": 0
      }
    }
  ]
}

List Time Entries

Returns an array of Time Entry objects that contain information about employee shift events. | key: listTimeEntries

Example Payload for List Time Entries

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "deleted": true,
      "jobReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "employeeReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "shiftReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "inDate": "2019-08-24T14:15:22Z",
      "outDate": "2019-08-24T14:15:22Z",
      "autoClockedOut": true,
      "businessDate": "string",
      "regularHours": 0,
      "overtimeHours": 0,
      "hourlyWage": 0,
      "breaks": [
        {
          "guid": "string",
          "breakType": {
            "guid": "string",
            "entityType": "string"
          },
          "paid": true,
          "inDate": "2019-08-24T14:15:22Z",
          "outDate": "2019-08-24T14:15:22Z",
          "missed": true,
          "auditResponse": true
        }
      ],
      "declaredCashTips": 0,
      "nonCashTips": 0,
      "cashGratuityServiceCharges": 0,
      "nonCashGratuityServiceCharges": 0,
      "tipsWithheld": 0,
      "nonCashSales": 0,
      "cashSales": 0
    }
  ]
}

Raw Request

Send raw HTTP request to Toast. | key: rawRequest

Update Employee

Performs Update Employee | key: updateEmployee

Example Payload for Update Employee

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "chosenName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "string",
    "passcode": "string",
    "externalEmployeeId": "string",
    "deleted": true,
    "jobReferences": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Update Shift

Updates an existing schedule shift record for a restaurant employee. | key: updateShift

Example Payload for Update Shift

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Use the Toast component to manage Employees, Jobs, Cash Entries, and more.

Description​

Connections​

Toast Client Credentials​

Triggers​

Webhook​

Data Sources​

Select Accessible Restaurant​

Select Connected Restaurant​

Select Employee​

Select Job​

Select Shift​

Actions​

Create Employee​

Create Shift​

Delete Employee​

Delete Shift​

Get Employee​

Get One Job​

Get Shift​

Get Time Entry​

List Accessible Restaurants​

List Cash Entries​

List Connected Restaurants​

List Deposits​

List Employees​

List Jobs​

List Shifts​

List Time Entries​

Raw Request​

Update Employee​

Update Shift​