API Docsbeta
Please submit all support requests to help@vericlock.com

Overview

The VeriClock API is a RESTful API. All requests are either HTTP GET or POSTs and are directed at the VeriClock API endpoint:
https://undefined
Currently all API actions are done in the context of a VeriClock user and are limited and restricted by the users specific set of permissions. For example a user that is an administrator has full API access. A user that is a regular employee will only be able to clock in/out, not be able to create jobs or employees, etc...

Request Format

All API requests must contain the following HTTP Headers:
HeaderDescription of Value
vericlock_api_public_key Your API Public Key in standard guid format: abcd1234-1234-1234-1234-abcd12345678
vericlock_domain The unique part of your access url. If your access URL is:

your_domain.vericlock.com

then the value for vericlock_domain would be

your_domain

Do not include the vericlock.com suffix.
vericlock_authtoken The guid authentication token received after authenticating. This is required for all API routes except authentication itself
vericlock_signature The HMAC signature for the request. See below on how to generate.
content-type application/json - Required only for HTTP POST requests that post a JSON body
idempotency_key Caches the request results in a lookup table with this key. Subsequent requests made within the timeout window will return the original request's results. This allows requests to behave idempotently where one or many invocations result in the request being processed only once. Valid key characters are A-Za-z0-9 dash(-), underscore(_), equals(=), plus(+) and forward slash(/). Idempotency keys will be removed from the cache after 24hours or longer depending on the API route.
All JSON object parameters, unless specified as [Required] can be considered optional and omitted if desired.

VeriClock Signature

The private key is a binary representation of your account's 16 byte private key. In your account, the keys are displayed as guid's for visual convenience only.
IMPORTAN! The path is the part of an API call after the hostname AND /api prefix ie.
Full url: https://api.vericlock.com/api/1.0/employee/query
path for HMAC: /1.0/employee/query 
private function _generateSignature($path, $privateKey, $bodyStr)
{
    $hashStr = $path . $bodyStr;
    $sig = hash_hmac('sha256', $hashStr, $privateKey);
    return $sig;
}

Response Format

The HTTP Response code will indicate whether the request was successful or not. 2xx responses indicate success. 4xx responses indicate some sort of user error, and the response JSON object will have more information. 5xx is an error on our side, and again the response JSON object may have additional information.

All content in the response body will be a JSON object related to the API request made. Usually a JSON object or JSON array.

Idempotency

Any non-GET request can be made idempotent by adding a unique key to the HTTP header idempotency_key. The results of such requests are cached for 24 hours, and subsequent requests of the same form with the same key will return the original results.

Some routes cannot be made idempotent, such as authentication. Generally all responses, 2xx,4xx, even 500 errors will be cached, making it safe to retry a request as many times as needed with the same idempotency key within the 24 hour window.

If a response was replayed from the idempotency cache, the response header idempotent_replayed will be set and equal to true.

Idempotency keys are unique to the authenticated user, but it is still strongly recommended to use a strongly random key, like a 128bit guid converted to hex or base64.

Responses to idempotent requests that generate specific error responses are not stored. Such errors are generally of the form 

    {
        "code": "errCode",
        "message": "errMsg"
    }

HTTP Response Code code message Details
409 IdempotencyConflict Request url does not match original request url The url (uri and query params) must match the original request for the same idempotency key
409 IdempotencyConflict Request method does not match original request method The request method must match the original request for the same idempotency key
409 IdempotencyConflict Request body does not match original request body The request body must match the original request for the same idempotency key
500 IdempotencyError Uknown error during idempotent request processing Something unexpected has occurred. You can try the request again, but likely you may need to contact support if the issue does not resolve itself.
500 IdempotencyError Timeout waiting for response The idempotecy_key has been used before, and the system timed out waiting for the original request to produce a result to be returned. The timeout is 2 minutes generally, and it is safe to retry, but if the request is not expected to take this long (few if any requests should take this long) then something unexpected may have happened and you will need to contact support to help resolve.

Authentication

Most API functions require authentication to occur first.
Authenticate
Description
Login & Authenticate with VeriClock's servers.
HTTP POST

https://undefined/1.0/auth

Post Body

{
  "user":string,             //(Required)[string] employee email address
  "password":string          //(Required)[string] plain text password
}

Response

{
  "authToken": "d35b1486-43ca-42bb-828d-9f35bc4be2d4"
}
Logout
Description
Purposely invalidate your authentication token - otherwise it will invalidate naturally due to inactivity
HTTP POST

https://undefined/api/1.0/logout

Post Details

Empty

Employee

Methods for creating, updating and retrieving employees.
Create Employee
Description
Create a new employee. Returns the newly created job on success.
HTTP POST

https://undefined/api/1.0/employee/create

Post Body

