UKG Ready API Integration Vol.3

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

Put Demographics

ID: put_demographics
Operation: write
Entities: employee, demographic, company
Summary: The Put Demographics API is used to update the demographic information of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body can include various demographic details such as citizenship, ethnicity, eye color, gender, height, and visa information. The API does not perform additional validation for fields marked as required in the demographic profile. The response can be a 204 No Content if successful, or various error codes such as 401 Unauthorized, 403 Forbidden, 404 Not Found, or 503 Service Unavailable if there are issues with the request.
Input Fields: Input Fields
Output Fields: Output Fields

Put Direct Deposit

ID: put_direct_deposit
Operation: write
Entities: employee, direct deposit, company
Summary: This API endpoint updates an existing employee's direct deposit account. It requires the company ID (cid) and the direct deposit ID (id) as path parameters. The request body must include details such as the account name, description, type, active dates, employee account ID, sequence, amount, calculation method, account type, account number, routing number, and routing type. The API returns a 204 No Content response if the update is successful. Other possible responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Document

ID: put_document
Operation: write
Entities: document, metadata, company
Summary: The Put Document API endpoint is used to update the metadata of an uploaded document for companies with the 'Integrated Document Storage' marketplace product. The API requires the company ID and document ID as path parameters. The request body must include the file name, display name, file date, document type, and description. Additional attributes such as employee viewability, directory, category, and extra information can be specified. The API returns a 204 No Content response if the metadata is successfully saved. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Employee

ID: put_employee
Operation: write
Entities: manager, employee, company
Summary: The Put Employee API is used to update the core employee information. It requires the company ID (cid) and account ID (aid) as path parameters. The request body can include various employee details such as name, address, phone numbers, and more. Some fields are ignored based on the type of request (ESS or other). The API uses a separate security profile to control access rights. The response can be a 204 No Content for a successful update or various error codes like 400, 401, 403, 500, 404, and 503 for different failure scenarios.
Input Fields: Input Fields
Output Fields: Output Fields

Put Hcm Application Details Widget

ID: put_hcm_application_details_widget
Operation: write
Entities: widget, hcm application, company
Summary: The Put Hcm Application Details Widget API allows updating fields in the Dimensions HCM Application Details Widget. It requires a path parameter 'cid' which is the company identifier. The request body includes various configuration options such as 'enable_decimal_rounding', 'allow_special_characters', and 'ui_integration'. The response is an array indicating the success of the operation with a severity level and a message.
Input Fields: Input Fields
Output Fields: Output Fields

Put Hcm System Details Widget

ID: put_hcm_system_details_widget
Operation: write
Entities: system configuration, widget, company
Summary: The 'Put Hcm System Details Widget' API allows updating fields in the Dimensions HCM System Details. It requires a path parameter 'cid' which is the company identifier. The request body must include the 'system_config' object containing details such as 'server_url', 'api_key', 'tenant_id', 'user_name', 'password', 'client_id', 'client_secret', and 'dimensions_hcm_mode'. Upon successful update, the API returns a response with a severity level and a message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employee Base Compensation History

ID: put_history
Operation: write
Entities: employee, compensation, company
Summary: This API updates the employee base compensation history for a specified company and compensation ID. It requires the company ID (cid) and compensation history ID (id) as path parameters. The request body must include details such as the employee's account ID, effective date, compensation amount, currency, amount period, time, time period, number of pay periods in a year, and auto pay details. The API returns a 204 No Content response upon successful update. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Hr Custom Fields

ID: put_hr_custom_fields
Operation: write
Entities: employee, hr custom field, company
Summary: The 'Put Hr Custom Fields' API is used to update the HR custom fields of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body should contain an array of custom fields, each with an index and a value. On successful update, the API returns a 204 No Content response. If the user does not have access, a 403 Forbidden response is returned. Other possible responses include 401 Unauthorized, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Inventory Item

