Skip to content

Employee hours

Returns list of employee hours in the system (simpler form of work shifts without shift). Returned data can be limited with start and end query parameters.

Operations

Download employee hours as JSON

Request

GET https://api.zoined.com/v2/download/employeeHours.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2017-01-01
endstring

Return data ending to given date

Example:end=2017-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/employeeHours.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
organisation_idstringrequired

Organisation / Store ID

Example:"540"
department_idstring

Store department ID

Example:"54021"
salesperson_idstring

Sales person ID

Example:"5402101"
employee_typestring

Employee Type

Example:"Permie"
absence_codestring

Code for the absense if this entry describes absence.

Example:"BREAK"
datestringrequired

Date of entry (yyyy-mm-dd)

Example:"2016-01-01"
timestringrequired

Time of entry (HH:mm:ss)

Example:"15:00:00"
scheduledboolean

Whether this is scheduled or punched shift, default is false

Example:false
productiveboolean

Whether this is productive or administrative work, default is true

Example:true
hoursnumberrequired

Number of hours to record for this specific time

Example:8
staff_costnumber

Salary cost associated with this hour

Example:500
breaksnumber

Total hours of breaks

Example:0.5
breaks_costnumber

Total salary cost associated for paid breaks

Example:40
currencystring

Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
Response
{
  "organisation_id": "540",
  "department_id": "54021",
  "salesperson_id": "5402101",
  "employee_type": "Permie",
  "absence_code": "BREAK",
  "date": "2016-01-01",
  "time": "15:00:00",
  "scheduled": false,
  "productive": true,
  "hours": 8,
  "staff_cost": 500,
  "breaks": 0.5,
  "breaks_cost": 40,
  "currency": "EUR",
  "custom_field_1": "XYZ",
  "custom_field_2": "XYZ",
  "custom_field_3": "XYZ",
  "custom_field_4": "XYZ",
  "custom_field_5": "XYZ"
}