Guides
Signup For Free

UKG Ready API Integration Vol.1

Suggest Edits

These are the list of integration use cases supported by Knit for UKG Ready API as part of the HRIS category

Delete Access Policy Profile

  • ID: delete_access_policy_profile
  • Operation: write
  • Entities: access policy profile, user, company
  • Summary: The Delete Access Policy Profile API allows a user to delete an existing access policy profile by its ID. The user must have the necessary permissions to delete access policies. The API requires two path parameters: 'cid' (the company identifier) and 'aid' (the access policy profile ID). Upon successful deletion, a 204 No Content response is returned. If the deletion cannot be performed, a 400 Bad Request response is returned with the reason in the response body. Other possible responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable, with the latter including an 'X-CallLimit-TimeToWait' header indicating when the service will be available again.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Account Group

  • ID: delete_account_group
  • Operation: write
  • Entities: security, account group, company
  • Summary: The Delete Account Group API allows for the deletion of an existing regular account group by its ID. It requires two path parameters: 'cid', which is the company identifier, and 'gid', which is the account group ID. The API returns a 204 No Content response if the account group is successfully deleted. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. In the event that the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Additional Compensation

  • ID: delete_additional_compensation
  • Operation: write
  • Entities: employee, compensation, company
  • Summary: The Delete Additional Compensation API is used to delete an employee's additional compensation record. It requires two path parameters: 'cid', which is the company identifier, and 'acid', which is the additional compensation record id. The API returns a 204 No Content response if the deletion is successful. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user does not have access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header indicates the time to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Applicant

  • ID: delete_applicant
  • Operation: write
  • Entities: account, applicant, company
  • Summary: The Delete Applicant API allows for the deletion of an existing applicant by their account ID. It requires the company ID (cid) and the account ID (account_id) as path parameters. The API returns a 204 No Content response if the applicant is successfully deleted. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user does not have access to the resource. If the resource does not exist, a 404 Not Found response is returned. In the event that the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Asset Assignment

  • ID: delete_asset_assignment
  • Operation: write
  • Entities: asset, assignment, company
  • Summary: The Delete Asset Assignment API endpoint allows for the deletion of a specific asset assignment by its ID. It requires the company ID (cid) and the asset assignment ID (id) as path parameters. The API returns a 204 No Content response if the deletion is successful. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Case

  • ID: delete_case
  • Operation: write
  • Entities: leave of absence, case, company
  • Summary: The Delete Case API endpoint is used to delete a leave of absence case for a specified company. The API requires the leave of absence functionality to be enabled for the company. It takes two path parameters: 'cid', which is the company identifier, and 'id', which is the case identifier. The API returns a 204 No Content response if the case is successfully deleted. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user does not have access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Collection

  • ID: delete_collection
  • Operation: write
  • Entities: shift, schedule, company
  • Summary: The Delete Collection API is used to perform a bulk operation to delete multiple shifts. It requires the Advanced Scheduler (SCHEDULE) Subsystem to be enabled in the company setup. The API endpoint requires two path parameters: 'cid', which is the company identifier, and 'schedule_id', which is the schedule identifier. The API returns a 204 No Content response if all shifts were successfully deleted, a 404 Not Found response if some required resources were not found, and a 500 Internal Server Error response if an internal error occurred during processing.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Contact

  • ID: delete_contact
  • Operation: write
  • Entities: employee, contact
  • Summary: The Delete Contact API endpoint allows for the deletion of an employee contact from a specified company. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the employee contact id. Upon successful deletion, a 204 No Content response is returned. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header indicates the duration to wait before making further calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Contracts

  • ID: delete_contracts
  • Operation: write
  • Entities: employee, contract, company
  • Summary: The Delete Contracts API allows for the deletion of multiple employee contracts by their IDs. It requires the company ID as a path parameter and the contract IDs as a query parameter. Upon successful deletion, it returns a 200 OK response with a message indicating success. If the contracts cannot be found, a 400 Bad Request response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Cost Center Job

  • ID: delete_cost_center_job
  • Operation: write
  • Entities: subsystem, cost center job, company
  • Summary: The 'Delete Cost Center Job' API endpoint allows users to delete a specific Cost Center Job within a company. The user must have the necessary permissions to perform this action. The API requires the company ID ('cid') and the cost center job ID ('id') as path parameters. The response will be a 204 No Content status if the deletion is successful. If the user is unauthorized, a 401 Unauthorized status is returned. A 403 Forbidden status is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found status is returned. If the call limit is exceeded, a 503 Service Unavailable status is returned, and the 'X-CallLimit-TimeToWait' header will specify the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Counter Adjustment

  • ID: delete_counter_adjustment
  • Operation: write
  • Entities: employee, counter adjustment, company
  • Summary: The Delete Counter Adjustment API is used to delete a specific counter adjustment identified by its ID. It requires three path parameters: 'cid' for the company ID, 'aid' for the account ID, and 'counter_adjustment_id' for the counter adjustment ID. The API returns various responses based on the outcome, including 200 OK if the deletion is successful, 400 Bad Request for validation errors, 403 Forbidden for security issues, 404 Not Found if the counter adjustment ID does not exist, 500 Internal Server Error for server issues, 204 No Content for successful deletion with no content, 401 Unauthorized if the user is not authorized, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Counter Adjustment Notes

  • ID: delete_counter_adjustment_notes
  • Operation: write
  • Entities: note, counter adjustment, company
  • Summary: The Delete Counter Adjustment Notes API allows users to delete specific counter adjustment notes for a company. The API requires the company ID as a path parameter and the note IDs to be deleted as a query parameter. The response will indicate the processing result for each note ID. A successful deletion will return a status of 'OK' for each note. If the user does not have access to the resource, a 403 Forbidden response will be returned. If the call limit is exceeded, a 503 Service Unavailable response will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Direct Deposit

  • ID: delete_direct_deposit
  • Operation: write
  • Entities: employee, direct deposit account, company
  • Summary: This API endpoint deletes an existing employee's direct deposit account. It is accessed via a DELETE request to the specified URL with path parameters 'cid' and 'id'. The 'cid' parameter is the company identifier, and the 'id' parameter is the identifier of the employee's direct deposit. The API returns a 204 No Content response if the deletion is successful. Other possible responses include 403 Forbidden if the account cannot be deleted, 404 Not Found if the account does not exist, 401 Unauthorized if the user is not authorized, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Disable Popup

  • ID: delete_disable_popup
  • Operation: write
  • Entities: employee, announcement, company
  • Summary: The 'Delete Disable Popup' API endpoint allows disabling an announcement popup on login for a specific employee within a company. It requires the company ID (cid), account ID (aid), and announcement ID (id) as path parameters. The API returns a 204 No Content response if the popup is successfully disabled. Possible error responses include 401 Unauthorized if the user is not authorized, 403 Forbidden if the user lacks access, 404 Not Found if the resource does not exist, and 503 Service Unavailable if the call limit is exceeded, with a header indicating the time to wait before retrying.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Document

  • ID: delete_document
  • Operation: write
  • Entities: document, company
  • Summary: The Delete Document API endpoint allows for the deletion of metadata for a specified document. This functionality is available for companies with the 'Integrated Document Storage' marketplace product. The API requires two path parameters: 'cid', which is the company identifier, and 'id', which is the ID of the uploaded document. The API returns various responses, including a 204 No Content response if the deletion is successful, and error responses such as 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable. The 503 response includes an 'X-CallLimit-TimeToWait' header indicating the time to wait before making subsequent calls if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee

  • ID: delete_employee
  • Operation: write
  • Entities: manager, employee, company
  • Summary: The Delete Employee API endpoint allows managers to delete an employee's account. The deletion is restricted based on the employee's pay statement status and security permissions. The API requires the company ID (cid) and account ID (aid) as path parameters. Successful deletion returns a 204 No Content response. Errors such as validation issues, security restrictions, or resource non-existence result in appropriate error responses like 400 Bad Request, 403 Forbidden, 404 Not Found, etc.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete External Paystatements

  • ID: delete_external_paystatements
  • Operation: write
  • Entities: pay statement, company
  • Summary: This API allows users to delete external pay statements data for a company. It is available for companies with the 'Import External Pay History' functionality enabled. The request requires two path parameters: 'cid', which is the company identifier, and 'pst_id', which is the ID of the external pay statement to be deleted. The API returns a 204 No Content response if the deletion is successful. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user has no access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete History

  • ID: delete_history
  • Operation: write
  • Entities: employee, compensation, company
  • Summary: The Delete History API is used to delete a specific Employee Base Compensation record. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the Employee Base Compensation id. The API returns a 204 No Content response if the deletion is successful. If the user is unauthorized, a 401 Unauthorized response is returned. If the user lacks access, a 403 Forbidden response is returned. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Inventory Item

  • ID: delete_inventory_item
  • Operation: write
  • Entities: inventory profile, inventory item, company
  • Summary: The Delete Inventory Item API endpoint allows for the deletion of a specific employee inventory item by its ID. It requires the company ID (cid), inventory profile ID (id), and inventory item ID (item_id) as path parameters. The API returns a 204 No Content response if the deletion is successful. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. In the event that the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Job Application

  • ID: delete_job_application
  • Operation: write
  • Entities: job application, company
  • Summary: The Delete Job Application API endpoint allows for the deletion of a specific job application identified by the job_app_id. It requires the company ID (cid) and job application ID (job_app_id) as path parameters. Upon successful deletion, it returns a 204 No Content response. If the user is unauthorized, lacks access, or the resource does not exist, it returns 401, 403, or 404 errors respectively. If the call limit is exceeded, a 503 error is returned, and the X-CallLimit-TimeToWait header specifies the wait time before subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete List

  • ID: delete_list
  • Operation: write
  • Entities: cost center, list, company
  • Summary: The 'Delete List' API endpoint allows for the deletion of a cost center list. It requires two path parameters: 'cid', which is the company identifier, and 'list_id', which is the cost center list identifier. Upon successful deletion, a 204 No Content response is returned. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. In the event that the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header indicates the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Lock

  • ID: delete_lock
  • Operation: write
  • Entities: account, lock, company
  • Summary: The Delete Lock API endpoint allows the deletion of an account's lock. It provides the ability to reset a user's password and TOTP Authenticator during the unlock process. The API requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The request body can include options to change the password and reset the authenticator on the next logon. The API returns a 204 No Content response if the account is successfully unlocked, a 403 Forbidden response if the user lacks access, a 404 Not Found response if the resource does not exist, and a 503 Service Unavailable response if the call limit is exceeded, with the duration specified by the X-CallLimit-TimeToWait header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Lock on Pay Period

  • ID: delete_lock_on_pay_period
  • Operation: write
  • Entities: lock, pay period, company
  • Summary: The Delete Lock on Pay Period API allows the caller to delete the lock on a specified pay period for a company. The API requires the company identifier (cid) and the pay period identifier (pay_period_id) as path parameters. Upon successful deletion of the lock, a 200 OK response is returned. If there are validation errors, a 400 Bad Request is returned. Security errors result in a 403 Forbidden response, and if the service is unavailable, a 503 Service Unavailable response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Mailbox Item

  • ID: delete_mailbox_item
  • Operation: write
  • Entities: mailbox item, company
  • Summary: The Delete Mailbox Item API endpoint allows for the deletion of a single mailbox item identified by its id within a specified company identified by cid. The API requires two path parameters: 'cid' which is the company identifier, and 'id' which is the mailbox item identifier. Upon successful deletion, the API returns a 204 No Content response. If the user is unauthorized, a 401 Unauthorized response is returned. If the user lacks access to the resource, a 403 Forbidden response is returned. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Manager

  • ID: delete_manager
  • Operation: write
  • Entities: manager, account group, company
  • Summary: The Delete Manager API allows for the deletion of an existing regular account group manager by its ID. It requires the company ID (cid), account group ID (gid), and group manager account ID (mid) as path parameters. The API returns a 204 No Content response if the deletion is successful. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user has no access to the resource. If the resource does not exist, a 404 Not Found response is returned. In the event that the call limit is exceeded, a 503 Service Unavailable response is returned, and the application will be unavailable for subsequent calls for the duration specified by the X-CallLimit-TimeToWait header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Member

  • ID: delete_member
  • Operation: write
  • Entities: account group, member, company
  • Summary: The Delete Member API allows for the deletion of an existing regular account group member by its ID. It requires the company ID (cid), account group ID (gid), and group member account ID (mid) as path parameters. The API returns a 204 No Content response if the deletion is successful. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user has no access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the application will be unavailable for subsequent calls for the duration specified by the X-CallLimit-TimeToWait header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Note

  • ID: delete_note
  • Operation: write
  • Entities: note, company
  • Summary: The Delete Note API allows users to delete a note by its ID. It requires the company ID (cid) and note ID (noteID) as path parameters, and a token as a query parameter to resolve user permissions. The API returns a 204 No Content response if the note is successfully deleted. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user has no access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Overtime Request

  • ID: delete_overtime_request
  • Operation: write
  • Entities: overtime request, user, company
  • Summary: This API endpoint is used to delete an overtime request for a company. The user must have 'Delete' permission for 'Overtime Requests'. If the user is deleting their own request, they must be the creator and the request should be in 'NEW' or 'DELETED' state. The API requires the 'TLM' subsystem. The path parameters include 'cid' which is the company identifier and 'id' which is the overtime request id. The possible responses include 204 No Content for successful deletion, 401 Unauthorized if the user is not authorized, 403 Forbidden if the user has no access, 404 Not Found if the resource does not exist, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Pay Statement

  • ID: delete_pay_statement
  • Operation: write
  • Entities: payroll, pay statement, company
  • Summary: The Delete Pay Statement API allows the user to delete a specific pay statement for a given company and payroll. The API requires the company ID (cid), payroll ID, and pay statement ID as path parameters. Upon successful deletion, a 204 No Content response is returned. If the user is unauthorized, a 401 Unauthorized response is returned. If the user lacks access to the resource, a 403 Forbidden response is returned. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Payroll

  • ID: delete_payroll
  • Operation: write
  • Entities: payroll, company
  • Summary: The Delete Payroll API allows for the deletion of a specific payroll record identified by its payroll id within a company identified by its company id. The API requires two path parameters: 'cid' for the company identifier and 'id' for the payroll identifier. Upon successful deletion, a 200 OK response is returned. If no content is available, a 204 No Content response is returned. Errors such as 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable may also be encountered, with the latter indicating that the call limit has been exceeded, as specified by the X-CallLimit-TimeToWait header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete PTO Request

  • ID: delete_pto_request
  • Operation: write
  • Entities: pto request, employee, company
  • Summary: The Delete PTO Request API endpoint is used to delete time off requests for a specific company. The company is identified using a path parameter 'cid', which can be the company id, unique id, or short name. The API requires the TA|TALITE|HR|SCHEDULE functionality to be enabled in the company setup. Upon successful deletion, the API returns a response indicating success, along with details of the deleted request. If the PTO request is not found, a 404 Not Found response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Rate Schedule

  • ID: delete_rate_schedule
  • Operation: write
  • Entities: rate schedule, rate table, company
  • Summary: The Delete Rate Schedule API endpoint allows users to delete a rate schedule by its ID. It requires the company ID (cid), rate table ID (tid), and rate schedule ID (sid) as path parameters. The API responds with a 204 No Content status if the deletion is successful. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the specified resource does not exist, a 404 Not Found response is returned. In case the call limit is exceeded, a 503 Service Unavailable response is returned, along with an X-CallLimit-TimeToWait header indicating the time to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Rate Table

  • ID: delete_rate_table
  • Operation: write
  • Entities: resource, rate table, company
  • Summary: The Delete Rate Table API endpoint allows for the deletion of a rate table by its ID. It requires two path parameters: 'cid', which is the company identifier, and 'tid', which is the rate table ID. The API returns a 204 No Content response if the rate table is successfully deleted. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user does not have access to the resource. If the resource does not exist, a 404 Not Found response is returned. In the event that the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Request

  • ID: delete_request
  • Operation: write
  • Entities: leave request, company
  • Summary: The Delete Request API allows for the deletion of a specific leave request identified by the request id. It requires the company id (cid) and the request id as path parameters. Upon successful deletion, it returns a 204 No Content response. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Schedule

  • ID: delete_schedule
  • Operation: write
  • Entities: schedule, company
  • Summary: The Delete Schedule API allows the deletion of a schedule identified by the schedule_id for a specific company identified by cid. The Advanced Scheduler (SCHEDULE) Subsystem must be enabled in the company setup. The API requires the path parameters 'cid' and 'schedule_id' to be provided. Upon successful deletion, a 204 No Content response is returned. If the user is unauthorized, a 401 Unauthorized response is returned. If the user lacks access to the resource, a 403 Forbidden response is returned. If the resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the X-CallLimit-TimeToWait header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Scheduled Deduction Mass Add, Edit, Or Delete

  • ID: delete_scheduled_deduction_mass_add_edit_or_delete
  • Operation: write
  • Entities: scheduled deduction, company
  • Summary: This API endpoint allows for the deletion of one or more scheduled deductions for a specified company. The request requires the company ID as a path parameter and a list of deduction IDs in the request body. The response will indicate success with a 201 status code if the deductions are successfully deleted. Errors such as bad requests, unauthorized access, or insufficient rights will return 400, 401, and 403 status codes respectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Scheduled Deductions

  • ID: delete_scheduled_deductions
  • Operation: write
  • Entities: scheduled deduction, company
  • Summary: The 'Delete Scheduled Deductions' API allows the user to delete a scheduled deduction from a specified company. The request requires a path parameter 'cid', which is the company identifier. The API responds with a 200 OK status and a message 'Item Removed' if the deletion is successful. If there is an error in the request, a 400 Bad Request status is returned. If authentication is required, a 401 Unauthorized status is returned. If the user has insufficient rights, a 403 Forbidden status is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Scheduled Earning Mass Add, Edit, Or Delete

  • ID: delete_scheduled_earning_mass_add_edit_or_delete
  • Operation: write
  • Entities: scheduled earning, company
  • Summary: This API endpoint allows the deletion of one or more scheduled earnings for a specified company. The request requires the company ID as a path parameter and a list of scheduled earning IDs in the request body. The response indicates whether the deletion was successful or if there were errors such as bad request, unauthorized access, or insufficient rights.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Scheduled Earnings

  • ID: delete_scheduled_earnings
  • Operation: write
  • Entities: scheduled earning, company
  • Summary: The Delete Scheduled Earnings API allows the user to delete a selected scheduled earning from a company. The request requires a path parameter 'cid', which is the company identifier. The response can be a 200 OK indicating the item was removed, a 401 Unauthorized if authentication is required, a 400 Bad Request if there is an error in the request, or a 403 Forbidden if the user has insufficient rights to perform the action.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Schedules

  • ID: delete_schedules
  • Operation: write
  • Entities: schedule, employee, company
  • Summary: The Delete Schedules API allows for the deletion of employee schedules within a specified date range for a given company. The company is identified by the 'cid' path parameter, which is required and can be a company id, unique id, or short name. The API returns a list of deleted schedule entries with their status. A successful response (200 OK) contains the list of deleted schedules, while error responses include 400 Bad Request for invalid data, 403 Forbidden for access issues, 500 Internal Server Error for server issues, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Service Account

  • ID: delete_service_account
  • Operation: write
  • Entities: service account, company
  • Summary: The Delete Service Account API endpoint allows for the deletion of a service account associated with a specific company. The request requires two path parameters: 'cid', which is the company identifier, and 'id', which is the service account identifier. Upon successful deletion, a 204 No Content response is returned. Possible error responses include 400 Bad Request for validation errors, 404 Not Found if the account does not exist, 500 Internal Server Error for server issues, 401 Unauthorized if the user is not authorized, 403 Forbidden if the user lacks access, and 503 Service Unavailable if the call limit is exceeded, with the wait time specified in the X-CallLimit-TimeToWait header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Shift

  • ID: delete_shift
  • Operation: write
  • Entities: shift, schedule, company
  • Summary: The Delete Shift API allows for the deletion of a specific shift within a company's schedule. The Advanced Scheduler (SCHEDULE) Subsystem must be enabled in the company setup. The API requires three path parameters: 'cid' (the company identifier), 'schedule_id' (the schedule identifier), and 'shift_id' (the shift identifier). Upon successful deletion, a 204 No Content response is returned. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the specified resource does not exist, a 404 Not Found response is returned. If the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Snapshot

  • ID: delete_snapshot
  • Operation: write
  • Entities: snapshot, pay period, company
  • Summary: The Delete Snapshot API allows the caller to delete an existing snapshot by specifying the company ID, pay period ID, and snapshot ID in the path parameters. The API returns a success status if the snapshot is deleted successfully. Possible responses include 200 Ok for success, 400 Bad Request for validation errors, 403 Forbidden for security errors, and 503 Service Unavailable if the service is unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete System Account

  • ID: delete_system_account
  • Operation: write
  • Entities: system account, company
  • Summary: The Delete System Account API endpoint allows for the deletion of a system account identified by the account ID (aid) within a specified company identified by the company ID (cid). The API requires both 'cid' and 'aid' as path parameters. Upon successful deletion, a 204 No Content response is returned. If there are validation errors, a 400 Bad Request is returned. Security issues result in a 403 Forbidden response, while unauthorized access results in a 401 Unauthorized response. If the resource does not exist, a 404 Not Found is returned. In case of server errors, a 500 Internal Server Error is returned. If the call limit is exceeded, a 503 Service Unavailable is returned, and the X-CallLimit-TimeToWait header specifies the wait time before subsequent calls can be made.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Time Entries

  • ID: delete_time_entries
  • Operation: write
  • Entities: time entry, employee, company
  • Summary: The Delete Time Entries API allows for the deletion of existing time entries for a specified employee within a given date range. The user must have DELETE permission to perform this action. The maximum date range allowed for the request is 31 days. The API requires the company to be identified by its ID or unique name and the employee by their account ID or external ID. The request must include the start and end dates for the time entries to be deleted. A successful deletion returns a 204 No Content response, indicating that the time entries were deleted successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Time Entry

  • ID: delete_time_entry
  • Operation: write
  • Entities: time entry, company
  • Summary: The Delete Time Entry API allows users to delete a specific time entry identified by the 'time_entry_id' for a company identified by 'cid'. The user must have the 'DELETE' permission for time entries and access to one of the required subsystems (TLM or TLM Small Business Edition: PR/HR Version). The API requires 'cid' and 'time_entry_id' as path parameters. On successful deletion, it returns a 204 No Content response. If the user is unauthorized, it returns a 401 Unauthorized response. If the user lacks access, it returns a 403 Forbidden response. If the resource does not exist, it returns a 404 Not Found response. If the call limit is exceeded, it returns a 503 Service Unavailable response, with the 'X-CallLimit-TimeToWait' header indicating the wait time before subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Time Entry Notes

  • ID: delete_time_entry_notes
  • Operation: write
  • Entities: time entry, note, company
  • Summary: The 'Delete Time Entry Notes' API endpoint allows for the deletion of time entry notes associated with a company. The request requires the company ID (cid) as a path parameter and the note IDs to be deleted as a query parameter. The response will indicate the processing results for each note ID, with a status of 'OK' or 'FAILURE'. In case of failure, error details will be provided. The API returns a 200 OK status if the notes are processed successfully, a 403 Forbidden status if the user lacks access, and a 503 Service Unavailable status if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Vehicle Assignment

  • ID: delete_vehicle_assignment
  • Operation: write
  • Entities: vehicle assignment, company
  • Summary: The Delete Vehicle Assignment API allows users to delete a specific vehicle assignment by its ID. The request requires two path parameters: 'cid', which is the company identifier, and 'id', which is the vehicle assignment ID. The API responds with a 204 No Content status if the deletion is successful. If the user is unauthorized, a 401 Unauthorized status is returned. A 403 Forbidden status is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found status is returned. If the call limit is exceeded, a 503 Service Unavailable status is returned, and the 'X-CallLimit-TimeToWait' header indicates the wait time before subsequent calls can be made.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Vehicle Insurance

  • ID: delete_vehicle_insurance
  • Operation: write
  • Entities: vehicle insurance, company
  • Summary: The Delete Vehicle Insurance API endpoint allows users to delete a specific vehicle insurance record by its ID. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the vehicle insurance ID. Upon successful deletion, a 204 No Content response is returned. If the user is unauthorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found response is returned. In case the call limit is exceeded, a 503 Service Unavailable response is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making subsequent calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Vehicle Maintenance

  • ID: delete_vehicle_maintenance
  • Operation: write
  • Entities: maintenance, vehicle, company
  • Summary: The Delete Vehicle Maintenance API allows users to delete a specific vehicle maintenance record by its ID. The request requires two path parameters: 'cid', which is the company identifier, and 'id', which is the maintenance record identifier. The API responds with a 204 No Content status if the deletion is successful. If the user is unauthorized, a 401 Unauthorized status is returned. A 403 Forbidden status is returned if the user lacks access to the resource. If the resource does not exist, a 404 Not Found status is returned. If the call limit is exceeded, a 503 Service Unavailable status is returned, and the 'X-CallLimit-TimeToWait' header specifies the duration to wait before making further calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Workload Manager

  • ID: delete_workload_manager
  • Operation: write
  • Entities: workload manager, schedule, company
  • Summary: The Delete Workload Manager API provides the ability to delete volume data, workload coverage, and generated open shifts from a schedule. It requires the Advanced Scheduler (SCHEDULE) Subsystem and Workload Manager functionality to be enabled in the company setup. The API requires a path parameter 'cid' to specify the company and a query parameter 'schedule_id' to specify the schedule. It returns a 204 No Content response if the data is successfully removed, or various error responses such as 400 Bad Request, 403 Forbidden, 404 Not Found, and 500 Internal Server Error based on different failure conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Access Policy Profile

  • ID: get_access_policy_profile
  • Operation: read
  • Entities: access policy profile, access option, company
  • Summary: The Get Access Policy Profile API retrieves an existing access policy profile by its ID. The user must have permission to view access policies. The API requires two path parameters: 'cid' which is the company identifier and 'aid' which is the access policy profile ID. The response includes details of the access policy profile such as its name, description, active status, mobile allowance, and access options. The access options include details like option ID, type (IPv4 or IPv6), IP range start and end, and comments. The API returns various HTTP status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Account Assignments

  • ID: get_account_assignments
  • Operation: read
  • Entities: assignment, account, position
  • Summary: The Get Account Assignments API retrieves information about all current, future, or past dated assignments of a specified account. The API requires two path parameters: 'cid', which is the company identifier, and 'account_Id', which is the unique identifier of the account. The response includes detailed information about each assignment, such as assignment ID, position details, assignee information, compensation details, and more. The API returns a 200 OK status for successful requests, and can return 404 Not Found, 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable for various error conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Account Group

  • ID: get_account_group
  • Operation: read
  • Entities: manager, account group, company
  • Summary: The Get Account Group API allows retrieval of an existing regular account group by its ID. It requires two path parameters: 'cid' which is the company identifier and 'gid' which is the account group ID. The response includes details about the account group such as its ID, name, description, members, and managers. The managers' permissions and active periods are also detailed. The response includes links for self, replace, and delete actions. The API returns various HTTP status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Account Groups

  • ID: get_account_groups
  • Operation: read
  • Entities: security configuration, account group, company
  • Summary: The Get Account Groups API allows retrieval of existing regular account groups for a specified company. It provides basic data for each group, including the group's ID, name, description, and relevant links for self, replace, and delete operations. The API requires a path parameter 'cid' which is the company identifier. The response includes a list of account groups with their details. Possible response codes include 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Accrual Balances

  • ID: get_accrual_balances
  • Operation: read
  • Entities: accrual balance, employee, company
  • Summary: The Get Accrual Balances API retrieves the accrual balance of an employee for the current period. The endpoint requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes detailed information about the accrual balances, such as current and projected balances, accrued hours, period details, and category information. The response is structured in a JSON format with various properties like 'current_balance', 'projected_balance', 'period', and more, each containing specific details about the accruals. The API returns a 200 OK status on success, with other status codes indicating errors such as unauthorized access or resource not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Accruals

  • ID: get_accruals
  • Operation: read
  • Entities: accrual profile, company
  • Summary: The Get Accruals API returns a list of Accruals Profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of accrual profiles, each with an 'id', 'display_name', and 'description'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Accruals Profiles

  • ID: get_accruals_profiles
  • Operation: read
  • Entities: accrual profile, company
  • Summary: The Get Accruals Profiles API returns a list of Accruals(1.0) Profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of profile objects, each containing an 'id', 'display_name', and 'description'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable errors under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Additional Compensation

  • ID: get_additional_compensation
  • Operation: read
  • Entities: employee, compensation, company
  • Summary: The Get Additional Compensation API retrieves a list of additional compensation records for a specific employee. It requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes an array of additional compensation objects, each containing details such as the compensation type, currency, effective date, change date, period, active status, and value. The API returns a 200 OK response on success, with potential error responses including 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Additional Compensation Types

  • ID: get_additional_compensation_types
  • Operation: read
  • Entities: item, compensation type, company
  • Summary: The 'Get Additional Compensation Types' API retrieves the additional compensation types used in a specified company. The API requires a path parameter 'cid', which is the company identifier. The response includes an array of compensation types, each with properties such as 'id', 'type', 'number', 'added_to_annual_total', 'added_to_hourly_and_pp_pay_total', and 'label'. The API returns a 200 OK response on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Combined Compensation Details

  • ID: get_all_compensation_information_for_an_employee
  • Operation: read
  • Entities: compensation, additional_compensation
  • Summary: The Get Combined Compensation Details API retrieves both additional and total compensation records for a specific employee within a company. It requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes two arrays: 'additional_compensations' and 'total_compensations'. Each additional compensation object contains details such as the compensation type, currency, effective date, change date, period, active status, and value. Each total compensation object includes details such as account ID, amount, currency, and the effective date. The API returns a 200 OK response on success, with potential error responses including 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Data Export

  • ID: get_all_data_export
  • Operation: read
  • Entities: user, data export, company
  • Summary: The 'Get All Data Export' API endpoint allows users to retrieve all available data exports for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of data exports, each with an 'id', 'name', and 'format'. The API returns a 200 OK status on success, and may return errors such as 401 Unauthorized, 403 Forbidden, 406 Not Acceptable, or 500 Internal Server Error based on different failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Data Exports

  • ID: get_all_data_exports
  • Operation: read
  • Entities: user, data export, company
  • Summary: The 'Get All Data Exports' API endpoint retrieves all available data exports that can be run by a user within a company. This endpoint has been deprecated as of April 03, 2023, but will continue to function according to the deprecation policy. Users are advised to use the alternative endpoint GET v2/companies/{cid}/data-export. The API requires an Authorization header with a bearer token for authentication. The Accept header can be used to specify the desired response media type. The response includes a list of data exports, each with an id, name, and format. Possible response codes include 200 (OK), 401 (Unauthorized), 403 (Forbidden), 406 (Not Acceptable), 500 (Internal Server Error), and 503 (Service Unavailable).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Imports

  • ID: get_all_imports
  • Operation: read
  • Entities: import, company
  • Summary: The 'Get All Imports' API endpoint retrieves a list of all available imports within the company. It requires the 'Accept' header to specify the media type for the response, which is mandatory. The response includes an array of import objects, each containing 'TypeId', 'Label', 'FileType', and 'Description'. The API returns various HTTP status codes, including 200 for success, 403 for insufficient rights, 406 for unsupported media types, 500 for internal server errors, and 503 when the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All PTO Requests

  • ID: get_all_pto_requests
  • Operation: read
  • Entities: pto request, employee, company
  • Summary: The 'Get All PTO Requests' API endpoint is used to list PTO requests for subordinate employees. It requires the TA|TALITE|HR functionality to be enabled in the company setup. The API uses the GET method and requires a path parameter 'cid', which is the company identifier. The response includes a list of PTO requests with details such as employee information, time off details, and PTO request specifics. The response can return various HTTP status codes, including 200 for success, 401 for unauthorized access, 404 if the account is not found, 403 if the required functionality is not enabled, 500 for internal server errors, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Anniversary Calendar

  • ID: get_anniversary_calendar
  • Operation: read
  • Entities: anniversary, employee, company
  • Summary: The Get Anniversary Calendar API endpoint returns a list of employees' anniversaries within a specified date range, which should be less than or equal to 366 days. The endpoint requires a company identifier as a path parameter and the type of anniversary, start date, and end date as query parameters. The response includes a list of anniversaries with each entry containing the date and employee details such as account ID and display name. The API requires specific security permissions to access the data and does not include terminated employees by default, except for the 'TERMINATED' anniversary type. The response can return various HTTP status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Announcements

  • ID: get_announcements
  • Operation: read
  • Entities: user, announcement, company
  • Summary: The Get Announcements API endpoint is used to fetch active announcements for users. The user must have permission to view announcements or there must be announcements available to the user based on their security profile and/or group. The API requires at least one of the following subsystems: TLM, HR, or HR (Small Business Edition). The endpoint requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes a list of announcements with details such as id, headline, body, creation date, availability dates, and associated documents. The response also indicates whether the user has permission to view announcements and provides a link to the announcements settings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Applicant

  • ID: get_applicant
  • Operation: read
  • Entities: document, applicant, company
  • Summary: The Get Applicant API allows you to retrieve details of an existing applicant using the company ID and account ID as path parameters. The response includes comprehensive information about the applicant, such as personal details, address, contact information, demographics, education, skills, work experiences, and more. The API returns a 200 OK response on success, and various error codes like 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable for different failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Applicant Job Applications

  • ID: get_applicant_job_applications
  • Operation: read
  • Entities: job application, applicant, company
  • Summary: The 'Get Applicant Job Applications' API endpoint returns a list of all job applications for a specific applicant within a company. It requires two path parameters: 'cid' which is the company identifier and 'account_id' which is the applicant's account ID. The response includes detailed information about each job application, such as the application ID, account details, applicant and company comments, application and creation timestamps, hiring stage, job application status, job requisition details, and rank. The response is structured as an array of job application objects, each containing these details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Applicants

  • ID: get_applicants
  • Operation: read
  • Entities: account, applicant, company
  • Summary: The Get Applicants API returns a list of applicants for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of applicants, each with details such as account ID, username, eligibility for work, available start date, and a summary. The response also includes a self-link for each applicant. The API returns various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Asset Assignment

  • ID: get_asset_assignment
  • Operation: read
  • Entities: asset, employee, asset assignment
  • Summary: The Get Asset Assignment API endpoint is used to fetch a specific asset assignment by its ID. It requires the company ID (cid) and the asset assignment ID (id) as path parameters. The API returns detailed information about the asset assignment, including employee details, asset properties, and various metadata such as creation date and status. The response includes a comprehensive JSON object with nested structures for employee and asset details, as well as links for related actions. The API supports various response codes, including 200 for success, 404 if the asset assignment is not found, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Asset Assignments

  • ID: get_asset_assignments
  • Operation: read
  • Entities: asset, employee, asset assignment
  • Summary: The Get Asset Assignments API endpoint returns a list of all asset assignments for a specified company. It requires the company to be identified via a path parameter 'cid', which can be the company id, unique id, or short name. The response includes details about each asset assignment, such as whether it is personal, the asset details, and the employee details associated with the asset. The response also includes links for self, edit, and delete actions for each asset assignment. The API requires authorization and access to the HR or HR (Small Business Edition) subsystems.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Asset Categories

  • ID: get_asset_categories
  • Operation: read
  • Entities: asset category, company
  • Summary: The Get Asset Categories API endpoint is used to fetch a list of all asset categories within a specified company. The request requires a path parameter 'cid', which is the company identifier. The response will return a list of asset categories in JSON format. The possible HTTP response codes include 200 (OK), 401 (Unauthorized), 403 (Forbidden), and 503 (Service Unavailable). The response body contains an array of objects, each with a 'name' field representing the asset category name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Asset Types

  • ID: get_asset_types
  • Operation: read
  • Entities: asset type, company
  • Summary: The Get Asset Types API endpoint is used to fetch a list of all asset types within a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of asset types, each with an 'id' and 'name'. The API returns a 200 OK status on success, and may return 401 Unauthorized if the user is not authorized, 403 Forbidden if the user has no access to the resource, or 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Assets

  • ID: get_assets
  • Operation: read
  • Entities: asset, company
  • Summary: The Get Assets API endpoint is used to fetch a list of all company assets. It requires a path parameter 'cid', which is the company identifier. The response includes a list of assets with details such as asset type, category, tag ID, description, quantity, current status, and creation date. The response also includes a total count of assets. Possible response codes include 200 OK, 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attendance

  • ID: get_attendance
  • Operation: read
  • Entities: attendance, employee, company
  • Summary: The Get Attendance API retrieves attendance data for a specific employee. It requires two path parameters: 'cid' for the company ID and 'aid' for the account ID. The response includes the employee's attendance status, the last start time, the last punch action type, and associated cost centers. The API returns a 200 OK response on success, with possible error responses including 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attestation Profiles

  • ID: get_attestation_profiles
  • Operation: read
  • Entities: attestation profile, profile, company
  • Summary: The Get Attestation Profiles API retrieves a list of attestation profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of attestation profiles, each with an 'id', 'display_name', and 'description'. The API returns a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Authentication

  • ID: get_authentication
  • Operation: read
  • Entities: authorization code flow, oauth client, company
  • Summary: The Get Authentication API is used to initiate the Authorization Code Flow by an OAuth client. It requires a path parameter 'cid', which is the company identifier. The API responds with a 302 Found status if the request is valid and the user is redirected to the OAuth Authorization Code Flow. If the company is locked or functionality is disabled, a 403 Forbidden status is returned. A 404 Not Found status is returned if invalid company or OAuth configuration references are provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Authorization Code

  • ID: get_authorization_code
  • Operation: read
  • Entities: authorization code, session, company
  • Summary: The 'Get Authorization Code' API endpoint is used for processing the Authorization Code Flow. It requires a path parameter 'cid', which is the company identifier. The API returns different HTTP status codes based on the outcome: '302 Found' indicates successful authorization and user login to WFR, '401 Unauthorized' indicates the user is not authorized, '403 Forbidden' indicates the company is locked or functionality is disabled, and '404 Not Found' indicates invalid references for Company, Account, or OAuth Configuration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Authorize

  • ID: get_authorize
  • Operation: read
  • Entities: authorization, resource owner, company
  • Summary: The Get Authorize API endpoint is used to interact with the resource owner and obtain an authorization grant as part of the OAuth 2.0 Authorization Framework. It implements the authorization endpoint as specified in RFC 6749 section 3.1 and is used by the authorization code grant type to fulfill Authorization Request as per RFC 6749 section 4.1.1. This implementation requires the use of Proof Key for Code Exchange (PKCE), making certain parameters mandatory. The API requires a path parameter 'cid' which is the company identifier. Upon a valid request, it responds with a 302 Found status, redirecting the user to an Authentication URL specified in the Location response header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Badges

  • ID: get_badges
  • Operation: read
  • Entities: badge, employee, company
  • Summary: The Get Badges API retrieves the badge information for a specific employee within a company. It requires the company ID (cid) and the account ID (aid) as path parameters. The API checks the user's access rights based on the security profile settings in the company. The response includes a list of badges with details such as badge type, badge number, and optional fields like pin, short_id, effective_from, and effective_to. The badge types can be SIMPLE_1, SIMPLE_2, SIMPLE_3, or EXTENDED. The API returns various HTTP status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Batches

  • ID: get_batches
  • Operation: read
  • Entities: payroll, payroll batch, company
  • Summary: The Get Batches API retrieves information about all payroll batches for a specified company and payroll ID. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the payroll ID. The response includes a list of batches, each with details such as 'id', 'display_name', 'status', 'master', and 'type'. The status can be one of several values including 'DELETING', 'CLOSED', 'OPEN', 'IMPORTING', or 'DELETING_ABORTED'. The API returns various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Benefit Plan

  • ID: get_benefit_plan
  • Operation: read
  • Entities: benefit plan, dependent, company
  • Summary: The Get Benefit Plan API endpoint allows users to fetch details of an employee's benefit plan by its ID. The request requires two path parameters: 'cid', which is the company identifier, and 'id', which is the employee benefit plan ID. The response includes detailed information about the benefit plan, such as the employee's account ID, benefit plan ID, currency, coverage effective dates, earnings and deductions, coverage details, and dependents. The API returns various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Benefit Plan List

  • ID: get_benefit_plan_list
  • Operation: read
  • Entities: benefit plan, deduction, company
  • Summary: The 'Get Benefit Plan List' API endpoint allows users to fetch a list of benefit plans for a specified company. The endpoint requires a path parameter 'cid', which is the company identifier. The response includes details about each benefit plan, such as the plan's ID, name, effective dates, whether it is company-provided, benefit type ID, and COBRA eligibility. Additionally, it provides information on associated earnings and deductions, as well as coverage details. The API returns a 200 OK response on success, with potential error responses including 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Benefit Plans

  • ID: get_benefit_plans
  • Operation: read
  • Entities: benefit plan, company
  • Summary: The Get Benefit Plans API endpoint is used to fetch a list of benefit plans for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of benefit plans, each with details such as id, name, description, effective dates, and whether the plan is company-provided. The API returns a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Benefit Types

  • ID: get_benefit_types
  • Operation: read
  • Entities: plan type, benefit type, company
  • Summary: The Get Benefit Types API endpoint is used to fetch a list of benefit types for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of benefit types, each with an 'id', 'name', 'base_type', and 'plan_type'. The base_type can be one of several predefined categories such as 'HEALTH', 'LIFE', etc., and the plan_type can be 'ACTIVE', 'COBRA', etc. The API returns a 200 OK response on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Benefit Plans

  • ID: get_benefits_for_employee
  • Operation: read
  • Entities: benefits
  • Summary: The Get Benefit Plans API endpoint returns a list of an employee's benefit plans. It requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes a list of benefits, each with details such as the benefit ID, employee account ID, benefit name, coverage level, benefit plan ID, currency, and coverage effective dates. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Benefit Plans

  • ID: get_benefits_of_given_employee_id
  • Operation: read
  • Entities: benefits
  • Summary: The Get Benefit Plans API endpoint returns a list of an employee's benefit plans. It requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes a list of benefits, each with details such as the benefit ID, employee account ID, benefit name, coverage level, benefit plan ID, currency, and coverage effective dates. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Birthday Calendar

  • ID: get_birthday_calendar
  • Operation: read
  • Entities: employee, birthday, company
  • Summary: The Get Birthday Calendar API endpoint returns a list of employees' birthdays within a specified date range, which should be less than or equal to 366 days. The API requires a company identifier (cid) as a path parameter and a date range specified by 'date_from' and 'date_to' as query parameters. The response includes a list of birthdays with each entry containing the date and employee details such as account_id and display_name. The API requires specific security permissions to access the data and returns various HTTP status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Cases

  • ID: get_cases
  • Operation: read
  • Entities: leave of absence, employee, case
  • Summary: The 'Get Cases' API endpoint is used to fetch leave of absence cases for a specified company. The company must have leave of absence functionality enabled. The API provides basic data for each case. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of cases, each containing details such as the case ID, employee account ID, start and end dates, case number, status, and links to the case and its notes. The API returns a 200 OK response on success, with possible error responses including 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Changed Employees

  • ID: get_changed_employees
  • Operation: read
  • Entities: employee, compensation, company
  • Summary: The 'Get Changed Employees' API returns basic information about employee records that have been updated within a specified time frame. It includes changes made to core employee fields such as 'Firstname' and related resources like 'Pay Information'. The API requires a path parameter 'cid' which is the company identifier. The response includes an array of entries, each containing an 'id', 'status', and an 'object' with employee details and links to related resources. The API handles various response codes including 200 for success, 404 for resource not found, 401 for unauthorized access, 403 for forbidden access, and 503 for service unavailable due to call limit exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Access

  • ID: get_company_access
  • Operation: read
  • Entities: access profile, company
  • Summary: The Get Company Access API returns a list of Access Profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of access profiles, each with an 'id', 'display_name', and 'description'. The API returns a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Assignments

  • ID: get_company_assignments
  • Operation: read
  • Entities: assignment, position, company
  • Summary: The Get Company Assignments API retrieves information about all current, future, or past dated assignments for a specified company. The company is identified using a path parameter 'cid', which is required and can be the company id, unique id, or short name. The API returns a detailed list of assignments, including assignment IDs, numbers, positions, account details, start and end dates, assignee information, compensation details, cost centers, and other attributes. The response is structured as a JSON object with an array of assignment objects, each containing comprehensive details about the assignment. The API supports various response codes, including 200 for success, 404 for resource not found, 401 for unauthorized access, 403 for forbidden access, and 503 for service unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Or Account Groups

  • ID: get_company_or_account_groups
  • Operation: read
  • Entities: account, group, company
  • Summary: The 'Get Company Or Account Groups' API retrieves groups associated with a specified company or account. It requires the 'cid' path parameter to identify the company, and the 'object_type' query parameter to specify the type of groups to query, either 'account' or 'company'. The response includes a list of groups with details such as group ID, name, type, and number of members. The API returns a 200 OK status on success, with potential error responses including 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Tax Quarters

  • ID: get_company_tax_quarters
  • Operation: read
  • Entities: quarter, tax, company
  • Summary: The 'Get Company Tax Quarters' API retrieves the tax quarter details for a specified company. It requires three path parameters: 'cid' (the company ID or unique identifier), 'year' (the four-digit year), and 'q' (the quarter number, ranging from 1 to 4). The API returns a JSON object containing details such as the quarter's ID, display name, year, quarter number, status (which can be 'OPEN', 'LOCKED', or 'SIGNED_OFF'), and links to the quarter's self and status URLs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Tax Year

  • ID: get_company_tax_year
  • Operation: read
  • Entities: tax form, tax year, company
  • Summary: The 'Get Company Tax Year' API retrieves the tax year details for a specified company and year. It requires two path parameters: 'cid', which is the company identifier, and 'year', which is the four-digit year. The response includes details such as the tax year ID, display name, year, status (which can be 'OPEN', 'LOCKED', or 'SIGNED_OFF'), the count of W2s and 1099s delivered, and relevant links for further actions. The API returns a 200 OK response with the tax year details in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Compensation History

  • ID: get_compensation_history
  • Operation: read
  • Entities: employee, compensation, company
  • Summary: The Get Compensation History API returns a list of Base Compensation entries for a specific employee. The API requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes an array of compensation objects, each containing details such as the effective date, amount, currency, and links to the detailed resource. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Contact

  • ID: get_contact
  • Operation: read
  • Entities: contact, employee, company
  • Summary: The Get Contact API endpoint is used to fetch the contact details of an employee by their contact ID. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the employee contact ID. The response includes detailed information about the contact, such as personal details, phone numbers, email, national identification numbers, and links for self, edit, and delete actions. The API supports backward compatibility for fields like 'bsn', 'social_insurance', 'social_security', and 'national_insurance'. The response schema provides a comprehensive structure of the contact details, including optional and required fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Contacts

  • ID: get_contacts
  • Operation: read
  • Entities: contact, employee, company
  • Summary: The Get Contacts API endpoint retrieves a list of employee contacts for a specified company and employee. It requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes a list of contacts with details such as contact ID, employee account ID, primary status, emergency status, relationship, and more. The response also includes links for creating new contacts and counts of different types of contacts. The API returns a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Cost Center

  • ID: get_cost_center
  • Operation: read
  • Entities: payroll, cost center, company
  • Summary: The Get Cost Center API allows retrieval of an existing cost center's details. It requires the company ID (cid) and cost center ID (ccid) as path parameters. The response includes various details about the cost center such as its external ID, abbreviation, name, payroll code, description, and more. The API also provides information on GL codes, custom fields, contact details, job settings, and job strain. The response is structured in a detailed JSON format, providing comprehensive information about the cost center.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Cost Center Job

  • ID: get_cost_center_job
  • Operation: read
  • Entities: skill, cost center job, company
  • Summary: The 'Get Cost Center Job' API endpoint allows users to retrieve details of a specific Cost Center Job within a company. The user must have the necessary permissions to view the Cost Center Job and must be subscribed to at least one of the following subsystems: HR or HR (Small Business Edition). The API requires two path parameters: 'cid', which is the company identifier, and 'id', which is the identifier of the cost center job. The response includes detailed information about the job, such as job category, name, description, and various other attributes related to the job's classification, compensation, and associated skills. The API returns a 200 OK response on success, and can return various error responses such as 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable under different conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Cost Center Jobs

  • ID: get_cost_center_jobs
  • Operation: read
  • Entities: job category, cost center job, company
  • Summary: The 'Get Cost Center Jobs' API endpoint retrieves all Cost Center Jobs available within a specified company. The user must have the necessary permissions to view Cost Center Jobs and must be subscribed to at least one of the following subsystems: HR or HR (Small Business Edition). The API requires a path parameter 'cid', which is the company identifier. The response includes a list of cost center jobs with details such as job category, name, abbreviation, description, external ID, payroll code, visibility, and applicant tracking display options. The API returns a 200 OK status on success, while 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable are possible error responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Cost Center Lists

  • ID: get_cost_center_lists
  • Operation: read
  • Entities: cost center, list, company
  • Summary: The Get Cost Center Lists API endpoint returns a collection of cost center lists for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of cost center lists, each with an 'id', 'name', and 'tree_index'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Cost Centers

  • ID: get_cost_centers
  • Operation: read
  • Entities: cost center, subsystem, company
  • Summary: The Get Cost Centers API allows retrieval of existing cost centers as a flat list. Relationships between cost centers can be traced using the parent_id field, where the root does not have a parent_id. All visible cost centers are returned, even if their parent is not visible. To access this API, the user must have Cost Center Definitions view permission and at least one of the following subsystems: TLM, TLM (Small Business Edition: PR/HR Version), HR, HR (Small Business Edition), Payroll, or Scheduler. The API requires a path parameter 'cid' which is the company identifier. The response includes a list of cost centers with details such as id, name, parent_id, description, payroll_code, external_id, and location_code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Counter Adjustment Notes

  • ID: get_counter_adjustment_notes
  • Operation: read
  • Entities: note, counter adjustment, company
  • Summary: The Get Counter Adjustment Notes API endpoint is used to retrieve notes associated with specific counter adjustments for a company. The request requires a path parameter 'cid' which is the company identifier, and a query parameter 'counter_adjustment_ids' which is a comma-separated list of counter adjustment IDs. The response includes an array of notes, each containing an 'id', 'counter_adjustment_id', and 'text'. The API returns a 200 OK response on success, and may return 403 Forbidden if the user lacks access, 503 Service Unavailable if the call limit is exceeded, or 401 Unauthorized if the user is not authorized.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Counter Adjustments

  • ID: get_counter_adjustments
  • Operation: read
  • Entities: employee, counter adjustment, company
  • Summary: The Get Counter Adjustments API allows users to fetch existing counters for a specified account within a given date range. The maximum date range for the request is 31 days. The API requires path parameters 'cid' (company id) and 'aid' (account id), and query parameters 'start_date' and 'end_date' to specify the date range. The response includes a list of counter adjustments with details such as id, record date, counter information, cost centers, value, reset status, and reason code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Counter Distribution Profiles

  • ID: get_counter_distribution_profiles
  • Operation: read
  • Entities: counter distribution profile, company
  • Summary: The 'Get Counter Distribution Profiles' API returns a list of Counter Distribution Profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of profile objects, each containing an 'id', 'display_name', and 'description'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Credential Types

  • ID: get_credential_types
  • Operation: read
  • Entities: credential type, company
  • Summary: The 'Get Credential Types' API endpoint is used to fetch a list of credential types for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of credential types, each with an 'id', 'display_name', and an optional 'description'. The API returns a 200 OK status on success, while it may return 401 Unauthorized if the user is not authorized, 403 Forbidden if the user has no access to the resource, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Current Employee

  • ID: get_current_employee
  • Operation: read
  • Entities: employee, company
  • Summary: The 'Get Current Employee' API retrieves basic information about the employee associated with the current 'Authentication Token'. It requires a path parameter 'cid' which is the company identifier. The response includes the employee's ID, username, first and last names, and a list of EINs with their display names and primary status. Additionally, it provides links to other APIs for detailed employee information. The API returns various HTTP status codes such as 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Forms List

  • ID: get_custom_forms_list
  • Operation: read
  • Entities: item, custom form, company
  • Summary: This API endpoint returns a list of available custom forms for a specified company. The company is identified by the 'cid' path parameter, which is required and can be a company id, unique id, or short name. The response includes a list of forms, each with an id, name, description, and a boolean indicating if it is an applicant form. Some forms may include items with details such as id, state, account_id, creation date, and a download link. The API returns various HTTP status codes to indicate success or specific errors, such as 400 for invalid date range, 404 if the account is not found, 401 for unauthorized access, 403 for forbidden access, and 503 if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Data Retention Profiles

  • ID: get_data_retention_profiles
  • Operation: read
  • Entities: data retention profile, company
  • Summary: The 'Get Data Retention Profiles' API returns a list of Data Retention Profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier and must be provided in the format of company id, unique id, or short name. The response includes a list of profiles, each with an 'id', 'display_name', and 'description'. The API can return various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Deduction Codes

  • ID: get_deduction_codes
  • Operation: read
  • Entities: deduction code, company
  • Summary: The Get Deduction Codes API endpoint is used to fetch a list of supported deduction codes for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response will return a list of deduction codes, each with an external ID, name, and code. The API supports various HTTP response codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 for service unavailability due to call limit exceedance.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Degrees

  • ID: get_degrees
  • Operation: read
  • Entities: degree, company
  • Summary: The Get Degrees API endpoint is used to fetch a list of degrees associated with a company. It requires the company to be identified via a path parameter 'cid', which can be the company id, unique id, or short name. The API returns a list of degree objects, each containing an id, code, degree name, and an optional description. The response is a JSON object with an 'items' array. The API supports HTTP GET method and returns a 200 OK status on success. Possible error responses include 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Delivery Policies

  • ID: get_delivery_policies
  • Operation: read
  • Entities: delivery policy, company
  • Summary: The Get Delivery Policies API returns a list of delivery policies for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of delivery policy profiles, each with an 'id', 'display_name', and 'description'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Demographic Profiles

  • ID: get_demographic_profiles
  • Operation: read
  • Entities: demographic profile, company
  • Summary: The Get Demographic Profiles API returns a list of demographic profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of profile objects, each containing an 'id', 'display_name', and 'description'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable under certain conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Demographics

  • ID: get_demographics
  • Operation: read
  • Entities: demographic information, employee, company
  • Summary: The Get Demographics API retrieves the demographic information of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The API checks for specific security profile items and manager permissions to control access rights. The response includes details such as citizenship, ethnicity, eye color, gender, height, and visa information. The API returns various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Device Access

  • ID: get_device_access
  • Operation: read
  • Entities: device access profile, company
  • Summary: The Get Device Access API returns a list of Device Access Profiles for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of profiles, each with an 'id', 'display_name', and 'description'. The API responds with a 200 OK status on success, and may return 401 Unauthorized, 403 Forbidden, or 503 Service Unavailable in case of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Direct Deposit

  • ID: get_direct_deposit
  • Operation: read
  • Entities: employee, direct deposit, company
  • Summary: The 'Get Direct Deposit' API endpoint retrieves the direct deposit account details of an employee for a specified company. This endpoint has been deprecated as of April 13, 2023, but will continue to function according to the deprecation policy. The API requires two path parameters: 'cid', which is the company identifier, and 'id', which is the employee's direct deposit ID. The response includes details such as the account name, description, sequence, type, active dates, account type, account number, routing number, and links for self, edit, and delete actions. The API returns various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Direct Deposits

  • ID: get_direct_deposits
  • Operation: read
  • Entities: employee, direct deposit, company
  • Summary: This API endpoint retrieves a list of direct deposit accounts for a specific employee within a company. It requires two path parameters: 'cid' for the company identifier and 'aid' for the account identifier. The response includes details about each direct deposit account, such as the account type, routing number, and calculation method. The endpoint has been deprecated as of April 13, 2023, but will continue to function according to the deprecation policy. The response can include various HTTP status codes, such as 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Document Metadata

  • ID: get_document_metadata
  • Operation: read
  • Entities: document, timesheet, company
  • Summary: The Get Document Metadata API endpoint is used to retrieve metadata of a specified document. It supports two types of documents: global documents and attached documents. Global documents are uploaded by system administrators and can be accessed by users, while attached documents are linked to specific resources like timesheets. The API requires two path parameters: 'cid' (company identifier) and 'id' (document ID). The response includes metadata such as document type, file name, size, creation details, and access links. The links provide different access levels (read, write, delete) with short expiration times. The API is available for companies with the 'Integrated Document Storage' marketplace product.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Document Preview

  • ID: get_document_preview
  • Operation: read
  • Entities: document, company
  • Summary: The 'Get Document Preview' API endpoint allows users to retrieve metadata for a specified document preview. This functionality is available for companies with the 'Integrated Document Storage' marketplace product. The API requires two path parameters: 'cid', which is the company identifier, and 'id', which is the ID of the uploaded document. The response includes the document's ID, type, display name, and details about each page, such as page number, size, and preview links. The response is returned in JSON format, and a successful request will return a 200 OK status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Document Storage

  • ID: get_document_storage
  • Operation: read
  • Entities: document, timesheet, company
  • Summary: The Get Document Storage API endpoint is used to retrieve a list of uploaded documents for a specified company. The documents can be either global or attached to specific resources like timesheets. Each document object includes metadata such as the document type, file name, size, and creation details. The API requires a path parameter 'cid' to specify the company. The response includes links to the document content with varying access levels (read, write, read-write). The API is available for companies with the 'Integrated Document Storage' marketplace product. The response schema includes detailed information about each document, including its attributes and links for content access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Document Types

  • ID: get_document_types
  • Operation: read
  • Entities: document type, company
  • Summary: The Get Document Types API returns a list of defined document types in the company. It requires a path parameter 'cid', which is the company identifier. The response includes an array of document types, each with an 'id' and 'display_name'. The API can return various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Earning Codes

  • ID: get_earning_codes
  • Operation: read
  • Entities: earning code, company
  • Summary: The Get Earning Codes API endpoint is used to fetch a list of supported earning codes for a specified company. The request requires a path parameter 'cid', which is the company identifier and must be provided in the format of company id, unique id, or short name. The response will return a list of earning codes, each with an external_id, name, code, and id. The API can return various HTTP status codes, including 200 for a successful request, 401 if the user is unauthorized, 403 if access is forbidden, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Education Levels

  • ID: get_education_levels
  • Operation: read
  • Entities: education level, company
  • Summary: The 'Get Education Levels' API endpoint is used to fetch a list of education levels for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of education level objects, each containing an 'id', 'name', 'active' status, 'description', and 'order'. The API returns a 200 OK status on success, with possible error responses including 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields