The restaurant API's closeoutHour
determines your
restaurant's businessDate
value in other Toast APIs. The
closeoutHour
is a value from 0-12 (midnight (0) to noon
(12)), which represents your restaurant's Business Day
Cutoff configuration in Toast Web. For example, if your
restaurant's Business Day Cutoff field is set to
4 AM, the closeoutHour
value will be
4
. The time zone for the Business Day
Cutoff is determined by your restaurant's Time
Zone configuration in Toast Web.
Note |
Your restaurant's Business Day Cutoff and Time Zone configurations can only be updated by Toast Support. |
When your restaurant's closeoutHour
time has been
reached, the following operations occur in Toast Web:
-
Any employees who are still clocked in are automatically clocked out.
-
Card payments that have not been captured yet are automatically captured. This is typically the entire day's card payments.
Note |
The Toast platform will not close unpaid orders. Unpaid orders remain open until they are resolved either by being paid or voided. |
When your restaurant's closeoutHour
time has been
reached, the following operations occur in Toast APIs.
-
closeDate
: ThecloseDate
value is set to a time after thecloseoutHour
. -
modifiedDate
: ThemodifiedDate
value is set to a time after thecloseoutHour
.
For more information about the orders API, see Toast orders API.
-
outDate
: Any time entries without anoutDate
value are automatically closed and theoutDate
value is set to the business cut-off time. -
modifiedDate
: ThemodifiedDate
value is set to the business cut-off time for any time entries closed at the business cut-off time.
For more information about the labor API, see Toast labor API.