Time Clock Entries

GET /locations/:locationId/time-clock-entries

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/time-clock-entries?updatedAtStart=2020-02-28T00:00:00Z&updatedAtEnd=2020-02-28T22:20:00Z&inStart={{inStart}}&inEnd={{inEnd}}&outStart={{outStart}}&outEnd={{outEnd}}

curl --location -g --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/time-clock-entries?updatedAtStart=2020-02-28T00:00:00Z&updatedAtEnd=2020-02-28T22:20:00Z&inStart={{inStart}}&inEnd={{inEnd}}&outStart={{outStart}}&outEnd={{outEnd}}' \
--header 'x-api-key;'

Retrieves all time clock entries that were last updated within the specified date/time range for the supplied location.

Only those time clock entries that were last updated within the past 90 days (approximately) are available.
The duration of the date range cannot exceed 7 days.
updatedAtStart is inclusive and updatedAtEnd is exclusive.
updatedAtEnd must be 5 or more minutes in the past. This delay is imposed to ensure that updates to orders are not "missed" due to internal database replication lag.

Suggested Time Clock Entries Retrieval Patterns

See the suggested data retrieval patterns for the "cash-deposits" endpoint since those same suggestions apply to time clock entries as well.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of time clock entry objects. Each object in the array will be structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the time clock entry.
locationId	string	The unique ID for the location.
deleted	boolean	True if the time clock entry has been marked as deleted.
voided	boolean	True if the time clock entry has been marked as voided.
employeeId	string	The unique ID of the employee that the time clock entry is for.	Yes
jobPositionId	string	The unique ID of the job position that the employee clocked in under. Important: This field will only be populated for entries that were last updated on or after "2020-01-16 15:08:43.630Z".	Yes
payRateAmount	DOLLARAMOUNT	The hourly pay rate in effect for this time clock entry.
declaredCashTipsAmount	DOLLARAMOUNT	The declared amount of cash tips collected by the employee during the shift that this time clock entry represents.
declaredCashTipsToOthersAmount	DOLLARAMOUNT	The declared amount of cash tips collected by the employee, but given to others for the shift that this time clock entry represents.
inAt	string	The RFC 3339 formatted date/time that the shift began.
outAt	string	The RFC 3339 formatted date/time that the shift ended. Will be null if the shift is currently in progress.
breaks	[]BREAK	An array containing breaks that were recorded during the shift.
lastUpdatedAt	string	The RFC 3339 formatted date/time that the time clock entry was last updated.

BREAK

Field Name	Field Type	Field Description
id	string	The unique ID for a particular break within a particular time clock entry. This field can be used to differentiate between a new recorded break and an existing break that was previously imported by the API consumer.
startedAt	string	The RFC 3339 formatted date/time that the break started.
endedAt	string	The RFC 3339 formatted date/time that the break ended. Will be null if the break is currently in progress.
kind	string	"UNPAID" for an unpaid break. "PAID" for a paid break.

DOLLARAMOUNT

An amount in US dollars expressed as a decimal number string. For example, $1.10 will be represented as "1.1".

📘
*Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.

Example Response

[
   {
        "id": "dssavigxuvchtoo4glocnn5w4q",
        "locationId": "LocationX",
        "deleted": false,
        "voided": false,
        "employeeId": "fcmnidnfurb5rbl0fjb2p4ffj2",
        "jobPositionId": "ze1ej1davrdtlpwomxollfamri",
        "payRateAmount": "3.75",
        "declaredCashTipsAmount": "0",
        "declaredCashTipsToOthersAmount": "0",
        "inAt": "2020-01-25T19:58:58Z",
        "outAt": "2020-01-26T03:49:05Z",
        "breaks": [
            {
                "id": "qkgtzvmtt3eb5mw4bdn42zxp0m",
                "startedAt": "2020-01-26T00:46:24Z",
                "endedAt": "2020-01-26T00:58:42Z",
                "kind": "UNPAID"
            }
        ],
        "lastUpdatedAt": "2020-01-26T03:49:05Z"
    }
]

Headers
x-api-key	Your API Key

Params
updatedAtStart	2020-02-28T00:00:00Z Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 7 days. Time clock entries that were last updated during the specified date/time range will be returned.
updatedAtEnd	2020-02-28T22:20:00Z Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range.
inStart	{{inStart}} Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 7 days. Time clock entries that were indatetime during the specified date/time range will be returned.
inEnd	{{inEnd}} Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range.
outStart	{{outStart}} Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 7 days. Time clock entries that were outdatetime during the specified date/time range will be returned.
outEnd	{{outEnd}} Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range.

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/time-clock-entries/:timeClockEntryId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/time-clock-entries/:timeClockEntryId

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//time-clock-entries/' \
--header 'x-api-key;'

Retrieves a time clock entry for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON time clock entry object. See the parent route's documentation for more details.

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location
timeClockEntryId	The unique ID for the time clock entry