{                            //Employee Object, Describes an employee
  "phoneID":string,          //[string] Numeric/touch-tone ID
  "firstName":string,        //(Required)[string] First name
  "middleName":string,       //[string] Middle initial (or name)
  "lastName":string,         //[string] Last name
  "emailAddress":string,     //[string] Email address
  "password":string,         //[string] Password - plaintext (salted and hashed server side)
  "oldpassword":string,      //[string] Old Password - only needed for an admin to change their own password
  "status":string,           //[string] [active,inactive,deleted] Active status
  "type":string,             //[string] [normal,admin] Employee type
  "groupGuid":string,        //[string] Group the employee belongs to
  "customData":object,       //[object] A custom JSON object to store with the employee
  "personalDetails":{        //An employee's contact and other personal details
    "addressLine1":string,   //[string] Address Line 1
    "addressLine2":string,   //[string] Address Line 2
    "city":string,           //[string] City
    "countryCode":string,    //[string] ISO 3166-1 Alpha 2 two character country code.
    "stateCode":string,      //[string] Two character state or province code - only applicable to USA/Canada
    "postalCode":string,     //[string] Zip/Postal Code
    "phoneHome":string,      //[string] Home phone number / phone number 1
    "phoneMobile":string,    //[string] Mobile phone number / phone number 2
    "phoneOther":string,     //[string] Other phone number / phone number 3
    "driversLicense":string, //[string] Zip/Postal Code
    "taxNumber":string,      //[string] Zip/Postal Code
    "birthday":string,       //[string] Employee's date of birth
    "privateNotes":string    //[string] undefined
  },
  "employmentDetails":{      //An employee's employement details
    "startDate":string,      //[string] Employment start date
    "endDate":string         //[string] Employment end date
  },
  "settings":{               //An employee's customized settings
    "phone":{                //Phone specific settings
      "clockInReport":string,//[string] [required,optional,disabled] Is a report required on clock in
      "clockOutReport":string,//[string] [required,optional,disabled] Is a report required on clock out
      "pinType":string,      //[string] [none,custom] Type of phone pin that is configured.  ['none', 'custom']. 'custom' means the employee must enter their phonePin when clocking in by phone or SMS
      "pin":string           //[string] Phone or SMS numeric PIN code - must be digits only.
    },
    "web":{                  //Web specific settings
      "clockInReport":string,//[string] [required,optional,disabled] Is a report required on clock in
      "clockOutReport":string//[string] [required,optional,disabled] Is a report required on clock out
    },
    "gpsSettings":{          //GPS specific settings
      "basicGeoTagging":string//[string] [enabled,disabled] Collect GPS coordinates on clock in and out on supported mobile devices (Mobile Web/App)
    },
    "location":{             //Employee GEO Tagging Settings
      "web":{                //Web browser based geo location - mobile browser
        "tagInOut":string,   //[string] [enabled,disabled] GEO tag when employee clocks in/out
        "accuracy":integer,  //[integer] When looking for a gps location, stop when a position with this level of accuracy is found
        "timeout":integer    //[integer] When looking for a gps location, stop after this many seconds
      },
      "app":{                //App based geo location - iOS App, Android App, etc...
        "tagInOut":string,   //[string] [enabled,disabled] GEO tag when employee clocks in/out
        "accuracy":integer,  //[integer] When looking for a gps location, stop when a position with this level of accuracy is found
        "timeout":integer,   //[integer] When looking for a gps location, stop after this many seconds
        "continuousTracking":string//[string] [enabled,disabled] GEO Tag at regular intervals during employee's shift. Can be taxing on battery life.
      },
      "network":{            //App based geo location - iOS App, Android App, etc...
        "tagInOut":string,   //[string] [always,sometimes,disabled] GEO tag when employee clocks in/out
        "frequency":integer  //[integer] When tagInOut is set to sometimes, events will randomly be tagged using network location using this frequency as a %
      }
    },
    "permissions":{          //Employee access permissions
      "canViewOwnTimeSheet":boolean,//[boolean] Employee can view their own timesheet
      "canEditOwnTimeSheet":boolean,//[boolean] Employee can edit their own timesheet
      "activityNotes":string,//[string] [disabled,textOnly,textAndFiles] Employee can upload activity notes and/or files
      "offlineClock":boolean //[boolean] Employee can clock in or out when offline
    }
  },
  "dailyBudgetMins":{        //Daily hour budgets
    "mon":number,            //[number] undefined
    "tue":number,            //[number] undefined
    "wed":number,            //[number] undefined
    "thu":number,            //[number] undefined
    "fri":number,            //[number] undefined
    "sat":number,            //[number] undefined
    "sun":number             //[number] undefined
  }
}

Response

{
  "guid": "745c9f42-f6ea-4644-bc01-d0a1ba9bca59",
  "status": "active",
  "type": "normal",
  "firstName": "Walter",
  "middleName": "Hartwell",
  "lastName": "White",
  "fullName": "Walter Hartwell White",
  "phoneID": "625",
  "publicPhoneID": "100*625",
  "clockState": "clockedOut",
  "groupGuid": null,
  "settings": {
    "phone": {
      "clockInReport": "disabled",
      "clockOutReport": "required",
      "pinType": "none"
    },
    "web": {
      "clockInReport": "disabled",
      "clockOutReport": "required"
    },
    "gpsSettings": {
      "basicGeoTagging": "disabled",
      "gpsAccuracyMeters": 75,
      "gpsTimeoutSeconds": 15,
      "continuousTracking": "disabled"
    },
    "permissions": {
      "canViewOwnTimeSheet": true,
      "canEditOwnTimeSheet": false,
      "canViewJobDetails": false,
      "canViewServiceItemDetails": false,
      "activityNotes": "textAndFiles",
      "offlineClock": true,
      "canEditJobs": false
    },
    "visualCustomizations": {
      "lists": {
        "render": {
          "employee": null,
          "job": null,
          "serviceItem": null,
          "customFieldListItem": null
        },
        "sort": {
          "employee": null,
          "job": null,
          "serviceItem": null,
          "customFieldListItem": null
        }
      }
    },
    "location": {
      "web": {
        "tagInOut": "disabled",
        "accuracy": 75,
        "usingDefaultAccuracy": true,
        "timeout": 15,
        "usingDefaultTimeout": true
      },
      "app": {
        "tagInOut": "disabled",
        "accuracy": 75,
        "usingDefaultAccuracy": true,
        "timeout": 15,
        "usingDefaultTimeout": true,
        "continuousTracking": "disabled"
      }
    }
  },
  "emailAddress": "wwhite@vericlock.com",
  "customData": {
    "nickname": "Heisenberg",
    "internalEmployeeID": "1"
  },
  "personalDetails": {
    "addressLine1": "3828 Piermont dr",
    "addressLine2": null,
    "city": "Albuquerque",
    "countryCode": "US",
    "stateCode": "NM",
    "postalCode": "87111",
    "phoneHome": "+1-505-555-1234",
    "phoneMobile": "+1-505-555-9876",
    "phoneOther": null,
    "driversLicense": null,
    "taxNumber": null,
    "birthday": "1959-09-07",
    "iDataCode1": null,
    "iDataCode2": null,
    "iDataCode3": null,
    "iDataCode4": null,
    "iDataCode5": null
  },
  "employmentDetails": {
    "startDate": "2009-09-08",
    "endDate": null,
    "payRate": null,
    "salary": 36000000,
    "jobTitle": null
  },
  "dailyBudgetMins": {
    "mon": null,
    "tue": null,
    "wed": null,
    "thu": null,
    "fri": null,
    "sat": null,
    "sun": null
  },
  "createdDate": null,
  "updateDate": 1680036486000,
  "passwordNotSet": true,
  "pinNotSet": true
}
Notes
Note that a few extra fields are returned: guid: employee guid, used to identify the employee in subsequent requests clockInState: clocked in state of employee: clockedIn or clockedOut publicPhoneID: the numeric ID used on public phone in/sms numbers
Update Employee
Description
Update an employee with the posted employee object. The posted employee may be incomplete; only set fields will be updated.
HTTP POST