ID: put_inventory_item
Operation: write
Entities: inventory profile, inventory item, company
Summary: The Put Inventory Item API endpoint replaces a given employee inventory item by its ID with a new one provided in the payload. It requires the company ID, inventory profile ID, and item ID as path parameters. The request body must include the employee account ID and up to 25 user-defined fields. On success, it returns a 204 No Content response. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Job Application

ID: put_job_application
Operation: write
Entities: job application, hiring stage, company
Summary: The Put Job Application API endpoint allows for replacing an existing job application identified by job_app_id with a new one provided in the payload. It requires the company ID (cid) and job application ID (job_app_id) as path parameters. The request body can include details such as applicant comments, application date, company comments, hiring stage, job application status, and rank. On successful replacement, the API returns a 204 No Content response. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable, with the latter including an X-CallLimit-TimeToWait header indicating the wait time for subsequent calls.
Input Fields: Input Fields
Output Fields: Output Fields

Put List

ID: put_list
Operation: write
Entities: cost center, list, company
Summary: The 'Put List' API endpoint is used to update a cost center list for a specified company. It requires the company ID ('cid') and the cost center list ID ('list_id') as path parameters. The request body must include the name of the cost center list and an array of cost centers with their IDs. The API returns various responses, including 200 OK if the update is successful, 204 No Content, 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

Put Lock Account

ID: put_lock_account
Operation: write
Entities: account, company
Summary: The Put Lock Account API endpoint allows users to lock an account by specifying the company ID (cid) and account ID (aid) in the path parameters. The API returns a 204 No Content response if the account is successfully locked. If the user does not have access to the resource, a 403 Forbidden response is returned. A 404 Not Found response is returned if the specified resource does not exist. 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

Put Managed Cost Center

ID: put_managed_cost_center
Operation: write
Entities: managed cost center, employee, company
Summary: The 'Put Managed Cost Center' API endpoint allows updating a Managed Cost Center (MCC) by its ACL id. It requires the company id (cid), account id (aid), and managed cost center id (mccid) as path parameters. The request body includes permissions for employee time and HR actions. The API returns a 204 No Content response if the MCC is successfully updated. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Manager

ID: put_manager
Operation: write
Entities: manager, account group, company
Summary: The Put Manager API allows an existing regular account group manager to be replaced. It requires the company ID (cid), account group ID (gid), and group manager account ID (mid) as path parameters. The request body includes details about the employee, such as account ID, username, active period, and permissions related to employee information, time, and pay statements. The API returns a 204 No Content response if the manager is successfully replaced. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Mass Edit for Direct Deposits

ID: put_mass_edit_for_direct_deposits
Operation: write
Entities: direct deposit, company
Summary: This API endpoint allows for mass editing of selected direct deposits for a specified company. The company is identified by the 'cid' path parameter, which is required. The request body must include 'direct_deposit_ids', a list of IDs for the direct deposits to be edited, 'aba', the ABA routing number, and 'pre_note_status', the pre-note status. The API returns a 204 No Content response if the update is successful, or a 400 Bad Request response if the update fails. Note that this resource has been deprecated as of April 13, 2023, but will continue to function according to the deprecation policy.
Input Fields: Input Fields
Output Fields: Output Fields

Put Migrate

ID: put_migrate
Operation: write
Entities: service account, account, company
Summary: The Put Migrate API allows for the migration from a regular account to a service account. It requires the company ID as a path parameter and a request body containing the username, login flags, company group IDs, edit permission, and account group IDs. The API responds with a 204 status code if the migration is successful, a 400 status code if the account is not found, and a 500 status code for internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Put Oauth Application

ID: put_oauth_application
Operation: write
Entities: company, security profile, OAuth application
Summary: The Put Oauth Application API allows updating an existing OAuth application. It requires the company ID and OAuth application ID as path parameters. The request body can include various fields such as name, secret, security profile, and others depending on the application type. The secret is optional unless the application is revoked, in which case a new secret is required to unrevoke it. The API returns a 204 status code on successful update, and various error codes for different failure scenarios.
Input Fields: Input Fields
Output Fields: Output Fields

Put Pay Information

