Object Hierarchy

The following diagram illustrates the core entities of the API data models. The items are broken down into four main groups: Application, Employer, Employee and calculated items.

Hierarchy Diagram

Note: Click the item headers for more information.

Key Company Information Personal Information Pay Frequency Employee Net Pay Accountancy / Ledger Mapping Payment / Deduction Information Summary Instruction Application Level Employer Level Employee Level Calculated Items Payment Date Consumer Key Consumer Secret Definition Language Taxation Information Scheme Information Employer Payment / Deduction Summary Calculation Details Asynchronous Background Work HMRC Fillings Employer Employee Pay Schedule Pay Line Nominal Code Pay Instruction Report Line Instruction Pay Run Application Report Pay Code Pension Reporting Line Commentary Jobs RTI Transactions

Application

At the top of the pile is the Application level entities. These items hold the authentication credentials and affect all descendant employers.

Consumer Key Consumer Secret Definition Language Asynchronous Background Work Application Report Jobs

Employer

The employer level entities are used to store company level data and instructions.

Company Information Pay Frequency Accountancy / Ledger Mapping Summary Instruction Taxation Information Scheme Information Employer Pay Schedule Nominal Code Report Line Instruction Pay Code Pension

Employee

The employee level is used to manage the employees and their payment instructions.

Personal Information Payment / Deduction Information Employee Pay Instruction

Calculated Items

Generated data resides at the calculated item level. Calculated items are not directly managed by the user, being created by asynchronous background jobs.

Employee Net Pay Payment Date Employer Payment / Deduction Summary Calculation Details HMRC Fillings Pay Line Pay Run Reporting Line Commentary RTI Transactions