https://undefined/api/1.0/employee/:employeeGuid/update

URI Parameters

Parameter Type Required | Optional Description
employeeGuid string Required Employee's guid

Post Body

{                            //Employee Object, Describes an employee
  "phoneID":string,          //[string] Numeric/touch-tone ID
  "firstName":string,        //[string] First name
  "middleName":string,       //[string] Middle initial (or name)
  "lastName":string,         //[string] Last name
  "emailAddress":string,     //[string] Email address
  "password":string,         //[string] Password - plaintext (salted and hashed server side)
  "oldpassword":string,      //[string] Old Password - only needed for an admin to change their own password
  "status":string,           //[string] [active,inactive,deleted] Active status
  "type":string,             //[string] [normal,admin] Employee type
  "groupGuid":string,        //[string] Group the employee belongs to
  "customData":object,       //[object] A custom JSON object to store with the employee
  "personalDetails":{        //An employee's contact and other personal details
    "addressLine1":string,   //[string] Address Line 1
    "addressLine2":string,   //[string] Address Line 2
    "city":string,           //[string] City
    "countryCode":string,    //[string] ISO 3166-1 Alpha 2 two character country code.
    "stateCode":string,      //[string] Two character state or province code - only applicable to USA/Canada
    "postalCode":string,     //[string] Zip/Postal Code
    "phoneHome":string,      //[string] Home phone number / phone number 1
    "phoneMobile":string,    //[string] Mobile phone number / phone number 2
    "phoneOther":string,     //[string] Other phone number / phone number 3
    "driversLicense":string, //[string] Zip/Postal Code
    "taxNumber":string,      //[string] Zip/Postal Code
    "birthday":string,       //[string] Employee's date of birth
    "privateNotes":string    //[string] undefined
  },
  "employmentDetails":{      //An employee's employement details
    "startDate":string,      //[string] Employment start date
    "endDate":string         //[string] Employment end date
  },
  "settings":{               //An employee's customized settings
    "phone":{                //Phone specific settings
      "clockInReport":string,//[string] [required,optional,disabled] Is a report required on clock in
      "clockOutReport":string,//[string] [required,optional,disabled] Is a report required on clock out
      "pinType":string,      //[string] [none,custom] Type of phone pin that is configured.  ['none', 'custom']. 'custom' means the employee must enter their phonePin when clocking in by phone or SMS
      "pin":string           //[string] Phone or SMS numeric PIN code - must be digits only.
    },
    "web":{                  //Web specific settings
      "clockInReport":string,//[string] [required,optional,disabled] Is a report required on clock in
      "clockOutReport":string//[string] [required,optional,disabled] Is a report required on clock out
    },
    "gpsSettings":{          //GPS specific settings
      "basicGeoTagging":string//[string] [enabled,disabled] Collect GPS coordinates on clock in and out on supported mobile devices (Mobile Web/App)
    },
    "location":{             //Employee GEO Tagging Settings
      "web":{                //Web browser based geo location - mobile browser
        "tagInOut":string,   //[string] [enabled,disabled] GEO tag when employee clocks in/out
        "accuracy":integer,  //[integer] When looking for a gps location, stop when a position with this level of accuracy is found
        "timeout":integer    //[integer] When looking for a gps location, stop after this many seconds
      },
      "app":{                //App based geo location - iOS App, Android App, etc...
        "tagInOut":string,   //[string] [enabled,disabled] GEO tag when employee clocks in/out
        "accuracy":integer,  //[integer] When looking for a gps location, stop when a position with this level of accuracy is found
        "timeout":integer,   //[integer] When looking for a gps location, stop after this many seconds
        "continuousTracking":string//[string] [enabled,disabled] GEO Tag at regular intervals during employee's shift. Can be taxing on battery life.
      },
      "network":{            //App based geo location - iOS App, Android App, etc...
        "tagInOut":string,   //[string] [always,sometimes,disabled] GEO tag when employee clocks in/out
        "frequency":integer  //[integer] When tagInOut is set to sometimes, events will randomly be tagged using network location using this frequency as a %
      }
    },
    "permissions":{          //Employee access permissions
      "canViewOwnTimeSheet":boolean,//[boolean] Employee can view their own timesheet
      "canEditOwnTimeSheet":boolean,//[boolean] Employee can edit their own timesheet
      "activityNotes":string,//[string] [disabled,textOnly,textAndFiles] Employee can upload activity notes and/or files
      "offlineClock":boolean //[boolean] Employee can clock in or out when offline
    }
  },
  "dailyBudgetMins":{        //Daily hour budgets
    "mon":number,            //[number] undefined
    "tue":number,            //[number] undefined
    "wed":number,            //[number] undefined
    "thu":number,            //[number] undefined
    "fri":number,            //[number] undefined
    "sat":number,            //[number] undefined
    "sun":number             //[number] undefined
  }
}

Response

