Key Concepts

The Real World

  • A Client is the unit of billing for paiyroll®. A Client will be created for you when you start to use paiyroll®.

  • A Company is associated with a jurisdiction for tax, and other regulatory purposes. Multiple Company objects can be created under one Client.

  • An Employee corresponds to a worker. An Employee can have multiple periods of employment. Multiple Employee objects can be created under one Company.

  • A Pay Item corresponds to an element of pay for a worker. Pay Items come in many types including payments such as Salary and Bonus as well as deductions (such as for Tax and Garnishes).

  • An Administrator manages Company, Employee and other objects under a Client. Multiple Administrators can be created under one Client, and they can have different Roles which limit what they can see and change.

After initial bring up, the only on-going set up activity is to reflect changes in Employees and their Pay Items.

Client Company Employee Pay Item Administrator

Internals

As well as having one or more Company objects under a Client, additional objects are used to set up other aspects of a Client. These include:

  • Credentials which are to be shared.

  • Invoices, both live and historic.

  • Identity Providers for SSO.

Similarly, as well as having one or more Employee objects under a Company, additional objects are used to set up other aspects of a Company. These include:

  • Departments to associate Employees who are workers and other Employees who are their managers.

  • Pay Schedules which describe the routine of running Pay Runs such as the pay frequency and the pay day (for example, weekly on the Friday or monthly on the 28th).

  • Pay Definitions are the basis for creating Pay Items for workers.

  • Report Definitions are used to set up the outputs from a Pay Run (such as payslips, payments for a bank, or tax to be paid to the government) and inputs needed by a Pay Run (for example, updated tax codes from the government or details of shifts worked).

  • Workflow Definitions are used to configure automated Bots to perform a series of steps, and which record their results in Process objects. For example:

    • For an Employee to request a holiday, and have it approved by their manager.

    • To perform the calculations for a Pay Run, and then to submit reports using APIs, retrying on errors as needed.

These Pay Definitions, Report Definitions and Workflow Definitions expose other internal template layers, and adapt them to the needs and policies of a Company:

Pay Items Pay Definitions Pay Templates Report Definitions Report Templates Reports & Data Feeds Generated Processes Workflow Definitions Workflow Templates Pay runs, Report & Data Feed runs, Hol & Sick days, Timesheets

After initial bring up, the only on-going set up activity is to reflect changes in Company needs or policies.