The Workers APIs support the management of workers in an organization. A worker is a person who performs duties and responsibilities for an organization. In that capacity, a worker fills one or more positions via a work assignment. For a given work assignment, a worker is related to the organization as an employee or contractor. The Workers APIs can be used to obtain a list of all workers in an organization and to get information about work assignments.
A Pay Statement describes the details of a payment made to a payee. These details include the net and gross payment amounts, deductions, earnings, and year-to-date payroll accuals. The Pay Statements APIs can be used to retrieve the list of a specified number of pay statements for an associate or to get details for a specific statement.
Time Entry is the act of logging time by a worker. The Time Entry APIs support 3 types of entries: Clock, Time Entry (hours) or Time pairs. These APIs support the viewing of entries for a time period as specified by the System of Record (SOR) and may allow the creation and deletion of time entries based on rules determined by the SOR. If authorized, the APIs support the resolution of exceptions in a timesheet and the review of timesheets (i.e. approval process).
Time Off APIs support the viewing of time off balances, and the viewing of time off requests if the worker is allowed to make requests. In addition, if the user is authorized, the APIs support requesting time off, and approving time off by a manager.
Pay data input is a one-time payroll change, such as a charity deduction, for a worker. The Pay Data Input v1 APIs are used to add, modify, or replace pay data input for a worker, or to view all of the pay data inputs appllied to a worker. API metadata is also available.
Worker payroll instructions are used to specify recurring general deductions, garnishments, and retirement plan deductions for a specified worker. The Worker Payroll Instructions v1 APIs are used to start or stop payroll instructions for a worker, or to change an instruction that was previously started. You can also view all of the payroll instructions for a worker. API metadata is available.