ID: put_pay_information
Operation: write
Entities: pay information, employee, company
Summary: The 'Put Pay Information' API is used to update the pay information of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body includes details such as default job ID, job change reason, job last changed date, standard work day, employee type, pay type, shift premium, medical eligibility, dental eligibility, dependent benefits eligibility, benefit auto-enrollment eligibility, EEO classification, workers comp code, union ID, payroll classification, bank account number, pay grade, and GL codes. The API responds with a 204 status code if the update is successful, and various error codes such as 401, 403, 404, and 503 for unauthorized access, forbidden access, resource not found, and service unavailable respectively.
Input Fields: Input Fields
Output Fields: Output Fields

Put Profiles

ID: put_profiles
Operation: write
Entities: profile, employee, company
Summary: The Put Profiles API is used to update employee profiles information. It requires path parameters 'cid' for company identification and 'aid' for account identification. The request body can include arrays for 'benefit', 'security', 'pay_period', 'work_schedule', and 'rate_tables', each with specific properties such as 'id', 'effective_from', and others. The API responds with various status codes including 204 for successful updates, 401 for unauthorized access, 403 for forbidden access, 404 for resource not found, and 503 for service unavailable due to call limits.
Input Fields: Input Fields
Output Fields: Output Fields

Put Project

ID: put_project
Operation: write
Entities: manager, project, company
Summary: The Put Project API updates the information of a project within a specified company. The API requires the company ID (cid) and project ID (projectId) as path parameters. The request body must include the project's name, start date, end date, and a list of employee IDs. Optional fields include business purpose, percent complete, description, cost center ID, cost center list ID, manager IDs, EIN details, and budget amount. The response returns the updated project details. Possible responses include 200 OK, 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Rate Schedule

ID: put_rate_schedule
Operation: write
Entities: rate schedule, rate table, company
Summary: The Put Rate Schedule API is used to update a rate schedule for a specific company, rate table, and schedule ID. It requires path parameters including the company ID (cid), rate table ID (tid), and rate schedule ID (sid). The request body includes details such as line number, type, description, rate items, rate reason code, usage, time entry record, and counter record. The API returns a 204 No Content response upon successful update, with possible error responses including 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Rate Table

ID: put_rate_table
Operation: write
Entities: user message, rate table, company
Summary: The Put Rate Table API allows updating a rate table for a specified company. The API requires the company ID (cid) and rate table ID (tid) as path parameters. The request body includes details such as the name, description, currency, and other configurations of the rate table. The response includes user messages indicating the status of the operation, with possible severities of INFO, WARN, or ERROR. The API returns various HTTP status codes, including 200 for successful updates with warnings, 204 for successful updates without content, and error codes for unauthorized access, forbidden access, resource not found, and service unavailability.
Input Fields: Input Fields
Output Fields: Output Fields

Put Reapply Rates

ID: put_reapply_rates
Operation: write
Entities: rate, table, company
Summary: The 'Put Reapply Rates' API is used to reapply rates for a specified rate table within a company. The API requires the company ID ('cid') and the rate table ID ('tid') as path parameters. The request body can optionally include 'date_from' and 'date_to' to specify the date range for reapplying rates. The API returns a response with user messages indicating the status of the operation. Possible response codes include 200 (OK), 204 (No Content), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), and 503 (Service Unavailable).
Input Fields: Input Fields
Output Fields: Output Fields

Put Revoke Oauth Application

ID: put_revoke_oauth_application
Operation: write
Entities: oauth application, company
Summary: The 'Put Revoke Oauth Application' API endpoint is used to revoke an OAuth application for a specified company. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the OAuth application id. The API does not require any request body or query parameters. Upon successful revocation, it returns a 204 No Content response. Possible error responses include 400 Bad Request for validation errors, 404 Not Found if the OAuth application is not found, 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 'X-CallLimit-TimeToWait' header indicating the wait time for subsequent calls.
Input Fields: Input Fields
Output Fields: Output Fields

Put Scheduled Deduction Mass Add, Edit, Or Delete

