KRONOS Connection

Overview
Quick Start
Configuration
Knowledge Base
What's New

Overview

KRONOS Connection

Configuration is provided for establishing connections with KRONOS via its REST API v.2. The configuration is used in the REST Connection Manager.

Quick Start

Establish connection

No votes yet

In this task, we will show you step-by-step how to create a connection to a KRONOS REST API using COZYROC's REST Connection Manager.

Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.

Step 2. From drop down menu Configuration select KRONOS.

Step 3. For successful authentication you need to replace [instance] and [companyid] inside Server address with actual instance and company Id. Providing valid user's Name, Password, LoginCompanyId and ApiKey is also required.
Hint: ApiKey can be generated on Api Keys control in Company Setup (client level)/ Company Configuration (admin level).

Step 3: After setting up the authentication parameters, test your connection by clicking Test connection button.

Consume data from service

No votes yet

Step 1. Open the right side panel and drag and drop REST Source component. Double click on it and select REST KRONOS connection, select from available KRONOSresources listed in second drop-down menu (Saved Reports) and enter values of required parameters in Parameters grid.

Step 2. Check resource metadata by selecting Columns

Step 3. If necessary, you can configure the Error Output

Step 4. Connect REST Source component to desired Destination component and edit mapping.

Push data to service

No votes yet

Step 1. Drag and drop REST Destination component from the SSIS Toolbox. Double click on it and select REST KRONOS connection, select from available KRONOS resources listed in third drop-down menu (Employees) , select from available Action listed in second drop-down menu (Create).

Step 2. Connect desired Source component to newly created REST Destination component and map columns.

Step 3. If necessary, you can configure the Error Output.

Contribute

Configuration

Service

Base URL address: https://[instance]/ta/rest/v2/companies/[companyid].

Authentication

The authentication uses a session token.

The authentication has the following user-defined parameters:

Name: Required. Specify user name.
Password: Required. Specify password.
ApiKey: Required. Specify API key.
LoginCompanyId: Required. Specify login company identifier.

The following request parameters will be automatically processed during the authentication process:

Authentication: Bearer {{=token.Access}}
Api-Key: {{=connection.user.ApiKey}}

Resources

Report

Based on resource template Base.

[Read] action

Endpoint URL address: {{=new Uri(connection.serverHost).authority()}}/ta/rest/v1/report/{{=parameters.reportType}}/{{=parameters.report_id}}.
The result is extracted from: {{=KRONOS.getReportData(response)}}.
The action uses POST method.

The action has the following user-defined parameters:

reportType: Required. Specify report type.
report_id: Required. The reports's id.
settings: Specify settings in JSON format. Optional.

The following request parameters will be automatically processed:

Accept: text/csv
application/json: {{=parameters.get('settings') ? JSON.parse(parameters.settings) : '{}'}}

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v1__report__saved__(settings_id)#get.

External Fields

[External]

The external fields URL address: {{=new Uri(connection.serverHost).authority()}}/ta/rest/v1/report/{{=parameters.reportType}}/{{=parameters.report_id}}. The external fields list is extracted from: {{=KRONOS.getReportFields(response)}}.

{{=external.name}}: Template: {{=external.template}}.

Applicant

Based on resource template Base.

[Read allApplicants] action (alias: "Get list of applicants")