{
  "guid": "745c9f42-f6ea-4644-bc01-d0a1ba9bca59",
  "status": "active",
  "type": "normal",
  "firstName": "Walter",
  "middleName": "Hartwell",
  "lastName": "White",
  "fullName": "Walter Hartwell White",
  "phoneID": "625",
  "publicPhoneID": "100*625",
  "clockState": "clockedOut",
  "groupGuid": null,
  "settings": {
    "phone": {
      "clockInReport": "disabled",
      "clockOutReport": "required",
      "pinType": "none"
    },
    "web": {
      "clockInReport": "disabled",
      "clockOutReport": "required"
    },
    "gpsSettings": {
      "basicGeoTagging": "disabled",
      "gpsAccuracyMeters": 75,
      "gpsTimeoutSeconds": 15,
      "continuousTracking": "disabled"
    },
    "permissions": {
      "canViewOwnTimeSheet": true,
      "canEditOwnTimeSheet": false,
      "canViewJobDetails": false,
      "canViewServiceItemDetails": false,
      "activityNotes": "textAndFiles",
      "offlineClock": true,
      "canEditJobs": false
    },
    "visualCustomizations": {
      "lists": {
        "render": {
          "employee": null,
          "job": null,
          "serviceItem": null,
          "customFieldListItem": null
        },
        "sort": {
          "employee": null,
          "job": null,
          "serviceItem": null,
          "customFieldListItem": null
        }
      }
    },
    "location": {
      "web": {
        "tagInOut": "disabled",
        "accuracy": 75,
        "usingDefaultAccuracy": true,
        "timeout": 15,
        "usingDefaultTimeout": true
      },
      "app": {
        "tagInOut": "disabled",
        "accuracy": 75,
        "usingDefaultAccuracy": true,
        "timeout": 15,
        "usingDefaultTimeout": true,
        "continuousTracking": "disabled"
      }
    }
  },
  "emailAddress": "wwhite@vericlock.com",
  "customData": {
    "nickname": "Heisenberg",
    "internalEmployeeID": "1"
  },
  "personalDetails": {
    "addressLine1": "3828 Piermont dr",
    "addressLine2": null,
    "city": "Albuquerque",
    "countryCode": "US",
    "stateCode": "NM",
    "postalCode": "87111",
    "phoneHome": "+1-505-555-1234",
    "phoneMobile": "+1-505-555-9876",
    "phoneOther": null,
    "driversLicense": null,
    "taxNumber": null,
    "birthday": "1959-09-07",
    "iDataCode1": null,
    "iDataCode2": null,
    "iDataCode3": null,
    "iDataCode4": null,
    "iDataCode5": null
  },
  "employmentDetails": {
    "startDate": "2009-09-08",
    "endDate": null,
    "payRate": null,
    "salary": 36000000,
    "jobTitle": null
  },
  "dailyBudgetMins": {
    "mon": null,
    "tue": null,
    "wed": null,
    "thu": null,
    "fri": null,
    "sat": null,
    "sun": null
  },
  "createdDate": null,
  "updateDate": 1680036486000,
  "passwordNotSet": true,
  "pinNotSet": true
}
Notes
* Updating an employee from a status of deleted to active or inactive requires the phoneID be unique. * Some fields are not directly changeable such as guid, clockInState and publicPhoneID
Get Employee
Description
Get a specific employee by guid
HTTP GET

https://undefined/api/1.0/employee/:employeeGuid

URI Parameters

Parameter Type Required | Optional Description
employeeGuid string Required Employee's guid

Response

{
  "guid": "745c9f42-f6ea-4644-bc01-d0a1ba9bca59",
  "status": "active",
  "type": "normal",
  "firstName": "Walter",
  "middleName": "Hartwell",
  "lastName": "White",
  "fullName": "Walter Hartwell White",
  "phoneID": "625",
  "publicPhoneID": "100*625",
  "clockState": "clockedOut",
  "groupGuid": null,
  "settings": {
    "phone": {
      "clockInReport": "disabled",
      "clockOutReport": "required",
      "pinType": "none"
    },
    "web": {
      "clockInReport": "disabled",
      "clockOutReport": "required"
    },
    "gpsSettings": {
      "basicGeoTagging": "disabled",
      "gpsAccuracyMeters": 75,
      "gpsTimeoutSeconds": 15,
      "continuousTracking": "disabled"
    },
    "permissions": {
      "canViewOwnTimeSheet": true,
      "canEditOwnTimeSheet": false,
      "canViewJobDetails": false,
      "canViewServiceItemDetails": false,
      "activityNotes": "textAndFiles",
      "offlineClock": true,
      "canEditJobs": false
    },
    "visualCustomizations": {
      "lists": {
        "render": {
          "employee": null,
          "job": null,
          "serviceItem": null,
          "customFieldListItem": null
        },
        "sort": {
          "employee": null,
          "job": null,
          "serviceItem": null,
          "customFieldListItem": null
        }
      }
    },
    "location": {
      "web": {
        "tagInOut": "disabled",
        "accuracy": 75,
        "usingDefaultAccuracy": true,
        "timeout": 15,
        "usingDefaultTimeout": true
      },
      "app": {
        "tagInOut": "disabled",
        "accuracy": 75,
        "usingDefaultAccuracy": true,
        "timeout": 15,
        "usingDefaultTimeout": true,
        "continuousTracking": "disabled"
      }
    }
  },
  "emailAddress": "wwhite@vericlock.com",
  "customData": {
    "nickname": "Heisenberg",
    "internalEmployeeID": "1"
  },
  "personalDetails": {
    "addressLine1": "3828 Piermont dr",
    "addressLine2": null,
    "city": "Albuquerque",
    "countryCode": "US",
    "stateCode": "NM",
    "postalCode": "87111",
    "phoneHome": "+1-505-555-1234",
    "phoneMobile": "+1-505-555-9876",
    "phoneOther": null,
    "driversLicense": null,
    "taxNumber": null,
    "birthday": "1959-09-07",
    "iDataCode1": null,
    "iDataCode2": null,
    "iDataCode3": null,
    "iDataCode4": null,
    "iDataCode5": null
  },
  "employmentDetails": {
    "startDate": "2009-09-08",
    "endDate": null,
    "payRate": null,
    "salary": 36000000,
    "jobTitle": null
  },
  "dailyBudgetMins": {
    "mon": null,
    "tue": null,
    "wed": null,
    "thu": null,
    "fri": null,
    "sat": null,
    "sun": null
  },
  "createdDate": null,
  "updateDate": 1680036486000,
  "passwordNotSet": true,
  "pinNotSet": true
}
Query For Employees
Description
Search VeriClock for employees matching query parameters. If no query parameters are supplied, returns a list of all active employees.
HTTP POST