ID: put_scheduled_deduction_mass_add_edit_or_delete
Operation: write
Entities: scheduled deduction, vendor, company
Summary: This API endpoint allows for the mass addition, editing, or deletion of scheduled deductions for a company. The company is identified by the 'cid' path parameter, which is required. The request body must include an array of scheduled deductions, each with detailed properties such as account deduction ID, sequence, vendor information, memo, active dates, annual maximums, and various calculation methods. The response will indicate success with a 204 No Content status, or provide error statuses such as 401 Unauthorized, 400 Bad Request, or 403 Forbidden if there are issues with the request or permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Put Scheduled Earning Mass Add, Edit, Or Delete

ID: put_scheduled_earning_mass_add_edit_or_delete
Operation: write
Entities: scheduled earning, pay statement type, company
Summary: The 'Put Scheduled Earning Mass Add, Edit, Or Delete' API endpoint allows users to update one or more scheduled earnings for a specified company. The request requires a path parameter 'cid' which is the company identifier. The request body must include an array of scheduled earnings with details such as 'id', 'active_from', 'active_to', 'annual_max', 'target_compensation', 'pay_statement_type', 'sequence', 'amount', 'amount_readonly', 'min', 'max', 'frequency', and 'cost_centers'. The response will return a 204 status code if the update is successful, or error codes 400, 401, or 403 for various error conditions.
Input Fields: Input Fields
Output Fields: Output Fields

Put Schedules

ID: put_schedules
Operation: write
Entities: schedule, employee, company
Summary: The 'Put Schedules' API endpoint is used to update employees' schedules for a specified date range. The date range is required and must not exceed 31 days. The API replaces all existing data within the specified date range with the new data provided. The 'shift_num' parameter is optional and defaults to 1 if not provided. The API requires a path parameter 'cid' to identify the company. The request body must include the employee schedule details, including company short name, employee username, date range, and schedule details such as date, shift number, shift premium, type name, start time, cost center, workday breakdown, day type, and lunch details. The response includes the processing status of each item in the request, with possible errors detailed in the response body. The API returns various HTTP status codes to indicate the result of the request, including 200 for success, 400 for bad requests, and others for specific errors.
Input Fields: Input Fields
Output Fields: Output Fields

Put Security Question

ID: put_security_question
Operation: write
Entities: security question, account, company
Summary: The 'Put Security Question' API endpoint allows changing the security question for an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body must include the new security question and its answer. On success, it returns a 204 No Content response. If the user lacks access, a 403 Forbidden response is returned. A 404 Not Found response indicates the resource does not exist, and a 503 Service Unavailable response is returned if the call limit is exceeded, with the duration specified in the X-CallLimit-TimeToWait header.
Input Fields: Input Fields
Output Fields: Output Fields

Put Service Account

ID: put_service_account
Operation: write
Entities: service account, security profile, company
Summary: The Put Service Account API is used to update an existing service account. It requires the company ID (cid) and service account ID (id) as path parameters. The request body can include details such as username, password, external ID, locked status, security profile, service type, login permissions, company group IDs, edit permissions, and account group IDs. The API responds with a 204 No Content status if the update is successful. Possible error responses include 400 Bad Request, 500 Internal Server Error, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Skills

ID: put_skills
Operation: write
Entities: skill, employee, company
Summary: The Put Skills API is used to update the skills information of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body must include an array of employee skills, each containing a skill ID, level, years of experience, and optionally a primary flag. The API returns a 204 No Content response on successful update, indicating that the employee skills were successfully replaced. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put System Account

ID: put_system_account
Operation: write
Entities: account, system account, company
Summary: The Put System Account API is used to update the core system account information for a specified company and account. The API requires the company ID (cid) and account ID (aid) as path parameters. The request body can include various fields such as username, first name, last name, email addresses, phone numbers, address details, and profile information. The 'id' field in the request body will be ignored if included. The API returns different status codes based on the outcome, including 204 for successful updates, 400 for validation errors, 403 for security issues, 500 for internal server errors, 401 for unauthorized access, 404 for non-existent resources, and 503 when the call limit is exceeded.
Input Fields: Input Fields
Output Fields: Output Fields