Endpoint URL address: /applicants.
The result is extracted from: {{=response.applicants}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__applicants#get.

[Read existingApplicant] action (alias: "Get existing applicant")

Endpoint URL address: /applicants/{{=parameters.account_id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

account_id: Required. The account's id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__applicants__(account_id)#get.

[Create] action

Endpoint URL address: /applicants.
The result is extracted from: {{=response.location}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__applicants#post.

[Update] action

Endpoint URL address: /applicants/{{=item.account.account_id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__applicants__(account_id)#put.

[Delete] action

Endpoint URL address: /applicants/{{=item.account.account_id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__applicants__(account_id)#delete.

The resource includes the fields from the Applicant template.

Attendance

Based on resource template Base.

[Read] action

Endpoint URL address: /attendance.
The result is extracted from: {{=response.attendance}}.

The action has the following user-defined parameters:

status: Allowed values: "IN", "OUT", "OPEN_ABSENCE".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__attendance#get.

The resource includes the fields from the Attendance template.

Benefit Plan

Based on resource template Base.

[Read benefitPlans] action (alias: "Get benefit plans")

Endpoint URL address: /benefits.
The result is extracted from: {{=response.benefits}}.

The action has the following user-defined parameters:

coverage_start: Required. Example: 2016-03-14. Can be used to retrieve start of coverage lower bounded employee benefit plans.
coverage_end: Required. Example: 2016-10-31. Can be used to retrieve end of coverage upper bounded employee benefit plans.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__benefits#get.

[Read benefitPlan] action (alias: "Get benefit plan")

Endpoint URL address: /benefits/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Employee benefit plan id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__benefits__(id)#get.

[Read employeeBenefitPlans] action (alias: "Get employee's benefit plans")

Endpoint URL address: /employees/{{=parameters.aid}}/benefits.
The result is extracted from: {{=response.benefits}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__benefits#get.

The resource includes the fields from the BenefitPlan template.

Calendar

Based on resource template Base.

[Read anniversary] action (alias: "Get anniversary calendar")

Endpoint URL address: /calendar/anniversary.
The result is extracted from: {{=response.anniversaries}}.

The action has the following user-defined parameters:

type: Required. Allowed values: "STARTED", "BENEFITS", "BIRTHDAY", "DECEASED", "HIRED", "PEO_HIRED", "REHIRED", "RETIRED", "REVIEW", "SENIORITY", "TERMINATED", "CUSTOM_DATE_1", "CUSTOM_DATE_2", "CUSTOM_DATE_3", "CUSTOM_DATE_4", "CUSTOM_DATE_5"
date_from: Required. Example: 2016-01-01. Start of date range.
date_to: Required. Example: 2016-12-31. End of date range.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__calendar__anniversary#get.

[Read birthday] action (alias: "Get birthday calendar")

Endpoint URL address: /calendar/birthday.
The result is extracted from: {{=response.birthdays}}.

The action has the following user-defined parameters:

date_from: Required. Example: 2016-01-01. Start of date range.
date_to: Required. Example: 2016-12-31. End of date range.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__calendar__birthday#get.

The resource includes the fields from the Calendar template.

Additional Compensation

Based on resource template Base.

[Read additionalCompensations] action (alias: "Get additional compensation records")

Endpoint URL address: /compensation/additional.
The result is extracted from: {{=response.additional_compensations}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__additional#get.

[Read additionalCompensation] action (alias: "Get additional compensation record")

Endpoint URL address: /compensation/additional/{{=parameters.acid}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

acid: Required. Additional Compensation record id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__additional__(acid)#get.

[Read employeeAdditionalCompensations] action (alias: "Get employee's additional compensation records")

Endpoint URL address: /employees/{{=parameters.aid}}/compensation/additional.
The result is extracted from: {{=response.additional_compensations}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__compensation__additional#get.

[Create] action

Endpoint URL address: /employees/{{=item.account.id}}/compensation/additional.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__compensation__additional#post.

[Update] action

Endpoint URL address: /compensation/additional/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__additional__(acid)#put.

[Delete] action

Endpoint URL address: /compensation/additional/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__additional__(acid)#delete.

The resource includes the fields from the AdditionalCompensation template.

Compensation History

Based on resource template Base.

[Read compensationHistorys] action (alias: "Get list of Base Compensation entries")

Endpoint URL address: /compensation/history.
The result is extracted from: {{=response.compensations}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__history#get.

[Read compensationHistory] action (alias: "Get Base Compensation entry")

Endpoint URL address: /compensation/history/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Employee Base Compensation id. Id is based on object composite key (account_id and effective_from) and has following format xxxxxxxxyyyyyyy where xxxxxxxxx - represents date from and yyyyyyy - account_id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__history__(id)#get.

[Read employeeCompensationHistory] action (alias: "Get employee's Base Compensation entries")

Endpoint URL address: /employees/{{=parameters.aid}}/compensation/history.
The result is extracted from: {{=response.compensations}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__compensation__history#get.

[Create] action

Endpoint URL address: /compensation/history.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__history#post.

[Update] action

Endpoint URL address: /compensation/history/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__history__(id)#put.

[Delete] action

Endpoint URL address: /compensation/history/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__history__(id)#delete.

The resource includes the fields from the CompensationHistory template.

Fields

notes

The value is gathered from /compensation/history/{{=item.id}}/notes address. The gathered value is processed with {{=response.notes}} expression. Field components:

An array.
Uses template: Note.

Total Compensation

Based on resource template Base.

[Read totalCompensation] action (alias: "Get Total Compensation")

Endpoint URL address: /compensation/total.
The result is extracted from: {{=response.total_compensations}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__compensation__total#get.

[Read employeeTotalCompensation] action (alias: "Get employee's Total Compensation")

Endpoint URL address: /employees/{{=parameters.aid}}/compensation/total.
The result is extracted from: {{=response.total_compensations}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__compensation__total#get.

The resource includes the fields from the TotalCompensation template.

Account Group

Based on resource template Base.

[Read accountGroups] action (alias: "Get account groups")

Endpoint URL address: /config/security/account-groups.
The result is extracted from: {{=response.account_groups}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__security__account-groups#get.

[Read accountGroup] action (alias: "Get account group")

Endpoint URL address: /config/security/account-groups/{{=parameters.gid}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

gid: Required. Account Group Id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__security__account-groups__(gid)#get.

[Create] action

Endpoint URL address: /config/security/account-groups.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__security__account-groups#post.

[Update] action

Endpoint URL address: /config/security/account-groups/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__security__account-groups__(gid)#put.

[Delete] action

Endpoint URL address: /config/security/account-groups/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__security__account-groups__(gid)#delete.

The resource includes the fields from the AccountGroup template.

Cost Center

Based on resource template Base.

[Read costCenters] action (alias: "Get cost centers")

Endpoint URL address: /config/cost-centers.
The result is extracted from: {{=response.cost_centers}}.

The action has the following user-defined parameters:

tree_index: Required. Tree index must be greater than or equal to 0 and less than or equal to 8.
name: The name of cost center.
external_id: The external id of cost center.
payroll_code: The payroll code of cost center.
visible: Whether cost center is visible or not. Default: true.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers#get.

[Read costCenter] action (alias: "Get cost center")

Endpoint URL address: /config/cost-centers/{{=parameters.ccid}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

ccid: Required. The id of cost center.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__(ccid)#get.

[Create] action

Endpoint URL address: /config/cost-centers/collection.
The result is extracted from: {{=response.items}}.

The following request parameters will be automatically processed:

application/json: {{=[item]}}

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__collection#post.

[Update] action

Endpoint URL address: /config/cost-centers/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__(ccid)#put.

The resource includes the fields from the CostCenter template.

Cost Center List

Based on resource template Base.

[Read costCenterLists] action (alias: "Get cost center lists")

Endpoint URL address: /config/cost-centers/lists.
The result is extracted from: {{=response.cost_center_lists}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__lists#get.

[Read costCenterList] action (alias: "Get cost center list")

Endpoint URL address: /config/cost-centers/lists/{{=parameters.list_id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

list_id: Required. Cost center list id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__lists__(list_id)#get.

[Create] action

Endpoint URL address: /config/cost-centers/lists.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__lists#post.

[Update] action

Endpoint URL address: /config/cost-centers/lists/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__lists__(list_id)#put.

[Delete] action

Endpoint URL address: /config/cost-centers/lists/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-centers__lists__(list_id)#delete.

The resource includes the fields from the CostCenterList template.

Cost Center Job

Based on resource template Base.

[Read costCenterJobs] action (alias: "Get cost center jobs")

Endpoint URL address: /config/cost-center-jobs.
The result is extracted from: {{=response.cost_center_jobs}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-center-jobs#get.

[Read costCenterJob] action (alias: "Get cost center job")

Endpoint URL address: /config/cost-center-jobs/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. The id of cost center job.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-center-jobs__(id)#get.

[Create] action

Endpoint URL address: /config/cost-center-jobs.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-center-jobs#post.

[Update] action

Endpoint URL address: /config/cost-center-jobs/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-center-jobs__(id)#put.

[Delete] action

Endpoint URL address: /config/cost-center-jobs/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__config__cost-center-jobs__(id)#delete.

The resource includes the fields from the CostCenterJob template.

Contact

Based on resource template Base.

[Read contact] action (alias: "Get contact")

Endpoint URL address: /contacts/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Employee Contact id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__contacts__(id)#get.

[Read contacts] action (alias: "Get employee's contacts")

Endpoint URL address: /employees/{{=parameters.aid}}/contacts.
The result is extracted from: {{=response.contacts}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__contacts#get.

[Create] action

Endpoint URL address: /contacts.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__contacts#post.

[Update] action

Endpoint URL address: /contacts/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__contacts__(id)#put.

[Delete] action

Endpoint URL address: /contacts/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__contacts__(id)#delete.

The resource includes the fields from the Contact template.

Direct Deposit

Based on resource template Base.

[Read directDeposit] action (alias: "Get direct deposit")

Endpoint URL address: /direct-deposits/{{=parameters.id}}.
The result is extracted from: {{=response.deposits}}.

The action has the following user-defined parameters:

id: Required. Id of the employee's direct deposit.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__direct-deposits__(id)#get.

[Read directDeposits] action (alias: "Get employee's direct deposits")

Endpoint URL address: /employees/{{=parameters.aid}}/direct-deposits.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__direct-deposits#get.

[Create] action

Endpoint URL address: /direct-deposits.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__direct-deposits#post.

[Update] action

Endpoint URL address: /direct-deposits/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__direct-deposits__(id)#put.

[Delete] action

Endpoint URL address: /direct-deposits/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__direct-deposits__(id)#delete.

The resource includes the fields from the DirectDeposit template.

Document Storage

Based on resource template Base.

[Read uploadedDocs] action (alias: "Get list of uploaded documents metadata")

Endpoint URL address: /ids.
The result is extracted from: {{=response.documents}}.

The action has the following user-defined parameters:

type: Required. Type of uploaded documents. Allowed values: "COMPANY_DOCUMENT", "TIMESHEET_DOCUMENT", "HR_EMPLOYEE_DOCUMENT", "HR_APPLICANT_RESUME", "BENEFIT_REQUEST_DOCUMENT", "ACCOUNT_DIRECT_DEPOSIT", "HR_ACTION_REQUEST_DOC_UPLOAD", "HR_ACCOUNT_CHECK_LIST", "HR_CHECK_LIST_ITEM", "CUSTOM_FORM", "DISCIPLINE_INCIDENT".
linked_id: ID of object that is linked to requested documents. It's required depending on "type". Document types with mandatory linked_id: "TIMESHEET_DOCUMENT", "HR_EMPLOYEE_DOCUMENT", "HR_APPLICANT_RESUME", "BENEFIT_REQUEST_DOCUMENT", "ACCOUNT_DIRECT_DEPOSIT", "HR_ACTION_REQUEST_DOC_UPLOAD", "HR_ACCOUNT_CHECK_LIST", "HR_CHECK_LIST_ITEM", "CUSTOM_FORM", "DISCIPLINE_INCIDENT".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__ids#get.

[Read uploadedDoc] action (alias: "Get uploaded document metadata")

Endpoint URL address: /ids/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. ID of uploaded document.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__ids__(id)#get.

[Create] action

Endpoint URL address: /ids.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__ids#post.

[Update] action

Endpoint URL address: /ids/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__ids__(id)#put.

[Delete] action

Endpoint URL address: /ids/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__ids__(id)#delete.

The resource includes the fields from the Document template.

Leave Of Absence Case

Based on resource template Base.

[Read loaCases] action (alias: "Get leave of absence cases")

Endpoint URL address: /loa/cases.
The result is extracted from: {{=response.cases}}.

The action has the following user-defined parameters:

start_date: Can restrict list to contain cases with start date equal or greater than specified.
end_date: Can restrict list to contain cases with end date equal or less than specified. End date means actual_end_date or est_end_date if there is no actual.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases#get.

[Read employeeLoaCases] action (alias: "Get employee's leave of absence cases")

Endpoint URL address: employees/{{=parameters.aid}}/loa/cases.
The result is extracted from: {{=response.cases}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.
start_date: Can be used for getting start date lower bounded cases.
end_date: Can be used for getting actual end date upper bounded cases.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__loa__cases#get.

[Read loaCase] action (alias: "Get leave of absence case")

Endpoint URL address: /loa/cases/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Case id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases__(id)#get.

[Create] action

Endpoint URL address: /loa/cases.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases#post.

[Update] action

Endpoint URL address: /loa/cases/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases__(id)#put.

[Delete] action

Endpoint URL address: /loa/cases/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases__(id)#delete.

The resource includes the fields from the LeaveOfAbsenceCase template.

Leave Of Absence Case Note

Based on resource template Base.

[Read] action

Endpoint URL address: /loa/cases/{{=parameters.id}}/notes.
The result is extracted from: {{=response.notes}}.

The action has the following user-defined parameters:

id: Required. Case id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases__(id)__notes#get.

[Create] action

Endpoint URL address: /loa/cases/{{=item.case_id}}/notes.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases__(id)__notes#post.

[Delete] action

Endpoint URL address: /loa/cases/{{=item.case_id}}/notes/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__cases__(id)__notes__(nid)#delete.

The resource includes the fields from the Note template.

Leave Of Absence Request

Based on resource template Base.

[Read loaRequests] action (alias: "Get leave of absence requests")

Endpoint URL address: /loa/requests.
The result is extracted from: {{=response.loa_requests}}.

The action has the following user-defined parameters:

date_from: Required. Lower bound of a date range for requests.
date_to: Required. Upper bound of a date range for requests.
state: State of the request. Valid values: "NEW", "APPROVED", "REJECTED", "DELETED".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests#get.

[Read employeeLoaRequests] action (alias: "Get employee's leave of absence requests")

Endpoint URL address: employees/{{=parameters.aid}}/loa/requests.
The result is extracted from: {{=response.loa_requests}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.
date_from: Lower bound of a date range for requests.
date_to: Upper bound of a date range for requests.
state: State of the request. Valid values: "NEW", "APPROVED", "REJECTED", "DELETED".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__loa__requests#get.

[Read loaRequest] action (alias: "Get leave of absence request")

Endpoint URL address: /loa/requests/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Request id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests__(id)#get.

[Create] action

Endpoint URL address: /loa/requests.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests#post.

[Delete] action

Endpoint URL address: /loa/requests/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests__(id)#delete.

The resource includes the fields from the LeaveOfAbsenceRequest template.

Leave Of Absence Request Note

Based on resource template Base.

[Read] action

Endpoint URL address: /loa/requests/{{=parameters.id}}/notes.
The result is extracted from: {{=response.notes}}.

The action has the following user-defined parameters:

id: Required. Request id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests__(id)__notes#get.

[Create] action

Endpoint URL address: /loa/requests/{{=item.request_id}}/notes.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests__(id)__notes#post.

[Delete] action

Endpoint URL address: /loa/requests/{{=item.request_id}}/notes/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__loa__requests__(id)__notes__(nid)#delete.

The resource includes the fields from the Note template.

Mailbox Item

Based on resource template Base.

[Read mailboxItems] action (alias: "Get mailbox items")

Endpoint URL address: /notifications/mailbox-items.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

created_from: Required. Date to find mailbox items created after the date. Example: 2017-04-05T08:00:00Z.
created_to: Required. Date to find mailbox items created before the date. Example: 2017-08-05T08:00:00Z.
unread: Required. Value to find only read or unread mailbox items (1 for unread, 0 for read items).

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__notifications__mailbox-items#get.

[Read employeeMailboxItems] action (alias: "Get employee's mailbox items")

Endpoint URL address: /employees/{{=parameters.aid}}/notifications/mailbox-items.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.
created_from: Date to find mailbox items created after the date. Example: 2017-04-05T08:00:00Z.
created_to: Date to find mailbox items created before the date. Example: 2017-08-05T08:00:00Z.
unread: Value to find only read or unread mailbox items (1 for unread, 0 for read items).
sort: Value to sort items by creation date (if "-created_at" then newer items will be the first).

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__notifications__mailbox-items#get.

[Create] action

Endpoint URL address: /employees/{{=item.account_id}}/notifications/mailbox-items.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__notifications__mailbox-items#post.

[Delete] action

Endpoint URL address: /notifications/mailbox-items/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__notifications__mailbox-items__(id)#delete.

The resource includes the fields from the MailboxItem template.

Overtime Request

Based on resource template Base.

[Read ovtRequests] action (alias: "Get overtime requests")

Endpoint URL address: /overtime/requests.
The result is extracted from: {{=response.overtime_requests}}.

The action has the following user-defined parameters:

date_from: Required. Defines a lower bound of a date range for overtimes.
date_to: Required. Defines an upper bound of a date range for overtimes.
state: State of the request. Valid values: "NEW", "APPROVED", "REJECTED", "DELETED", "ACCEPTED_BY_EMPLOYEE", "MODIFIED", "REJECTED_BY_EMPLOYEE".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__overtime__requests#get.

[Read employeeOvtRequests] action (alias: "Get employee's overtime requests")

Endpoint URL address: employees/{{=parameters.aid}}/overtime/requests.
The result is extracted from: {{=response.overtime_requests}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.
date_from: Required. Defines a lower bound of a date range for overtimes.
date_to: Required. Defines an upper bound of a date range for overtimes.
state: State of the request. Valid values: "NEW", "APPROVED", "REJECTED", "DELETED", "ACCEPTED_BY_EMPLOYEE", "MODIFIED", "REJECTED_BY_EMPLOYEE".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__overtime__requests#get.

[Read ovtRequest] action (alias: "Get overtime request")

Endpoint URL address: /overtime/requests/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Overtime request id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__overtime__requests__(id)#get.

[Create] action

Endpoint URL address: /overtime/requests.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__overtime__requests#post.

[Delete] action

Endpoint URL address: /overtime/requests/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__overtime__requests__(id)#delete.

The resource includes the fields from the OvertimeRequest template.

Fields

notes

The value is gathered from /overtime/requests/{{=item.id}}/notes address. The gathered value is processed with {{=response.notes}} expression. Field components:

An array.
Uses template: Note.

Pay Period

Based on resource template Base.

[Read] action

Endpoint URL address: /pay-periods.
The result is extracted from: {{=response.pay_periods}}.

The action has the following user-defined parameters:

ein_id: The ein id to get the pay periods if a company has multiple eins. All pay periods for all eins are returned if not specified. A list of company eins can be fetched using the ein lookup api.
date_from: Used for getting pay periods to date lower bounded. The date, six months prior to today's date is used as date_from if not specified.
date_to: Used for getting pay periods to date upper bounded. Today's date is used as date_to if not specified.
locked: Used for specifying the type of pay periods to be listed, "true" for all locked pay-periods, "false" for open. All open and locked pay periods are returned if the locked parameter is not specified.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__pay-periods#get.

The resource includes the fields from the PayPeriod template.

Payroll

Based on resource template Base.

[Read payrolls] action (alias: "Get company payrolls")

Endpoint URL address: /payrolls.
The result is extracted from: {{=response.payrolls}}.

The action has the following user-defined parameters:

pay_date: Used for getting payrolls with specified pay date. The value is the absolute pay date of the payroll. When no value is specified, a date range spanning the current date and one year in the past is used. The default value of this parameter is conditional on the value of the start_date and end_date parameters. If either is provided on the request, then no default value is used for pay_date and the field will not be used when fetching available payrolls.
start_date: Used for getting payrolls with a specific payroll pay period start date. The value is the absolute value of the start date of the payroll.
end_date: Used for getting payrolls with a specific payroll pay period end date. The value is the absolute value of the start date of the payroll.
status: Used for getting payrolls according to specified status(NEW, OPEN, CLOSED, SUBMITTED, FINALIZED, OPEN_FAILED, CLOSE_FAILED, ROLLBACK_FAILED, FINALIZE_FAILED).
type: Used for getting payrolls of specified type.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__payrolls#get.

[Read payroll] action (alias: "Get company payroll")

Endpoint URL address: /payrolls/{{=parameters.id}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

id: Required. Payroll id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__payrolls__(id)#get.

[Create] action

Endpoint URL address: /payrolls.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__payrolls#post.

[Delete] action

Endpoint URL address: /payrolls/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__payrolls__(id)#delete.

The resource includes the fields from the Payroll template.

Fields

batches

The value is gathered from /payrolls/{{=item.id}}/batches address. The gathered value is processed with {{=response.batches}} expression. Field components:

Contains the following components: .

pay_statements

The value is gathered from /payrolls/{{=item.id}}/pay-statements address. The gathered value is processed with {{=response.pay_statements}} expression. Field components:

An array.
Uses template: Payroll.

Job Requisition

Based on resource template Base.

[Read] action

Endpoint URL address: /recruitment/job-requisitions.
The result is extracted from: {{=response.job_requisitions}}.

The action has the following user-defined parameters:

job_locations: Query parameter for job locations to filter out records.
job_categories: Query parameter for job categories to filter out records.
keywords: Query parameter for keyword based filtering.
offset: Offset query parameter for pagination.
size: Lot size query parameter for pagination.
include_all: Query parameter to fetch all records.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__recruitment__job-requisitions#get.

The resource includes the fields from the JobRequisition template.

Time Entry

Based on resource template Base.

[Read timeEntries] action (alias: "Get time entries")

Endpoint URL address: /time-entries.
The result is extracted from: {{=response.time_entry_sets}}.

The action has the following user-defined parameters:

start_date: Required. Minimum date of time entry.
end_date: Required. Maximum date of time entry.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__time-entries#get.

[Read employeeTimeEntries] action (alias: "Get employee's time entries")

Endpoint URL address: employees/{{=parameters.aid}}/time-entries.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

aid: Required. Company should be referenced via company id or company short name using |short_name format.
start_date: Required. Minimum date of time entry.
end_date: Required. Maximum date of time entry.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__time-entries#get.

[Update] action

Endpoint URL address: /time-entries/collection.
The result is extracted from: {{=response.time_entry_sets}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__time-entries__collection#put.

[Delete] action

Endpoint URL address: /time-entries/{{=item.time_entries.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__time-entries__(time_entry_id)#delete.

The resource includes the fields from the TimeEntrySet template.

Time Punch

Based on resource template Base.

[Read] action

Endpoint URL address: /employees/{{=parameters.aid}}/punches/recent.
The result is extracted from: {{=response.punches}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.
num: Number of punches to return. Number of punches must be more than 0 and less or equal 64. Default: 10.
types: The comma separated list of calc punch types.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__punches__recent#get.

[Create] action

Endpoint URL address: /time-punches/collection.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__time-punches__collection#post.

The resource includes the fields from the TimePunch template.

Timesheet

Based on resource template Base.

[Read] action

Endpoint URL address: /employees/{{=parameters.aid}}/timesheets.
The result is extracted from: {{=response.timesheets}}.

The action has the following user-defined parameters:

aid: Required. Company should be referenced via company id or company short name using |short_name format.
date: Date to find by Account and Date.
current: Mark, to return current timesheet of employee.
previous: Mark, to return previous timesheet of employee.
next: Mark, to return next timesheet of employee.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)__timesheets#get.

[Update] action

Endpoint URL address: /timesheets/{{=item.id}}/action/{{=item.action_name}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

ignore_warnings: Required. If set to 'true', forces API to ignore all warnings produced by timesheet rules.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__timesheets__(id)__action__(action_name)#put.

The resource includes the fields from the Timesheet template.

Fields

comment: Template: LongText.

Lookup

Based on resource template Base.

[Read additionalCompensationTypes] action (alias: "Get Additional Compensation Types")

Endpoint URL address: /lookup/additional-compensation-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__additional-compensation-types#get.

[Read assets] action (alias: "Get Assets")

Endpoint URL address: /lookup/assets.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__assets#get.

[Read assetCategories] action (alias: "Get Asset Categories")

Endpoint URL address: /lookup/asset-categories.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__asset-categories#get.

[Read assetTypes] action (alias: "Get Asset Types")

Endpoint URL address: /lookup/asset-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__asset-types#get.

[Read benefitTypes] action (alias: "Get Benefit Types")

Endpoint URL address: /lookup/benefit/types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__benefit__types#get.

[Read benefitPlans] action (alias: "Get Benefit Plans")

Endpoint URL address: /lookup/benefit-plans.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__benefit-plans#get.

[Read deductionCodes] action (alias: "Get Deduction Codes")

Endpoint URL address: /lookup/deduction-codes.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__deduction-codes#get.

[Read documentTypes] action (alias: "Get Document Types")

Endpoint URL address: /lookup/document-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__document-types#get.

[Read degrees] action (alias: "Get Degrees")

Endpoint URL address: /lookup/degrees.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__degrees#get.

[Read earningCodes] action (alias: "Get Earning Codes")

Endpoint URL address: /lookup/earning-codes.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__earning-codes#get.

[Read educationLevels] action (alias: "Get Education Levels")

Endpoint URL address: /lookup/education-levels.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__education-levels#get.

[Read eins] action (alias: "Get EINs")

Endpoint URL address: /lookup/eins.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__eins#get.

[Read employeeTypes] action (alias: "Get Employee Types")

Endpoint URL address: /lookup/employee-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__employee-types#get.

[Read firstScreens] action (alias: "Get First Screens")

Endpoint URL address: /lookup/first-screens.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__first-screens#get.

[Read jobs] action (alias: "Get Jobs")

Endpoint URL address: /lookup/jobs.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__jobs#get.

[Read jobCategories] action (alias: "Get Job Categories")

Endpoint URL address: /lookup/job-categories.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__job-categories#get.

[Read jobChangeReasons] action (alias: "Get Job Change Reasons")

Endpoint URL address: /lookup/job-change-reasons.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__job-change-reasons#get.

[Read jobRequisitionCategories] action (alias: "Get Job Requisition Categories")

Endpoint URL address: /lookup/job-req/job-categories.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__job-req__job-categories#get.

[Read jobRequisitionLocations] action (alias: "Get Job Requisition Locations")

Endpoint URL address: /lookup/job-req/job-locations.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__job-req__job-locations#get.

[Read eyeColor] action (alias: "Get Eye Color")

Endpoint URL address: /lookup/eye-color.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__eye-color#get.

[Read loaReasons] action (alias: "Get LOA Reasons")

Endpoint URL address: /lookup/loa/reasons.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__loa__reasons#get.

[Read locales] action (alias: "Get Locales")

Endpoint URL address: /lookup/locales.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__locales#get.

[Read manualCounters] action (alias: "Get Manual Counters")

Endpoint URL address: /lookup/manual-counters.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__manual-counters#get.

[Read objectLists] action (alias: "Get Object Lists")

Endpoint URL address: /lookup/object-list/{{=parameters.type}}.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

type: Required. Type of the object list. Valid values: "COST_CENTER_0", "COST_CENTER_1", "COST_CENTER_2", "COST_CENTER_3", "COST_CENTER_4", "COST_CENTER_5", "COST_CENTER_6", "COST_CENTER_7", "COST_CENTER_8".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__object-lists__(type)#get.

[Read overtimeReasons] action (alias: "Get Overtime Reasons")

Endpoint URL address: /lookup/overtime/reasons.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__overtime__reasons#get.

[Read payCategories] action (alias: "Get Pay Categories")

Endpoint URL address: /lookup/pay-categories.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

date: Date of timesheet.
owner_id: Required. Timesheet owner id.
type: Required. Type of the record to assign pay category to. Valid values: "TIME", "EXTRA_PAY", "ADJUSTMENT".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__pay-categories#get.

[Read payCalculationProfiles] action (alias: "Get Pay Calculation Profiles")

Endpoint URL address: /lookup/pay-cal-profiles.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__pay-cal-profiles#get.

[Read payGrades] action (alias: "Get Pay Grades")

Endpoint URL address: /lookup/pay-grades.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__pay-grades#get.

[Read payPeriodProfiles] action (alias: "Get Pay Period Profiles")

Endpoint URL address: /lookup/pay-period-profiles.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

include_emp_profile: Can be used for including active employee pay period profile.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__pay-period-profiles#get.

[Read payStatementTypes] action (alias: "Get Pay Statement Types")

Endpoint URL address: /lookup/pay-statement-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__pay-statement-types#get.

[Read payTypes] action (alias: "Get Pay Types")

Endpoint URL address: /lookup/pay-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__pay-types#get.

[Read payrollBatchTypes] action (alias: "Get Payroll Batch Types")

Endpoint URL address: /lookup/payroll-batch-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__payroll-batch-types#get.

[Read payrollTypes] action (alias: "Get Payroll Types")

Endpoint URL address: /lookup/payroll-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__payroll-types#get.

[Read performanceReview] action (alias: "Get Performance Review")

Endpoint URL address: /lookup/profiles/performance-review.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__performance-review#get.

[Read paystatementPopulation] action (alias: "Get Paystatement Population")

Endpoint URL address: /lookup/profiles/paystatement-population.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__pst-population#get.

[Read companyAccess] action (alias: "Get Company Access")

Endpoint URL address: /lookup/profiles/system-access.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__system-access#get.

[Read training] action (alias: "Get Training")

Endpoint URL address: /lookup/profiles/training.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__training#get.

[Read workingTimeRegulation] action (alias: "Get Working Time Regulation")

Endpoint URL address: /lookup/profiles/working-time-regulation.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__working-time-regulation#get.

[Read payGrades] action (alias: "Get Pay Grades")

Endpoint URL address: /lookup/profiles/pay-grades.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__pay-grades#get.

[Read accruals] action (alias: "Get Accruals")

Endpoint URL address: /lookup/profiles/accruals.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__accruals#get.

[Read payPrepProfiles] action (alias: "Get Pay Prep Profiles")

Endpoint URL address: /lookup/profiles/pay-prep-profiles.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__profiles__pay-prep-profiles#get.

[Read premiumShifts] action (alias: "Get Premium Shifts")

Endpoint URL address: /lookup/shift-premiums.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__shift-premiums#get.

[Read reasonCodes] action (alias: "Get Reason Codes")

Endpoint URL address: /lookup/reason-codes.
The result is extracted from: {{=response.items}}.

The action has the following user-defined parameters:

date: Date of timesheet.
owner_id: Required. Timesheet owner id.
type: Required. Type of the record to assign reason code to. Valid values: "MANUAL_COUNTER".

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__reason-codes#get.

[Read referrals] action (alias: "Get Referrals")

Endpoint URL address: /lookup/referrals.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__referrals#get.

[Read skills] action (alias: "Get Skills")

Endpoint URL address: /lookup/skills.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__skills#get.

[Read taxCodes] action (alias: "Get Tax Codes")

Endpoint URL address: /lookup/tax-codes.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__tax-codes#get.

[Read terminationReason] action (alias: "Get Termination Reason")

Endpoint URL address: /lookup/termination-reason.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__termination-reason#get.

[Read timeZones] action (alias: "Get TimeZones")

Endpoint URL address: /lookup/timezones.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__timezones#get.

[Read unions] action (alias: "Get Unions")

Endpoint URL address: /lookup/unions.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__unions#get.

[Read vendors] action (alias: "Get Vendors")

Endpoint URL address: /lookup/vendors.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__vendors#get.

[Read workersCompCodes] action (alias: "Get Workers Comp Codes")

Endpoint URL address: /lookup/workers-comp-codes.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__workers-comp-codes#get.

[Read workerTypes] action (alias: "Get Worker Types")

Endpoint URL address: /lookup/worker-types.
The result is extracted from: {{=response.items}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__lookup__worker-types#get.

The resource includes the fields from the Lookup template.

Employee

Based on resource template Base.

[Read employees] action (alias: "Get employees")

Endpoint URL address: /employees.
The result is extracted from: {{=response.employees}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees#get.

[Read currentEmployee] action (alias: "Get current employee")

Endpoint URL address: /employees/me.
The result is extracted from: {{=[response]}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__me#get.

[Read employee] action (alias: "Get employee")

Endpoint URL address: /employees/{{=parameters.aid}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

aid: Required. Account should be referenced via account id or account external id using |external_id format.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)#get.

[Create] action

Endpoint URL address: /employees.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees#post.

[Update] action

Endpoint URL address: /employees/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)#put.

[Delete] action

Endpoint URL address: /employees/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__(aid)#delete.

The resource includes the fields from the Employee template.

Fields

custom_forms

The value is gathered from /employees/{{=item.id}}/forms/custom address. The gathered value is processed with {{=response.forms}} expression. Field components:

An array.
Contains the following components: id, name, description, is_applicant_form, items.

holidays

The value is gathered from /employees/{{=item.id}}/holidays address. The gathered value is processed with {{=response.holidays}} expression. Field components:

An array.
Contains the following components: date, name, is_day_off.

announcements

The value is gathered from /employees/{{=item.id}}/announcements address. The gathered value is processed with {{=response.announcements}} expression. Field components:

An array.
Contains the following components: id, account_id, headline, body, countdown, show_as_popup, show_marketplace_link, interval, created_by, created_at, _links, documents.

badges

The value is gathered from /employees/{{=item.id}}/badges address. The gathered value is processed with {{=response.badges}} expression. The value is sent to /employees/{{=item.id}}/badges address. Field components:

An array.
Contains the following components: badge_number, effective_from, effective_to, badge_type, pin, short_id.

managed_cost_centers

The value is gathered from /employees/{{=item.id}}/managed-cost-centers address. The gathered value is processed with {{=response.managed_cost_centers}} expression. The value is sent to /employees/{{=item.id}}/managed-cost-centers address. Field components:

An array.
Contains the following components: id, cost_center, cost_center_tree, permissions.

skills

The value is gathered from /employees/{{=item.id}}/skills address. The gathered value is processed with {{=response.employee_skills}} expression. The value is sent to /employees/{{=item.id}}/skills address. Field components:

An array.
Uses template: Skill.

demographics

Template: Demographics. The value is gathered from /employees/{{=item.id}}/demographics address.

Changed Employee

Based on resource template Base.

[Read] action

Endpoint URL address: /employees/changed.
The result is extracted from: {{=response.entries}}.

The action has the following user-defined parameters:

since: Used to set reference date to determine changes, the value cannot be more than 31 days in the past. Date should be expressed according to ISO 8601. Default value is today minus 5 days. Example: 2017-09-15T20:55:00Z

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__employees__changed#get.

Fields

id

Template: Integer.

status

Template: ShortText.

Documentation: Allowed values: "CREATED", "MODIFIED", "DELETED"..

object

Template: Employee.

Inventory Item

Based on resource template Base.

[Read] action

Endpoint URL address: /inventory-profiles/{parameters.inventory_profile_id}/inventory-items.
The result is extracted from: {{=response.employee_inventory_items}}.

The action has the following user-defined parameters:

inventory_profile_id: Required. Id to locate the inventory profile.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__inventory-profiles__(id)__inventory-items#get.

[Create] action

Endpoint URL address: /inventory-profiles/{item.inventory_profile_id}/inventory-items.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__inventory-profiles__(id)__inventory-items#post.

[Update] action

Endpoint URL address: /inventory-profiles/{item.inventory_profile_id}/inventory-items/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__inventory-profiles__(id)__inventory-items__(item_id)#put.

[Delete] action

Endpoint URL address: /inventory-profiles/{item.inventory_profile_id}/inventory-items/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__inventory-profiles__(id)__inventory-items__(item_id)#delete.

The resource includes the fields from the InventoryItem template.

Vehicle Assignment

Based on resource template Base.

[Read] action

Endpoint URL address: /vehicle/assignments.
The result is extracted from: {{=response.vehicle_assignments}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__assignments#get.

[Create] action

Endpoint URL address: /vehicle/assignments.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__assignments#post.

[Update] action

Endpoint URL address: /vehicle/assignments/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__assignments__(id)#put.

[Delete] action

Endpoint URL address: /vehicle/assignments/{{=item.id}}.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__assignments__(id)#delete.

The resource includes the fields from the VehicleAssignment template.

Fields

action

The value is sent to /vehicle/assignments/{{=item.id}}/action/{{=item.action.name}} address. Field components:

Uses template: ShortText.
Contains the following components: name, comments, date, status_change_to.

Vehicle Insurance

[Create] action

Endpoint URL address: /vehicle/insurances.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__insurances#post.

[Delete] action

Endpoint URL address: /vehicle/insurances/{{=item.insurance_id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__insurances__(id)#delete.

Fields

insurance_id

A key field. Template: Id.

effective_from

Template: Date.

Documentation: Date needs to be in the format yyyy-mm-dd within the 1900-12-31 and 2079-06-05 date range.

effective_to

Template: Date.

Documentation: Date needs to be in the format yyyy-mm-dd within the 1900-12-31 and 2079-06-05 date range.

insurance_carrier

Template: ShortText.

policy_num

Template: ShortText.

vehicle

Field components:

Uses template: Id.
Contains the following components: id, display_name.

Vehicle Maintenance

[Create] action

Endpoint URL address: /vehicle/maintenances.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__maintenances#post.

[Delete] action

Endpoint URL address: /vehicle/maintenances/{{=item.maintenances_id.

Documentation: https://secure.saashr.com/ta/docs/rest/public/?r=__v2__companies__(cid)__vehicle__maintenances__(id)#delete.

Fields

maintenances_id

A key field. Template: Id.

odometer_reading

Template: Integer.

performed_on

Template: Date.

Documentation: Date needs to be in the format yyyy-mm-dd within the 1900-12-31 and 2079-06-05 date range.

performed_at

Template: ShortText.

type

Template: ShortText.

vehicle

Field components:

Uses template: Id.
Contains the following components: id, display_name.

Referenced Resource Definitions

Base

[Read] action

The following request parameters will be automatically processed:

_includeUserParameters: {{=parameters}}

[Create] action

The action uses POST method.

The following request parameters will be automatically processed:

application/json: {{=item}}

[Update] action

The action uses PUT method.

The following request parameters will be automatically processed:

application/json: {{=item}}

[Delete] action: The action uses DELETE method.

Referenced Fields Definitions

ShortText

Data type: DT_WSTR ( length 255 )

LongText

Data type: DT_WSTR ( length 1024 )

JSONObject

Data type: DT_NTEXT

Integer

Data type: DT_I4

Bool

Data type: DT_BOOL

Date

Data type: DT_DBDATE

DateTime

Data type: DT_DBTIMESTAMP

Number

Data type: DT_R8

Id

Data type: DT_UI8

Applicant

Field components:

Uses template: ApplicantAccount.
Contains the following components: account, address, phones, demographics, photo_href, required_salary, required_salary_per, eligible_for_work, will_relocate, relocation_cost, willing_to_travel, reliable_transportation, managed_people, available_start_date, summary, education, skills, other_skills, traits, work_experiences, professional_references, job_categories, applicant_custom_fields, _links.

ApplicantAccount

Field components:

Uses template: Id.
Contains the following components: account_id, username, salutation, first_name, last_name, nickname, middle_name, name_suffix, primary_email, secondary_email, force_change_password, locked, ssn, bsn, sin, nin, security_question, locale, time_zone.

Address

Field components:

Uses template: ShortText.
Contains the following components: address_line_1, address_line_2, address_line_3, country, city, state, zip, number, number_addition.

Phones

Field components:

Uses template: ShortText.
Contains the following components: work_phone, home_phone, cell_phone, preferred_phone.

Demographics

Field components:

Uses template: ShortText.
Contains the following components: gender, height, weight, eye_color, ethnicity, citizenship, smoker, primary_language, secondary_language, visa, full_time_student, veteran, demographics_custom_fields.

Education

Field components:

Contains the following components: highest_education, schools.

Skill

Field components:

Uses template: ShortText.
Contains the following components: account_id, skill, level, years, primary.

WorkExperience

Field components:

Uses template: Integer.
Contains the following components: index, company, supervisor, payment, reason_for_leaving, job_titles.

ProfessionalReference

Field components:

Uses template: ShortText.
Contains the following components: company, contact.

JobCategory

Field components:

Uses template: Integer.
Contains the following components: job, years.

LinkSelf

Field components:

Uses template: LongText.
Contains the following components: self.

School

Field components:

Uses template: ShortText.
Contains the following components: country, school_name, school_type, school_type_other, education_status, major, minor, start_date, end_date, gpa, max_gpa, degree_level, credit_hours, extracurricular_activities.

AccountIdName

Field components:

Uses template: Id.
Contains the following components: account_id, display_name.

AccountId

Field components:

Uses template: Id.
Contains the following components: account_id.

Period

Template: ShortText.

Documentation: Allowed values: "YEAR", "MONTH", "WEEK", "HOUR", "PAY_PERIOD"..

Attendance

Field components:

Uses template: AccountIdName.
Contains the following components: employee, status, last_start, last_end, cost_centers.

BenefitPlan

Field components:

Uses template: Id.
Contains the following components: id, employee, benefit_plan, coverage_effective_from, coverage_effective_to, coverage_level, custom_fields, earnings_deductions, coverage, dependents.

Calendar

Field components:

Uses template: Date.
Contains the following components: date, employee.

AdditionalCompensation

Field components:

Uses template: Id.
Contains the following components: id, type, account, currency, effective_from, change_date, period, active, value, _links.

CompensationHistory

Field components:

Uses template: Id.
Contains the following components: id, employee, effective_from, amount, hourly_pay, amount_period, time, time_period, num_pp_in_year, auto_pay, _links.

Note

Field components:

Uses template: Id.
Contains the following components: id, case_id, request_id, text, created_at, created_by, _links.

TotalCompensation

Field components:

Uses template: Number.
Contains the following components: account, amount, effective_from, currency.

AccountGroup

Field components:

Uses template: Id.
Contains the following components: id, name, description, members, managers, _links.

Manager

Field components:

Uses template: AccountId.
Contains the following components: employee, active_from, active_to, permissions.

IndexEdit

Field components:

Uses template: Integer.
Contains the following components: index, edit.

ViewEdit

Field components:

Uses template: Bool.
Contains the following components: view, edit.

IndexValue

Field components:

Uses template: Integer.
Contains the following components: index, value.

CostCenter

Field components:

Uses template: ShortText.
Contains the following components: external_id, abbreviation, name, payroll_code, description, time_allocation, manning, gl_codes, visible, custom_fields, location_factor, contacts, contact_address, use_employee_home_address, state_assigned_tax_code, is_operating_and_reportable, delivery_point_barcode, primary_comment_code, secondary_comment_code, reasons_for_change, cost_center_skills, job_settings, id, parent_id, parent_cc, level, workers_comp_code, job_strain.

CostCenterSkillId

Field components:

Contains the following components: main_skill, alternative_skills.

CostCenterSkillFull

Field components:

Contains the following components: main_skill, alternative_skills.

JobStrain

Field components:

Uses template: ShortText.
Contains the following components: reference_type, id, name.

CostCenterList

Field components:

Uses template: Id.
Contains the following components: id, name, tree_index, cost_centers.

CostCenterJob

Field components:

Uses template: Id.
Contains the following components: id, job_category, name, abbreviation, description, job_description, external_id, payroll_code, visible, applicant_tracking_display, applicant_tracking_display_only, standard_work_day, employee_type, eeo_classification, union, pay_grade, pay_type, first_screen, worker_type, linked_company_eins, worker_comp_code_types, salary_surveys, competency_groups, defaults, cost_center_skills, job_strain.

IdEmployeeOverride

Field components:

Uses template: Id.
Contains the following components: id, employee_override.

EmployeeOverrideProfilesFull

Field components:

Uses template: Bool.
Contains the following components: employee_override, profiles.

EmployeeOverrideProfilesId

Field components:

Uses template: Bool.
Contains the following components: employee_override, profiles.

Contact

Field components:

Uses template: Id.
Contains the following components: id, employee, primary, emergency, dependent, beneficiary, salutation, first_name, middle_name, last_name, name_suffix, relationship, work_phone, home_phone, cell_phone, email, ssn, bsn, sin, nin, birthdate, gender, height, weight, ethnicity, smoker, actual_marital_status, full_time_student, disability, always_eligible_for_benefit_plans, is_in_any_benefit_plan, use_employee_address, address, _links.

NumberPrimary

Field components:

Uses template: ShortText.
Contains the following components: number, primary.

DirectDeposit

Field components:

Uses template: Id.
Contains the following components: id, name, description, sequence, type, employee, active_from, active_to, active, amount, percentage, calc_method, account_type, account_number, routing_number, pre_note_status, cancel_pre_note, pre_note_sent_date, pre_note_expiration_date, arrearage_function, payroll_frequency, last_payroll, month_to_date, quarter_to_date, year_to_date, used_in_pay_statement, _documents_count, _links.

Document

Field components:

Uses template: Id.
Contains the following components: id, type, file_name, file_size, display_name, file_date, document_type, description, linked_id, attributes, account_type, created_by, created_at, _links.

LeaveOfAbsenceCase

Field components:

Uses template: Id.
Contains the following components: id, employee, reason, start_date, est_end_date, end_date, categories, ignore_look_back_rules, status, sub_status, custom_fields, case_number, leave_time, resolution, _links.

EmployeeAccount

Field components:

Uses template: Id.
Contains the following components: account_id, username, external_id.

LeaveTime

Field components:

Uses template: ShortText.
Contains the following components: type, frequency_interval_type, total_time_type, schedule_type, total_time, frequency, frequency_interval, weeks_in_cycle, use_separate_settings, weekdays.

LeaveOfAbsenceRequest

Template: RequestBase. Field components:

Uses template: ShortText.
Contains the following components: state, start_date, est_end_date, status, leave_time, custom_fields, comment.

RequestBase

Field components:

Uses template: Id.
Contains the following components: id, employee, reason, approved_by, approved_at, rejected_by, rejected_at, created_by, created_at, notes_count, _links.

MailboxItem

Field components:

Uses template: Id.
Contains the following components: id, account_id, recipient, from, subject, body, unread, created_at, documents, _links.

DocumentBase

Field components:

Uses template: Id.
Contains the following components: id, display_name, file_size, created_by, created_at, _links.

OvertimeRequest

Template: RequestBase. Field components:

Uses template: ShortText.
Contains the following components: type, date_from, date_to, time_from, time_to, duration, state.

PayPeriod

Field components:

Uses template: EIN.
Contains the following components: pay_period_profile, ein, total_employees, locked_employees, available_employees, start_date, end_date, pay_date, submit_date, process_date, locked.

EIN

Field components:

Uses template: Id.
Contains the following components: id, ein_name, ein_tax_id.

Payroll

Field components:

Uses template: Id.
Contains the following components: id, name, start_date, end_date, pay_date, type, status, ein, billable.

PayrollPayStatement

Field components:

Uses template: AccountIdName.
Contains the following components: employee, id, pay_date, status, type, pay_period_start, pay_period_end, _links.

JobRequisition

Field components:

Uses template: Id.
Contains the following components: id, job_categories, job_title, location.

TimeEntrySet

Field components:

Uses template: AccountId.
Contains the following components: employee, start_date, end_date, time_entries.

TimeEntry

Field components:

Uses template: Id.
Contains the following components: id, type, date, start_time, end_time, total, time_off, pay_category, premium_shift, is_raw, is_calc, calc_start_time, calc_end_time, calc_total, calc_pay_category, calc_premium_shift, cost_centers, custom_fields, piecework, amount, from, to.

TimePunch

Field components:

Uses template: AccountId.
Contains the following components: employee, ip, timestamp, raw_type, type, cost_centers.

Lookup

Field components:

Uses template: Id.
Contains the following components: id, order, number, num_items, type, label, name, abbrev, display_name, date_format, language, ein_tax_id, ein_name, base_type, category, plan_type, java_name, joda_time_zone, offset, effective_from, effective_to, code, external_id, payroll_code, degree, company_provided, active, added_to_hourly_and_pp_pay_total, added_to_annual_total, visible, schedulable, rehireable, dst, is_user_profile, description, effective_from, effective_to, period_type.

Employee

Field components:

Uses template: Id.
Contains the following components: id, primary_account_id, username, first_name, last_name, photo_href, middle_name, external_id, employee_id, status, bsn, address, use_separate_mailing_address, mailing_address, ein, force_change_password, locked, first_screen, phones, locale, managers, national_insurance, nickname, primary_email, secondary_email, salutation, social_insurance, social_security, suffix, timezone, cost_centers_info, add_to_new_hire_export, dates, account_extra_fields, time_entry_extra_fields, _links, hardware_settings, managed_cost_centers_enabled, managed_cost_centers_settings.

Timesheet

Field components:

Uses template: Id.
Contains the following components: id, action_name, employee, start_date, end_date, state, editable.

InventoryItem

Field components:

Uses template: Id.
Contains the following components: id, inventory_profile_id, employee, _notes_count, _attachments_count, profile, _links, user_field1, user_field2, user_field3, user_field4, user_field5, user_field6, user_field7, user_field8, user_field9, user_field10, user_field11, user_field12, user_field13, user_field14, user_field15, user_field16, user_field17, user_field18, user_field19, user_field20, user_field21, user_field22, user_field23, user_field24, user_field25.

VehicleAssignment

Field components:

Uses template: Id.
Contains the following components: id, _links, employee, vehicle, is_personal, actual_return_date, issued_odometer_reading, issue_date, issue_value, lost_destroyed_on_date, returned_odometer_reading, return_condition, return_value, scheduled_return_date.

Vehicle

Field components:

Uses template: Id.
Contains the following components: id, code, color, description, inspection_expiration, lic_plate_num, lic_state, make, manufacture_year, model, registration_expiration, vin.

Scripts

Main

Knowledge Base

What's New

2.1 SR-1

New: Defined hr_customFields and pay_info fields under Employee resource.

2.1

New: Support for global reports.

1.9 SR-2

Fixed: Defined identifier field type was not large enough.

1.9 SR-1

Fixed: Failed to retrieve "Saved Reports" resource from US-hosted service (Thank you, Hardik).

1.9

New: Introduced connection.

SSIS+ Components Suite

SSIS NoW

Excel Add-in for SAS

Overview

Quick Start

Configuration

Knowledge Base

What's New

Newsletter

Contact Us

Follow Us

Support

SSIS+ Components Suite

SSIS NoW

Excel Add-in for SAS

KRONOS Connection

Overview

Quick Start

Configuration

Knowledge Base

What's New

Related documentation