https://undefined/api/1.0/employee/query

Post Body

{
  "status":string,array,     //[string,array] Employee's status
  "teamView":boolean,        //[boolean] Indicate query is for team view purposes, resulting in reduced info list and subject to team view permissions
  "includeAdminNotes":boolean,//[boolean] Return private admin notes for employees.
  "modifiedSinceDate":string //[string] Return records modified at or after this date-time
}

Response

[
  {
    "guid": "b724bee7-51d0-4054-8b49-7a6473cde1b9",
    "firstName": "Walter",
    "lastName": "White"
  },
  {
    "guid": "b55cbf37-aefd-45e7-87cc-446eb4b472a7",
    "firstName": "Skyler",
    "lastName": "White"
  }
]
Notes
Returned employee objects are complete objects, the above example omits fields for clarity.

Job

Methods for retrieving Jobs, and creating new Jobs.
Get the cost for a job
Description
Returns the cost for a job referenced by the supplied guid
HTTP GET

https://undefined/api/1.0/job/:jobGuid/getCost/:budgetType

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Required Job's guid
budgetType string Required Type of job cost report
Valid Values: [allTime, monthly, weekly, daily, payroll]

Response

{
  "totalDollars": 1650,
  "totalHours": 24.25,
  "hasTimeGuard": false,
  "missingRatesByPayrollItem": [
    {
      "_payrollItem": {
        "Regular": true
      },
      "employeeFullName": "Walter White",
      "employeeGuid": "5c235f53-2222-3333-4444-abc6ec86ed77",
      "payrollItems": [
        "Regular"
      ]
    }
  ],
  "missingPayrollItemsByTimeType": []
}

Group

Methods for clocking groups in and out of the service.
Get a Group by guid
Description
Get a Group by guid
HTTP GET

https://undefined/api/1.0/group/:groupGuid

URI Parameters

Parameter Type Required | Optional Description
groupGuid string Required Group's guid

Response

{
  "guid": "19d9fd56-b893-4391-6ebe-f1d93e1c2c7e",
  "name": "Sales Team",
  "description": "",
  "employees": [
    "...employees in group list..."
  ]
}

Timesheet

Methods for retrieving time data.
Time Sheet Query
Description
Retrieve all clock events that match the posted search criteria
HTTP POST

https://undefined/api/1.0/timesheet/query

Post Body

{                            //A time sheet query object describes what time data to retrieve
  "searchPeriod":{           //Search time frame
    "start":string,          //(Required)[string] Search period begins at this date-time
    "end":string,            //(Required)[string] Search period ends at this date-time
    "searchType":string,     //[string] [inOutTimeInclusive,inTimeInclusive,inOrOutTimeInclusive] Changes how search interprets start and end time ranges. inTimeInclusive will only consider a clock event's clock in time, inOutTimeInclusive will consider both the clock in time AND out time, both must be in the search window, and 'inOrOutTimeInclusive' either the clock event's start or end time must be within the search window. Default is 'inOutTimeInclusive'
    "includeInProgressEvents":boolean//[boolean] Include clock events of employees still clocked in - duration, cost, etc will assume a time up to the current moment
  },
  "applyScheduledDeductions":boolean,//[boolean] Apply the scheduled time deductions to all events
  "activeFilter":string,     //[string] [active,deleted,all] Allows the inclusive of deleted events as well or exclusively. Default is 'active'
  "approvedFilter":string,   //[string] [all,approved,unapproved] Filter for only approved timesheet entries. One of ['all','approved','unapproved']. Default is 'all'
  "employeeList":array,      //[array] Array of employee guid's
  "groupList":array,         //[array] Array of group guid's
  "jobList":array,           //[array] Array of job guid's
  "includeEmployeeIds":array,//[array] undefined
  "excludeEmployeeIds":array,//[array] undefined
  "includeGroupIds":array,   //[array] undefined
  "excludeGroupIds":array,   //[array] undefined
  "includeJobIds":array,     //[array] undefined
  "excludeJobIds":array,     //[array] undefined
  "includeServiceItemIds":array,//[array] undefined
  "excludeServiceItemIds":array,//[array] undefined
  "includeDeletedCustomFields":boolean,//[boolean] Include custom field data attached to the clock event even if the custom field has been deleted
  "requestExtraData":{       //Data returned will be minimal unless additional fields or objects are requested
    "reportsIn":boolean,     //[boolean] Include clock in reports for each clock event
    "reportsOut":boolean,    //[boolean] Include clock out reports for each clock event
    "customFieldsIn":boolean,//[boolean] Include clock in custom field data for each clock event
    "customFieldsOut":boolean,//[boolean] Include clock out custom field data for each clock event
    "editEmployee":boolean,  //[boolean] Include the last employee to edit each clock event
    "editReport":boolean,    //[boolean] Include all edit notes for each clock event
    "webInfoIn":boolean,     //[boolean] Include clock in details for web clocks if available. IP, Browser, etc...
    "phoneInfoIn":boolean,   //[boolean] Include clock in details for phone clocks if available. Caller ID, etc...
    "smsInfoIn":boolean,     //[boolean] Include clock in details for sms clocks if available. Caller ID, etc...
    "appInfoIn":boolean,     //[boolean] Include clock in details for app clocks if available. IP, Device, etc...
    "gpsInfoIn":boolean,     //[boolean] Include clock in GPS info if available. Lat, Lng, etc...
    "webInfoOut":boolean,    //[boolean] Include clock out details for web clocks if available. IP, Browser, etc...
    "phoneInfoOut":boolean,  //[boolean] Include clock out details for phone clocks if available. Caller ID, etc...
    "smsInfoOut":boolean,    //[boolean] Include clock out details for sms clocks if available. Caller ID, etc...
    "appInfoOut":boolean,    //[boolean] Include clock out details for app clocks if available. IP, Device, etc...
    "gpsInfoOut":boolean     //[boolean] Include clock out GPS info if available. Lat, Lng, etc...
  },
  "reportType":string        //[string] Custom report or not?
}

