# Worklio Embedded Payroll Documentation > Documentation for Worklio Embedded Payroll ## Guides: Quick Start - [Getting an API Access](https://apidocs.worklio.com/docs/getting-an-api-access.md): Every request to the Worklio API needs a bearer access token. To get one you need a developer account, your client credentials(credentials are shared in sandbox), and a token request against… - [Create a Company](https://apidocs.worklio.com/docs/create-a-company.md) - [Create a Company Bank Account](https://apidocs.worklio.com/docs/create-a-company-bank-account.md) - [Create an Employee](https://apidocs.worklio.com/docs/create-an-employee.md) - [Company Tax Setup](https://apidocs.worklio.com/docs/tax-setup-1.md) - [Employee Tax Setup](https://apidocs.worklio.com/docs/employee-tax-setup-2.md) - [Run Payroll](https://apidocs.worklio.com/docs/run-payroll-1.md) - [Front-End Library](https://apidocs.worklio.com/docs/front-end-library-1.md) ## Guides: Using The Api - [JSON Merge Patch](https://apidocs.worklio.com/docs/json-merge-patch-1.md) - [Address Validation API](https://apidocs.worklio.com/docs/address-validation-api.md) - [White-label UI (iFrames)](https://apidocs.worklio.com/docs/iframes-v2.md) - [Embedding the white-label UI (v2)](https://apidocs.worklio.com/docs/embedding-the-white-label-ui-v2.md) - [Embedding the white-label UI (v1, legacy)](https://apidocs.worklio.com/docs/embedding-the-white-label-ui-v1-legacy.md) - [Migrating from v1 to v2](https://apidocs.worklio.com/docs/migrating-from-v1-to-v2.md) - [iFrame events (postMessage)](https://apidocs.worklio.com/docs/iframe-events-postmessage.md) - [Worklio Admin iFrame API (Back Office embed)](https://apidocs.worklio.com/docs/worklio-admin-iframe-api-back-office-embed.md) - [Pagination, Filtering & Sorting](https://apidocs.worklio.com/docs/pagination.md) ## Guides: Time Off - [TimeOff Policies](https://apidocs.worklio.com/docs/timeoff-policies.md) - [Employee TimeOff Policy Setup](https://apidocs.worklio.com/docs/employee-timeoff-setup.md) - [TimeOff Types](https://apidocs.worklio.com/docs/timeoff-types.md) - [TimeOff Requests](https://apidocs.worklio.com/docs/timeoff-requests.md) ## Guides: Webhooks - [Webook Walkthrough](https://apidocs.worklio.com/docs/registering-a-webhook.md) - [WebHook Event Types](https://apidocs.worklio.com/docs/webhook-events.md) ## Guides: Users & Access Rights - [User Types](https://apidocs.worklio.com/docs/user-types.md) - [How to get API access](https://apidocs.worklio.com/docs/api-access-modes.md) ## Guides: Company Onboarding - [ Company Bank & Verification](https://apidocs.worklio.com/docs/bank-verification-integration-guide.md) ## Guides: Employee Self-Onboarding - [Employee Bank Account Verification With Plaid](https://apidocs.worklio.com/docs/employee-bank-account-verification-with-plaid.md): This guide describes the API sequence for adding an employee bank account and verifying it through Plaid. ## Guides: Payroll - [Banking](https://apidocs.worklio.com/docs/banking-1.md) ## Guides: System Calls - [White-label API Guide](https://apidocs.worklio.com/docs/white-label-api-guide.md) - [Custom Colors Data Structure](https://apidocs.worklio.com/docs/custom-colors.md) ## API Reference: User API - [Retrieves the current-user profile for API v1.0.](https://apidocs.worklio.com/reference/get_wep-me.md): Access: authenticated users only. The response contains login contact details, the highest current role, and company or employee access derived from the authenticated login. System-level… - [Updates the current user's phone number without a verification flow.](https://apidocs.worklio.com/reference/post_wep-me-phones.md): Access: authenticated users only. The supplied phone number is normalized before it is saved. The response returns the refreshed basic login profile after the phone update completes. - [Starts phone verification for the current user.](https://apidocs.worklio.com/reference/post_wep-me-phoneverify.md): Access: authenticated users only. The endpoint requests a phone verification flow for the supplied number and returns the refreshed basic login profile. - [Confirms a phone verification request by using the received verification code.](https://apidocs.worklio.com/reference/post_wep-me-phonecode.md): Access: authenticated users only. The supplied code is validated against the phone verification request for the authenticated login. The response returns the refreshed basic login profile… - [Starts email verification or an email change for the current user.](https://apidocs.worklio.com/reference/post_wep-me-emailverify.md): Access: authenticated users only. Set `verifyCurrent` to re-verify the current email address. Otherwise, provide the new email address together with the current password to start an… - [Confirms email verification or a pending email change by using a verification code.](https://apidocs.worklio.com/reference/post_wep-me-emailcode.md): Access: authenticated users only. The endpoint applies the verified email state for the authenticated login and returns the refreshed basic login profile. - [Changes the password for the authenticated login.](https://apidocs.worklio.com/reference/post_wep-me-password.md): Access: authenticated users only. The current password must match the existing login password. The endpoint returns HTTP 204 when the password is updated successfully. - [Changes the login email address for the authenticated login.](https://apidocs.worklio.com/reference/post_wep-me-login.md): Access: authenticated users only. The current password is required to authorize the email change. The endpoint returns HTTP 204 when the login email has been updated successfully. - [Retrieves the current user's person profile in a specific company context.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-me.md): Access: System, Admin, ClientAdmin, and Employee users. The response resolves the authenticated login against the supplied company and returns the person record that is… - [Generates a back-office SSO link for the current role.](https://apidocs.worklio.com/reference/get_wep-backoffice.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns a short-lived dashboard URL for the authenticated role. Successful links are valid for approximately… - [Lists capability definitions for a requested role type.](https://apidocs.worklio.com/reference/get_wep-role-type-capabilities.md): Access: System, Admin, ClientAdmin, and Employee users. The type query parameter accepts `system`, `super`, `admin`, or `employee`. The response contains the… - [Retrieves week-of-year information for the current role.](https://apidocs.worklio.com/reference/get_wep-me-week-of-year-info.md): Access: System, Admin, ClientAdmin, and Employee users. When date is omitted, the current date is resolved in the current role's time zone before the week metadata is… - [Lists capability codes that are enabled for the current Worklio instance.](https://apidocs.worklio.com/reference/get_wep-capabilities.md): Access: authenticated users only. The response aggregates supported capability codes from all registered capability providers and returns only the codes that are currently enabled on this… - [Lists the effective capabilities available to the current user in the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-me-capabilities.md): Access: System, Admin, ClientAdmin, and Employee users only. The response merges capabilities reported by all registered capability providers for the supplied company… - [Generates a back-office SSO link for another user's highest eligible admin or system role.](https://apidocs.worklio.com/reference/get_wep-backoffice-behalf-of-user.md): Access: PEO full-admin users only. The endpoint resolves the target user by email, selects the highest eligible admin or system role, and returns a back-office dashboard URL for that role.… ## API Reference: Company API - [MiddeskWebhook.](https://apidocs.worklio.com/reference/post_wep-middesk-webhook.md) - [Lists companies visible to the current caller.](https://apidocs.worklio.com/reference/get_wep-companies.md): Access: System, Admin, ClientAdmin, and Employee users. Broader administration roles can receive more than one company. Employee-scoped callers receive only companies… - [Create Company](https://apidocs.worklio.com/reference/post_wep-companies.md): Create company and set information about it. \ \ This endpoint can be called only by System level user. \ \ Newly created company is… - [Lists companies using the administration-focused projection.](https://apidocs.worklio.com/reference/get_wep-companies-list.md): Access: System and Admin users only. Use this endpoint when the consumer needs the expanded company list payload intended for administration scenarios. - [Gets the company profile for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid.md): Access: System, Admin, and ClientAdmin users with access to the company, plus employee users enabled by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. The… - [Update Company](https://apidocs.worklio.com/reference/patch_wep-companies-companyid.md): Update company and set information about it. \ \ This endpoint can be called only by System level user. \ \ Employee call will return… - [Block Company](https://apidocs.worklio.com/reference/post_wep-companies-companyid-block.md): Block company \ \ Only for internal use. This endpoint can be called only by Super level user. \ When company is blocked, company cannot start new… - [Block Status](https://apidocs.worklio.com/reference/get_wep-companies-companyid-block.md): Returns if company is blocked and reason. \ \ When company is blocked, company cannot start new payrolls and move payrolls forward/back \ \ - [Unblock Company](https://apidocs.worklio.com/reference/post_wep-companies-companyid-unblock.md): Unblock company \ \ Only for internal use. This endpoint can be called only by Super level user. \ When company is blocked, company cannot start new… - [Request Policy](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employee-request-policies.md): Gets Policy for Employee Requests under company. \ \ This endpoint can be called only by System and Admin level users. \ - [Save Request Policy](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employee-request-policies.md): Create or Update Policy for Employee Requests. \ \ This endpoint can be called only by System and Admin level users. \ - [Lists help and support contacts available for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-help-contacts.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The response is filtered by the visibility configured on each contact. Employees… - [Lists the help and support contact categories configured for the company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-help-contacts-types.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The returned identifiers are used by `supportContactTypeIds` on help and support… - [Get Current Tax Setup](https://apidocs.worklio.com/reference/get_wep-companies-companyid-taxsetup-1.md): Retrieves current company tax setup. \ Returned data contains federal, state, and local tax setup. \ Tax setup is effective dated due legal consequences. Please be aware… - [Update Tax Setup Values](https://apidocs.worklio.com/reference/post_wep-companies-companyid-taxsetup-1.md): Updates current company tax setup. \ Call requires array of TaxValues as source. \ TaxId, type and validation info are returned from System and Admin level users. \ \… - [Create Bank Account](https://apidocs.worklio.com/reference/post_wep-companies-companyid-bankaccounts.md): Create bank account and set information about it. \ This endpoint can be called only by System and Admin level users. \ \ Employee… - [Get Bank Account](https://apidocs.worklio.com/reference/get_wep-companies-companyid-bankaccounts-accountid.md): Retrieves bank account information for specified accountId parameter. \ This endpoint can be called only by System and Admin level users. \ \… - [Update Bank Account](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-bankaccounts-accountid.md): Update bank account and set information about it. \ This endpoint can be called only by System and Admin level users. \ \ Employee… - [Return list of signed and unsigned documents](https://apidocs.worklio.com/reference/get_wep-companies-companyid-signdocs.md) - [Return selected document](https://apidocs.worklio.com/reference/get_wep-companies-companyid-signdocs-docid.md) - [Upload file with signed document](https://apidocs.worklio.com/reference/post_wep-companies-companyid-signdocs-docid-upload.md) - [Sign file of the document using signature string and stores it](https://apidocs.worklio.com/reference/post_wep-companies-companyid-signdocs-docid-sign.md) - [Lists divisions for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-divisions-1.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The endpoint returns company divisions only when the divisions feature is enabled for… - [Lists positions configured for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-positions.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. Each item contains the company position together with its default workers'… - [Creates a new company position.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-positions.md): Access: System, Admin, and ClientAdmin users only. The supplied default workers' compensation code is validated against the company configuration before the position is… - [Updates an existing company position.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-positions-positionid.md): Access: System, Admin, and ClientAdmin users only. The request replaces the editable position fields with the values supplied in the payload and validates any submitted… - [Deletes a company position.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-positions-positionid.md): Access: System, Admin, and ClientAdmin users only. On success the position is removed from the company and the endpoint returns no response body. - [Gets metadata for the company root folder or a specific company document subfolder.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-folders-folderid.md): Access: System, Admin, and ClientAdmin users only. When folderId is omitted, the endpoint returns the root folder assigned to the company. When it is supplied, the endpoint… - [Gets the immediate child folders and documents stored in a company document folder.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-folders-folderid-items.md): Access: System, Admin, and ClientAdmin users only. The response can contain both folder entries and document entries. Folder entries contain folder identity fields only, while… - [Gets the employee documents that are visible to the current caller for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-documents.md): Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. Employee callers can only retrieve documents they are allowed to see for themselves. Admin-level… - [Uploads a new document for an employee and returns the stored document metadata.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-documents.md): Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. This endpoint consumes `multipart/form-data`. The uploaded file is required and files larger than 20 MB… - [Gets a single employee document together with download and signature status metadata.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-documents-docid.md): Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. The route must identify a document that belongs to the specified employee within the specified company.… - [Deletes an employee document.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-documents-docid.md): Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. The document must belong to the supplied employee and company. Admin-level callers also need document… - [Gets the recorded signature audit entries for an employee document.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-documents-docid-signatures.md): Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. The response describes who signed the document and how the signature was captured. The endpoint returns… - [Records a signature entry for an employee document.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-documents-docid-sign.md): Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. Provide either a signature image file or a textual signature in signByText. The signature is stored as… - [Get list of Companies for EWA](https://apidocs.worklio.com/reference/get_wep-companies-ewalist.md): Gets list of companies for EWA partner. \ \ System level users can see more than one company in output, Admin and Employee level users will see only… - [EWA Status for the Company/](https://apidocs.worklio.com/reference/get_wep-companies-companyid-ewa.md) - [EWA Widget for Company Admins](https://apidocs.worklio.com/reference/get_wep-companies-companyid-ewa-widget.md) - [Returns connection URL for Affix bridge](https://apidocs.worklio.com/reference/get_wep-connections-affixapi-auth.md): Retrieve connection URL for Affix bridge to start data migration process for specified companyId parameter. \ \ This endpoint can be called only by System level… - [Returns connection URL for Affix bridge for specified company](https://apidocs.worklio.com/reference/get_wep-companies-companyid-connections-affixapi-auth.md): Retrieve connection URL for Affix bridge to start data migration process for specified companyId parameter. \ \ This endpoint can be called only by System level… - [Issues access token with user identity from SCU (state param from authentication) for Affix bridge](https://apidocs.worklio.com/reference/get_wep-connections-affixapi-token.md): Retrieve connection URL for Affix bridge to start data migration process for specified companyId parameter. \ \ This endpoint can be called only by System level… - [Get name of the bank by routing number](https://apidocs.worklio.com/reference/get_wep-banking-routing-routingnum.md): Returns name of the bank by routing number. If an exact match is found, it will return name of the bank. If it doesn't find an exact match, it tries to search by prefix with more than 5… - [Get bank provider configuration for specified bank account](https://apidocs.worklio.com/reference/get_wep-companies-companyid-bankprovider-accountid.md): Retrieve bank operation provider configuration for specified companyId and bankAccountId parameters. \ \ This endpoint can be called only by System and Admin… - [Create or Update bank operation provider configuration for specified bank account](https://apidocs.worklio.com/reference/post_wep-companies-companyid-bankprovider-accountid.md): Create or Update bank operation provider configuration for specified companyId and bankAccountId parameter. \ \ This endpoint can be called only by System and… - [Get bank provider configuration for specified bank account with prefilled missing data](https://apidocs.worklio.com/reference/get_wep-companies-companyid-bankprovider-accountid-prefill.md): Retrieve the bank provider configuration based on the specified companyId and bankAccountId parameters. If the configuration record is missing or incomplete, the system evaluates the gaps and… - [Sign bank provider approval preview document for specified bank account](https://apidocs.worklio.com/reference/post_wep-companies-companyid-bankprovider-accountid-sign.md): Sign bank provider approval preview document. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call… - [Get Bank Setup Status](https://apidocs.worklio.com/reference/get_wep-companies-companyid-banksetup.md): Retrieve Bank Setup status including detailed information about all accounts. - [Get Bank Onboarding Obsolete](https://apidocs.worklio.com/reference/get_wep-companies-companyid-bankonboarding.md): Retrieve Bank Setup status including detailed information about all accounts. - [Lists bulletin messages visible for the current caller in the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-bulletin-messages.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. Employee and client-admin callers receive only messages visible to their audience.… - [Adds or removes bulletin message status flags for the current caller.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-bulletin-messages-id-statuses.md): Access: ClientAdmin and Employee users only. The request can add flags, remove flags, or do both in a single call. The response returns the message with the recalculated… - [Lists HR integrations available for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-integrations-hr.md): Access: System, Admin, and ClientAdmin users only. Each item describes an HR integration option together with its display name, sort order, and current activation status for… - [Get Estimated Annual Wage](https://apidocs.worklio.com/reference/post_wep-companies-companyid-estimatedannualwage.md) - [Get Estimated Annual Wage](https://apidocs.worklio.com/reference/post_wep-companies-companyid-policies-policyid-estimatedannualwage.md) - [Lists calendar events for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-events.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The result combines events from all registered event providers. When fromDate is… - [Lists event types that can appear in the company calendar.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-event-types.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The response combines event type definitions reported by all registered event… - [Returns holiday calendar events visible for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-calendar-events.md): Access: System, Admin, and ClientAdmin users only. The response combines: company-specific records, inherited client copies of master records, and master records… - [Creates a company-specific holiday calendar event.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-calendar-events.md): Access: System, Admin, and ClientAdmin users only. This endpoint creates only client-specific records (no master linkage). Business validation includes date… - [Partially updates an existing company holiday event.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-calendar-events-eventid.md): Access: System, Admin, and ClientAdmin users only. PATCH behavior is partial: only explicitly sent fields are updated; omitted fields keep current values. Master records… - [Soft-deletes a company holiday event.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-calendar-events-eventid.md): Access: System, Admin, and ClientAdmin users only. Deletion is logical (row status update), not physical remove. Master records cannot be deleted through company… - [Creates a company copy of a master holiday event.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-calendar-events-copy-master.md): Access: System, Admin, and ClientAdmin users only. Creates an inherited company record linked to the specified master event. Only `ApplyTimeOff` and `Description`… - [Downloads Holiday Calendar import template for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-calendar-events-import-template.md): Access: System, Admin, and ClientAdmin users only. Template variant is selected by company brand setting `IBrands.IsGlobalHrEnable`: `ImportHoliday_Global.xlsx`… - [Imports Holiday Calendar events from XLSX file.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-calendar-events-import.md): Access: System, Admin, and ClientAdmin users only. Request format is `multipart/form-data` with file field `file`. Import is create-only (existing records are not… - [Returns all Holiday Groups for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-holiday-groups.md): Access: System, Admin, and ClientAdmin users only. Only groups in status `Valid` or `InSetup` are returned; `Deleted` groups are excluded. Results are sorted by… - [Creates a new Holiday Group in `InSetup` status for the specified company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-holiday-groups.md): Access: System, Admin, and ClientAdmin users only. Required fields: `name`, `payCodeId`, `compensationMins`. The `payCodeId` is validated for company ownership,… - [Returns the detail of a single Holiday Group including Step 1, Step 2, and Step 3 data.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-holiday-groups-groupid.md): Access: System, Admin, and ClientAdmin users only. Only groups in status `Valid` or `InSetup` are returned. Response includes `groupInfo`, `holidaySelection`, and… - [Partially updates a Holiday Group (Step 1, Step 2, and/or Step 3 data).](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-holiday-groups-groupid.md): Access: System, Admin, and ClientAdmin users only. PATCH behavior is partial: only explicitly sent sections/fields are updated; omitted sections keep current values.… - [Deletes a Holiday Group](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-holiday-groups-groupid.md): Access: System, Admin, and ClientAdmin users only. The operation is idempotent: deleting an already-deleted group returns `204`. - [Publishes a Holiday Group by transitioning its status from `InSetup` to `Valid`.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-holiday-groups-groupid-publish.md): Access: System, Admin, and ClientAdmin users only. Full validation of all mandatory fields (Step 1 + Step 3) is enforced before the transition. The `payCodeId`… - [Lists E-Verify cases for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-e-verify-cases.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns the company's active E-Verify cases together with their case reference target and current workflow… - [Gets the effective E-Verify setup for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-e-verify.md): Access: System, Admin, and ClientAdmin users only. The response contains the company-level E-Verify credentials, activation state, and whether the company overrides the… - [Creates or updates the company E-Verify setup.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-e-verify.md): Access: System, Admin, and ClientAdmin users only. The submitted credentials are validated before they are saved. The response returns the persisted setup after the save… - [Activates or deactivates the company E-Verify setup.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-e-verify-activations.md): Access: System, Admin, and ClientAdmin users only. The request updates the active flag and whether the company should keep using its own setup instead of the instance-level… - [Lists helpful links visible to the current caller.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-helpful-links.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The list is filtered by the link visibility assigned to each record and includes the… - [Creates a helpful link for the specified company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-helpful-links.md): Access: System, Admin, and ClientAdmin users only. The request defines the link title, URL, optional note, and target audience. The response returns the created link including… - [Gets a single helpful link visible to the current caller.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-helpful-links-id.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The requested link must belong to the selected company and be visible for the current… - [Updates a helpful link for the specified company.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-helpful-links-id.md): Access: System, Admin, and ClientAdmin users only. This endpoint consumes JSON Merge Patch. Properties omitted from the payload remain unchanged; properties present in the… - [Reorders helpful links for the specified company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-helpful-links-order.md): Access: System, Admin, and ClientAdmin users only. The request body supplies the desired ordered list of helpful link identifiers. The response returns the refreshed helpful… - [List of HR Custom Fields](https://apidocs.worklio.com/reference/get_wep-companies-companyid-hr-fields.md): List of HR Custom Fields.\ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \ \ Employee… - [Create HR Custom Field](https://apidocs.worklio.com/reference/post_wep-companies-companyid-hr-fields.md): Create HR Custom Field. \ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \ \ Employee… - [Get HR Custom Field](https://apidocs.worklio.com/reference/get_wep-companies-companyid-hr-fields-id.md): Get HR Custom Fields. \ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \ \ Employee call… - [Update existing custom field. If exist user data under existing Custom Field then existing Custom Field will be deleted and system creates new Custom Field.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-hr-fields-id.md): Update existing custom field. \ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \ \… - [Delete HR Custom Field](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-hr-fields-id.md): Delete HR Custom Field. \ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \ \ Employee… - [Order HR Custom Fields](https://apidocs.worklio.com/reference/post_wep-companies-companyid-hr-fields-order.md): Order HR Custom Fields. \ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \ \ Employee… - [List of Field Values for current HR Custom Field across all employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-hr-fields-values.md): List of Field Values for current HR Custom Field across all employees. \ \ This endpoint can be called only by System and Admin and ClientAdmin level… - [Set status of HR Custom Field - Activate or Deactivate it](https://apidocs.worklio.com/reference/put_wep-companies-companyid-hr-fields-id-status.md): Set status of HR Custom Field - Activate or Deactivate it. \ \ This endpoint can be called only by System and Admin and ClientAdmin level users. \… - [Lists supported identity document collection types.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-id-collection-types.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The response describes the document types and page-count rules required when creating… - [Get Kotapay configuration for specified bank account](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kotapay-accountid.md): Retrieve Kotapay configuration for specified companyId and bankAccountId parameters. \ \ This endpoint can be called only by System and Admin level users. \… - [Create or Update Kotapay configuration for specified bank account](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kotapay-accountid.md): Create or Update Kotapay configuration for specified companyId and bankAccountId parameter. \ \ This endpoint can be called only by System and Admin level… - [Get Kotapay configuration for specified bank account with prefilled missing data](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kotapay-accountid-prefill.md): Retrieve the Kotapay configuration based on the specified companyId and bankAccountId parameters. If the configuration record is missing or incomplete, the system evaluates the gaps and provides… - [Sign Kotapay preview document for specified bank account](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kotapay-accountid-sign.md): Sign Kotapay preview document. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [Get KYC configuration for specified companyId parameter.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc.md): Retrieve KYC configuration for specified companyId parameter. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Create or Update KYC configuration.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc.md): Create or Update KYC configuration for specified companyId parameter. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Verify company for KYC.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-verify.md): Verify company for KYC. \ \ This endpoint can be called only by System level users. \ \ Employee call will return Forbidden result even for… - [Process company for KYC.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-process.md): Process company for KYC. Set status processing for sending to approval. \ \ This endpoint can be called only by System level users. \ \… - [Get list of documents for KYC](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-documents.md): Retrieves list of documents. \ Returned data contains document information. \ \ This endpoint can be called only by System and Admin level users.… - [Create document.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-documents.md): Create document. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden result… - [Get list of documents for KYC](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-signatories-signatoryid-documents.md): Retrieves list of documents. \ Returned data contains document information. \ \ This endpoint can be called only by System and Admin level users.… - [Create Signatory document .](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-signatories-signatoryid-documents.md): Create document for Signatory. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [Get document for KYC](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-documents-documentid.md): Retrieves document. \ Returned data contains document information. \ \ This endpoint can be called only by System and Admin level users. \… - [Delete document.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-kyc-documents-documentid.md): Delete document. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden result… - [Get signatory document for KYC](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-signatories-signatoryid-documents-documentid.md): Retrieves document. \ Returned data contains document information. \ \ This endpoint can be called only by System and Admin level users. \… - [Delete Signatory document.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-kyc-signatories-signatoryid-documents-documentid.md): Delete document. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden result… - [Get list of document types.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-documenttypes.md): Retrieves list of document types by scope (Key property can be used to create document). \ Returned data contains document type information. \ \ This endpoint… - [Get set of document configurations.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-documenttypes-key.md): Retrieves set of document configurations by key parameter (key can be obtained from API method companies/{companyId:int}/kyc/documenttypes). \ Document can contain one or more… - [Verify company document for KYC.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-documents-documentid-verify.md): Verify company document for KYC. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [Get list of signatories for KYC](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-signatories.md): Retrieves list of signatories. \ Returned data contains signatory information. \ \ This endpoint can be called only by System and Admin level… - [Create signatory](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-signatories.md): Create signatory. \ Returned data contains signatory information. \ \ This endpoint can be called only by System and Admin level users. \… - [Get signatory for KYC](https://apidocs.worklio.com/reference/get_wep-companies-companyid-kyc-signatories-signatoryid.md): Retrieves signatory. \ Returned data contains signatory information. \ \ This endpoint can be called only by System and Admin level users. \… - [Update signatory](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-kyc-signatories-signatoryid.md): Update signatory. \ Returned data contains signatory information. \ \ This endpoint can be called only by System and Admin level users. \… - [Delete signatory](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-kyc-signatories-signatoryid.md): Delete signatory. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden… - [Verify signatory for KYC.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-signatories-signatoryid-verify.md): Verify signatory for KYC. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [Verify signatory document for KYC.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-kyc-signatories-signatoryid-documents-documentid-verify.md): Verify signatory document for KYC. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will… - [Gets the active NPS survey for the current full-administration context.](https://apidocs.worklio.com/reference/get_wep-nps.md): Access: System and Admin users only. The response returns the active survey identifier and first question for the current role. When no survey is available, the response object… - [Gets the active NPS survey for the specified company context.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-nps.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The response returns the active survey identifier and first question for the current… - [Casts a vote for the active NPS survey in the full-administration context.](https://apidocs.worklio.com/reference/post_wep-nps-surveyid.md): Access: System and Admin users only. The rating is required and the comment is optional. The response contains the survey vote result returned by the NPS service. - [Casts a vote for the active NPS survey in the specified company context.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-nps-surveyid.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. The rating is required and the comment is optional. The response contains the survey… - [Skips the active NPS survey for the specified company context.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-nps-surveyid-skip.md): Access: System, Admin, ClientAdmin, and Employee users with access to the company. When the skip is recorded successfully, the endpoint returns no response body. - [Get the organization structure including unassigned employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-orgstruct.md): Access: System, Admin, ClientAdmin, and Employee users only. Gets the organization structure list with all nodes (employees assigned in the org. structure), where the… - [Create new empty organizational structure](https://apidocs.worklio.com/reference/post_wep-companies-companyid-orgstruct.md): Access: System, Admin, and ClientAdmin users only. Creates a new empty organizational structure for the specified company and returns its effective date. - [Add (an unassigned) employee to the organizational structure](https://apidocs.worklio.com/reference/put_wep-companies-companyid-orgstruct-employeeid.md): Access: System, Admin, and ClientAdmin users only. Adds an unassigned employee to the organizational structure. When an organization structure does not exist, it is created… - [Move an existing node in the organizational structure](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-orgstruct-nodeid.md): Access: System, Admin, and ClientAdmin users only. Moves an existing organizational structure node under a new parent node. - [Remove an employee from the organizational structure](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-orgstruct-nodeid.md): Access: System, Admin, and ClientAdmin users only. Removes an employee node from the organizational structure and optionally removes its subordinate nodes. - [Add subordinate employees under the employee node assigned in the organizational structure](https://apidocs.worklio.com/reference/post_wep-companies-companyid-orgstruct-nodeid-subordinates.md): Access: System, Admin, and ClientAdmin users only. Adds subordinate employees under an existing employee node in the organizational structure. - [Swap employees in the organizational structure](https://apidocs.worklio.com/reference/post_wep-companies-companyid-orgstruct-nodeid-swap.md): Access: System, Admin, and ClientAdmin users only. Swaps the employee assigned to an existing organizational structure node. - [List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-mine.md): List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are… - [List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-mine-history.md): List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are… - [List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-mine.md): List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are… - [List of Pulse Survey Definitions created by logged user (as author)](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-created.md): List of Pulse Survey Definitions created by logged user (as author). \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the… - [List of Pulse Survey Definitions created by logged user (as author)](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-created-history.md): List of Pulse Survey Definitions created by logged user (as author). \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the… - [List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-mine-history.md): List of Pulse Survey Definitions created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are… - [List of Pulse Surveys](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse.md): List of Pulse Surveys received by logged user for answering. \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the limit,… - [List of Pulse Surveys](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-history.md): List of Pulse Surveys received by logged user for answering. \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the limit,… - [List of Pulse Surveys as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-assigned.md): List of Pulse Surveys assigned to logged user as editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the limit, output… - [List of Pulse Surveys as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-assigned-history.md): List of Pulse Surveys assigned to logged user as editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the limit, output… - [List of Pulse Surveys as Reviewer](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-review.md): List of Pulse Surveys assigned to logged user as reviewer. \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the limit, output… - [List of Pulse Surveys as Reviewer](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-review-history.md): List of Pulse Surveys assigned to logged user as reviewer. \ This endpoint supports paging by specifying fromId and limit. \ If there are more surveys than the limit, output… - [Get Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-definition.md): Get Pulse Survey Definition. - [Update Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-pulse-surveyid-definition.md): Updates Pulse Survey Definition. - [Delete Pulse Survey Definition](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-surveys-pulse-surveyid-definition.md): Deletes Pulse Survey Definition. - [Get Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-definition.md): Get Pulse Survey Definition. - [Create Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-definition.md): Creates Pulse Survey Definition and returns newly created ID as part of response. - [Publish Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyid-publishdefinition.md): Publishes Pulse Survey Definition. Sets StartDate property and performs necessary checks during the process. - [Finish Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyid-finishdefinition.md): Finishes Pulse Survey Definition. Sets status as finished (closed - ended). - [Change Pulse Survey Definition Deadline](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyid-deadline.md): Changes Pulse Survey Definition deadline. The deadline can only be extended. - [Get List of Selection (assignment definition) for Receivers of current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-receivers.md): Get List of Selection (assignment definition) for Receivers of current Pulse Survey Definition. The list can be used to update the list of receivers. - [Update List of Receivers for Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-pulse-surveyid-receivers.md): Update List of Receivers for Pulse Survey Definition. - [Get List of Receivers for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-listreceivers.md): Get List of Receivers for current Pulse Survey Definition. - [Get List of selection (assignment definition) for Editors of current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-editors.md): Get List of selection (assignment definition) for Editors of current Pulse Survey Definition. The list can be used to update the list of editors. - [Update List of Editors for Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-pulse-surveyid-editors.md): Update List of Editors for Pulse Survey Definition. - [Get List of Editors for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-listeditors.md): Get List of Editors for current Pulse Survey Definition. - [Get List of Selection (assignment definition) for Receivers of current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-receivers.md): Get List of Selection (assignment definition) for Receivers of current Pulse Survey Definition. The list can be used to update the list of receivers. - [Get List of Questions for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-questions.md): Get List of Questions for current Pulse Survey Definition. - [Update List of Receivers for Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-surveyid-receivers.md): Update List of Receivers for Pulse Survey Definition. - [Create Question for current Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyid-questions.md): Create Question for current Pulse Survey Definition. - [Get Question for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-questions-questionid.md): Get Question for current Pulse Survey Definition. - [Get List of Receivers for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-listreceivers.md): Get List of Receivers for current Pulse Survey Definition. - [Update Question for current Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-pulse-surveyid-questions-questionid.md): Update Question for current Pulse Survey Definition. - [Delete Question in current Pulse Survey](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-surveys-pulse-surveyid-questions-questionid.md): Delete Question in current Pulse Survey. - [Order List of Questions for current Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyid-questions-order.md): Order List of Questions for current Pulse Survey Definition. - [Get List of selection (assignment definition) for Editors of current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-editors.md): Get List of selection (assignment definition) for Editors of current Pulse Survey Definition. The list can be used to update the list of editors. - [Get Summary Answers for all Questions in current Pulse Survey](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-results.md): Get Summary Answers for all Questions in current Pulse Survey. - [Update List of Editors for Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-surveyid-editors.md): Update List of Editors for Pulse Survey Definition. - [Get Summary and Data of Employee Answers for current Question](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-results-questionid.md): Get Summary and Data of Employee Answers for current Question. - [Get results of Pulse Survey for employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-employeesresults.md): Get results of Pulse Survey for employees. - [Get List of Editors for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-listeditors.md): Get List of Editors for current Pulse Survey Definition. - [Get part of results of Pulse Survey - number of receivers that completed survey over time.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyid-results-completionrate.md): Number of receivers that completed survey over time. Each number is calculated as a sum of the previous numbers. - [Get survey](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-surveyvalueid.md): Gets survey detail with questions to be used for answering the questions or displaying reactions. - [Save survey answers](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyvalueid.md): Save answers for survey questions. - [Get List of Questions for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-questions.md): Get List of Questions for current Pulse Survey Definition. - [Create comment to survey answer](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyvalueid-questions-questionid-comment.md): Creates comment to survey answer. \ \ - [Create Question for current Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-surveyid-questions.md): Create Question for current Pulse Survey Definition. - [Create reaction to survey answer](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyvalueid-questions-questionid-react-reactionkey.md): Creates reaction to survey answer. \ \ - [Create reaction to comment to survey answer](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-surveyvalueid-questions-questionid-comment-threadid-react-reactionkey.md): Creates reaction to comment survey answer. \ \ - [List of Survey Templates created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-templates.md): List of Survey Templates created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are more… - [Get Question for current Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-questions-questionid.md): Get Question for current Pulse Survey Definition. - [Update Question for current Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-surveyid-questions-questionid.md): Update Question for current Pulse Survey Definition. - [Delete Question in current Pulse Survey](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-surveys-surveyid-questions-questionid.md): Delete Question in current Pulse Survey. - [Copies survey templates from a company into the master template set.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-templates-copyto-templatecompanyid.md) - [Order List of Questions for current Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-surveyid-questions-order.md): Order List of Questions for current Pulse Survey Definition. - [Get List of valid Users which can be assigned as Editors of Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-validusers.md): Get List of valid Users which can be assigned as Editors for Pulse Survey Definition. - [Get Summary Answers for all Questions in current Pulse Survey](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-results.md): Get Summary Answers for all Questions in current Pulse Survey. - [Get Summary and Data of Employee Answers for current Question](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-results-questionid.md): Get Summary and Data of Employee Answers for current Question. - [Get results of Pulse Survey for employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-employeesresults.md): Get results of Pulse Survey for employees. - [Get part of results of Pulse Survey - number of receivers that completed survey over time.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyid-results-completionrate.md): Number of receivers that completed survey over time. Each number is calculated as a sum of the previous numbers. - [Get survey](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-surveyvalueid.md): Gets survey detail with questions to be used for answering the questions or displaying reactions. - [Save survey answers](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-surveyvalueid.md): Save answers for survey questions. - [Create comment to survey answer](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-surveyvalueid-questions-questionid-comment.md): Creates comment to survey answer. \ \ - [Create reaction to survey answer](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-surveyvalueid-questions-questionid-react-reactionkey.md): Creates reaction to survey answer. \ \ - [Create reaction to comment to survey answer](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-surveyvalueid-questions-questionid-comment-threadid-react-reactionkey.md): Creates reaction to comment survey answer. \ \ - [List of Survey Templates created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-templates-history.md): List of Survey Templates created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \ If there are more… - [List of Pulse Survey Templates created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-pulse-templates.md): List of Pulse Survey Templates created by logged user (as author) or assigned as Editor. This endpoint supports paging by specifying fromId and limit. \ If there are more… - [Create Pulse Survey Definition from Template](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-pulse-fromtemplate-templateid.md): Creates Pulse Survey Definition from Template and returns newly created ID as part of response. The surevy will be created as draft. - [List of Planned Survey Templates created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-planned-templates.md): List of Planned Survey Templates created by logged user (as author) or assigned as Editor. This endpoint supports paging by specifying fromId and limit. \ If there are more… - [Create Planned Survey Definition from Template](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-planned-fromtemplate-templateid.md): Creates Planned Survey Definition from Template and returns newly created ID as part of response. The surevy will be created as draft. - [Get Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-planned-surveyid-definition.md): Get Pulse Survey Definition. - [Update Pulse Survey Definition](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-planned-surveyid-definition.md): Updates Pulse Survey Definition. This results to the plan being executed and new surveys created - unless saveAsDraft is set. - [Create Pulse Survey Definition](https://apidocs.worklio.com/reference/post_wep-companies-companyid-surveys-planned-definition.md): Creates Pulse Survey Definition and returns newly created ID as part of response. - [Preview first planned survey instance start+end dates.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-planned-preview.md): Updates Pulse Survey Definition. - [Pause Planned Pulse Survey](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-planned-surveyid-pause.md): Pauses Planned Pulse Survey so it no longer creates surveys. - [Unpause Planned Pulse Survey](https://apidocs.worklio.com/reference/put_wep-companies-companyid-surveys-planned-surveyid-unpause.md): Unpauses Planned Pulse Survey to resume creating surveys. - [List of Planned Surveys Definitions (and their runs) created by logged user (as author) or assigned as Editor](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-planned.md): List of Planned Surveys Definitions (and their runs) created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId and limit. \… - [List of Planned Survey instances created from selected survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-planned-surveyid.md): List of Planned Survey instances created from selected survey Definition created by logged user (as author) or assigned as Editor. \ This endpoint supports paging by specifying fromId… - [Get List of valid Users which can be assigned as Editors of Pulse Survey Definition](https://apidocs.worklio.com/reference/get_wep-companies-companyid-surveys-validusers.md): Get List of valid Users which can be assigned as Editors for Pulse Survey Definition. - [Returns company-level Team EE onboarding counts over a date-range timeline.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-team-onboarding-counts-timeline.md): Access: System, Admin, and ClientAdmin users only. This endpoint counts `EEOnboarding` rows by onboarding type and lifecycle; it is not equivalent to the Team… - [Returns company-level team workforce-activity counts over a date-range timeline.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-team-workforce-activity-counts-timeline.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns aggregate counts only. It never exposes employee IDs, names, SSNs, emails, addresses, total… - [Returns company-level team workforce counts over a date-range timeline.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-team-workforce-counts-timeline.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns aggregate counts only. It never exposes individual employee identifiers, names, SSNs, emails,… - [Returns company-level current-day Team workforce counts.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-team-workforce-counts.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns aggregate counts only for valid `ClientEmployee` rows in the requested company. It never… - [Returns window-aware filter values for Team workforce counts.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-team-workforce-counts-filter-values.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns one complete, deterministic value set for the workforce-counts filter dimensions over the… ## API Reference: Company Structure API - [Returns work locations for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-worklocations-1.md): Access: System, Admin, and ClientAdmin users with access to the company, plus employee users enabled by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute. Returns… - [Creates a company work location.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-worklocations-1.md): Access: System, Admin, and ClientAdmin users only. Creates a new company work location from the supplied code, name, and address fields. If address validation can suggest a… - [Returns a single work location for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-worklocations-wlocationid-1.md): Access: System, Admin, and ClientAdmin users only. Returns the requested work location together with its business code, display name, address data, and default-location flag.… - [Partially updates an existing company work location.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-worklocations-wlocationid-1.md): Access: System, Admin, and ClientAdmin users only. Uses PATCH semantics: only properties present in the request body are applied; omitted properties keep their current… - [Deletes a company work location.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-worklocations-wlocationid.md): Access: System, Admin, and ClientAdmin users only. Deletes the specified work location and applies the supplied delete options, including the effective date and optional… - [Streams per-item results for creating work locations in bulk.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-worklocations-bulk.md): Access: System, Admin, and ClientAdmin users only. Accepts a JSON array of create payloads and returns a streamed JSON array of… - [Streams per-item results for updating work locations in bulk.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-worklocations-bulk.md): Access: System, Admin, and ClientAdmin users only. Accepts a JSON object whose property names are work location identifiers and whose values are PATCH payloads. Each payload… - [Get list of Company Departments](https://apidocs.worklio.com/reference/get_wep-companies-companyid-departments.md): Retrieves list of company departments. \ Returned data contains department information. \ Manager is ID of company employee. Department doesn't need to have manager.… - [Create Company Department](https://apidocs.worklio.com/reference/post_wep-companies-companyid-departments.md): Create company department. \ Returned data contains newly created department information. \ Manager is ID of company employee. Department doesn't need to have manager and… - [Get Company Department](https://apidocs.worklio.com/reference/get_wep-companies-companyid-departments-departmentid.md): Retrieves company department. \ Returned data contains department information. \ Manager is ID of company employee. Department doesn't need to have manager. \… - [Update Company Department](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-departments-departmentid.md): Update company department. \ Returned data contains updated department. \ Manager is ID of company employee. Department doesn't need to have manager and you can null.… - [Delete Department](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-departments-departmentid.md): Deletes a company department and assigns all employee in the department to a new department(if provided) This endpoint can be called only by System and Admin… - [Get list of Employees of selected Division](https://apidocs.worklio.com/reference/get_wep-companies-companyid-divisions-divisionid-employees.md): Gets list of employees having the division set in their contracts to selected one. \ \ ... - [Get Company Division information](https://apidocs.worklio.com/reference/get_wep-companies-companyid-divisions-divisionid.md): Retrieve division information for specified companyId and divisionId parameters. \ \ ... - [Update Company Division](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-divisions-divisionid.md): Update company and set information about it. \ \ ... - [Delete Division](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-divisions-divisionid.md): Deletes a division and assigns all employee in the division to a new division(if provided) This endpoint can be called only by System and Admin level users. \… - [Activate Company Divisions](https://apidocs.worklio.com/reference/post_wep-companies-companyid-activatedivisions.md) - [Create Company Division](https://apidocs.worklio.com/reference/post_wep-companies-companyid-divisions.md): Create company and set information about it. \ \ ... - [Create Company Division by Bulk](https://apidocs.worklio.com/reference/post_wep-companies-companyid-divisions-bulk.md): Create company and set information about it. \ \ ... - [Update Company Division Bulk](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-divisions-bulk.md): Update company and set information about it. \ \ ... ## API Reference: Employee API - [Lists employees for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees.md): Access: System, Admin, ClientAdmin, and Employee users. Employee callers receive only the employee-safe subset of the employee contract. Administrative callers can… - [Creates a new employee for the specified company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees.md): Access: System, Admin, and ClientAdmin users only. When payroll address validation suggests a corrected address, the endpoint responds with HTTP 400 and an `AddressFix_v10`… - [Creates a new contract for the employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-contracts.md): Access: System, Admin, and ClientAdmin users only. The employee must belong to the specified company. The created contract is returned as the public contract DTO. - [Lists employees assigned to the specified department.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-departments-departmentid-employees.md): Access: System, Admin, and ClientAdmin users only. Use this endpoint when the consumer needs department-scoped employee results instead of the full company employee list. - [Gets the full employee record for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid.md): Access: System, Admin, ClientAdmin, the employee's manager, and the employee themself. The returned contract includes employee-owned nested objects such as contract, login,… - [Partially updates an existing employee record.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid.md): When the request contains a Login block, the endpoint links the employee to the normalized Login e-mail. In Default LinkMode, a clean employee with Login.Email and omitted or null Login.AccessLevel… - [Terminates the specified employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-terminate.md): Access: System, Admin, and ClientAdmin users only. The termination payload controls the effective termination date and optional downstream handling such as deduction coverage… - [Sends an application invitation email to an existing employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-email-invitation.md): Access: System, Admin, and ClientAdmin users only. The invitation is sent to the employee's personal email by default, or to the work email when useWorkEmail is true. The… - [Checks whether the employee is in the current or future organizational structure for a given date.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-terminate-check-org-structure-fordate.md): Access: System, Admin, and ClientAdmin users only. The endpoint evaluates both membership in the organization chart and whether the employee serves as a manager on the… - [Gets the employee's sensitive personal data.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-sensitive-personal-data.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the employee's unmasked SSN or FEIN representation together with the birth date after verifying that the… - [Gets the employee avatar photo metadata.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-avatar.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the file token needed to download or render the employee avatar together with fallback initials. - [Uploads a new employee avatar photo.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-avatar.md): Access: System, Admin, ClientAdmin, and Employee users. Submit the image file as multipart form data. When provided, uploadedPicture supplies the crop rectangle that… - [Gets the employee profile image metadata.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-profileimage.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the file token needed to download or render the employee profile image together with fallback initials. - [Uploads a new employee profile image.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-profileimage.md): Access: System, Admin, ClientAdmin, and Employee users. Submit the image file as multipart form data. When provided, uploadedPicture supplies the crop rectangle that… - [Gets the employee's timezone information.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-timezone.md): Access: System, Admin, ClientAdmin, the employee's manager, and the employee themself. Returns the current timezone identifier together with the display name, abbreviation,… - [Updates the employee's timezone selection.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-timezone.md): Access: System, Admin, ClientAdmin, and Employee users. The request payload supplies the timezone identifier to persist. The response returns the refreshed timezone… - [Gets the employee's emergency contact information.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-emergency-info.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the current emergency contact record when one exists; otherwise the endpoint responds with HTTP 204 and… - [Creates or updates the employee's emergency contact information.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-emergency-info.md): Access: System, Admin, ClientAdmin, and Employee users. The supplied contact data replaces the stored emergency contact record for the employee. When the save… - [Updates the employee's consent for electronic W-2 delivery.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-w2-delivery-consent.md): Access: System, Admin, ClientAdmin, and Employee users. The employer remains responsible for enabling electronic delivery. This endpoint stores whether the employee… - [Permanently removes an employee record.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid.md): Access: PEO Full Admin only. This endpoint is intended for forced cleanup scenarios. Optional query flags can target only HR data or only onboarding data when forced employee removal is… - [Creates multiple employees for the specified company as a streamed response.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-bulk.md): Access: System, Admin, and ClientAdmin users only. This endpoint streams one result per requested employee. Each streamed item contains either the created employee detail or… - [Updates the employee's W-2 contact name and mailing address.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-w2-contact.md): Access: System, Admin, and ClientAdmin users with `AdvanceAccess.ChangeW2Address`. This updates tax-form delivery data used for W-2 generation. It does not accept or change… - [Get Current Tax Setup](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-taxsetup-1.md): Retrieves current employee tax setup. \ Returned data contains federal and state tax setup. \ Tax setup is effective dated due legal consequences. Please be aware that user… - [Update Tax Setup Values](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-taxsetup-1.md): Updates current employee tax setup. \ Call requires array of TaxValues as source. \ TaxId, type and validation info are returned from Employee users allowed by the `AllowEmployee` policy. The response contains the active contract and any future-dated contract versions available for the requested employee or… - [Lists historical contracts for the employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-contracts-history.md): Access: Employee users allowed by the `AllowEmployee` policy. The response returns prior contract versions so API consumers can inspect historical employment terms for the requested… - [Gets the contract effective for the requested date.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-contract.md): Access: Employee users allowed by the `AllowEmployee` policy. When effectiveDate is omitted, the endpoint returns the currently effective contract. When a date is supplied, the contract… - [Gets one contract by identifier.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-contracts-id.md): Access: Employee users allowed by the `AllowEmployee` policy. The contract must belong to the employee and company identified in the route. - [Partially updates an existing contract.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-contracts-id.md): Access: System, Admin, and ClientAdmin users only. The endpoint reads the submitted JSON body through `PatchValueHelper` so omitted fields remain unchanged while supplied… - [Deletes an existing contract.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-contracts-id.md): Access: System, Admin, and ClientAdmin users only. The contract must belong to the specified employee and company. On success the endpoint returns `204 No Content`. - [Lists all 1099 forms available for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-f1099s.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Each list item includes the tax year, payer name, employee reference, and the download token for the… - [Gets the most recent 1099 form available for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-f1099.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Use this endpoint when the consumer needs the latest 1099 form without first enumerating historical… - [Gets a specific 1099 form for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-f1099s-formid.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Use the formId returned by the list endpoint to retrieve a single historical 1099 form. - [Lists all W-2 forms available for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-w2s.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Returns one item per available W-2 year together with the download token for the generated file. - [Gets the most recent W-2 form available for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-w2.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Use this endpoint when the consumer needs the latest W-2 without first enumerating all historical forms. - [Gets a specific W-2 form for the specified employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-w2s-w2id.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Use the w2Id value returned by the list endpoint to retrieve a single W-2 form with all available tax… - [Lists HR custom-field values for the employee form.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-hr-fields.md): Access: System, Admin, ClientAdmin, and eligible Employee users. The response contains the field definitions together with the employee-specific stored value for each… - [Saves multiple HR custom-field values for the employee form.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-hr-fields.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Submit the set of field/value pairs that should be stored for the employee. The response returns the… - [Saves a single HR custom-field value for the employee form.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-hr-fields-fieldid.md): Access: System, Admin, ClientAdmin, and eligible Employee users. This operation updates one field identified by fieldId for the employee form. - [Lists identity-document collections for an employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-id-collection.md): Access: System, Admin, ClientAdmin, and eligible Employee users. The endpoint returns the document collections already uploaded for the employee. A payment-required… - [Creates a new identity-document collection for an employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-id-collection.md): Access: System, Admin, and ClientAdmin users only. Submit the document metadata and up to four page files as multipart form data. Page 1 is required; additional pages are… - [Gets one identity-document collection for an employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-id-collection-id.md): Access: System, Admin, ClientAdmin, and eligible Employee users. Returns the document metadata together with page download tokens. If the document exists but has no… - [Deletes an identity-document collection for an employee.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-id-collection-id.md): Access: System, Admin, and ClientAdmin users only. The document is marked as deleted through business logic. A payment-required response is returned when the feature is… - [Updates employee visibility for an identity-document collection.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-id-collection-id-visibility.md): Access: System, Admin, and ClientAdmin users only. Use this endpoint to change the access level granted to the employee for the selected document collection. - [Replaces one uploaded page in an identity-document collection.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-id-collection-id-page-pageno.md): Access: System, Admin, and ClientAdmin users only. Submit a single JPG or PNG file for the specified page number. The endpoint returns the refreshed document detail after the… - [Gets the employee's scheduled working time for the current day.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-working-hours.md): Access: System, Admin, ClientAdmin, the employee's manager, and the employee themself. The response describes the daily working-time value configured for the requested… - [Gets the employee's pending address-change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-address.md): Access: Employee users only. If no waiting request exists, the endpoint falls back to the employee's current residential address. If neither is available, the endpoint returns `204 No… - [Creates or replaces the employee's pending address-change request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-address.md): Access: Employee users only. The country and state combination is validated against the employee's legislative profile before the request is stored. - [Deletes the employee's pending address-change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-address.md): Access: Employee users only. Only waiting address-change requests are removed. - [Gets the employee's pending contact-information change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-contactinfo.md): Access: Employee users only. If no waiting request exists, the endpoint returns the employee's current personal and company contact values. If no values can be resolved, the endpoint… - [Creates or replaces the employee's pending contact-information change request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-contactinfo.md): Access: Employee users only. Phone numbers are normalized before the request is stored. The response returns the saved request payload. - [Deletes the employee's pending contact-information change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-contactinfo.md): Access: Employee users only. Only waiting contact-information requests are removed. - [Lists employee self-service requests.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests.md): Access: Employee users only. The response contains communication-module requests for the employee, ordered from newest to oldest, including status, request type, and completion metadata… - [Gets the employee's pending emergency-contact change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-emergencyinfo.md): Access: Employee users only. If no waiting request exists, the endpoint returns the employee's current emergency-contact information. If no information is available, the endpoint returns… - [Creates or replaces the employee's pending emergency-contact change request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-emergencyinfo.md): Access: Employee users only. Phone numbers are normalized before the request is stored. The response returns the saved request payload. - [Deletes the employee's pending emergency-contact change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-emergencyinfo.md): Access: Employee users only. Only waiting emergency-contact requests are removed. - [Gets the employee's pending general-information change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-general.md): Access: Employee users only. If no waiting request exists, the endpoint returns the employee's current general profile values, including optional W-2 electronic-consent information when… - [Creates or replaces the employee's pending general-information change request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-general.md): Access: Employee users only. For US employees, citizenship is required. The response returns the saved request payload after the waiting request is created. - [Deletes the employee's pending general-information change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-general.md): Access: Employee users only. Only waiting general-information requests are removed. - [Gets the employee's pending name-change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-name.md): Access: Employee users only. If no waiting request exists, the endpoint returns the employee's current name values. If no values can be resolved, the endpoint returns `204 No Content`. - [Creates or replaces the employee's pending name-change request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-name.md): Access: Employee users only. The saved request echoes back the normalized name payload that will be reviewed by the employer. - [Deletes the employee's pending name-change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-name.md): Access: Employee users only. Only waiting name-change requests are removed. - [Gets the employee's pending net-pay-allocation change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-netpayallocation.md): Access: Employee users only. The payload reflects the waiting request currently stored for the employee. If no request exists, the endpoint returns `204 No Content`. - [Creates or replaces a pending change request for an existing net-pay allocation.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-netpayallocation.md): Access: Employee users only. The request targets an existing salary-allocation record identified by `data.Id`. Unless overwrite is requested, an unrelated pending request causes the call to… - [Creates or replaces a pending request for a new net-pay allocation.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-requests-netpayallocation.md): Access: Employee users only. The request stores full bank-account information in the waiting request. Unless overwrite is requested, an existing pending request prevents creation of another… - [Deletes the employee's pending net-pay-allocation change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-netpayallocation.md): Access: Employee users only. Only waiting net-pay-allocation requests are removed. - [Gets the employee's pending question request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-questions.md): Access: Employee users only. The endpoint returns the currently waiting free-form question submitted by the employee, if any. - [Creates or replaces a pending request to remove a net-pay allocation.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-requests-netpayallocation-remove.md): Access: Employee users only. The request references an existing salary-allocation record and marks it for removal as of the supplied end date. - [Creates or replaces the employee's pending question request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-questions.md): Access: Employee users only. The endpoint stores a free-form employee message as a waiting request and returns the saved payload. - [Deletes the employee's pending question request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-questions.md): Access: Employee users only. Only waiting question requests are removed. - [Gets the employee's pending identification-number change request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-requests-ssn.md): Access: Employee users only. The returned payload is formatted according to the employee's legislative profile, for example SSN, FEIN, or national ID. - [Creates or replaces the employee's pending identification-number change request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-requests-ssn.md): Access: Employee users only. The submitted identification type must match the employee's legislative setup. The response returns the saved request payload in the public DTO format. - [Deletes the employee's pending identification-number change request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-requests-ssn.md): Access: Employee users only. Only waiting identification-number requests are removed. - [Creates or replaces a pending net-pay-allocation request that references an employee bank account.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-requests-netpayallocation-account.md): Access: Employee users only. Version 2.0 accepts a bank-account identifier instead of raw account details. The endpoint resolves the account through employee bank-account logic and copies… - [Lists bank accounts available for the employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-bankaccounts.md): Access: System, Admin, ClientAdmin, and Employee users. The response includes validated employee bank accounts plus ACH salary-allocation accounts that are not already… - [Creates a new bank account for the employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-bankaccounts.md): Access: System, Admin, ClientAdmin, and Employee users. The employee must belong to the specified company. The created account is returned using the public v2.0… - [Gets one bank account for the employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-bankaccounts-id.md): Access: System, Admin, ClientAdmin, and Employee users. The account must belong to the requested employee and be available through the employee bank-account business… - [Deletes a bank account for the employee.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-bankaccounts-id.md): Access: System, Admin, ClientAdmin, and Employee users. The bank account must belong to the requested employee and company. On success the endpoint responds with `204… ## API Reference: Employee Self-Onboarding API - [Returns the onboarding templates that can be used for the company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-templates-1.md): Access: System, Admin, and ClientAdmin users only. The response contains only valid templates that can be selected when creating a new onboarding. - [Creates a new onboarding and returns the initial setup workflow metadata.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-onboarding-start-1.md): Access: System, Admin, and ClientAdmin users only. This endpoint supports standard onboarding creation, rehire onboarding creation, and ATS-driven onboarding initialization.… - [Saves the employer-entered basic employee information for phase 1.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-eebasicinfo-1.md): Access: System, Admin, and ClientAdmin users only. The request stores the employee's identifying setup data and validates onboarding-type-specific country and SSN rules before… - [Returns the saved basic employee information for phase 1.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-eebasicinfo-1.md): Access: System, Admin, and ClientAdmin users only. The payload includes the current field values together with setup-step navigation metadata. - [Saves phase-1 employment basics such as hire dates and distribution settings.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-employmentbasic-1.md): Access: System, Admin, and ClientAdmin users only. Validation depends on whether the onboarding is for a new hire or a rehire. The returned navigation payload… - [Returns the saved phase-1 employment basics for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-employmentbasic-1.md): Access: System, Admin, and ClientAdmin users only. The request requires the basic employee-information step to be completed before employment details can be loaded. - [Saves detailed U.S. employment settings for the onboarding.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-employmentdetail-1.md): Access: System, Admin, and ClientAdmin users only. This endpoint validates compensation, workers' compensation, payroll-policy, and referenced entity selections before… - [Returns saved detailed U.S. employment settings for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-employmentdetail-1.md): Access: System, Admin, and ClientAdmin users only. The previous employment-basic step must already contain data before this step can be loaded. - [Saves detailed global-employment settings for the onboarding.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-employmentdetail-global.md): Access: System, Admin, and ClientAdmin users only. This variant is only valid for global onboardings and enforces global compensation and pay-period rules.… - [Returns saved detailed global-employment settings for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-employmentdetail-global.md): Access: System, Admin, and ClientAdmin users only. The previous employment-basic step must already contain data before this step can be loaded. - [Returns employer-side HR custom fields for the phase-1 setup step.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-hr-fields.md): Access: System, Admin, and ClientAdmin users only. The response contains the active HR-field definitions for the company together with any values already staged for the… - [Saves phase-1 HR custom-field values and advances the onboarding step state.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-hr-fields.md): Access: System, Admin, and ClientAdmin users only. Unlike the draft-save endpoint, this operation persists the values and lets the onboarding workflow treat the HR-fields step… - [Saves phase-1 HR custom-field values without completing the step.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-hr-fields-data.md): Access: System, Admin, and ClientAdmin users only. Use this endpoint to persist draft HR-field values while keeping the onboarding on the same setup step. Field… - [Returns which employee personal-information fields are currently required.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-personalinfoee-meta.md): Access: System, Admin, and ClientAdmin users only. The response resolves required-field names from the employee personal-information step and already-known onboarding values. - [Prefills the employee personal-information step from the employer side.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-personalinfoee.md): Access: System, Admin, and ClientAdmin users only. The endpoint lets the employer seed or correct personal-information fields that the employee later sees in phase 2.… - [Returns which employee contact-information fields are currently required.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-contactinfoee-meta.md): Access: System, Admin, and ClientAdmin users only. The required-field list is resolved from the onboarding template's contact-info step settings. - [Prefills the employee contact-information step from the employer side.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-contactinfoee.md): Access: System, Admin, and ClientAdmin users only. This endpoint stores employer-supplied contact details that phase 2 can start from. When requested, the… - [Returns custom client-admin access settings for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-settings-cca.md): Access: System, Admin, and ClientAdmin users only. This endpoint determines whether the onboarding process is visible to all CCAs or only to a specific list of client users.… - [Updates custom client-admin access settings for the onboarding.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-onboarding-start-id-settings-cca.md): Access: System, Admin, and ClientAdmin users only. This endpoint allows updating the visibility of an onboarding process for CCAs. If access is not limited, all… - [Downloads the default Word template for onboarding documents.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-document-template.md): Access: System, Admin, and ClientAdmin users only. The downloaded file can be customized offline and then uploaded as a document-template step attachment. - [Lists active onboarding document templates configured for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-documents.md): Access: System, Admin, and ClientAdmin users only. The response includes only valid document templates associated with the onboarding template currently assigned to the record. - [Uploads a new onboarding document template.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-onboarding-start-id-documents.md): Access: System, Admin, and ClientAdmin users only. Only `.docx` files are accepted. The uploaded document is stored together with the selected signing-field… - [Returns a single onboarding document template with its download token and required custom fields.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-start-id-documents-documentid.md): Access: System, Admin, and ClientAdmin users only. The file content is not streamed by this endpoint; use the returned file token with the file APIs when the document itself… - [Updates metadata and required custom fields for an onboarding document template.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-start-id-documents-documentid.md): Access: System, Admin, and ClientAdmin users only. The document binary is not replaced here; only the display name, note, and required custom-field flags are updated. - [Soft-deletes an onboarding document template.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-onboarding-start-id-documents-documentid.md): Access: System, Admin, and ClientAdmin users only. If the deleted document was the last active document template, the onboarding document-step state can change as a result. - [Completes the setup document step and returns the next required onboarding step.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-onboarding-start-id-documents-finish.md): Access: System, Admin, and ClientAdmin users only. The response contains the same navigation contract used by other setup endpoints so the client can continue the phase-1… - [Returns employee-facing HR custom fields for phase 2 onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-ee-ercu-hr-fields.md): Access: Anonymous users with a valid onboarding link token. The response combines the active HR field definitions with values already saved for the onboarding. Read-only… - [Saves employee-provided HR custom field values for phase 2 onboarding.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-ee-ercu-hr-fields.md): Access: Anonymous users with a valid onboarding link token. Only fields that are writable for the employee can be persisted. The request is validated against the current active… - [Returns the employee HR-field answers for employer-side review.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-overview-id-hr-fields.md): Access: System, Admin, and ClientAdmin users only. This endpoint exposes the same employee HR-field values collected during phase 2, but for the employer review screen.… - [Finalizes the onboarding and creates the employee record.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-finish-1.md): Access: System, Admin, and ClientAdmin users only. This endpoint can run only after all employee steps are approved and the onboarding is in the employer verification phase. - [Returns the employee's net-pay allocation records for verification.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-netpay-1.md): Access: System, Admin, and ClientAdmin users only. The payload resolves prenote defaults and payroll timing information so the verifier can review ACH behavior without… - [Marks the net-pay verification step as completed.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-netpay-1.md): Access: System, Admin, and ClientAdmin users only. Use this after reviewing or updating all required net-pay allocation rows. - [Returns document-signing previews and signature requirements for verification.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-docreview-1.md): Access: System, Admin, and ClientAdmin users only. The preview pages are returned as inline base64 image strings so the client can render every document that still requires… - [Completes the document-signing verification step.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-docreview-finish-1.md): Access: System, Admin, and ClientAdmin users only. If the onboarding requires an employer signature, the request must specify the signature mode and, for electronic… - [Returns the list of handwritten documents that can or must be uploaded.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-docupload-1.md): Access: System, Admin, and ClientAdmin users only. The response identifies every document type that is currently visible in the manual-upload wizard and whether a file has… - [Uploads a manually signed or handwritten document for the verification workflow.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-onboarding-finalize-id-docupload-upload-type-1.md): Access: System, Admin, and ClientAdmin users only. The file is stored against the workflow step implied by the requested document type and completes the manual-upload artifact… - [Returns preview images for Form 8850.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-form885-preview-1.md): Access: System, Admin, and ClientAdmin users only. The response returns one base64 data URI per rendered page. If no preview is available, the endpoint responds with no… - [Returns preview images for the W-9 form under review.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-w9-preview.md): Access: System, Admin, and ClientAdmin users only. The response returns one base64 data URI per rendered W-9 page. If no preview is available, the endpoint responds with no… - [Saves the employer verification data for Form 8850.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-form885-1.md): Access: System, Admin, and ClientAdmin users only. The payload captures employer contact details, targeted-group answers, key dates, and the employer signature mode used for… - [Returns the current Form 8850 verification data.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-form885-1.md): Access: System, Admin, and ClientAdmin users only. If the employee skipped Form 8850, the response indicates that state instead of returning editable employer-verification… - [Returns preview images for Form I-9.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-i9-preview-1.md): Access: System, Admin, and ClientAdmin users only. The response returns one base64 data URI per rendered page. If no preview is available, the endpoint responds with no… - [Returns the stored Form I-9 verification data for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-i9-1.md): Access: System, Admin, and ClientAdmin users only. The response resolves the citizenship-specific document structure into a normalized API contract that always exposes List A,… - [Marks the Form I-9 verification step as completed.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-i9-finish-1.md): Access: System, Admin, and ClientAdmin users only. Use this after reviewing the saved Form I-9 data and attached identity-document evidence. - [Saves Form I-9 verification data for non-resident-alien employees.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-i9-nonresidentalien-1.md): Access: System, Admin, and ClientAdmin users only. The endpoint validates the non-resident-alien document combination selected by the verifier and persists the related… - [Saves Form I-9 verification data for resident-alien employees.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-i9-residentalien-1.md): Access: System, Admin, and ClientAdmin users only. The accepted document combinations depend on the resident-alien document path chosen in the payload and are validated before… - [Saves Form I-9 verification data for U.S. citizen or permanent-resident employees.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-i9-uscitizenpermanenresident-1.md): Access: System, Admin, and ClientAdmin users only. The request accepts either a single List A document or a List B and List C combination and stores the employer-signature… - [Returns uploaded I-9 identity-document images for employer review.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-i9-id-collection.md): Access: System, Admin, and ClientAdmin users only. The response groups all captured document pages into preview collections so the verifier can inspect the employee-submitted… - [Marks the I-9 identity-document review step as completed.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-i9-id-collection-finish.md): Access: System, Admin, and ClientAdmin users only. Use this after the uploaded identity-document images have been reviewed and accepted. - [Returns the tax-setup data that must be verified before finalization.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-taxsetup-1.md): Access: System, Admin, and ClientAdmin users only. The response combines stored tax-setup data with values derived from onboarding addresses, work locations, and… - [Marks the tax-setup verification step as completed.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-taxsetup-finish-1.md): Access: System, Admin, and ClientAdmin users only. This operation validates tax addresses and required tax-setup data before completing the verification step. - [Updates a single net-pay allocation row during verification.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-onboardingid-netpay-id.md): Access: System, Admin, and ClientAdmin users only. Only ACH allocations can enable prenote settings. The returned payload reflects the persisted values after verification… - [Downloads a generated form that should be signed or completed outside the portal.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-docupload-download-type-1.md): Access: System, Admin, and ClientAdmin users only. The returned file depends on the requested document type and can represent federal forms, state forms, or a combined export… - [Marks the Form 8850 verification step as completed.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-form885-finish-1.md): Access: System, Admin, and ClientAdmin users only. Use this after reviewing the populated Form 8850 data and signature requirements. - [Marks the W-9 review step as completed.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-w9-finish.md): Access: System, Admin, and ClientAdmin users only. Use this after reviewing the generated or uploaded W-9 artifact for the onboarding. - [Lists onboardings for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-1.md): Access: System, Admin, and ClientAdmin users only. Results can be filtered by onboarding type, workflow status, and created, finished, or hired date ranges.… - [Generates the employee-facing onboarding URL.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-id-geturl-1.md): Access: System, Admin, and ClientAdmin users only. The returned link contains the encrypted onboarding token used by the employee portal. The endpoint validates… - [Discards the onboarding record.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-id-discard-1.md): Access: System, Admin, and ClientAdmin users only. This operation is available only to the user who currently holds the onboarding lock. It removes the onboarding… - [Returns the verification-step status list for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-finalize-id-status-1.md): Access: System, Admin, and ClientAdmin users only. The response includes only verification steps that are visible for the onboarding and identifies whether each step is… - [Transfers the onboarding lock to the current authorized user.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-id-takecontrol-1.md): Access: System, Admin, and ClientAdmin users only. Use this endpoint when another user currently owns the onboarding lock and the current user needs to continue work on the… - [Returns phase-1 continuation information for the onboarding.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-onboarding-id-continueinfo-1.md): Access: System, Admin, and ClientAdmin users only. The response identifies the current setup step together with the ordered step list from the assigned template.… - [Assigns a manager to the onboarding before finalization completes.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-onboarding-finalize-id-setup-manager-managerid.md): Access: System, Admin, and ClientAdmin users only. Use this endpoint when finalization requires the employee to be linked to a specific manager record. ## API Reference: Payroll API - [Payroll Policy Info](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll.md): Retrieves default payroll policy information. \ Returned data are suitable for displaying information about payroll (including status of currently running payroll) or driving automated… - [List of Company Policies](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies.md): Returns the list of payroll policies defined for a company. The list contains IDs which can be used to call other endpoints. - [Create Payroll Policy](https://apidocs.worklio.com/reference/post_wep-companies-companyid-policies.md): Creates new payroll policy. Policy name DEFAULT is reserved for Default payroll policy used by Start Default Payroll endpoint. - [Payroll Policy Info](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-1.md): Retrieves payroll policy information based on Policy ID. \ Returned data are suitable for displaying information about payroll (including status of currently running payroll) or driving… - [Allows changing Payroll Policy](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-policies-policyid-1.md): Currently, only Policy name or Autorun flag can be changed. - [Removes Payroll Policy](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-policies-policyid-1.md): Policy with employee(s) assigned cannot be removed. Company default policy cannot be removed. - [Get Policy Schedule Calendar](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-schedulecalendar-1.md): Gets the list of next scheduled payrolls. - [Named Payroll Policy Info](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-policyname.md): Retrieves payroll policy information. \ Returned data are suitable for displaying information about payroll (including status of currently running payroll) or driving automated… - [List of Policy Employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-employees-1.md): Retrieves a list of employees who have this payroll policy assigned. - [Assign Employee to a Policy](https://apidocs.worklio.com/reference/post_wep-companies-companyid-policies-policyid-employees-employeeid-1.md): Assign employee to this payroll policy. Moves the employee from any previously assigned policy. - [Checks the Policy for eligibility to be run automatically](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-autoruneligible.md): Checks whether the Payroll Policy is eligible to be Auto-Run. It requires all the Employees included in the Policy to have Net pay allocation set as 100% to ACH. Employees which do not fulfill this… - [Assign Employees to a Policy (bulk)](https://apidocs.worklio.com/reference/post_wep-companies-companyid-policies-policyid-employees.md): Atomically (re-)assigns every employee in the request body to the specified payroll policy. Either all employees are moved, or none. Duplicate IDs in the body are deduplicated. - [Start Default Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll.md): Start default payroll based on default policy. \ Returns status data about run for UI rendering. \ Call is idempotent - in case that payroll already running, you will get… - [Skip Default Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-skip-1.md): Skip default payroll based on default policy. \ This operation is not reversible. Payroll will be skiped for next payroll period and interim payroll needs to be used if you need to run… - [Retrieve Payroll Status](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-1.md): Retrieves payroll status. \ Returns status data about run for UI rendering. \ \ Warnings are info only and payroll can continue. \ Errors are… - [Next Payroll Step](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-runid-next-1.md): Task system to move payroll forward. \ Moving to next step will process all needed calculations and operations between current and next step. Processing is done on background and… - [Previous Payroll Step](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-runid-back-1.md): Task system to move payroll backwards. \ Moving to previous step will process all needed rollbacks, discards, and operations between current and following step. Processing is done on… - [Discard Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-runid-discard-1.md): Task system to DISCARD payroll. \ Locked payroll cannot be discarded after deadline. \ Discarding payroll will process all needed rollbacks, removals, and operations.… - [Finalize payroll.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-runid-finalize.md): Finalizes a locked payroll run. Once finalized, payroll data can no longer be changed. - [Get Years For Void Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-void-1.md): Retrieves list of years for voiding payroll default payroll policy. \ Returned data are list of years where is at least one payroll. Year is one of parameters for getting list of… - [Start Void Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-void-1.md): Start void payroll. \ Returns status data about run for UI rendering. \ Call is NOT idempotent - you can start as much void payrolls as you want. \ \… - [Get Employees For Void Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-void-year-employees-1.md): Retrieves list of Employees for voiding payroll in default payroll policy and in selected year. \ Returned data are list of employees who have at least one pay stub in selected year.… - [Get Payrolls For Void Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-void-year-payrolls-1.md): Retrieves list of Payrolls for voiding payroll in default payroll policy and in selected year. \ Returned data are list of payrolls in selected year. \ This… - [Get Employee Pay Stubs For Void Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-void-year-employees-employeeid-1.md): Retrieves list of Employee Pay Stubs for voiding payroll in default payroll policy and in selected year. \ Returned data are list of employee pay stubs in selected year. \… - [Get Years For Void Named Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-policyname-void-1.md): Retrieves list of years for voiding payroll named payroll policy. \ Returned data are list of years where is at least one payroll. Year is one of parameters for getting list of voidable… - [Get Employees For Void Named Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-policyname-void-year-employees-1.md): Retrieves list of Employees for voiding payroll in named payroll policy and in selected year. \ Returned data are list of employees who have at least one pay stub in selected year.… - [Get Payrolls For Void Named Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-policyname-void-year-payrolls-1.md): Retrieves list of Payrolls for voiding payroll in named payroll policy and in selected year. \ Returned data are list of payrolls in selected year. \ This… - [Get Employee Pay Stubs For Void Named Payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-policyname-void-year-employees-employeeid-1.md): Retrieves list of Employee Pay Stubs for voiding payroll in named payroll policy and in selected year. \ Returned data are list of employee pay stubs. \ This… - [Get Years For Void Payroll by Policy ID](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-void.md): Retrieves list of years for voiding payroll by payroll policy ID. Access: System and Admin users only. Employee calls return Forbidden even for the employee's own company. If… - [Get Employees For Void Payroll by Policy ID](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-void-year-employees.md): Retrieves list of Employees for voiding payroll by payroll policy ID and selected year. Access: System and Admin users only. Employee calls return Forbidden even for the… - [Get Payrolls For Void Payroll by Policy ID](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-void-year-payrolls.md): Retrieves list of Payrolls for voiding payroll by payroll policy ID and selected year. Access: System and Admin users only. Employee calls return Forbidden even for the employee's… - [Get Employee Pay Stubs For Void Payroll by Policy ID](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-void-year-employees-employeeid.md): Retrieves list of Employee Pay Stubs for voiding payroll by payroll policy ID and selected year. Access: System and Admin users only. Employee calls return Forbidden even for the… - [List of current year payrolls](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payrolls-1.md) - [List of scheduled payrolls](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-scheduled-1.md) - [List of years with any payroll for employee](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payrolls-years-1.md) - [List of payrolls for year](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payrolls-year-year-1.md) - [Get payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payrolls-paystubid-1.md): Gets detailed info on one payroll (identified by its Paystub Id - obtained by calling EmployeePayrollList() method - [Get payroll](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payrolls-paystubid-ext.md): Gets detailed info on one payroll (identified by its Paystub Id - obtained by calling EmployeePayrollList() method - [Get list of Earning Code presets](https://apidocs.worklio.com/reference/get_wep-payroll-earningcodes-presets.md): Gets list of earning code presets. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will… - [Get list of Earning Codes](https://apidocs.worklio.com/reference/get_wep-companies-companyid-earningcodes.md): Gets list of earning codes. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [Create Earning Code](https://apidocs.worklio.com/reference/post_wep-companies-companyid-earningcodes.md): Create earning code and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee… - [Get Earning Code information](https://apidocs.worklio.com/reference/get_wep-companies-companyid-earningcodes-earningcodeid.md): Retrieve earning code information for specified companyId, earningcodeId parameters. \ \ This endpoint can be called only by System and Admin level users. \… - [Update Earning Code](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-earningcodes-earningcodeid.md): Update earning code and set information about it. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will… - [Delete Earning Code](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-earningcodes-earningcodeid.md): Remove earning code. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden result even for… - [Create Earning Code Bulk](https://apidocs.worklio.com/reference/post_wep-companies-companyid-earningcodes-bulk.md): Create earning code and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee… - [Get list of Pay Allocations](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payallocations.md): Retrieves list of pay allocation information for specified employee. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Create Pay Allocation](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-payallocations.md): Create pay allocation and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Get Pay Allocation](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-payallocations-pallocationid-1.md): Retrieves pay allocation information for specified companyId, employeeId, pallocationId parameters. \ \ This endpoint can be called only by System and Admin… - [Update Pay Allocation](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-payallocations-pallocationid-1.md): Update pay allocation and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Delete Pay Allocation](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-payallocations-pallocationid-1.md): Remove pay allocation. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden… - [Create Pay Allocation](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-payallocations-account.md): Create pay allocation and set information about it. \ For use with Employee Bank Account Id only. \ \ This endpoint can be called only by System and… - [Update Pay Allocation](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-payallocations-account-pallocationid.md): Update pay allocation and set information about it. \ For use with Employee Bank Account Id only. \ \ This endpoint can be called only by System and… - [Employee status for payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-status-employees-payroll.md): Gets a list of EEs status for payroll. \ \ This endpoint can be called only by System and Admin level users. \ - [Employee validity for payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-status-employees-payrollvalid.md): Gets a list of valid EEs for payroll. \ \ This endpoint can be called only by System and Admin level users. \ - [Get Paystub](https://apidocs.worklio.com/reference/get_wep-payroll-paystubs-paystubid.md): Gets detailed info on one payroll (identified by its Paystub Id - obtained by calling EmployeePayrollList() or Payroll Overview method This endpoint can be called only by System level users.… - [Get Paystub (extended data)](https://apidocs.worklio.com/reference/get_wep-payroll-paystubsex-paystubid.md): Gets detailed info on one payroll (identified by its Paystub Id - obtained by calling EmployeePayrollList() or Payroll Overview method This endpoint can be called only by System level users.… - [Start Named Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-policyname.md): Start payroll based on named policy. \ Returns status data about run for UI rendering. \ Call is idempotent - in case that payroll already running, you will get same status… - [Start Bonus Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-bonus-1.md): Start bonus payroll. \ Returns status data about run for UI rendering. \ Call is NOT idempotent - you can start as much bonus payrolls as you want. \ \… - [Start Off-Cycle Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-offcycle-1.md): Start Off-Cycle payroll. \ Returns status data about run for UI rendering. \ Call is NOT idempotent - you can start as much off-cycle payrolls as you want. \ \… - [Skip Named Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-policyname-skip-1.md): Skip payroll based on named policy. \ This operation is not reversible. Payroll will be skiped for next payroll period and interim payroll needs to be used if you need to run payroll.… - [Start Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-policies-policyid-start-1.md): Start payroll based on policy ID. \ Returns status data about run for UI rendering. \ Call is idempotent - in case that payroll already running, you will get same status… - [Get data for payment authorization page](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-payauth.md): Returns data necessary for displaying the payment authorization page. This stage requires the user to authorize all transactions generated from the payroll computation. - [Payroll Overview](https://apidocs.worklio.com/reference/get_wep-payroll-runid-overview.md): Retrieve payroll properties and reports. \ You can call this endpoint only on already counted payroll which has not been finalized yet (UI Step is Overview or Locked). Payrolls in… - [Skip Payroll by Policy ID](https://apidocs.worklio.com/reference/post_wep-companies-companyid-policies-policyid-skip.md): Skip payroll based on policy ID. This operation is not reversible. Payroll will be skipped for the next payroll period and interim payroll needs to be used if payroll must be run. Access:… - [Payroll Overview Transaction Detail](https://apidocs.worklio.com/reference/get_wep-payroll-runid-overview-transactions-transactionid.md): Retrieve transaction detail for transactions from payroll overview \ You can call this endpoint only on already counted payroll which has not been finalized yet (UI Step is Overview or… - [Payroll Overview Check Detail](https://apidocs.worklio.com/reference/get_wep-payroll-runid-overview-paystubs-paystubid-checkdetail.md): Retrieve check detail for checks from payroll overview \ You can call this endpoint only on already counted payroll which has not been finalized yet (UI Step is Overview or Locked).… - [Payroll History Overview](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-history-overview.md): Retrieve payroll properties and reports. \ You can call this endpoint only on finalized payrolls. \ Reports are generated in downloadable PDFs and can be served directly to… - [List of Payrolls.](https://apidocs.worklio.com/reference/get_wep-payroll.md): Retrieves list of payrolls. \ \ This endpoint can be called only by System level users. \ \ - [List of Scheduled Payrolls](https://apidocs.worklio.com/reference/get_wep-payroll-scheduled.md): Retrieves list of scheduled payrolls. \ \ This endpoint can be called only by System level users. \ - [Payroll History](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-history-1.md): Retrieve named payroll history based on Policy ID. \ Endpoint returns history of payrolls (based on policy ID). History contains overall data. More details can be got by calling System and Admin level users. \ \… - [Payroll Overview](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-overview-1.md): Retrieve payroll properties and reports. \ You can call this endpoint only on already counted payroll which has not been finalized yet (UI Step is Overview or Locked). Payrolls in… - [Default Payroll History](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-history-1.md): Retrieve default payroll history. \ Endpoint returns history of payrolls (based on default policy). History contains overall data. More details can be got by calling System and Admin level users. \ \ Employee call will return Forbidden result… - [Get Running Payrolls for admin](https://apidocs.worklio.com/reference/get_wep-payroll-running.md): Returns running payrolls for every company for which has current user(role) access rights This endpoint can be called only by System and Admin level users. \ \… - [Payroll History.](https://apidocs.worklio.com/reference/get_wep-payroll-history.md): Retrieve payroll history. \ Endpoint returns history of payrolls accross companies. History contains overall data. More details can be got by calling System and Admin users only. Employee calls return Forbidden… - [Default Payroll Count](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-history-count.md): Retrieve default payroll count. \ Endpoint returns count of payrolls (based on default policy).\ \ This endpoint can be called only by System and… - [Named Payroll Count](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-policyname-history-count.md): Retrieve named payroll count. \ Endpoint returns count of payrolls (based on named policy).\ \ This endpoint can be called only by System and… - [Payroll Overview Check Detail](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-overview-paystubs-paystubid-checkdetail.md): Retrieve check detail for checks from payroll overview \ You can call this endpoint only on already counted payroll which has not been finalized yet (UI Step is Overview or Locked).… - [Payroll Overview Transaction Detail](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-overview-transactions-transactionid.md): Retrieve transaction detail for transactions from payroll overview \ You can call this endpoint only on already counted payroll which has not been finalized yet (UI Step is Overview or… - [Payroll History Overview Transaction Detail](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-history-overview-transactions-transactionid.md): Retrieve transaction detail for transactions from payroll history overview \ You can call this endpoint only on finalized payrolls. \ \ This endpoint can be… - [Payroll History Overview Check Detail](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-history-overview-paystubs-paystubid-checkdetail.md): Retrieve check detail for checks from payroll history overview \ You can call this endpoint only on finalized payrolls. \ \ This endpoint can be called only by… - [Get list of Earnings](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-paystubs.md): Gets list of all Earnings included in current payroll. \ Earnings includes information about employees their earning items. \ As earnings need to be rendered properly (for… - [Get Earnings setup](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-paystubs-setup.md): Gets list of all Earnings configuration for current payroll. \ This call returns information needed for proper rendering of payroll earnings (aka Timesheet) editor. \ Setup… - [Update Earnings](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-payroll-runid-paystubs-paystubid.md): Update Earnings item. \ Items vales must follow Setup settings (for example - there is difference between different wage types) you should call System and Admin users only. Employee calls… - [Terminated employees by Policy ID](https://apidocs.worklio.com/reference/get_wep-companies-companyid-policies-policyid-termination-employees-1.md): List of terminated employees who do not get their last payroll. Returns only employees assigned to the selected payroll policy. Access: System and Admin users only. Employee calls… - [Get payroll Gross up](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-paystubs-paystubid-grossup.md): Gets info of paystub Gross up from payroll run. \ \ This endpoint can be called only by System and Admin level users and can be called only for payrolls on… - [Add new payroll Gross up](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-runid-paystubs-paystubid-grossup.md): Add new paystub Gross up in payroll run. \ \ This endpoint can be called only by System and Admin level users and can be called only for payrolls on Timesheet… - [Update payroll Gross up](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-payroll-runid-paystubs-paystubid-grossup.md): Update paystub Gross up in payroll run. \ \ This endpoint can be called only by System and Admin level users and can be called only for payrolls on Timesheet… - [Remove payroll Gross up](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-payroll-runid-paystubs-paystubid-grossup.md): Remove gross up from paystub in payroll run. - [Payroll Checks Generating progress](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-checks-1.md): Gets info on progress of generating Actual Checks PDF. - [Payroll Checks Generating progress](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-checksstatus-1.md): Gets info on progress of generating Actual Checks PDF. - [Get FileToken to download Payroll Checks](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-checksdownload-1.md): Gets FileToken for download actual checks in PDF.\ NOTE: Download is valid only if Payroll Checks Generating progress… - [Get a list of payroll paylines messages](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-payline-messages.md): Returns a list of all message types (errors/warnings/info) for paylines from the given payroll run. - [Get a list of payline messages](https://apidocs.worklio.com/reference/get_wep-companies-companyid-payroll-runid-payline-messages-paylineid.md): Returns a list of all message types (errors/warnings/info) for given payline. - [Returns client pay codes for a specific company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-pay-codes.md): Access: System, Admin, and ClientAdmin users only. Without filters, the response contains only active company pay codes whose related master pay type is active. If… - [Unblock Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-payroll-runid-unblock.md): Unblocks a payroll run if the current user has the necessary permissions. \ This endpoint can be called only by System and Admin level users. \ ## API Reference: Dashboard API - [Gets the current admin dashboard definition.](https://apidocs.worklio.com/reference/get_wep-dashboard-1.md): Access: System and Admin users only. When includeData is true, each widget includes its widget-specific payload in the response. When it is false, the response still includes widget… - [Saves the widget order and visibility for the current admin dashboard.](https://apidocs.worklio.com/reference/post_wep-dashboard-1.md): Access: System and Admin users only. The request body supplies the widgets that should remain on the dashboard together with their visibility flags, in the order they should be… - [Gets a single widget from the current admin dashboard.](https://apidocs.worklio.com/reference/get_wep-dashboard-key-1.md): Access: System and Admin users only. The key route value selects the widget definition to resolve for the caller's dashboard scope. If the widget has a saved dashboard override,… - [Gets the dashboard definition for a specific company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-dashboard-1.md): Access: System, Admin, and ClientAdmin users only. The companyId route value is validated before the dashboard is loaded so the request is always tied to an existing company… - [Saves the widget order and visibility for a specific company dashboard.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-dashboard-1.md): Access: System, Admin, and ClientAdmin users only. The request body supplies the widgets that should remain on the company dashboard together with their visibility flags, in… - [Gets a single widget from a specific company dashboard.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-dashboard-key-1.md): Access: System, Admin, and ClientAdmin users only. The endpoint validates the company context before resolving the widget selected by key. If the widget has a saved… - [Gets the dashboard definition for a specific employee.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-dashboard-1.md): Access: System, Admin, ClientAdmin, and Employee users. The route identifies both the company and employee context for the dashboard that should be resolved. When… - [Saves the widget order and visibility for a specific employee dashboard.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-dashboard-1.md): Access: System, Admin, ClientAdmin, and Employee users. The request body supplies the widgets that should remain on the employee dashboard together with their… - [Gets a single widget from a specific employee dashboard.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-dashboard-key-1.md): Access: System, Admin, ClientAdmin, and Employee users. The route identifies the employee dashboard and key selects the widget definition to resolve inside that… - [Gets the example schema container for dashboard widget data payloads.](https://apidocs.worklio.com/reference/get_wep-dashboard-widgets-datastructure-1.md): Access: System and Admin users only. This helper is intended for Swagger and API consumers that need to inspect the possible payload shapes that can appear in a dashboard widget's… ## API Reference: Reports API - [Get list of Segments](https://apidocs.worklio.com/reference/get_wep-companies-companyid-jobcosting.md): Retrieve list of job/project costing segments for Company. \ Items from segments can be used later in Update… - [Creates new Segment](https://apidocs.worklio.com/reference/post_wep-companies-companyid-jobcosting.md): Create new job costing segment of the length 10 characters. \ Maximum length is 40 characters so only 4 segments are allowed. \ NOTE: Purpose of this endpoint is to set up… - [Retrieves Segment information](https://apidocs.worklio.com/reference/get_wep-companies-companyid-jobcosting-jobcostingid.md): Retrieve job/project costing segment for Company. \ Items from segment can be used later in Update Earnings… - [Removes Segment](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-jobcosting-jobcostingid.md): Removes Job Costing Segment. \ NOTE: Purpose of this endpoint is to set up initial company job costing, later changes may lead to issues. \ \ This endpoint can… - [Update Segment information](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-jobcosting-jobcostingid.md): Update job/project costing segment for Company. \ Items from segment can be used later in Update Earnings \… - [Get list of Cost Codes](https://apidocs.worklio.com/reference/get_wep-companies-companyid-jobcosting-jobcostingid-codes.md): Retrieve list of job/project costing codes for Company and Segment. \ Codes can be used later in Update… - [Create Cost Code](https://apidocs.worklio.com/reference/post_wep-companies-companyid-jobcosting-jobcostingid-codes.md): Create job/project costing code for Company and Segment. \ Codes can be used later in Update Earnings \… - [Retrieves Cost Code information](https://apidocs.worklio.com/reference/get_wep-companies-companyid-jobcosting-jobcostingid-codes-codeid.md): Retrieve job/project costing code for Company and Segment. \ Codes can be used later in Update Earnings \… - [Update Cost Code](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-jobcosting-jobcostingid-codes-codeid.md): Update job/project costing code for Company and Segment. \ Codes can be used later in Update Earnings \… - [Delete Cost Code](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-jobcosting-jobcostingid-codes-codeid.md): Delete job/project costing code from Segment for Company. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Get a list of Job Costing Segments](https://apidocs.worklio.com/reference/get_wep-companies-companyid-jobcosting-segments.md): \ This endpoint can be called only by System and Admin and ClientAdmin and Employee level users. \ - [Create Cost Code in Bulk](https://apidocs.worklio.com/reference/post_wep-companies-companyid-jobcosting-jobcostingid-codes-bulk.md): Create job/project costing code for Company and Segment. \ Codes can be used later in Update Earnings \… - [Update Cost Code By Bulk](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-jobcosting-jobcostingid-codes-bulk.md): Update job/project costing code for Company and Segment. \ Codes can be used later in Update Earnings \… - [Create Deduction Benefit Register Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-deductionbenefitregister-1.md): Let system create Deduction Benefit Register Report. \ Report data can be downloaded later (up to 7 days) with Get Report… - [Create SUTA Rates Report](https://apidocs.worklio.com/reference/post_wep-reports-sutarates.md): Let system create SUTA Rates Report. \ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Terminated Companies Report](https://apidocs.worklio.com/reference/post_wep-reports-terminatedcompany.md): Let system create Terminated Companies Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Deduction Benefit Roster Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-deductionbenefitrosterclient-1.md): Let system create Deduction Benefit Roster Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Employees Arrears Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-employeesarrears-1.md): Let system create Employees Arrears Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Deduction Benefit Register Report](https://apidocs.worklio.com/reference/post_wep-reports-deductionbenefitregister.md): Let system create Deduction Benefit Register Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Employees Arrears Report](https://apidocs.worklio.com/reference/post_wep-reports-employeesarrears.md): Let system create Employees Arrears Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Employee Direct Deposit Register Report](https://apidocs.worklio.com/reference/post_wep-reports-directdepositregister.md): Let system create Employee Direct Deposit Register Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Scheduled Pay Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-scheduledpay-1.md): Let system create Scheduled Pay Report. \ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Unpaid Active Employee List Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-unpaidactiveemployeelist-1.md): Let system create Unpaid Active Employee List Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Birthday List Report](https://apidocs.worklio.com/reference/post_wep-reports-birthdaylist.md): Let system create Birthday List Report. \ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Employee Tax Setup Report](https://apidocs.worklio.com/reference/post_wep-reports-employeetaxsetup.md): Let system create Employee Tax Setup Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Employee Termination Report](https://apidocs.worklio.com/reference/post_wep-reports-employeetermination.md): Let system create Employee Termination Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Employment Details Report](https://apidocs.worklio.com/reference/post_wep-reports-employmentdetails.md): Let system create Employment Details Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Net Pay Allocation Roster Report](https://apidocs.worklio.com/reference/post_wep-reports-netpayallocationroster.md): Let system create Net Pay Allocation Roster Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Scheduled Pay Report](https://apidocs.worklio.com/reference/post_wep-reports-scheduledpay.md): Let system create Scheduled Pay Report. \ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Unpaid Active Employee List Report](https://apidocs.worklio.com/reference/post_wep-reports-unpaidactiveemployeelist.md): Let system create Unpaid Active Employee List Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create FICA Tip Credit Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-ficatipcredit-1.md): Let system create FICA Tip Credit Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Hours Earnings Recap Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-hoursandearningsrecap-1.md): Let system create Hours Earnings Recap Report. \ Report data can be downloaded later (up to 7 days) with Get… - [Create Job Costing Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-jobcostingclient-1.md): Let system create Job Costing Report. \ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Payroll Recap Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-payrollrecapclient-1.md): Let system create Payroll Recap Report. This report is available as PDF Only\ Report data can be downloaded later (up to 7 days) with PDF Only\ Report data can be downloaded later (up to 7 days) with Get… - [Create Payroll Register Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-payrollregister-1.md): Let system create Payroll Register Report. This report is available as PDF Only\ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Time Entry Sheet Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-timeentrysheetclient-1.md): Let system create Time Entry Sheet Report. This report is available as PDF Only\ Report data can be downloaded later (up to 7 days) with Get… - [Create Payroll Recap Report](https://apidocs.worklio.com/reference/post_wep-reports-payrollrecapclient.md): Let system create Payroll Recap Report. This report is available as PDF Only\ Report data can be downloaded later (up to 7 days) with PDF Only\ Report data can be downloaded later (up to 7 days) with PDF Only\ Report data can be downloaded later (up to 7 days) with Get Report… - [Create Time Entry Sheet Report](https://apidocs.worklio.com/reference/post_wep-reports-timeentrysheetclient.md): Let system create Time Entry Sheet Report. This report is available as PDF Only\ Report data can be downloaded later (up to 7 days) with Get… - [Get Existing Report](https://apidocs.worklio.com/reference/get_wep-companies-companyid-reports-reportdataid-1.md): Download data from existing report. \ Data can be downloaded up to 7 days from time when they were created. \ Output model can contains FileUrl/FileUrl for downloadable… - [Get Existing Report File](https://apidocs.worklio.com/reference/get_wep-companies-companyid-reports-reportdataid-getfile-reportfileid-1.md): Download data from existing report. \ Data can be downloaded up to 7 days from time when they were created. \ Output model can contains FileUrl/FileUrl for downloadable… - [Create Worker's Compensation History Report](https://apidocs.worklio.com/reference/post_wep-companies-companyid-reports-workcomphistory.md): Let system create Worker's Compensation History Report. \ Report data can be downloaded later (up to 7 days) with System and Admin level users. \ \… - [Get TimeOff Policy information](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-policies-policyid.md): Retrieve timeoff policy information for specified companyId, policyId parameters. \ \ This endpoint can be called only by System and Admin level users. \… - [Deactivate TimeOff Policy](https://apidocs.worklio.com/reference/put_wep-companies-companyid-timeoff-policy-deactivations-policyid.md) - [List of Presets](https://apidocs.worklio.com/reference/get_wep-timeoff-policy-presets.md): Load Time off presets - [Get list of TimeOff Policies](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-groups.md): Gets list of time-off policy. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [Get a list of Time Off transactions, sorted from newest to oldest.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-timeoff-policies-policyid-transactions.md): Please do not manually sort the results by date. They are already sorted by date and transaction type, and further sorting by date alone may disrupt the order. - [Create a new "Manual Adjustment" Time Off transaction](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-timeoff-policies-policyid-transaction-adjustments.md): This endpoint can be called only by System and Admin level users. \ This endpoint can be called only by System and Admin level users. - [Delete a "Manual Adjustment" Time Off transaction.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-timeoff-policies-policyid-transaction-adjustments-id.md): The transaction date must be set to today or a future day. \ \ This endpoint can be called only by System and Admin level users. - [Update a "Manual Adjustment" Time Off transaction.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-timeoff-policies-policyid-transaction-adjustments-id.md): The transaction date must be set to today or a future day. \ \ This endpoint can be called only by System and Admin level users. - [Returns balance for employee and policy.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-timeoff-policies-policyid-balance.md) - [Get a list of active time off policies assigned to the employee, including hours used, balance, and other relevant statistics. All statistics are in minutes.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-timeoff-policies.md) - [Initial setup to Employee's TimeOff Policy](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-timeoff-policy-setups-policyid.md): Initial setup to timeoff employee policy and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Gets participation limits (%) for Employee's TimeOff Policy](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-timeoff-policy-setups-policyid-participation-limits.md): This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden result even for Employee own company. \ - [Sets participation limits (%) for Employee's TimeOff Policy](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-timeoff-policy-setups-policyid-participation-limits.md): This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden result even for Employee own company. \ - [Deactivate Employee's TimeOff Policy](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-timeoff-policy-deactivations-policyid.md) ## API Reference: System API - [Create Admin Login](https://apidocs.worklio.com/reference/post_wep-companies-companyid-logins.md): Create new admin login for company. \ Admin login DOESN'T HAVE EMPLOYEE ROLE AND CAN'T BE USED FOR PAYROLL CALCULATIONS. \ You can call Admin login DOESN'T HAVE EMPLOYEE ROLE AND CAN'T BE USED FOR PAYROLL CALCULATIONS. \ You can call System, Admin, and ClientAdmin… - [Blocks a company admin login.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-logins-block.md): Blocks an existing company admin login for companyId and returns the refreshed admin record. Use block to identify the target by `AdminId`, `LoginId`, or `Email`. When multiple identifiers are… - [Create Admin Login](https://apidocs.worklio.com/reference/post_wep-companies-companyid-admins.md): Create new admin login for company. \ Admin login DOESN'T HAVE EMPLOYEE ROLE AND CAN'T BE USED FOR PAYROLL CALCULATIONS. \ You can call Admin login DOESN'T HAVE EMPLOYEE ROLE AND CAN'T BE USED FOR PAYROLL CALCULATIONS. \ You can call PEO admin users only. Full system users receive every admin account. PEO full-admin users do not receive true system accounts. Partner-scoped multi-admin users receive only… - [Creates a new system admin or multi-admin account.](https://apidocs.worklio.com/reference/post_wep-admins.md): Access: PEO admin users only. Full system and PEO full-admin users create accounts with broad system access. Partner-scoped multi-admin users create a new account by cloning their own… - [Gets one system admin or multi-admin account.](https://apidocs.worklio.com/reference/get_wep-admins-id.md): Access: callers with PEO full-admin access can retrieve any admin account. Other PEO admin callers can retrieve a record only when the requested `id` matches the caller's current login ID.… - [Update Admin Login](https://apidocs.worklio.com/reference/patch_wep-admins-id.md): Update existing admin login for company. \ Admin login DOESN'T HAVE EMPLOYEE ROLE AND CAN'T BE USED FOR PAYROLL CALCULATIONS. \ You can call PEO admin users only. The endpoint marks the requested admin account as inactive, triggers the standard admin-updated webhook notification, and returns the refreshed admin detail.… - [Activates a system admin or multi-admin account.](https://apidocs.worklio.com/reference/patch_wep-admins-id-activate.md): Access: PEO admin users only. The endpoint marks the requested admin account as active, triggers the standard admin-updated webhook notification, and returns the refreshed admin detail.… - [Address Validation](https://apidocs.worklio.com/reference/post_wep-addressvalidation.md): Validates address and return GEO location information for further use. \ Be aware that overly extensive use can lead to additional charges. \ This… - [Get list of new user and company registrations and their current status.](https://apidocs.worklio.com/reference/get_wep-registrations.md): Retrieves information about new users and companies registration and their current status. - [Get detailed info about new user and companies registration and current status.](https://apidocs.worklio.com/reference/get_wep-registrations-id.md): Retrieves information about new user and companies. - [Gets the resolved brand setup for a specific company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-brand.md): Access: authenticated callers in the requested company context, including employee callers allowed by this endpoint. Returns the branding values currently resolved for the specified company,… - [Uploads the light logo for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-logo.md): Access: System, Admin, and ClientAdmin users only. The request must be sent as `multipart/form-data` and include the logo image in the `file` form part. When… - [Uploads the dark-theme logo for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-logo-dark.md): Access: System, Admin, and ClientAdmin users only. The request must be sent as `multipart/form-data` and include the dark logo image in the `file` form part. When… - [Uploads the favicon for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-favicon.md): Access: System, Admin, and ClientAdmin users only. The request must be sent as `multipart/form-data` and the uploaded file must be an ICO favicon. - [Uploads the standard application icon for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-icon.md): Access: System, Admin, and ClientAdmin users only. The request must be sent as `multipart/form-data` and the icon is validated as an image upload before it is stored. - [Uploads the dark-theme application icon for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-icon-dark.md): Access: System, Admin, and ClientAdmin users only. The request must be sent as `multipart/form-data` and the icon is validated as an image upload before it is stored. - [Updates the branded application name for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-app-name.md): Access: System, Admin, and ClientAdmin users only. The request body uses Worklio.ApiModels.API.Models.Common.BrandSaveData_v10 and expects the new application name in its… - [Updates the custom color payload for a specific company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-brand-custom-colors.md): Access: System, Admin, and ClientAdmin users only. The request body uses Worklio.ApiModels.API.Models.Common.BrandSaveData_v10 and expects the color configuration serialized… - [Gets brand setup by resolving the supplied RCU token.](https://apidocs.worklio.com/reference/get_wep-brand-rcu.md): Access: anonymous callers. The route token is decrypted and validated to resolve the company context for the branding lookup. If the RCU payload does not include a company identifier, the… - [Gets the brand setup resolved for the current caller context.](https://apidocs.worklio.com/reference/get_wep-brand.md): Access: authenticated callers, including client administrators and employees allowed by this endpoint. The response is resolved from the caller's active role and can represent master-level,… - [Uploads the light logo for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-logo.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master logo, client administrators update their client logo, and custom PEO administrators… - [Uploads the dark-theme logo for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-logo-dark.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master dark logo, client administrators update their client dark logo, and custom PEO… - [Uploads the favicon for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-favicon.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master favicon, client administrators update their client favicon, and custom PEO… - [Uploads the standard application icon for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-icon.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master icon, client administrators update their client icon, and custom PEO administrators… - [Uploads the dark-theme application icon for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-icon-dark.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master dark icon, client administrators update their client dark icon, and custom PEO… - [Updates the branded application name for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-app-name.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master application name, client administrators update their client value, and custom PEO… - [Updates the custom color payload for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-custom-colors.md): Access: System, Admin, and ClientAdmin users only. Full administrators update the master custom colors, client administrators update their client value, and custom PEO… - [Updates the support email address for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-supportemail.md): Access: System and Admin users only. After authorization succeeds, the action resolves the caller's current role to choose the persistence scope: full PEO administrators update the… - [Updates the support phone number for the caller's resolved brand scope.](https://apidocs.worklio.com/reference/post_wep-brand-supportphone.md): Access: System and Admin users only. After authorization succeeds, the action resolves the caller's current role to choose the persistence scope: full PEO administrators update the… - [Gets the effective employee application access policy for the company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-access-policy.md): Access: System, Admin, and ClientAdmin users only. The response reflects which applications employees are currently allowed to use for the selected company. - [Updates the employee application access policy for the company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-access-policy.md): Access: System, Admin, and ClientAdmin users only. The request updates the company setting that controls employee access to supported applications. The response contains the… - [Lists active custom termination reasons.](https://apidocs.worklio.com/reference/get_wep-custom-termination-reasons.md): Access: System, Admin, and ClientAdmin users only. Returns only custom termination reasons whose row status is valid. Use this endpoint to populate reference lists before… - [Creates a custom termination reason.](https://apidocs.worklio.com/reference/post_wep-custom-termination-reasons.md): Access: System, Admin, and ClientAdmin users only. If `type` is omitted or sent as `null`, the reason is stored with the… - [Gets a custom termination reason by identifier.](https://apidocs.worklio.com/reference/get_wep-custom-termination-reasons-customterminationreasonid.md): Access: System, Admin, and ClientAdmin users only. Returns the current stored values for a single custom termination reason so clients can review or edit an existing record. - [Updates an existing custom termination reason.](https://apidocs.worklio.com/reference/patch_wep-custom-termination-reasons-customterminationreasonid.md): Access: System, Admin, and ClientAdmin users only. This endpoint applies JSON Merge Patch semantics. Properties omitted from the request body keep their current stored values.… - [Soft-deletes a custom termination reason.](https://apidocs.worklio.com/reference/delete_wep-custom-termination-reasons-customterminationreasonid.md): Access: System, Admin, and ClientAdmin users only. The endpoint marks the custom termination reason as deleted so it no longer appears in the list endpoint, then returns no… - [Lists active gender identities.](https://apidocs.worklio.com/reference/get_wep-gender-identities.md): Access: System, Admin, ClientAdmin, and Employee users. Returns gender identity reference values with valid status only so API consumers can populate selection lists… - [Lists the current effective NAICS codes.](https://apidocs.worklio.com/reference/get_wep-naics.md): Access: System, Admin, and ClientAdmin users only. Returns one active NAICS entry per code, using the latest effective record for the current application date. Use this… - [Lists supported time zones.](https://apidocs.worklio.com/reference/get_wep-timezones.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the cached Worklio time zone catalog. Each item includes a display label, the current abbreviation, the… - [Lists employees together with their employee-portal access state.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-access.md): Access: System, Admin, and ClientAdmin users only. The response includes each employee's login details, portal status, invitation information, and portal-specific contact… - [Configures employee-portal access for a single employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-access-employeeid-employee-portal.md): Access: System, Admin, and ClientAdmin users only. Use this endpoint to enable or disable portal access, set an expiration date, choose the contact email, and optionally… - [Configures employee-portal access for multiple employees.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-access-employee-portal-bulk.md): Access: System, Admin, and ClientAdmin users only. The endpoint streams one result item per submitted employee so callers can inspect per-employee success or failure details… - [Exchanges a file token for short-lived download metadata.](https://apidocs.worklio.com/reference/get_wep-files-filetoken-info-1.md): Access: System, Admin, ClientAdmin, and Employee users only. Accepts a role-scoped file token issued by another authenticated endpoint and converts it to a… - [Downloads a file by short-lived download token.](https://apidocs.worklio.com/reference/get_wep-files-downloadtoken-download-1.md): Access: Anonymous requests are allowed, but the download token is still validated server-side. Streams the original stored or generated file and sets `Content-Disposition: attachment` so… - [Streams a file for inline preview by short-lived download token.](https://apidocs.worklio.com/reference/get_wep-files-downloadtoken-preview.md): Access: Anonymous requests are allowed, but the download token is still validated server-side. Sets `Content-Disposition: inline` so browsers can render previewable formats in the current… - [Downloads a single employee avatar by file token.](https://apidocs.worklio.com/reference/get_wep-files-filetoken-avatar.md): Access: System, Admin, ClientAdmin, and Employee users only. Accepts an employee-photo file token and returns the avatar image as a binary file download with… - [Downloads up to 10 employee avatars and returns them in a top-level JSON array.](https://apidocs.worklio.com/reference/post_wep-files-avatars.md): Access: System, Admin, ClientAdmin, and Employee users only. Accepts a list of employee photo file tokens, typically obtained from the employees listing endpoint, and… - [Returns older comments for a post, pin, or survey thread.](https://apidocs.worklio.com/reference/get_wep-messaging-posts-newsfeeditemid-thread.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses fromTime and fromId as the paging cursor and returns comments older than that cursor for the… - [Returns older comments for a post, pin, or survey thread.](https://apidocs.worklio.com/reference/get_wep-messaging-pins-newsfeeditemid-thread.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses fromTime and fromId as the paging cursor and returns comments older than that cursor for the… - [Returns older comments for a post, pin, or survey thread.](https://apidocs.worklio.com/reference/get_wep-messaging-surveys-newsfeeditemid-thread.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses fromTime and fromId as the paging cursor and returns comments older than that cursor for the… - [Updates an existing comment.](https://apidocs.worklio.com/reference/patch_wep-messaging-posts-parentpostid-thread-commentid.md): Access: System, Admin, ClientAdmin, and permitted Employee users. The route determines whether the comment belongs to a post, pin, or survey item. - [Updates an existing comment.](https://apidocs.worklio.com/reference/patch_wep-messaging-pins-parentpostid-thread-commentid.md): Access: System, Admin, ClientAdmin, and permitted Employee users. The route determines whether the comment belongs to a post, pin, or survey item. - [Updates an existing comment.](https://apidocs.worklio.com/reference/patch_wep-messaging-surveys-parentpostid-thread-commentid.md): Access: System, Admin, ClientAdmin, and permitted Employee users. The route determines whether the comment belongs to a post, pin, or survey item. - [Returns the first page of notifications for the current system context.](https://apidocs.worklio.com/reference/get_wep-messaging-getinitialevents.md): Access: System and Admin users only. Returns the newest notifications visible to the caller. Set unreadOnly to limit the response to unread notifications. - [Returns the first page of notifications for a selected company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-getinitialevents.md): Access: System, Admin, and ClientAdmin users only. System users can use companyId to query notifications as if they were scoped to that company. - [Returns the first page of notifications for an employee-scoped request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-getinitialevents.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses the selected employee role when employeeId is supplied. System users with multiple roles can also… - [Returns notifications created after a previously received notification.](https://apidocs.worklio.com/reference/get_wep-messaging-getnewevents.md): Access: System and Admin users only. Use fromTime and fromId as the cursor returned by a previous notification query. - [Returns company-scoped notifications created after a previously received notification.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-getnewevents.md): Access: System, Admin, and ClientAdmin users only. Use fromTime and fromId as the cursor returned by a previous notification query. - [Returns employee-scoped notifications created after a previously received notification.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-getnewevents.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses the selected employee role when employeeId is supplied. - [Returns older notifications before a previously received notification.](https://apidocs.worklio.com/reference/get_wep-messaging-getpastevents.md): Access: System and Admin users only. Use fromPriority, fromTime, and fromId as the cursor returned by a previous notification query. - [Returns older notifications before a previously received notification for a selected company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-getpastevents.md): Access: System, Admin, and ClientAdmin users only. Use fromPriority, fromTime, and fromId as the cursor returned by a previous notification query. - [Returns older notifications before a previously received notification for an employee-scoped request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-getpastevents.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses the selected employee role when employeeId is supplied. - [Marks a notification as read.](https://apidocs.worklio.com/reference/get_wep-messaging-events-eventid-read.md): Access: System and Admin users only. Returns the timestamp payload for the stored read status. - [Marks a company-scoped notification as read.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-eventid-read.md): Access: System, Admin, and ClientAdmin users only. Returns the timestamp payload for the stored read status. - [Marks an employee-scoped notification as read.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-eventid-read.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses the selected employee role when employeeId is supplied. - [Marks a notification as dismissed.](https://apidocs.worklio.com/reference/get_wep-messaging-events-eventid-dismiss.md): Access: System and Admin users only. Dismissed status behaves like a read acknowledgment while indicating that the notification was intentionally dismissed. - [Marks a company-scoped notification as dismissed.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-eventid-dismiss.md): Access: System, Admin, and ClientAdmin users only. Dismissed status behaves like a read acknowledgment while indicating that the notification was intentionally dismissed. - [Marks an employee-scoped notification as dismissed.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-eventid-dismiss.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses the selected employee role when employeeId is supplied. Dismissed status behaves like a read… - [Refreshes the current state of specific notifications.](https://apidocs.worklio.com/reference/post_wep-messaging-refreshevents.md): Access: System and Admin users only. Clients can call this endpoint periodically to retrieve the current state of already received notifications. - [Refreshes the current state of specific notifications for a selected company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-messaging-refreshevents.md): Access: System, Admin, and ClientAdmin users only. Clients can call this endpoint periodically to retrieve the current state of already received notifications. - [Refreshes the current state of specific notifications for an employee-scoped request.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-messaging-refreshevents.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Uses the selected employee role when employeeId is supplied. Clients can call this endpoint… - [Returns survey-answer messaging items for a company-scoped route with both parent and reference identifiers.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-surveys-parentid-refid.md): Access: System, Admin, and ClientAdmin users only. Returns survey-related messaging items for the supplied survey parent and answer reference identifiers. unreadOnly is… - [Returns survey-answer messaging items for a company-scoped route filtered by parent identifier.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-messaging-surveys-parentid.md): Access: System, Admin, and ClientAdmin users only. Returns survey-related messaging items for the supplied survey parent identifier. unreadOnly is accepted for… - [Returns survey-answer messaging items for an employee-scoped route filtered by parent identifier.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-surveys-parentid.md): Access: permitted Employee users. Uses the selected employee role when employeeId is supplied. unreadOnly is accepted for compatibility but is not used by this endpoint implementation. - [Returns survey-answer messaging items that currently have comments or reactions.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-messaging-surveys-parentid-refid.md): Access: permitted Employee users. Uses the selected employee role when employeeId is supplied. Each returned item contains up to five most recent comments in its thread preview. Use the… - [Removes a reaction from a post, pin, or survey item.](https://apidocs.worklio.com/reference/delete_wep-messaging-posts-postid-reactions-reactionkey.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Use this overload when the reaction is attached directly to the parent item and not to an individual… - [Removes a reaction from a post, pin, or survey item.](https://apidocs.worklio.com/reference/delete_wep-messaging-pins-postid-reactions-reactionkey.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Use this overload when the reaction is attached directly to the parent item and not to an individual… - [Removes a reaction from a post, pin, or survey item.](https://apidocs.worklio.com/reference/delete_wep-messaging-surveys-postid-reactions-reactionkey.md): Access: System, Admin, ClientAdmin, and permitted Employee users. Use this overload when the reaction is attached directly to the parent item and not to an individual… - [Removes a reaction from a comment.](https://apidocs.worklio.com/reference/delete_wep-messaging-posts-postid-thread-commentid-reactions-reactionkey.md): Access: System, Admin, ClientAdmin, and permitted Employee users. The route determines whether the comment belongs to a post, pin, or survey item. - [Removes a reaction from a comment.](https://apidocs.worklio.com/reference/delete_wep-messaging-pins-postid-thread-commentid-reactions-reactionkey.md): Access: System, Admin, ClientAdmin, and permitted Employee users. The route determines whether the comment belongs to a post, pin, or survey item. - [Removes a reaction from a comment.](https://apidocs.worklio.com/reference/delete_wep-messaging-surveys-postid-thread-commentid-reactions-reactionkey.md): Access: System, Admin, ClientAdmin, and permitted Employee users. The route determines whether the comment belongs to a post, pin, or survey item. - [Refreshes the current state of mixed messaging feed items.](https://apidocs.worklio.com/reference/post_wep-messaging-refresh.md): Access: System and Admin users only. Returns the latest state for the requested events, posts, and pins, including thread preview updates for items whose thread information was… - [Refreshes the current state of mixed messaging feed items for a selected company.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-messaging-refresh.md): Access: System, Admin, and ClientAdmin users only. Returns the latest state for the requested events, posts, and pins. - [Refreshes the current state of mixed messaging feed items for an employee-scoped request.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-messaging-refresh.md): Access: permitted Employee users. Uses the selected employee role when employeeId is supplied and returns the latest state for the requested events, posts, and pins. - [Get Support Chat Info](https://apidocs.worklio.com/reference/get_wep-supportchat.md): Retrieves information needed for support chat. \ Valid only for partners with appropriate support agreement. \ This endpoint can be called only by… - [Get Support Chat Info](https://apidocs.worklio.com/reference/get_wep-systemhelp.md): Retrieves information needed for support chat. \ Valid only for partners with appropriate support agreement. \ This endpoint can be called only by… - [List Registered Company WebHooks](https://apidocs.worklio.com/reference/get_wep-companies-companyid-webhooks-1.md): Retrieves current company registered webhooks. \ Returned data contains list of all registered webhooks. \ This endpoint can be called only by System and… - [Create Company WebHook Registration](https://apidocs.worklio.com/reference/post_wep-companies-companyid-webhooks-1.md): Create Company WebHook Registration. \ Returned with registered webhook. \ This endpoint can be called only by System and Admin level users. \… - [List Registered WebHooks](https://apidocs.worklio.com/reference/get_wep-webhooks-1.md): Retrieves system wide registered webhooks. \ Returned data contains list of all system wide registered webhooks. \ This endpoint can be called only by… - [Create WebHook Registration](https://apidocs.worklio.com/reference/post_wep-webhooks-1.md): Create system wide WebHook Registration. \ Returned with registered system wide webhook. \ This endpoint can be called only by System level users. \… - [Get Company WebHook Registration](https://apidocs.worklio.com/reference/get_wep-companies-companyid-webhooks-webhookid-1.md): Get Company WebHook Registration. \ Returned with registered webhook. \ This endpoint can be called only by System and Admin level users. \… - [Delete Company WebHook Registration](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-webhooks-webhookid-1.md): Delete Company WebHook Registration. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden… - [Get WebHook Registration](https://apidocs.worklio.com/reference/get_wep-webhooks-webhookid-1.md): Get system wide WebHook Registration. \ Returned with registered webhook. \ This endpoint can be called only by System level users. \ \… - [Delete WebHook Registration](https://apidocs.worklio.com/reference/delete_wep-webhooks-webhookid-1.md): Delete system wide WebHook Registration. \ This endpoint can be called only by System level users. \ \ Admin and Employee call will return Forbidden… - [Test Company WebHook Registration](https://apidocs.worklio.com/reference/get_wep-companies-companyid-webhooks-webhookid-test-1.md): Test Company WebHook Registration. \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return Forbidden… - [Test WebHook Registration](https://apidocs.worklio.com/reference/get_wep-webhooks-webhookid-test-1.md): Test system wide WebHook Registration. \ This endpoint can be called only by System level users. \ \ Admin and Employee call will return Forbidden result - [List of fees configurations for a all clients.](https://apidocs.worklio.com/reference/get_wep-billingmodule-fees.md): List of fees configurations for a all clients.\ Requires System Admin role. \ Only System level fees configurations (not assigned to any client) are also included in the… - [List of fees configurations for a specific client.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-billingmodule-fees.md): List of fees configurations for a specific client.\ Requires Client or System Admin role. \ System level fees configurations (not assigned to any client) are also included… - [List of billing history for all clients.](https://apidocs.worklio.com/reference/get_wep-billingmodule-history-year-month.md): List of billing history items for a all clients, month and year.\ Requires System Admin role. \ - [List of billing history for a specific client.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-billingmodule-history-year-month.md): List of billing history items for a specific client, month and year.\ Requires Client or System Admin role. \ ## API Reference: Benefits Deductions API - [Gets the employee benefits overview.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-benefits-1.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the active and finished benefits, active enrollments, dependents, beneficiaries, and the life-event… - [Gets the detail of a single employee benefit or deduction.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-benefits-benefitid-1.md): Access: System, Admin, ClientAdmin, and Employee users. Returns the selected benefit together with additional schedule, premium, coverage, beneficiary, loan, and… - [Gets the employee benefits-and-deductions summary grouped by category.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-benefitsdeductions-1.md): Access: System, Admin, ClientAdmin, and Employee users. Returns simplified lists of benefits, garnishments, and miscellaneous deductions for scenarios that do not… - [Create New Hire Enrollment](https://apidocs.worklio.com/reference/post_wep-companies-companyid-enrollment-newhire-1.md): Create New Hire Enrollment. \ - [Create Open Enrollment](https://apidocs.worklio.com/reference/post_wep-companies-companyid-enrollment-open-1.md): Create Open Enrollment. \ - [Create QLE Enrollment](https://apidocs.worklio.com/reference/post_wep-companies-companyid-enrollment-qle-1.md): Create QLE Enrollment. \ - [Get enrollments for client](https://apidocs.worklio.com/reference/get_wep-companies-companyid-enrollments-1.md): Get Enrollments for Client. \ - [List of employees Event Life Requests.](https://apidocs.worklio.com/reference/get_api-ebr-companies-companyid-employees-employeeid-qlerequests-1.md): Retrieve list of employees event life requests. \ Can be called by all types of accounts. - [List of employees Event Life Requests.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-qlerequests-1.md): Retrieve list of employees event life requests. \ Can be called by all types of accounts. - [Get Employees Event Life Request.](https://apidocs.worklio.com/reference/get_api-ebr-companies-companyid-employees-employeeid-qlerequests-requestid-1.md): Retrieve employees event life request. \ Can be called by all types of accounts. - [Update Life Event Request.](https://apidocs.worklio.com/reference/patch_api-ebr-companies-companyid-employees-employeeid-qlerequests-requestid-1.md): Update Life Event Request. \ Returned data contains updated life event request. \ - [Delete Live Event Request.](https://apidocs.worklio.com/reference/delete_api-ebr-companies-companyid-employees-employeeid-qlerequests-requestid-1.md): Delete Life Event Request. \ - [Get Employees Event Life Request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-qlerequests-requestid-1.md): Retrieve employees event life request. \ Can be called by all types of accounts. - [Update Life Event Request.](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-qlerequests-requestid-1.md): Update Life Event Request. \ Returned data contains updated life event request. \ - [Delete Live Event Request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-qlerequests-requestid-1.md): Delete Life Event Request. \ - [List Of Available Life Event Types.](https://apidocs.worklio.com/reference/get_api-ebr-companies-companyid-employees-employeeid-qlerequests-lifeeventtypes-1.md): Retrieve list of available life event types. \ Can be called by all types of accounts. - [List Of Available Life Event Types.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-qlerequests-lifeeventtypes-1.md): Retrieve list of available life event types. \ Can be called by all types of accounts. - [Create Life Event Request.](https://apidocs.worklio.com/reference/post_api-ebr-companies-companyid-employees-employeeid-qlerequests-lifeevent-1.md): Create Life Event Request. \ Returned data contains newly created life event request. \ - [Create Life Event Request.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-qlerequests-lifeevent-1.md): Create Life Event Request. \ Returned data contains newly created life event request. \ - [List of Benefit Templates](https://apidocs.worklio.com/reference/get_wep-companies-companyid-benefittemplates-1.md): Retrieves current company Benefit Templates. \ Returned data contains list of all benefit templates in Company. \ This endpoint can be called only by… - [Create Benefit Template](https://apidocs.worklio.com/reference/post_wep-companies-companyid-benefittemplates-1.md): Create new company Benefit Template. \ Settings in template could be used later for creating new benefits deductions on Employee level. \ This endpoint can be… - [Update Benefit Template](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-benefittemplates-templateid-1.md): Update current company Benefit Template. \ Be aware that updating benefit template WILL NOT UPDATE employee deductions created with this template. \ This… - [Delete Benefit Template](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-benefittemplates-templateid-1.md): Delete current company Benefit Template. \ Be aware that deleting benefit template WILL NOT DELETE employee deductions created with this template. \ This… - [List of Company Benefits](https://apidocs.worklio.com/reference/get_wep-companies-companyid-benefits.md): Get list of current company benefits. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will… - [List of Assigned Employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-benefits-benefitid-benefitemployees-1.md): Get list of assigned employees. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call will return… - [List of Employee Benefit Deductions](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-benefit-1.md): Retrieve list of employee's benefit deductions. \ Benefit Deductions and Benefit Templates are unconnected entities. From this reason you are not able to see which Benefit Template was… - [Create Employee Benefit](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-deductions-benefit-1.md): Create Employee Benefit Deduction. \ Benefit Template working as default source of data. All items not filled in Employee Benefit Deduction model will be taken from Benefit Template (if… - [Get Employee Benefit](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-benefit-benefitid-1.md): Get selected Employee Benefits. \ Benefit Deductions and Benefit Templates are unconnected entities. From this reason you are not able to see which Benefit Template was used for create… - [Update Employee Benefit](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-deductions-benefit-benefitid-1.md): Updates current Employee Benefit Deduction. \ Benefit Deductions and Benefit Templates are unconnected entities. From this reason you are not able to see which Benefit Template was used… - [Delete Employee Benefit Deduction](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-deductions-benefit-benefitid-1.md): Delete Employee Benefit Deduction. \ Employee Benefit would be deleted by settings of ValidTo item to previous day. This will keep deduction in system (which is mandatory) but… - [List of Current Deductions](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions.md): Get list of current deductions. \ Miscellaneous, Child Support garnishment and Benefits are supported now.\ Each type is stored as json array in separated object.… - [Get Child Support Deduction](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-childsupport-deductionid.md): Retrieve employee Child support deduction. \ \ This endpoint can be called by all level users. - [Update Child Support Deduction](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-deductions-childsupport-deductionid.md): Update employee Child Support Deduction \ \ This endpoint can be called by all level users. - [List of Child Support Deductions](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-childsupport.md): Get list of current post-tax, child support deductions. \ \ This endpoint can be called by all level users. - [Create Child Support Deduction](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-deductions-childsupport.md): Create employee Child Support Deduction. \ \ This endpoint can be called by all level users. - [List of Employee Deduction History](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-deductionid-history-1.md): Retrieve employee deduction history. \ \ This endpoint can be called by all level users. - [Get Miscellaneous Deduction](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-misc-deductionid.md): Retrieve employee Miscellaneous support deduction. \ \ This endpoint can be called by all level users. - [Update Miscellaneous Deduction](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-employees-employeeid-deductions-misc-deductionid.md): Update employee Miscellaneous Deduction \ \ This endpoint can be called by all level users. - [List of Miscellaneous Deductions](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-deductions-misc.md): Get list of current post-tax, Miscellaneous deductions. \ \ This endpoint can be called by all level users. - [Create Miscellaneous Deduction](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-deductions-misc.md): Create employee Miscellaneous Deduction \ \ This endpoint can be called by all level users. - [List of Benefit Groups](https://apidocs.worklio.com/reference/get_wep-companies-companyid-benefit-groups.md): Retrieves current company Benefit Groups. \ Returned data contains list of all benefit groups in Company. \ This endpoint can be called only by System… ## API Reference: Time-Off Requests API - [Get timeoff request employee's policy](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-timeoff-request-policy.md): Gets timeoff request employee's policy.\ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager and Employee level… - [Update timeoff request employee's policy](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-timeoff-request-policy.md): Update timeoff request employee's policy. \ This endpoint can be called only by System and Admin level users. \ - [Get list of timeoff request policies](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-request-policies.md): Gets list of timeoff request policies. This endpoint can be called only by System and Admin level users. \ - [Update timeoff request policy](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-timeoff-request-policies-id.md): Update timeoff request policy and set information about it. \ This endpoint can be called only by System and Admin level users. \ - [Get list of timeoff requests](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-requests.md): Get list of timeoff request - [Create timeoff request](https://apidocs.worklio.com/reference/post_wep-companies-companyid-timeoff-requests.md): Create timeoff request and set information about it. - [Gets information about current role.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-requests-me.md) - [Retrieves timeoff request information](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-requests-id.md): Retrieve timeoff request information for specified companyId, requestId parameters. - [Update timeoff request](https://apidocs.worklio.com/reference/put_wep-companies-companyid-timeoff-requests-id.md): Update timeoff request and set information about it. \ This endpoint can be called only by System, Admin and Employee level users. \… - [Remove time off request](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-timeoff-requests-id.md): Remove timeoff request. \ This endpoint can be called only by System, Admin and Employee level users. - [Calculate duration](https://apidocs.worklio.com/reference/post_wep-companies-companyid-calc-duration-timeoff-requests.md) - [Calculate balance](https://apidocs.worklio.com/reference/post_wep-companies-companyid-calc-balance-timeoff-requests.md) - [Cancel time off request](https://apidocs.worklio.com/reference/post_wep-companies-companyid-timeoff-request-cancel-id.md): Remove time off request, with possibility split. - [Approve timeoff request](https://apidocs.worklio.com/reference/put_wep-companies-companyid-approved-timeoff-requests-id.md): Approve timeoff request. \ This endpoint can be called only by System and Admin level users or Manager of Employee. - [Deny timeoff request](https://apidocs.worklio.com/reference/put_wep-companies-companyid-denied-timeoff-requests-id.md): Deny timeoff request. \ This endpoint can be called only by System and Admin level users or Manager of Employee. - [Get list of timeoff request types](https://apidocs.worklio.com/reference/get_wep-companies-companyid-timeoff-request-types.md): Gets list of timeoff request types. - [Create timeoff request type](https://apidocs.worklio.com/reference/post_wep-companies-companyid-timeoff-request-types.md): Create timeoff request type and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ - [Update timeoff request type](https://apidocs.worklio.com/reference/put_wep-companies-companyid-timeoff-request-types-id.md): Update timeoff request type and set information about it. \ This endpoint can be called only by System and Admin level users. \ - [Remove timeoff request type](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-timeoff-request-types-id.md): Remove timeoff request type. \ This endpoint can be called only by System and Admin level users. \ ## API Reference: Worker's Comp API - [Get list of Workers' Compensation Codes](https://apidocs.worklio.com/reference/get_wep-workcomp-codes.md): Retrieves list of Workers' Compensation Codes. \ Returned data contains Code and Description \ This endpoint can be called only by System and… - [Get list of Workers' Compensation Codes for specified company](https://apidocs.worklio.com/reference/get_wep-companies-companyid-workcomp-codes.md): Retrieves list of Workers' Compensation Codes for specified company. \ Returned data contains Code and Description \ This endpoint can be called only by… - [Get list of Workers' Compensation Codes for specified company and division](https://apidocs.worklio.com/reference/get_wep-companies-companyid-divisions-divisionid-workcomp-codes.md): Retrieves list of Workers' Compensation Codes for specified company and division. \ Returned data contains Code and Description \ This endpoint can be called… - [Get list of Workers' Compensation Codes for specified company and state](https://apidocs.worklio.com/reference/get_wep-companies-companyid-workcomp-state-codes.md): Retrieves list of Workers' Compensation Codes for specified company and state. \ Returned data contains Code and Description \ This endpoint can be called only… - [Get list of Workers' Compensation Codes for specified company, division and state](https://apidocs.worklio.com/reference/get_wep-companies-companyid-divisions-divisionid-workcomp-state-codes.md): Retrieves list of Workers' Compensation Codes for specified company, division and state. \ Returned data contains Code and Description \ This endpoint can be… - [Get list of Workers' Compensation Codes for specified employee](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-workcomp-codes.md): Retrieves list of Workers' Compensation Codes for specified employee. \ Returned data contains Code and Description \ This endpoint can be called only by… - [Get list of Workers' Compensation Company Rates](https://apidocs.worklio.com/reference/get_wep-companies-companyid-workcomp-rates.md): Retrieves list of Workers' Compensation Rates. \ This endpoint can be called only by System and Admin level users. \ \ Employee call… - [Create Workers' Compensation Company Rate](https://apidocs.worklio.com/reference/post_wep-companies-companyid-workcomp-rates.md): Create Workers' Compensation Company Rate and set information about it. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Get Workers' Compensation Company Rate](https://apidocs.worklio.com/reference/get_wep-companies-companyid-workcomp-rates-versionid.md): Retrieve Workers' Compensation Company Rate informations for specified versionId parameter. \ This endpoint can be called only by System and Admin level… - [Update Workers' Compensation Company Rate](https://apidocs.worklio.com/reference/patch_wep-companies-companyid-workcomp-rates-versionid.md): Update Workers' Compensation Company Rate. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call… ## API Reference: YTDImport API - [Gets whether prior payroll history import is completed for the company onboarding flow.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-companyonboarding-isimportcompleted.md): Access: System, Admin, and ClientAdmin users only. Swagger consumers can use this endpoint to decide whether onboarding setup can rely on imported historical payroll data.… - [Start Setup Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll.md): Start setup payroll wizard for the year of the first planned payroll in our system if eesPaidInCurrentYear parameter is set to True. \ If eesPaidInCurrentYear parameter = False then the record is… - [Get Setup Payroll Status](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll.md): Gets the current status of setup payroll wizard. \ This endpoint can be called even before starting a wizard for a company to get the year for which the wizard should be started \ and the deadline… - [Discard Setup Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-discard.md): Discard setup payroll wizard. \ The operation irreversibly removes all entered data. - [Get Eligible Employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll-eligibleemployees.md): Get eligible employees and contractors. \ An emploee / contractor is eligible for adding if there is an employment and an employee tax setup defined for them for the setup payroll wizard year. \ \… - [Get Employees](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll-employees.md): Get list of employees/contractors in setup payroll. \ This endpoint is supposed to provide the overview of the progress of data entering during DataEntry state. \ \ Setup Payroll Wizard State:… - [Add Employees](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-employees.md): Add employees/contactors to setup payroll \ \ Setup Payroll Wizard State: DataEntry - [Remove Employee](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-setuppayroll-employees-employeeid.md): Remove employee/contractor from setup payroll. \ Data entered for this employee (paystubs, quarter totals data, ...) are removed as well. \ The employee will appear in GetEligibleEmployees list… - [Get Quarter Data](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter.md): Get setup payroll wizard data for given quarter. \ Depending on the type of data in the quarter output contains either the list of entered paystubs (in case of per-paystub quarter) \… - [Save Data](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter.md): Saves totals quarter data. The GetQuarterData method needs to be called prior to this call to get the info on which items should be filled in. \ The save request needs to contain "Token" received… - [Get Paystub Data](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter-fields.md): Get data necessary for submitting Year-To-Date data for paystub in selected quarter. \ \ The method may return list of available pay periods. \ Also, one of the periods (for which no data has… - [Get Paystub Data](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter-fields-paystubid.md): Get data necessary for editing Year-To-Date data of existing paystub. \ \ The items which can be filled-in are returned in 4 lists: Wage items, Deductions, Taxes and Reimbursements.\ Any… - [Save WagesReceived](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter-wages.md): Set or unset WagesReceived flag for per-paystub or totals quarters. \ If there is some previously stored data (totals or paystubs) the data is retained when changing WagesReceived. \ Note: For… - [Add Paystub](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter-addpaystub.md): Saves paystub data as a new paystub record. The GetPaystubData method needs to be called prior to this call to get the info on which items should be filled in. \ In case of pay period (dates)… - [Update Paystub](https://apidocs.worklio.com/reference/put_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter-paystubid.md): Updates existing paystub record. The GetPaystubData method needs to be called prior to this call \ to get the info on which items should be filled in and previous values of the items. \ \ In case… - [Remove Paystub](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-setuppayroll-employees-employeeid-quarter-quarter-paystubid.md): Removes existing paystub. The operation is irreversible. \ Setup Payroll Wizard State: DataEntry - [Get Quarters Overview](https://apidocs.worklio.com/reference/get_wep-companies-companyid-setuppayroll-quartersoverview.md): Gets overview of entered data per employee for every quarter and also for all quarters combined. \ \ Setup Payroll Wizard State: Overview - [Process Data](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-process.md): Starts data processing. Data processing is a background process. It's progress can be tracked by calling GetSetupPayrollStatus endpoint. \ \ Setup Payroll Wizard State: Processing - [Finish Setup Payroll](https://apidocs.worklio.com/reference/post_wep-companies-companyid-setuppayroll-finish.md): Finish the setup payroll wizard after the processing had finished. ## API Reference: W4 Requests API - [Lists employees for whom a new W-4 request can be created.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests-candidates.md): Access: System, Admin, and ClientAdmin users only. The response contains employee identifiers only. Each identifier represents an employee who is currently eligible for a new… - [Creates a new W-4 request for an employee.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-w-4-requests.md): Access: System, Admin, ClientAdmin, and Employee users. The request captures a snapshot of the employee data used for the W-4 flow, including the residential address,… - [Lists W-4 requests that are visible to the caller for the specified company.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests.md): Access: System, Admin, ClientAdmin, and Employee users. Employee callers receive only their own requests. Other callers receive only requests for employees they are… - [Generates the workflow URL for a W-4 request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests-id-url.md): Access: System, Admin, ClientAdmin, and Employee users. The URL can be generated only while the request is in… - [Gets detailed metadata for a single W-4 request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests-id.md): Access: System, Admin, ClientAdmin, and Employee users. The response expands the overview model with author information, optional completer information, and workflow… - [Cancels an existing W-4 request.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-w-4-requests-id.md): Access: System, Admin, ClientAdmin, and Employee users. The request must belong to the specified company and be visible to the caller. A successful cancellation returns… - [Downloads a generated W-4 document for the request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests-id-verification-documents-type.md): Access: System, Admin, ClientAdmin, and Employee users. Documents can be downloaded only when the request is in… - [Uploads a manually signed W-4 document for employer verification.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-w-4-requests-id-verification-documents-type.md): Access: System, Admin, and ClientAdmin users only. Manual documents can be uploaded only when the request is in Worklio.ApiModels.API.Enums.W4.Status_v10.EmployeeFinished or… - [Loads the tax setup data used during W-4 verification.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests-id-verification-tax-setup.md): Access: System, Admin, and ClientAdmin users only. The endpoint returns the saved verification tax setup when it already exists; otherwise it constructs a default tax setup… - [Finalizes the tax setup step for W-4 verification.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-w-4-requests-id-verification-tax-setup.md): Access: System, Admin, and ClientAdmin users only. The endpoint loads or constructs the verification tax setup, calculates default tax parameters, marks the tax setup step as… - [Returns the current employer verification status for a W-4 request.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-w-4-requests-id-verification.md): Access: System, Admin, and ClientAdmin users only. The response tells the caller whether the request is ready for finalization and, when it is not, which verification steps… - [Finalizes a verified W-4 request.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-w-4-requests-id-finish.md): Access: System, Admin, and ClientAdmin users only. Finalization is available only after the request reaches the employer verification stage. A successful call creates the… ## API Reference: Client General Ledger API - [Returns a list of supported third-party connectors](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-export-connectors.md): Returns a list of supported third-party connectors. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Returns the currently activated third-party connector.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-export-connectors-current.md): Returns the currently activated third-party connector. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Returns current settings for QuickBooks Online connector.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-export-connectors-exportconnectorid-settings-quickbooksonline.md): Returns current settings for QuickBooks Online connector. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Sets settings for QuickBooks Online connector.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-gl-export-connectors-exportconnectorid-settings-quickbooksonline.md): Sets settings for QuickBooks Online connector. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee… - [Returns OAuth Authorization URL for selected Connector API.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-export-connectors-exportconnectorid-connect.md): Authorization URL. See CanConnect flag on Worklio.ApiModels.API.Models.ClientGL.ExportConnectors.ExportConnector_v10. \ \ This endpoint can be called only by… - [Disconnects from the Thidr-party app (such as QuickBooks Online).](https://apidocs.worklio.com/reference/post_wep-companies-companyid-gl-export-connectors-exportconnectorid-disconnect.md): See CanDisconect flag on Worklio.ApiModels.API.Models.ClientGL.ExportConnectors.ExportConnector_v10. \ \ This endpoint can be called only by System and… - [Deactivates (discards) the Connector.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-gl-export-connectors-exportconnectorid-deactivate.md): See CanDeactivate flag on Worklio.ApiModels.API.Models.ClientGL.ExportConnectors.ExportConnector_v10.\ \ This endpoint can be called only by System and… - [Returns list of Bank Accounts for active Connector](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-mapping-bank-accounts.md): Gets list of Bank Accounts for active Connector. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee… - [Returns simplified mapping records for active Connector.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-mapping-simplified-mappings.md): Returns simplified mapping records for active Connector. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Updates simplified mapping records for active Connector.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-gl-mapping-simplified-mappings.md): Updates simplified mapping records for active Connector. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Gets a list of ClientGL Journal Entry exports.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-exports.md): This function retrieves a list of ClientGL Journal Entry exports. To retrieve specific exports, use the id_in query parameter. \ \ \ This endpoint can be… - [Starts exporting the given list of payrolls using the current export connector.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-gl-exports.md): Starts exporting the given list of payrolls using the current export connector.\ \ This endpoint can be called only by System and Admin level users. \… - [Returns details of a ClientGL Journal Entry export record.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-exports-exportid.md): Returns details of a ClientGL Journal Entry export record. \ \ This endpoint can be called only by System and Admin level users. \ \… - [Deletes ClientGL Journal Entry export record.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-gl-exports-exportid.md): Deletes ClientGL export. See CanDelete flag on Worklio.ApiModels.API.Models.ClientGL.Exports.Export_v10. \ \ This endpoint can be called only by System and… - [Retries a failed ClientGL Journal Entry export.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-gl-exports-exportid-retry.md): Retries a failed ClientGL Journal Entry export. See CanRetry flag on Worklio.ApiModels.API.Models.ClientGL.Exports.Export_v10. \ \ This endpoint can be called only… - [Returns a detailed list of exported items.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-exports-exportid-details.md): Returns a detailed list of exported items. \ \ This endpoint can be called only by System and Admin level users. \ \ Employee call… - [Returns a list of warning/error messages that occurred during the export process.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-exports-exportid-alerts.md): Returns a list of warning/error messages that occurred during the export process. \ \ This endpoint can be called only by System and Admin level users. \… - [This endpoint is used to receive authorization tokens from QuickBooks Online and other third-party apps.](https://apidocs.worklio.com/reference/get_wep-clientgl-oauthcallback.md): \ \ This endpoint can be called by anybody. - [Gets list of payrolls for given criteria.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-gl-payrolls.md): Gets a list of payrolls based on the given criteria. If no criteria are provided, it returns all non-processed payrolls for the current export connector.\ \ This endpoint… ## API Reference: Time Attendance API - [Events Types](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-event-types.md): Get list of time attendance events for specified companyId. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's… - [List of Policies](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-policies.md): Return list of Time Attendance Policies under Company for Employee where employee is responsibble for filling time. \ This endpoint can be called only by System and… - [Get summarized Time Attendance for a single day](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-summarized-daily-events.md): Returns summarized employee Time Attendance data for one day. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's… - [Get summarized Time Attendance for a date range](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-summarized-period-events.md): Returns summarized employee Time Attendance data for a range of days. \ This endpoint can be called only by System and Admin and ClientAdmin and… - [Get team summarized Time Attendance for a date range](https://apidocs.worklio.com/reference/get_wep-companies-companyid-time-attendance-summarized-period-events.md): Returns summarized Time Attendance data for multiple employees over a range of days. \ This endpoint can be called only by System and Admin and… - [Get current employee Time Clock status](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-status.md): Returns the currently open employee event for the current day. \ This endpoint can be called by Employee only. - [Start a new Time Clock event](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-start.md): Starts a new Time Clock event for the employee. \ This endpoint can be called by Employee only. - [Start a new work event](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-start-work.md): Starts a new work event for the employee with optional Work Setup configuration. \ This endpoint can be called by Employee only. - [End the current Time Clock event](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-end.md): Ends the currently open Time Clock event for the employee. \ This endpoint can be called by Employee only. - [Delete a Time Clock event](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-id.md): Deletes an existing employee's Time Clock event. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager… - [Update a Time Clock event](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-id.md): Updates an existing employee's Time Clock event. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager… - [Create a new Time Clock event](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events.md): Creates a new Time Clock event for the employee. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager… - [Returns current company time attendance statuses together with referenced event type definitions.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-time-attendance-time-clock-events-status.md): Access: System, Admin, ClientAdmin, Employee's Manager, and Employee users only. Returns the current company time clock snapshot, including active employee… - [Transfer Work Setup](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-event-work-setup-transfers.md): Access: System, Admin, ClientAdmin, Employee's Manager, and Employee users. Changes the Work Setup for one or more existing Time Clock work events that all… - [Get detailed daily events](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-daily-events.md): Returns Time Attendance events for a specific day. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager… - [Breaks from Policies](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-missing-breaks.md): \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager and Employee level users. \ - [Resolve Rest Breaks](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-time-attendance-missing-rest-breaks.md): Endpoint can be called by Employee only. - [Resolve Meal Breaks](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-time-attendance-missing-meal-breaks.md): Endpoint can be called by Employee only. - [Gets attestation messages for the employee approval period.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-approving-attestations.md): Access: System, Admin, ClientAdmin, Employee's Manager, and Employee users. Returns attestation messages that apply to the employee's reported time in the… - [Approves or disapproves reported time for a date range.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-approving.md): Access: Employee users only, limited to their own employee record. Updates the approval status for all reported hours in the inclusive range defined by… - [Time Clock - Event Change Log](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-time-clock-events-id-change-log.md): Get change log for events \ \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager and Employee… - [Load changes](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-change-log.md): Load Admin changes for Employee Events. Returns changes for Time Clock, Timesheet and Work Setup \ This endpoint can be called only by System and Admin and… - [Timesheet - Event Change Log](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-id-change-log.md): Get change log for events \ \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager and Employee… - [Resolve Change Log](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-change-log-process.md): Approve or Deny changes \ Endpoint can be called by Employee only. - [Lists day-level Timecard Notes write permissions for every calendar day in an employee date range.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-day-note-permissions.md): Access: System and Admin and ClientAdmin and Employee and Manager users with access to the requested employee. Both from and to are required ISO date query… - [Lists current notes for an employee day or date range.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-day-notes.md): Access: System and Admin and ClientAdmin and Employee and Manager users with access to the requested employee. When no date filter is supplied, the endpoint… - [Creates a new standalone note or reply for the requested employee day.](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-day-notes.md): Access: System and Admin and ClientAdmin and Employee and Manager users with access to the requested employee. The request supports two mutually exclusive modes:… - [Creates a new current version for an existing note.](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-time-attendance-day-notes-noteid.md): Access: only the note author. The endpoint preserves the previous version and returns the newly created current version row. If the supplied noteId already points to a historical row, the… - [Soft-deletes the current note version.](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-time-attendance-day-notes-noteid.md): Access: only the note author. The endpoint is idempotent. Deleting an already deleted current note still returns success. If the supplied noteId points to a historical row, the endpoint returns… - [Returns the full version chain for a single logical note.](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-day-notes-noteid-versions.md): Access: System and Admin and ClientAdmin and Employee and Manager users with access to the requested employee. The response returns versions in chronological… - [Get Timesheet events](https://apidocs.worklio.com/reference/get_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-policyid-from-to.md): Returns Timesheet events. The employee must be assigned to a Time Attendance Policy which type is Timesheet and must have active employment for the requested date range. \… - [Create a Timesheet Work Setup](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-policyid-work-setup.md): Creates or returns an existing Work Setup for Timesheet. Creates a new Work Setup for a specific day with zero work time. \ This endpoint can be called only by System… - [Create a Timesheet event](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-events.md): Creates a new Timesheet event for the employee. Reports new data for a specific day, Work Setup and event. \ This endpoint can be called only by System and… - [Update a Timesheet event](https://apidocs.worklio.com/reference/put_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-events-id.md): Updates an existing Timesheet event for the employee. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's… - [Delete events for a specific day](https://apidocs.worklio.com/reference/delete_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-policyid-day-work-setup-worksetupid.md): Deletes all Timesheet events for a specific day and Work Setup. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's… - [Update a Timesheet Work Setup](https://apidocs.worklio.com/reference/post_wep-companies-companyid-employees-employeeid-time-attendance-timesheet-policyid-day-work-setup-worksetupid.md): Updates the Work Setup for a specific day. \ This endpoint can be called only by System and Admin and ClientAdmin and Employee's Manager and… ## Changelog - [V1 API updates](https://apidocs.worklio.com/changelog/v1-api-updates.md) - [New v2 API available](https://apidocs.worklio.com/changelog/worklio-api-changelog.md)