### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/pay-setup-overview Manages employee benefit setup details. ```APIDOC PUT /employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/cost-centers Endpoint for managing an employee's benefit setup. ```APIDOC Employee Benefit Setup API Endpoints: PUT /employee-benefit-setup - Add/update employee's benefit setup - Creates or updates an employee's benefit enrollment and configuration. ``` -------------------------------- ### WebLink API Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/docs/errors Manages employee benefit setup details. ```APIDOC Add/update employee's benefit setup: Method: PUT Description: Adds or updates an employee's benefit setup information. Reference: /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### WebLink API Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/new-hire-webhooks Manages the setup and updates of employee benefits within the system. ```APIDOC put Add/update employee's benefit setup ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/patch_compliance-v1-companies-companyid-clientonboarding-billing-billingcode Manages the setup and updates of employee benefit configurations. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup - Adds or updates an employee's benefit setup details. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/onboarding Allows for adding or updating an employee's benefit setup. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/get-company-specific-open-api-documentation Endpoint for managing an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/get_compliance-v1-companies-b6001-clientonboardings Endpoint for adding or updating an employee's benefit setup details. ```APIDOC PUT /employee-benefit-setup - Add/update employee's benefit setup - Adds or updates the benefit setup configuration for an employee. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/assessments-overview Endpoint for managing an employee's benefit setup information. ```APIDOC PUT /employee-benefits - Add/update employee's benefit setup: Creates or updates the benefit setup details for an employee. Parameters: - body: Benefit setup object including employee ID, benefit plan details, and enrollment status. ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/post_compliance-v1-companies-companyid-clientonboarding-billing Endpoint for managing an employee's benefit setup. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup - Adds or updates an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/delete_compliance-v1-companies-b6001-backgroundcheck-candidatescreeningorders-subscription-callbackid Endpoint for managing an employee's benefit setup. ```APIDOC Employee Benefit Setup API Endpoints: PUT - Add/update employee's benefit setup - Configures or updates an employee's benefit enrollment details. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/get_compliance-v1-companies-b6001-backgroundcheck-candidatescreeningorders-subscription Manages the setup and updates for employee benefits, providing control over benefit configurations. ```APIDOC PUT /integrations/reference/update-or-add-employee-benefit-setup: Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/client-onboarding-1 Endpoint for adding or updating an employee's benefit setup, managing their enrollment and plan details. ```APIDOC PUT Add/update employee's benefit setup: /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/employees API endpoint for managing an employee's benefit setup. ```APIDOC PUT /employee-benefits - Add/update employee's benefit setup - Description: Adds or updates the benefit setup details for an employee. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/delete_compliance-v1-companies-companyid-clientonboarding-billing-billingcode Enables adding or updating an employee's benefit setup. ```APIDOC PUT - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/post_compliance-v1-companies-b6001-backgroundcheck-candidatescreeningorders-subscription Endpoint for adding or updating an employee's benefit setup. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup - Adds or updates the benefit setup configuration for an employee. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/get-all-employees Endpoint for managing an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup - Add or update an employee's benefit setup. ``` -------------------------------- ### Manage Employee Benefit Setup via WebLink API Source: https://developer.paylocity.com/integrations/reference/subscription-1 Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup - Add or update an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/custom-fields API endpoint for managing employee benefit setup information within the Paylocity WebLink system. This includes operations to add or update benefit setup records. Specific parameters and return types are not detailed in the provided source. ```APIDOC Employee Benefit Setup API Endpoints: PUT Add/update employee's benefit setup - Description: Adds or updates an employee's benefit setup details. - Parameters: Not specified in the provided text. - Returns: Not specified in the provided text. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/get-earning-by-earning-code-and-start-date Endpoint for updating or adding an employee's benefit setup details. ```APIDOC Add/Update Employee's Benefit Setup: PUT /integrations/reference/update-or-add-employee-benefit-setup - Adds or updates an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/callback API endpoint for managing an employee's benefit setup. ```APIDOC Add/update employee's benefit setup (PUT) - Description: Adds new benefit setup details or updates existing ones for an employee. - Parameters: Not detailed in this overview. - Returns: Not detailed in this overview. ``` -------------------------------- ### Manage Employee Benefit Setup via WebLink API Source: https://developer.paylocity.com/integrations/reference/rate-limits API endpoint for adding or updating an employee's benefit setup. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup - Description: Adds or updates an employee's benefit setup details. ``` -------------------------------- ### Manage Employee Benefit Setup via WebLink API Source: https://developer.paylocity.com/integrations/reference/get-local-tax-by-tax-code API endpoint for adding or updating an employee's benefit setup details. ```APIDOC Add/update employee's benefit setup: PUT - Creates or modifies the benefit setup information for an employee. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/get_apihub-learningmanagementsystem-v1-companies-companyid-contents Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /integrations/reference/update-or-add-employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/post_compliance-v1-companies-b6001-clientonboarding-status Endpoint for adding or updating an employee's benefit setup details. ```APIDOC Add/update employee's benefit setup PUT /employee-benefits - Adds or updates an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/post_apihub-payroll-v1-companies-companyid-jobs Endpoint for adding or updating an employee's benefit setup details. ```APIDOC PUT /integrations/reference/update-or-add-employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/candidate-screening-order Manages the setup of employee benefits, allowing for updates or additions to benefit configurations. ```APIDOC PUT /employee-benefit-setup - Description: Add or update an employee's benefit setup. ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/rate-limits-weblink Manages the setup and updates of employee benefit configurations. This endpoint is used to modify or add benefit-related information for an employee. ```APIDOC PUT Add/update employee's benefit setup - Adds new or updates existing benefit setup details for an employee. ``` -------------------------------- ### Manage Employee Benefit Setup via WebLink API Source: https://developer.paylocity.com/integrations/reference/employee Endpoint to add or update an employee's benefit setup. -------------------------------- ### Get Employee Earning by Code and Start Date API Source: https://developer.paylocity.com/integrations/reference/get-earning-by-earning-code-and-start-date Documents the Paylocity API endpoint for retrieving a single earning record for a specific employee. The earning is identified by its code and start date. This API requires OAuth2 or Bearer token authentication. ```APIDOC GET https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate} - Description: Retrieves a single earning with the provided earning code and start date for the selected employee. - Parameters: - companyId: string (Path Parameter) - The ID of the company. - employeeId: string (Path Parameter) - The ID of the employee. - earningCode: string (Path Parameter) - The code of the earning. - startDate: string (Path Parameter) - The start date of the earning (e.g., YYYY-MM-DD). - Authentication: OAuth2, Bearer - Returns: The single earning record matching the criteria. ``` -------------------------------- ### API Reference: Get Employee Punch Details V2 Source: https://developer.paylocity.com/integrations/reference/employee-punch-details This entry provides the full specification for the GET Punch Detail V2 API endpoint. It includes the method signature, path and query parameters, and examples for filtering by date range. This API is crucial for accessing and analyzing detailed employee time records. ```APIDOC GET /apiHub/time/v2/companies/{companyId}/employees/{employeeId}/punchDetails Description: Retrieves detailed punch information for a specific employee within a company. Path Parameters: - companyId (string, required): The unique identifier for the company. - employeeId (string, required): The unique identifier for the employee. Query Parameters: - startDate (string, optional): The start date and time for filtering punch details. Format: YYYY-MM-DDTHH:MM:SS (e.g., "2024-03-05T00:00:00"). - endDate (string, optional): The end date and time for filtering punch details. Format: YYYY-MM-DDTHH:MM:SS (e.g., "2024-03-05T23:59:00"). Returns: Employee punch details, including punch times and non-work pay types with up to four decimals of precision. Usage Examples: - Filtering by Date Range: startDate={{relativeStartTime}}&endDate={{relativeEndTime}} - Example URL with parameters: /Time/v2/companies/{{companyId}}/employees/{{employeeId}}/punchdetails?startDate={{relativeStartTime}}&endDate={{relativeEndTime}} - Example Date Format: "startDate": "2024-03-05T00:00:00" "endDate": "2024-03-05T23:59:00" ``` -------------------------------- ### Partner Onboarding API Endpoints Source: https://developer.paylocity.com/integrations/reference/pay-setup-overview API endpoints for managing client onboarding statuses for partners. ```APIDOC GET /apihub-security-v1-companies-b6001-clientonboardings - Retrieves the onboarding status for clients. PUT /apihub-security-v1-companies-b6001-companyonboardingstatuses - Upserts (updates or inserts) the onboarding status for a company. ``` -------------------------------- ### Onboarding API Endpoints Source: https://developer.paylocity.com/integrations/reference/pay-setup-overview Handles the process of adding new employees to the onboarding system. ```APIDOC POST /onboarding - Add Employee to Onboarding ``` -------------------------------- ### WebLink API Company-Specific Schema Retrieval Source: https://developer.paylocity.com/integrations/reference/put_apihub-performancemanagement-v1-companies-companyid-assessmentpackages Retrieves the OpenAPI documentation specific to a company's configuration. This allows integrators to get a tailored API schema based on the company's setup. ```APIDOC GET /company-specific-openapi-documentation - Retrieve the company-specific OpenAPI documentation. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/add-or-update-an-employee-earning Endpoint for adding or updating an employee's benefit setup details. ```APIDOC Add/update employee's benefit setup PUT /integrations/reference/update-or-add-employee-benefit-setup - Adds or updates the benefit setup configuration for an employee. ``` -------------------------------- ### Manage Employee Recurring Earnings via Pay Setup API Source: https://developer.paylocity.com/integrations/reference/get_apihub-security-v1-companies-b6001-clientonboardings This API provides full control over employee recurring earnings, enabling creation, retrieval (batch and single), updates, and deletions. Operations are scoped by company and employee, using unique IDs and earning codes. Filtering capabilities are available for GET requests. ```APIDOC POST /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/earnings - Description: Creates a new recurring earning for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - Request Body: (JSON object representing the earning details) - Returns: Details of the created earning. GET /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/earnings - Description: Retrieves a batch of recurring earnings for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - Query Parameters: (Supports filtering, details not specified) - Returns: An array of employee earning objects. GET /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/earnings/{earningCode} - Description: Retrieves a single recurring earning by its code for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - earningCode: The code of the earning to retrieve. - Returns: A single employee earning object. GET /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{resourceId} - Description: Retrieves a single recurring earning by its resource ID for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - earningCode: The code of the earning. - resourceId: The unique resource ID of the earning. - Returns: A single employee earning object. PUT /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{resourceId} - Description: Updates an existing recurring earning by its resource ID for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - earningCode: The code of the earning to update. - resourceId: The unique resource ID of the earning. - Request Body: (JSON object with updated earning details) - Returns: Updated earning details. DELETE /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{resourceId} - Description: Deletes a recurring earning by its resource ID from an employee's record. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - earningCode: The code of the earning to delete. - resourceId: The unique resource ID of the earning. - Returns: No content on successful deletion. ``` -------------------------------- ### Manage Employee Recurring Deductions via Pay Setup API Source: https://developer.paylocity.com/integrations/reference/get_apihub-security-v1-companies-b6001-clientonboardings This API allows for comprehensive management of employee recurring deductions, including creation, retrieval (batch and single), updates, and deletions. Operations are performed at the company and employee level, identified by unique IDs and deduction codes. Filtering capabilities are available for GET requests. ```APIDOC POST /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/deductions - Description: Creates a new recurring deduction for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - Request Body: (JSON object representing the deduction details) - Returns: Details of the created deduction. GET /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/deductions - Description: Retrieves a batch of recurring deductions for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - Query Parameters: (Supports filtering, details not specified) - Returns: An array of employee deduction objects. GET /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode} - Description: Retrieves a single recurring deduction by its code for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - deductionCode: The code of the deduction to retrieve. - Returns: A single employee deduction object. GET /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{resourceId} - Description: Retrieves a single recurring deduction by its resource ID for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - deductionCode: The code of the deduction. - resourceId: The unique resource ID of the deduction. - Returns: A single employee deduction object. PUT /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{resourceId} - Description: Updates an existing recurring deduction by its resource ID for a specific employee. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - deductionCode: The code of the deduction to update. - resourceId: The unique resource ID of the deduction. - Request Body: (JSON object with updated deduction details) - Returns: Updated deduction details. DELETE /apihub-payroll-v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{resourceId} - Description: Deletes a recurring deduction by its resource ID from an employee's record. - Path Parameters: - companyId: The unique ID of the company. - employeeId: The unique ID of the employee. - deductionCode: The code of the deduction to delete. - resourceId: The unique resource ID of the deduction. - Returns: No content on successful deletion. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/updatelocaltax API endpoint for managing an employee's benefit setup. ```APIDOC Employee Benefit Setup API: PUT /employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/get_apihub-positionmanagement-v1-companies-companyid-positions API endpoint for managing an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup - Add or update an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/partner-onboarding Manages an employee's benefit setup. This endpoint is used to add or update the details of an employee's benefits package. ```APIDOC PUT /employee-benefits - Add or update an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/filtering-deductions-1 This section describes the API endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /employeebenefitsetup - Description: Add or update an employee's benefit setup. - Parameters: Not specified in this documentation. - Returns: Not specified in this documentation. ``` -------------------------------- ### WebLink API Onboarding Management Source: https://developer.paylocity.com/integrations/reference/post_compliance-v1-companies-b6001-backgroundcheck-candidatescreeningorders-subscription Endpoint for adding new employees to the onboarding process. ```APIDOC Add Employee to Onboarding: POST /integrations/reference/addonboarding - Initiates the onboarding process for a new employee. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/pay-entry-overview Endpoint for managing an employee's benefit setup details, enabling the addition or update of their benefit configurations. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup - Adds or updates an employee's benefit setup details. ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/get_documents_v1_companies_companyid_employeedocuments-1 Endpoint for adding or updating an employee's benefit setup details. ```APIDOC PUT /employee-benefit-setup - Add/update employee's benefit setup - Reference: /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### WebLink API Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/subscription API endpoint for managing employee benefit setup information within the Paylocity WebLink system. ```APIDOC Add/update employee's benefit setup: PUT ``` -------------------------------- ### WebLink API: General Information Source: https://developer.paylocity.com/integrations/reference/client-onboarding-1 Provides links to documentation for API authentication methods and rate limiting policies, essential for understanding API usage. ```APIDOC Authentication: /integrations/reference/authentication-weblink Rate Limits: /integrations/reference/rate-limits-weblink ``` -------------------------------- ### WebLink API Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/get_apihub-payroll-v1-companies-companyid-taxes Endpoint for managing an employee's benefit setup. ```APIDOC PUT /integrations/reference/update-or-add-employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/get_apihub-payroll-v1-companies-companyid-employees-employeeid-earnings-earningcode Endpoint to add or update an employee's benefit setup. ```APIDOC PUT: Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Onboarding Endpoints Source: https://developer.paylocity.com/integrations/reference/get-company-specific-open-api-documentation Endpoint for adding new employees to the onboarding process within WebLink. ```APIDOC POST /onboarding - Add Employee to Onboarding ``` -------------------------------- ### WebLink API: Employee Onboarding Source: https://developer.paylocity.com/integrations/reference/get_compliance-v1-companies-b6001-clientonboardings Endpoint for adding new employees to the onboarding process within the WebLink system. ```APIDOC POST /onboarding - Add Employee to Onboarding - Initiates the onboarding process for a new employee. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/get_apihub-corehr-v1-companies-companyid-costcentersandlevels Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /integrations/reference/update-or-add-employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/get-all-local-taxes Manages the setup and updates of employee benefit configurations. This endpoint is used to modify or add an employee's specific benefit plan details. ```APIDOC Employee Benefit Setup API Endpoints: PUT /employee-benefit-setup - Description: Add/update employee's benefit setup - Parameters: Not detailed in source. - Returns: Not detailed in source. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/get-all-direct-deposit Endpoint to add or update an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup/add-update - Description: Adds or updates an employee's benefit setup. ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/filtering-jobcodes Endpoint for managing an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup - Add or update an employee's benefit setup details. ``` -------------------------------- ### WebLink API: Employee Onboarding Source: https://developer.paylocity.com/integrations/reference/put_apihub-performancemanagement-v1-companies-b6001-assessmentorders-callback Endpoint for adding new employees to the onboarding process within WebLink. This facilitates the initial setup of new hires. ```APIDOC POST /v1/onboarding - Add Employee to Onboarding - Description: Initiates the onboarding process for a new employee. - Parameters: (Details not provided in source, typically includes employee details for onboarding) - Returns: (Details not provided in source, typically a confirmation or onboarding ID) ``` -------------------------------- ### WebLink API Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/errors Endpoint for adding or updating an employee's benefit setup details. ```APIDOC Employee Benefit Setup API Endpoints: PUT /employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### Partner Onboarding API Source: https://developer.paylocity.com/integrations/reference/new-hire-webhooks API endpoints for managing client onboarding statuses for partners. ```APIDOC GET /apihub-security-v1-companies-b6001-clientonboardings - Description: Get Onboarding Status PUT /apihub-security-v1-companies-b6001-companyonboardingstatuses - Description: Upsert Onboarding Status ``` -------------------------------- ### WebLink API: Onboarding Management Source: https://developer.paylocity.com/integrations/reference/pay-entry-overview Endpoint for adding new employees to the onboarding process within the WebLink system. This facilitates the initial setup of new hires. ```APIDOC Add Employee to Onboarding: POST /integrations/reference/addonboarding - Adds a new employee to the onboarding workflow. ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/deprecated_payentryv2_getpayentryimport Endpoint for managing an employee's benefit setup. ```APIDOC PUT /employee-benefits - Add or update an employee's benefit setup. ``` -------------------------------- ### Manage Client Onboarding and Billing Codes API Source: https://developer.paylocity.com/integrations/reference/pay-setup-overview Provides endpoints for managing client onboarding status, adding, retrieving, updating, and deleting billing codes associated with client onboarding processes. Includes both current and deprecated versions for billing code management. ```APIDOC Upsert Onboarding Status: POST /compliance-v1-companies-b6001-clientonboarding-status Add Billing Codes: POST /compliance-v1-companies-companyid-clientonboarding-billing Get Company Billing Codes: GET /compliance-v1-companies-companyid-clientonboarding-partner-billing Get client onboardings: GET /compliance-v1-companies-b6001-clientonboardings Update Billing Code Status: PATCH /compliance-v2-companies-companyid-clientonboarding-billingcode Delete Billing Code: DELETE /compliance-v2-companies-companyid-clientonboarding-billingcode [DEPRECATED] Updates Billing Code Status: PATCH /compliance-v1-companies-companyid-clientonboarding-billing-billingcode [DEPRECATED] Delete Billing Code: DELETE /compliance-v1-companies-companyid-clientonboarding-billing-billingcode ``` -------------------------------- ### WebLink API: Onboarding Endpoints Source: https://developer.paylocity.com/integrations/reference/get-all-local-taxes Facilitates the process of adding new employees to the WebLink onboarding system. This endpoint allows for the initiation of the onboarding workflow for new hires. ```APIDOC Onboarding API Endpoints: POST /onboarding - Description: Add Employee to Onboarding - Parameters: Not detailed in source. - Returns: Not detailed in source. ``` -------------------------------- ### Client Onboarding API Endpoints Source: https://developer.paylocity.com/integrations/reference/post_apihub_time_v2_companies_companyid_punchdetails This section outlines the API endpoints for managing client onboarding processes, including status updates, billing code management, and retrieval of onboarding information. The provided documentation only includes the HTTP method and endpoint path; detailed request/response schemas or parameter descriptions are not available in this source. ```APIDOC POST /compliance-v1-companies-b6001-clientonboarding-status - Upserts the onboarding status for a client. POST /compliance-v1-companies-companyid-clientonboarding-billing - Adds billing codes for a company's client onboarding. GET /compliance-v1-companies-companyid-clientonboarding-partner-billing - Retrieves company billing codes for client onboarding. GET /compliance-v1-companies-b6001-clientonboardings - Retrieves a list of client onboardings. PATCH /compliance-v2-companies-companyid-clientonboarding-billingcode - Updates the status of a specific billing code for client onboarding (V2). DELETE /compliance-v2-companies-companyid-clientonboarding-billingcode - Deletes a specific billing code for client onboarding (V2). PATCH /compliance-v1-companies-companyid-clientonboarding-billing-billingcode - [DEPRECATED] Updates the status of a specific billing code for client onboarding (V1). DELETE /compliance-v1-companies-companyid-clientonboarding-billing-billingcode - [DEPRECATED] Deletes a specific billing code for client onboarding (V1). ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/client-credentials API endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /employee-benefits - Add/update employee's benefit setup ``` -------------------------------- ### Partner Onboarding API Endpoints Source: https://developer.paylocity.com/integrations/reference/get-all-local-taxes Supports the management of client and company onboarding statuses for partners. ```APIDOC GET /apihub-security-v1-companies-b6001-clientonboardings - Retrieve the onboarding status for a client. PUT /apihub-security-v1-companies-b6001-companyonboardingstatuses - Create or update the onboarding status for a company. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/add-or-update-sensitive-data Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT Add/update employee's benefit setup - Adds or updates an employee's benefit setup details. ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/add-client-secret Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /api/employee-benefits - Add or update an employee's benefit setup. ``` -------------------------------- ### Manage Employee Benefit Setup via WebLink API Source: https://developer.paylocity.com/integrations/reference/getalldeductions This section describes the API endpoint for adding or updating an employee's benefit setup information. ```APIDOC Employee Benefit Setup API Endpoints: PUT /employee-benefit-setup - Add or update an employee's benefit setup. ``` -------------------------------- ### Manage Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference API endpoint for updating or adding an employee's benefit setup details. ```APIDOC PUT /employee-benefit-setup Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/webhooks-overview Endpoint for adding or updating an employee's benefit setup details. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/search-for-pay-rates API endpoint for managing an employee's benefit setup. ```APIDOC Add/update employee's benefit setup (PUT) - Endpoint: /employee-benefits - Description: Adds new benefit setup details or updates existing ones for an employee. ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/screening-package Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /employee-benefit-setup - Add or update an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Onboarding Source: https://developer.paylocity.com/integrations/reference/get_compliance-v1-companies-b6001-backgroundcheck-candidatescreeningorders-subscription Facilitates the process of adding new employees to the onboarding workflow within the Paylocity WebLink system. ```APIDOC POST /integrations/reference/addonboarding: Add Employee to Onboarding ``` -------------------------------- ### Manage Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/put_apihub-payroll-v1-companies-companyid-jobs-jobcode Endpoint to add or update an employee's benefit setup details. ```APIDOC PUT Add/update employee's benefit setup ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/post_documents_v1_companies_companyid_documents_documentid_downloads-1 Facilitates the addition or update of an employee's benefit setup information. ```APIDOC put /integrations/reference/update-or-add-employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### Manage Partner Client Onboarding Status Source: https://developer.paylocity.com/integrations/reference/addonboarding This API facilitates the management of client onboarding statuses for partners, allowing for retrieval and updates. ```APIDOC GET /apihub-security-v1-companies-b6001-clientonboardings - Get onboarding status PUT /apihub-security-v1-companies-b6001-companyonboardingstatuses - Upsert onboarding status ``` -------------------------------- ### Client Onboarding API Endpoints Source: https://developer.paylocity.com/integrations/reference/subscription-1 This section details the API endpoints for managing client onboarding processes, including status updates, billing code management, and retrieval of onboarding information. It includes both current and deprecated versions of some endpoints for backward compatibility. ```APIDOC Upsert Onboarding Status: POST /compliance/v1/companies/b6001/clientonboarding/status Add Billing Codes: POST /compliance/v1/companies/{companyId}/clientonboarding/billing Get Company Billing Codes: GET /compliance/v1/companies/{companyId}/clientonboarding/partner-billing Get Client Onboardings: GET /compliance/v1/companies/b6001/clientonboardings Update Billing Code Status: PATCH /compliance/v2/companies/{companyId}/clientonboarding/billingcode Delete Billing Code: DELETE /compliance/v2/companies/{companyId}/clientonboarding/billingcode [DEPRECATED] Update Billing Code Status: PATCH /compliance/v1/companies/{companyId}/clientonboarding/billing-billingcode [DEPRECATED] Delete Billing Code: DELETE /compliance/v1/companies/{companyId}/clientonboarding/billing-billingcode ``` -------------------------------- ### Partner Onboarding API Source: https://developer.paylocity.com/integrations/reference/rate-limits-weblink Provides endpoints for managing client onboarding statuses. ```APIDOC GET /apihub-security-v1-companies/b6001/clientonboardings - Description: Retrieves the onboarding status for a client. PUT /apihub-security-v1-companies/b6001/companyonboardingstatuses - Description: Upserts (updates or inserts) the onboarding status for a company. ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/get_documents_v1_companies_companyid_companydocuments-1 Facilitates the addition and update of employee benefit setup details. ```APIDOC PUT /employee-benefit-setup - Description: Adds or updates an employee's benefit setup. ``` -------------------------------- ### WebLink API: Employee Onboarding and Staging Source: https://developer.paylocity.com/integrations/reference/addonboarding API operations for adding new employees to the onboarding process and staging new employee records in WebLink. ```APIDOC Employee Onboarding & Staging API Endpoints: - Add Employee to Onboarding: POST /integrations/reference/addonboarding Description: Initiates the onboarding process for a new employee. - Add new employee to Web Link: POST /integrations/reference/add-new-employee-to-web-link Description: Adds a new employee record to the Web Link system. ``` -------------------------------- ### WebLink API Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/get_apihub-payroll-v1-companies-companyid-jobs Allows for the addition or update of an employee's benefit setup information. ```APIDOC Add/Update Employee's Benefit Setup: PUT /integrations/reference/update-or-add-employee-benefit-setup Description: Creates or modifies an employee's benefit enrollment and configuration. Parameters: (Refer to documentation for request body schema) ``` -------------------------------- ### WebLink API Onboarding Endpoints Source: https://developer.paylocity.com/integrations/docs/errors Facilitates adding new employees to the onboarding process. ```APIDOC Add Employee to Onboarding: Method: POST Description: Adds a new employee to the WebLink onboarding system. Reference: /integrations/reference/addonboarding ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/get_apihub-corehr-v1-companies-companyid-ratecodes Endpoint for adding or updating an employee's benefit setup. ```APIDOC PUT /integrations/reference/update-or-add-employee-benefit-setup (Add/update employee's benefit setup) ``` -------------------------------- ### Employee Staging API Endpoints Source: https://developer.paylocity.com/integrations/reference/pay-setup-overview Facilitates adding new employees to the Web Link staging area. ```APIDOC POST /employee-staging - Add new employee to Web Link ``` -------------------------------- ### WebLink API: Employee Onboarding Source: https://developer.paylocity.com/integrations/reference/get_apihub-learningmanagementsystem-v1-companies-companyid-contents Endpoint for adding new employees to the onboarding process. ```APIDOC POST /integrations/reference/addonboarding - Add Employee to Onboarding ``` -------------------------------- ### WebLink API: Employee Onboarding Source: https://developer.paylocity.com/integrations/reference/onboarding Facilitates adding new employees to the onboarding process. ```APIDOC Add Employee to Onboarding: POST /integrations/reference/addonboarding ``` -------------------------------- ### WebLink API: Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/paystatements Manages the setup of employee benefits within the system. This endpoint supports adding new benefit configurations or updating existing ones for employees. ```APIDOC Add/Update Employee's Benefit Setup: Method: PUT Description: Creates or modifies an employee's benefit setup details. Reference: /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### Employee Benefit Setup API Endpoints Source: https://developer.paylocity.com/integrations/reference/future-dated-change-webhooks Allows for the addition and update of an employee's benefit setup details. ```APIDOC PUT /employee-benefit-setup - Add or update an employee's benefit setup. ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/filtering-earnings-1 Facilitates the addition or update of an employee's benefit setup details. ```APIDOC PUT /employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/get_apihub_scheduling_v1_companies_companyid_shifts This section outlines the API endpoint for managing an employee's benefit setup. It supports operations to add or update benefit configurations for individual employees. ```APIDOC Employee Benefit Setup API Endpoints: PUT /employeebenefits - Description: Add or update an employee's benefit setup. - Parameters: - employeeId (string): The ID of the employee. - benefitSetup (object): The benefit setup details. - Returns: Success status. ``` -------------------------------- ### WebLink API: Employee Onboarding Source: https://developer.paylocity.com/integrations/reference/cost-centers Endpoint for adding new employees to the onboarding process within WebLink. ```APIDOC Onboarding API Endpoints: POST /onboarding - Add Employee to Onboarding - Initiates the onboarding process for a new employee. ``` -------------------------------- ### Client Onboarding API Endpoints Source: https://developer.paylocity.com/integrations/reference/get-all-local-taxes This section details the API endpoints for managing client onboarding processes, including status updates, billing code management, and retrieval of onboarding information. It also includes deprecated endpoints for reference. ```APIDOC Client Onboarding API: POST /compliance-v1-companies-b6001-clientonboarding-status - Upserts the onboarding status for a client. POST /compliance-v1-companies-companyid-clientonboarding-billing - Adds new billing codes for a company. GET /compliance-v1-companies-companyid-clientonboarding-partner-billing - Retrieves billing codes for a specific company. GET /compliance-v1-companies-b6001-clientonboardings - Retrieves a list of client onboardings. PATCH /compliance-v2-companies-companyid-clientonboarding-billingcode - Updates the status of an existing billing code. DELETE /compliance-v2-companies-companyid-clientonboarding-billingcode - Deletes a specific billing code. [DEPRECATED] PATCH /compliance-v1-companies-companyid-clientonboarding-billing-billingcode - Updates the status of an existing billing code (deprecated). [DEPRECATED] DELETE /compliance-v1-companies-companyid-clientonboarding-billing-billingcode - Deletes a specific billing code (deprecated). ``` -------------------------------- ### WebLink API: Employee Benefit Setup Source: https://developer.paylocity.com/integrations/reference/put_apihub-payroll-v1-companies-companyid-employees-employeeid-earnings-earningcode-resourceid Provides functionality to add or update an employee's benefit setup details. ```APIDOC PUT /employee-benefits - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API: Onboarding Endpoints Source: https://developer.paylocity.com/integrations/reference/put_apihub-performancemanagement-v1-companies-companyid-assessmentorders-subscription Handles the process of adding new employees to the onboarding system via the WebLink API. ```APIDOC POST /onboarding: Add Employee to Onboarding ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/put_apihub-corehr-v1-companies-companyid-costcenterlevels-level-costcenters-code Manages the setup of employee benefits, including adding or updating benefit configurations. ```APIDOC Add/update employee's benefit setup: PUT /integrations/reference/update-or-add-employee-benefit-setup ``` -------------------------------- ### WebLink API: Employee Benefit Setup Endpoints Source: https://developer.paylocity.com/integrations/reference/post_apihub_time_v2_companies_companyid_punchimport Endpoint for adding or updating an employee's benefit setup details. ```APIDOC Employee Benefit Setup API Endpoints: PUT /integrations/reference/update-or-add-employee-benefit-setup - Add/update employee's benefit setup ``` -------------------------------- ### WebLink API Employee Benefit Setup Management Source: https://developer.paylocity.com/integrations/reference/post_apihub-payroll-v1-companies-companyid-employees-employeeid-earnings Endpoint for adding or updating an employee's benefit setup details. ```APIDOC PUT /employees/{employeeId}/benefit-setup - Add or update an employee's benefit setup. - Parameters: - employeeId (string): The unique identifier for the employee. - Benefit setup details (object, e.g., plan ID, coverage level, effective date) - Returns: Confirmation or updated benefit setup object ```