Response

[
  {
    "guid": "8ab6f6fe-ee2b-432b-b309-2f253faf73f1",
    "rootGuid": "8ab6f6fe-ee2b-432b-b309-2f253faf73f1",
    "employeeGuid": "c6c2b737-6e74-4c36-bee1-52172543be83",
    "jobGuid": "a9dd55f0-73bf-43d5-b34a-ea48ee850b45",
    "jobCode": null,
    "jobName": null,
    "serviceItemGuid": null,
    "serviceItemCode": null,
    "serviceItemName": null,
    "serviceRatePennies": 0,
    "start": "2009-01-01T08:05:00.000Z",
    "end": "2009-01-01T17:49:00.000Z",
    "duration": 584,
    "clockInReportId": null,
    "inDetails": {
      "method": "phone",
      "report": {
        "type": "audio",
        "url": "https://url.to.the.report/mp3/or/wav"
      },
      "callerID": "+15055551234",
      "calledNumber": "+15055550000",
      "callLength": "37"
    },
    "clockOutReportId": null,
    "outDetails": {
      "method": "web",
      "report": {
        "type": "text",
        "value": "Lab session went perfectly"
      },
      "ipAddress": "192.168.0.25",
      "userAgent": "chrome browser"
    },
    "deleted": false,
    "flags": 10,
    "gpsFlags": 0,
    "updateDate": null,
    "flagged": {
      "accessControlCallerIDClockIn": true
    },
    "approved": true
  },
  {
    "guid": "268cd2d3-43b1-44dd-b267-df1fd87d9158",
    "rootGuid": "268cd2d3-43b1-44dd-b267-df1fd87d9158",
    "employeeGuid": "042ec6c2-671a-4b8b-90df-91ec3dd4a47e",
    "jobGuid": "49d99a20-5215-4eec-b6ba-0b381f4caba8",
    "jobCode": null,
    "jobName": null,
    "serviceItemGuid": null,
    "serviceItemCode": null,
    "serviceItemName": null,
    "serviceRatePennies": 0,
    "start": "2009-02-01T08:27:00.000Z",
    "end": "2009-02-01T12:12:00.000Z",
    "duration": 225,
    "clockInReportId": null,
    "inDetails": {
      "method": "sms",
      "callerID": "+15055551234",
      "calledNumber": "+15055550000",
      "rawSMS": "in 625 100"
    },
    "clockOutReportId": null,
    "outDetails": {
      "method": "mobileWeb",
      "ipAddress": "192.168.0.119",
      "userAgent": "iphone/safari browser",
      "geoTagging": {
        "latitude": "49.264585002149",
        "longitude": "-123.12476435135",
        "accuracy": 25
      }
    },
    "deleted": false,
    "flags": 42,
    "gpsFlags": 0,
    "updateDate": null,
    "flagged": {
      "accessControlCallerIDClockIn": true,
      "jobRulesAssignmentMismatch": true
    },
    "approved": true
  },
  {
    "guid": "268cd2d3-43b1-44dd-b267-df1fd87d9158",
    "rootGuid": "268cd2d3-43b1-44dd-b267-df1fd87d9158",
    "employeeGuid": "526a8fe0-7298-414c-935d-ae396a96b0b1",
    "jobGuid": "cd35a71e-85b8-475c-8982-d04a9cafbc71",
    "jobCode": null,
    "jobName": null,
    "serviceItemGuid": null,
    "serviceItemCode": null,
    "serviceItemName": null,
    "serviceRatePennies": 0,
    "start": "2009-02-01T08:27:00.000Z",
    "end": "2009-02-01T12:12:00.000Z",
    "duration": 225,
    "clockInReportId": null,
    "inDetails": {
      "method": "phone",
      "callerID": "+15055551234",
      "calledNumber": "+15055550000"
    },
    "clockOutReportId": null,
    "outDetails": {
      "method": "phone",
      "callerID": "+15055551234",
      "calledNumber": "+15055550000"
    },
    "deleted": false,
    "flags": 24,
    "gpsFlags": 0,
    "updateDate": null,
    "flagged": {
      "accessControlCallerIDClockIn": true,
      "accessControlCallerIDClockOut": true
    }
  }
]
Notes
duration: in minutes inDetails.method: 'phone', 'sms', 'web', 'mobileWeb', 'edit', 'manualEntry'

Payroll

Gets the payroll items
Description
Gets the payroll items
HTTP POST

https://undefined/api/1.0/payroll/query

Post Body

{
  "guid":string,             //[string] Payroll Item's guid
  "status":string,array      //[string,array] Payroll Item's status
}
Create payroll item
Description
Creates a new payroll item. Returns the newly created payroll item on success.
HTTP POST

https://undefined/api/1.0/payroll/create

Post Body

{                            //PayrollItem Object. Describes a payroll item
  "name":string,             //(Required)[string] Name for the payroll item.
  "description":string,      //[string] Description of the payroll item.
  "status":string,           //[string] [active,inactive,deleted] Payroll item's active status
  "type":string,             //[string] [hourly,overtime,salary] Payroll item's pay type
  "linkedGuid":string,       //[string] Guid of linked payroll item
  "multiplier":number        //[number] Multiplier for the payroll item rate. This is only valid if linkedGuid is valid
}

Response

{
  "guid": "4df172c1-e093-4673-83c3-d589dc9bb4a5",
  "name": "Painting overtime",
  "description": "Overtime payroll for painting",
  "status": "active",
  "type": "hourly",
  "linkedGuid": null,
  "linkedName": null,
  "multiplier": null,
  "createdDate": "2023-03-28T20:48:06.000Z"
}
Update payroll items
Description
Update a payroll item with the posted payroll item object. The posted payroll item may be incomplete, only set fields will be updated.
HTTP POST