Put Tax Information

ID: put_tax_information
Operation: write
Entities: employee, tax information, company
Summary: The Put Tax Information API is used to update the tax information of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body includes details such as employee tax type, pension box type, FEIN, DBA company name, and third-party sick pay option. The API responds with a 204 No Content status if the update is successful. Other possible responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Timesheet Action

ID: put_timesheet_action
Operation: write
Entities: timesheet, action, company
Summary: The Put Timesheet Action API allows performing actions on a timesheet based on its current state and user permissions. The API requires path parameters including the company ID (cid), timesheet ID (id), and the action name (action_name) to specify the action to be performed. The request body can optionally include a comment. The response includes the timesheet details such as ID, employee account ID, start and end dates, state, and editability, along with links to possible actions. The API returns various status codes including 200 for success, 400 for bad requests with user-friendly error messages, 403 for forbidden access, 404 for not found resources, and 503 for service unavailability due to call limits.
Input Fields: Input Fields
Output Fields: Output Fields

Update Leave of Absence Case

ID: put_update_leave_of_absence_case
Operation: write
Entities: leave of absence, case, company
Summary: This API endpoint is used to update a leave of absence case for a company. The company must have leave of absence functionality enabled. The request requires path parameters 'cid' (company ID) and 'id' (case ID). The request body includes details such as employee account ID, reason for leave, start and estimated end dates, and other case details. Several fields are read-only and cannot be updated. The response indicates the success or failure of the update operation, with possible status codes including 204 (No Content) for success, and various error codes for failure scenarios.
Input Fields: Input Fields
Output Fields: Output Fields

Put Vca Report Dialogs Settings

ID: put_vca_report_dialogs_settings
Operation: write
Entities: vca configuration, employee, company
Summary: The 'Put Vca Report Dialogs Settings' API updates the employee VCA configuration for report dialogs in notifications. It requires the company ID (cid) and account ID (aid) as path parameters. The API returns a response with a schema containing 'enabled', 'text', 'phone', and 'email' fields. Possible responses include 200 Ok, 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields

Put Vehicle Assignment

ID: put_vehicle_assignment
Operation: write
Entities: vehicle, vehicle assignment, company
Summary: The Put Vehicle Assignment API endpoint replaces a given vehicle assignment by its ID with a new one provided in the payload. It requires the company ID (cid) and the vehicle assignment ID (id) as path parameters. The request body must include details such as actual return date, issued odometer reading, issue date, issue value, lost or destroyed date, returned odometer reading, return condition, return value, scheduled return date, and vehicle details like code, color, description, inspection expiration, license plate number, license state, make, manufacture year, model, registration expiration, and VIN. The API responds with a 204 No Content status if successful, or various error statuses such as 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable depending on the situation.
Input Fields: Input Fields
Output Fields: Output Fields

Put Vehicle Assignment Action

ID: put_vehicle_assignment_action
Operation: write
Entities: vehicle assignment, action, company
Summary: The 'Put Vehicle Assignment Action' API allows performing actions such as marking a vehicle assignment as returned or lost/destroyed. It requires path parameters including 'cid' for the company identifier, 'id' for the vehicle assignment identifier, and 'action_name' for the action to perform. The request body can include 'comments', 'date', and 'status_change_to'. The API responds with a 204 No Content status if successful, or error statuses such as 403 Forbidden, 404 Not Found, or 503 Service Unavailable if there are issues.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Employee

ID: terminate_employee
Operation: write
Entities: employee, termiantion
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

Put Tax Information

ID: update_tax_for_employee
Operation: write
Entities: taxes
Summary: The Put Tax Information API is used to update the tax information of an employee. It requires the company ID (cid) and account ID (aid) as path parameters. The request body includes details such as employee tax type, pension box type, FEIN, DBA company name, and third-party sick pay option. The API responds with a 204 No Content status if the update is successful. Other possible responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
Input Fields: Input Fields
Output Fields: Output Fields