POS Time Card

Aggregate and indexed Time Card information.

Time card includes information about employee working hours.

TimeCard
TimeCardSegment

Methods

Retrieve Time cards

Retrieve a specific location time cards for a given time frame

GET /pos/v2/{locationId}/time-cards

Query Parameters

Name	Type	Description
filter	object	Set of search parameters. They can be defined as a URI parameters or JSON object
filter.dateTimeFrom	string	date from in ISO 8601 format, e.g., `2007-03-01T00:00:00Z`
filter.dateTimeTo	string	date to in ISO 8601 format, e.g., `2007-03-01T23:59:59Z`

Response 200

Returns time cards completed in requested location for specified time period

{
  "results": [
    {
      "posRef": "string",
      "employeeRef": "string",
      "employeeName": "string",
      "jobName": "string",
      "clockedInAt": "2025-06-04T12:38:48.010Z",
      "clockedOutAt": "2025-06-04T12:38:48.010Z",
      "cashTips": 0,
      "creditTips": 0,
      "adjustedTips": 0,
      "totalTips": 0,
      "totalPay": 0,
      "timeCardSegments": [
        {
          "type": "break",
          "duration": 0,
          "payRate": 0,
          "pay": 0
        }
      ]
    }
  ],
  "meta": {}
}

TimeCard

Employee time card

Name	Type	Description
posRef*	string	POS TimeCard reference ID. Unique per location.
employeeRef*	string	POS Employee reference GUID/ID
employeeName*	string	Employee name
jobName	string	Name of employee job
clockedInAt*	string	Date and time in UTC when employee clocked in
clockedOutAt*	string	Date and time in UTC when employee clocked out
cashTips*	number	Cash tips. Important: this amount is reported as `0` by FuturePOS point of sale, please reach out to your technical representative for more details.
creditTips*	number	Credit card tips, also registered as part of payment information. Important: this amount is reported as `0` by FuturePOS point of sale, please reach out to your technical representative for more details.
adjustedTips*	number	Adjusted tips. Important: this amount is reported as `0` by FuturePOS point of sale, please reach out to your technical representative for more details.
totalTips*	number	Total reported tips. Important: this amount is reported as `0` by FuturePOS point of sale, please reach out to your technical representative for more details.
totalPay*	number	Total employee pay for time card. Important: this field is deprecated, the point of sales report it as `0`.
timeCardSegments	array	Segments for this time card

TimeCardSegment

Time card segment representing certain time period in the TimeCard

Name	Type	Description
type*	string	Segment type. One of: `break`, `regular` or ~~`overtime`~~. Important: the `overtime` segment type is deprecated. This segment type is reported as a `regular` type.
duration*	integer	Segment duration in seconds
payRate*	number	Employee hourly pay rate for the segment. Important: if a pay rate is bigger than zero for a `break` segment type then this is a paid break, otherwise non paid break.
pay*	number	Pay for the segment Important: This field is deprecated. It will be reported with a value of 0.

Time Cards