https://undefined/api/1.0/payroll/:guid/update

URI Parameters

Parameter Type Required | Optional Description
guid string Required Payroll item's guid

Post Body

{                            //PayrollItem Object. Describes a payroll item
  "name":string,             //[string] Name for the payroll item.
  "description":string,      //[string] Description of the payroll item.
  "status":string,           //[string] [active,inactive,deleted] Payroll item's active status
  "type":string,             //[string] [hourly,overtime,salary] Payroll item's pay type
  "linkedGuid":string,       //[string] Guid of linked payroll item
  "multiplier":number        //[number] Multiplier for the payroll item rate. This is only valid if linkedGuid is valid
}

Response

{
  "guid": "4df172c1-e093-4673-83c3-d589dc9bb4a5",
  "name": "Painting overtime",
  "description": "Overtime payroll for painting",
  "status": "active",
  "type": "hourly",
  "linkedGuid": null,
  "linkedName": null,
  "multiplier": null,
  "createdDate": "2023-03-28T20:48:06.000Z"
}
Notes
* Some fields are not directly changeable such as guid
Gets payroll item rules
Description
Gets the list of payroll item rules
HTTP POST

https://undefined/api/1.0/payroll/queryRules

Post Body

{
  "payType":integer,         //[integer] Pay type
  "jobGuid":string,          //[string] Job's guid
  "serviceItemGuid":string,  //[string] Service item's guid
  "employeeGuid":string,     //[string] Employee's guid
  "groupGuid":string,        //[string] Group's guid
  "payrollItemGuid":string   //[string] Payroll item's guid
}
Creates a payroll item rule
Description
Creates a payroll item rule
HTTP POST

https://undefined/api/1.0/payroll/createRule

Post Body

{
  "payType":integer,         //(Required)[integer] Pay type
  "jobGuid":string,          //(Required)[string] Job's guid
  "serviceItemGuid":string,  //(Required)[string] Service item's guid
  "employeeGuid":string,     //(Required)[string] Employee's guid
  "groupGuid":string,        //(Required)[string] Group's guid
  "payrollItemGuid":string   //(Required)[string] Payroll item's guid
}
Delete a payroll item rule
Description
Delete a payroll item rule
HTTP POST

https://undefined/api/1.0/payroll/deleteRule

Post Body

{
  "payType":integer,         //(Required)[integer] Pay type
  "jobGuid":string,          //(Required)[string] Job's guid
  "serviceItemGuid":string,  //(Required)[string] Service item's guid
  "employeeGuid":string,     //(Required)[string] Employee's guid
  "groupGuid":string,        //(Required)[string] Group's guid
  "payrollItemGuid":string   //(Required)[string] Payroll item's guid
}
Queries payroll info for specified employee
Description
Queries payroll info for specified employee
HTTP POST

https://undefined/api/1.0/payroll/queryPayrollInfo

Post Body

{
  "employeeGuid":string      //(Required)[string] Employee's guid
}

ServiceItem

Activity Notes - Files

File activity notes
File Activity Note Upload
Description
Uploads file activity note to server
HTTP POST

https://undefined/api/1.0/files/clockevent/upload

Post Body

{
  "clockEventGuid":string,   //(Required)[string] Clock event's guid
  "originalFileName":string, //(Required)[string] Original file name from user
  "description":string       //[string] Description of picture
}
File Activity Notes Get
Description
Gets file activity note from server
HTTP POST

https://undefined/api/1.0/files/clockevent/get

Post Body

{
  "clockEventGuid":string,   //[string] Clock event's root guid
  "employeeGuid":string,     //[string] Employee's guid
  "jobGuid":string,          //[string] Job's guid
  "startDate":string,        //[string] Search period begins at this date-time (UTC)
  "endDate":string           //[string] Search period ends at this date-time (UTC)
}

Response

[
  {
    "guid": "8e153f4f-37ba-4657-8105-dbc661e02942",
    "createDate": "2020-12-08T19:37:48.000Z",
    "fileURL": "https://s3.amazonaws.com/CustomerClockEventFilesDev/xxxxxxxxxxxx.png",
    "fileSize": 113167,
    "fileType": "Image",
    "metadata": {
      "fileName": "xxxxxxxxxxxxx.png",
      "originalFileName": "floorplan.png",
      "description": "Floor plan of the garage - note the window placement"
    },
    "clockEventRootGuid": "dd7a0a7e-f579-439a-840a-16e9f07d9423",
    "employeeGuid": "95cfc3d1-684c-4048-89d6-4b7c1de572a2",
    "employeeName": "Jane Smith",
    "jobGuid": "992f59bf-7f4c-4f43-adfa-f2eb0f91b277",
    "jobName": "Garage Inspection - 556"
  }
]
File Activity Note Delete
Description
Delete file activity note
HTTP POST

https://undefined/api/1.0/files/clockevent/delete

Post Body

{
  "fileGuid":string          //(Required)[string] File's guid
}
File Activity Note Delete List
Description
Deletes file activity notes by list
HTTP POST

https://undefined/api/1.0/files/clockevent/deleteList

Post Body

{
  "guidList":array           //(Required)[array] undefined
}

Activity Notes - Text

Text only activity notes
Activity Notes Upload
Description
Uploads text only activity note to server
HTTP POST

https://undefined/api/1.0/attachments/text/create

Post Body

{
  "clockEventGuid":string,   //(Required)[string] Clock event's guid
  "report":string            //(Required)[string] Report description
}
Text Activity Notes Get
Description
Gets text only activity note from server
HTTP POST

https://undefined/api/1.0/attachments/text/get

Post Body

{
  "clockEventGuid":string,   //[string] Clock event's root guid
  "employeeGuid":string,     //[string] Employee's guid
  "jobGuid":string,          //[string] Job's guid
  "startDate":string,        //[string] Search period begins at this date-time (UTC)
  "endDate":string           //[string] Search period ends at this date-time (UTC)
}

Response

[
  {
    "guid": "24d4d179-2bf9-474c-b2c8-2a79ed8853db",
    "createDate": "2020-12-08T20:09:31.000Z",
    "report": "Roof needs a closer inspection next visit",
    "clockEventRootGuid": "dd7a0a7e-f579-439a-840a-16e9f07d9423",
    "employeeGuid": "95cfc3d1-684c-4048-89d6-4b7c1de572a2",
    "employeeName": "Jane Smith",
    "jobGuid": "992f59bf-7f4c-4f43-adfa-f2eb0f91b277",
    "jobName": "Garage Inspection - 556"
  }
]
Text Activity Note Delete
Description
Delete text activity note
HTTP POST

https://undefined/api/1.0/attachments/text/delete

Post Body

{
  "reportGuid":string        //(Required)[string] Report's guid
}
Text Activity Note Delete List
Description
Deletes text activity notes by list
HTTP POST

https://undefined/api/1.0/attachments/text/deleteList

Post Body

{
  "guidList":array           //(Required)[array] undefined
}

Settings - Clock Access Control

Methods for changing the clock in/out access control settings
Create caller ID Access Rule
Description
Creates/updates a caller ID access rule for job referenced by URI parameter :jobGuid
HTTP POST

https://undefined/api/1.0/settings/accessControl/callerID/:jobGuid

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Required The GUID of the job this rule will apply to or 'global' for the global rules

Post Body

{
  "permission":string,       //(Required)[string] [allow,deny] Permission type
  "flagOnly":boolean,        //[boolean] Flag Only - if true, clocks matching rule are not blocked, but are instead flagged only
  "phoneNumber":string,      //[string] Phone number for the rule, blank for generic base case. International format.
  "notes":string             //[string] Short description about the phone number
}
Get caller ID Access Rule
Description
Retrieves all or a specific caller ID access rule referenced by URI parameter :jobGuid
HTTP GET

https://undefined/api/1.0/settings/accessControl/callerID/:jobGuid

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Optional The GUID of the job this rule will apply to - use 'global' to refer to the global rules. Leave empty to retrieve all rules.
Removes a caller ID access rule
Description
URI parameter :jobGuid refers to the rule to be deleted.
HTTP DELETE

https://undefined/api/1.0/settings/accessControl/callerID/:jobGuid

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Optional The GUID of the job this rule will apply to - use 'global' to refer to the global rules.

Post Body

{
  "phoneNumber":string       //[string] Phone number for the rule, blank for generic base case, wildcard * for entire rule.  International format.
}
Create IP Address Access Rule
Description
Creates/updates a IP Address access rule for job referenced by URI parameter :jobGuid
HTTP POST

https://undefined/api/1.0/settings/accessControl/ipAddress/:jobGuid

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Required The GUID of the job this rule will apply to or 'global' for the global rules

Post Body

{
  "permission":string,       //(Required)[string] [allow,deny] Permission type
  "flagOnly":boolean,        //[boolean] Flag Only - if true, clocks matching rule are not blocked, but are instead flagged only
  "ipAddress":string,        //[string] IP Address for the rule, blank for generic base case, wildcard * for entire rule..
  "notes":string             //[string] Short description about the IP address
}
Get IP Address Access Rule
Description
Retrieves all or a specific IP Address access rule referenced by URI parameter :jobGuid
HTTP GET

https://undefined/api/1.0/settings/accessControl/ipAddress/:jobGuid

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Optional The GUID of the job this rule will apply to - use 'global' to refer to the global rules. Leave empty to retrieve all rules.
Removes an IP Address access rule
Description
URI parameter :jobGuid refers to the rule to be deleted.
HTTP DELETE

https://undefined/api/1.0/settings/accessControl/ipAddress/:jobGuid

URI Parameters

Parameter Type Required | Optional Description
jobGuid string Optional The GUID of the job this rule will apply to - use 'global' to refer to the global rules.

Post Body

{
  "ipAddress":string         //[string] IP Address for the rule, blank for generic base case, wildcard * for entire rule..
}

Clock

Clock in/out employees
Clock In Group
Description
Clock in list of employees - authenticated user must be the employees' manager or be an administrator
HTTP POST

https://undefined/api/1.0/clock/group/in

Post Body

{
  "employeeGuids":array,     //(Required)[array] List of employees guids
  "jobGuid":string,          //[string] Job guid
  "serviceItemGuid":string,  //[string] Service item guid
  "report":string,           //[string] A text clock in report to be attached to the clock event
  "returnClockRootId":boolean//[boolean] undefined
}

Response

{
  "23930782-390b-439f-88b6-7576593b3c6f": true,
  "9583b0b8-7eda-42ec-bbf0-7cdc8a7c48b8": true,
  "390bb0b8-439f-490b-7576-239307824324": false
}
Notes
* The response lists the employee guids and true or false indicating if the clock in was successful - the primary reason for failure is due to already being clocked in * Job Rules (if enabled and applicable) are applied as though this is a 'web' clock * 'customFieldData' is and available field to attach custom data, but requires additional info, details coming soon...
Clock Out Group
Description
Clock out list of employees - authenticated user must be the employees' manager or be an administrator
HTTP POST

https://undefined/api/1.0/clock/group/out

Post Body

{
  "employeeGuids":array,     //(Required)[array] List of employees guids
  "report":string,           //[string] A text clock out report to be attached to the clock event
  "flags":integer            //[integer] undefined
}

Response

{
  "23930782-390b-439f-88b6-7576593b3c6f": true,
  "9583b0b8-7eda-42ec-bbf0-7cdc8a7c48b8": true,
  "390bb0b8-439f-490b-7576-239307824324": false
}
Notes
* The response lists the employee guids and true or false indicating if the clock out was successful - the primary reason for failure is due to already being clocked out * 'customFieldData' coming soon

Schedule

Schedule

Webhooks 

function _validateSignature($privateKey, $data, $signature)
{
    $sig = hash_hmac('sha256', $data, $privateKey);
    return ($sig === $signature);
}
  • $privateKey is binary.
  • $data is the URI ('/' if blank) concatenated with the request body
  • $signature is the HEX string in the http header: VERICLOCK_SIGNATURE