Connect Claude & ChatGPT to Staffology Payroll

346 tools for Staffology Payroll

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• create_a_payscheduleMoves moneyUpdate an existing schedule identified by ordinal. Financial or irreversible action; may require approval. API summary: Create a PaySchedule.
• create_assessmentChanges dataCreate a new assessment. API summary: Assess Employee for AutoEnrolment.
• create_attachmentorder_documentChanges dataCreate a new document for a attachmentorder. API summary: Add Document.
• create_contribution_markassentChanges dataCreate a new markassent for a contribution. API summary: Mark as Sent.
• create_employeeChanges dataCreate a new employee. Search employees first to avoid duplicates. API summary: Get list of FPS Employees for EYFPS for the given Ids.
• create_employee_benefitChanges dataCreate a new benefit for a employee. API summary: Create Benefit.
• create_employee_leaveChanges dataRecord leave for an employee by `employee_id`. In `body` set `type` (e.g. Holiday, Sick, Maternity), `from` and `to` dates, `pay` (e.g. PayAsUsual, StatutoryPay) and optional `notes`. This affects the employee's pay.
• create_employee_loanChanges dataCreate a new loan for a employee. API summary: Create Loan.
• create_employee_noteChanges dataAdd a note to an employee's record by `employee_id`, with `note_text`, optional `note_date` and `type` (General, NewStarterStatement, RtwProof, P45).
• create_employee_orderChanges dataCreate a new order for a employee. API summary: Create AttachmentOrder.
• create_employee_pensionChanges dataCreate a new pension for a employee. API summary: Create Pension.
• create_employerChanges dataCreate a new employer. Search employers first to avoid duplicates. API summary: Create an Employer.
• create_employer_costcentreChanges dataCreate a new costcentre for a employer. Required: code or title. API summary: Create Cost Centre.
• create_employer_custompayslipChanges dataCreate a new custompayslip for a employer. API summary: Update Payslip Customisations.
• create_employer_departmentChanges dataCreate a new department for a employer. Required: code or title. API summary: Create Department.
• create_employer_employeeChanges dataCreate a new employee for a employer. Search employees first to avoid duplicates.
• create_employer_logoChanges dataCreate a new logo for a employer. API summary: Update Employer Logo.
• create_employer_paycodeMoves moneyCreate a new paycode for a employer. Required: title or code. Financial or irreversible action; may require approval. API summary: Create PayCode.
• create_employer_payeeChanges dataCreate a new payee for a employer. Required: title. API summary: Create Payee.
• create_employer_pensionschemeChanges dataCreate a new pensionscheme for a employer. Required: name. API summary: Create a PensionScheme.
• create_ep_markasacceptedChanges dataCreate a new markasaccepted for a ep. API summary: Mark as Sent.
• create_fp_markasacceptedChanges dataCreate a new markasaccepted for a fp. API summary: Mark as Sent.
• create_fp_mostrecentforemployeeChanges dataCreate a new mostrecentforemployee for a fp. API summary: Get most recent FPS for Employees.
• create_leave_documentChanges dataCreate a new document for a leave. API summary: Add Document.
• create_loan_documentChanges dataCreate a new document for a loan. API summary: Add Document.
• create_note_documentChanges dataCreate a new document for a note. API summary: Add Document.
• create_notice_markasactionedChanges dataCreate a new markasactioned for a notice. API summary: Mark Pension Notice as Actioned (Beta).
• create_notice_retryChanges dataCreate a new retry for a notice. API summary: Retry Pension Notice (Beta).
• create_payrun_addpayrunentryMoves moneyCreate a new addpayrunentry for a payrun. Financial or irreversible action; may require approval. API summary: Add PayRunEntries (deprecated).
• create_payrun_paymentdateMoves moneyCreate a new paymentdate for a payrun. Financial or irreversible action; may require approval. API summary: Set PaymentDate.
• create_payrun_recalculatepayrunentryMoves moneyCreate a new recalculatepayrunentry for a payrun. Financial or irreversible action; may require approval. API summary: Recalculate PayRunEntries.
• create_payrun_supplementaryMoves moneyCreate a new supplementary for a payrun. Required: description, payment date or employee unique ids. Financial or irreversible action; may require approval. API summary: Creates a supplementary PayRun.
• create_payrun_zeroiseMoves moneyCreate a new zeroise for a payrun. Financial or irreversible action; may require approval. API summary: Zeroise PayRunEntries.
• create_report_employeeMoves moneyCreate a new employee for a report. Search employees first to avoid duplicates. Financial or irreversible action; may require approval. API summary: Employee Payments Report.
• create_retrieveChanges dataCreate a new retrieve. API summary: Manually Retrieve Pension Notices (Beta).
• create_userChanges dataCreate a new user. API summary: Set User Employer Options.
• delete_assessmentDeletesPermanently delete a assessment by assessment id. Destructive action; may require approval. API summary: Delete AE Assessment.
• delete_attachmentorder_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete AttachmentOrder Document.
• delete_completedsMoves moneyPermanently delete a completed. Financial or irreversible action; may require approval. API summary: Delete Completed Jobs.
• delete_deletesDeletesPermanently delete a delete by employer id. Destructive action; may require approval. API summary: Delete Employees.
• delete_departmentsMoves moneyPermanently delete a department by employer id. Financial or irreversible action; may require approval. API summary: Delete Department.
• delete_employee_benefitDeletesPermanently delete a benefit by benefit id. Destructive action; may require approval. API summary: Delete Benefit.
• delete_employee_leaveDeletesPermanently delete a leave record by `employee_id` and `leave_id`.
• delete_employee_loanDeletesPermanently delete a loan by loan id. Destructive action; may require approval. API summary: Delete Loan.
• delete_employee_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete Note.
• delete_employee_orderDeletesPermanently delete a order by order id. Destructive action; may require approval. API summary: Delete AttachmentOrder.
• delete_employee_pensionDeletesPermanently delete a pension by pension id. Destructive action; may require approval. API summary: Remove Pension.
• delete_employee_pensionsMoves moneyPermanently delete a pension by employee id. Financial or irreversible action; may require approval. API summary: Remove Pension (deprecated).
• delete_employeesMoves moneyPermanently delete a employee by employee id. Financial or irreversible action; may require approval. API summary: Delete Photo.
• delete_employerDeletesPermanently delete a employer by employer id. Destructive action; may require approval. API summary: Delete an Employer.
• delete_employer_costcentreDeletesPermanently delete a costcentre by costcentre code. Destructive action; may require approval. API summary: Delete Cost Centre (deprecated).
• delete_employer_costcentresMoves moneyPermanently delete a costcentre by employer id. Financial or irreversible action; may require approval. API summary: Delete Cost Centre.
• delete_employer_departmentDeletesPermanently delete a department by department code. Destructive action; may require approval. API summary: Delete Department (deprecated).
• delete_employer_employeeDeletesPermanently delete a employee by employee id. Destructive action; may require approval. API summary: Delete an Employee.
• delete_employer_paycodeMoves moneyPermanently delete a paycode by paycode code. Financial or irreversible action; may require approval. API summary: Delete PayCode (deprecated).
• delete_employer_payeeDeletesPermanently delete a payee by payee id. Destructive action; may require approval. API summary: Delete Payee.
• delete_employer_payrunMoves moneyPermanently delete a payrun by period number. Financial or irreversible action; may require approval.
• delete_employer_pensionschemeDeletesPermanently delete a pensionscheme by pensionscheme id. Destructive action; may require approval.
• delete_employer_scheduleMoves moneyPermanently delete a schedule by pay period. Financial or irreversible action; may require approval. API summary: Delete PaySchedule (deprecated).
• delete_employer_userDeletesPermanently delete a user by user id. Destructive action; may require approval. API summary: Remove User.
• delete_epDeletesPermanently delete a ep by ep id. Destructive action; may require approval. API summary: Delete Eps.
• delete_fpDeletesPermanently delete a fp by fp id. Destructive action; may require approval. API summary: Delete FPS.
• delete_leave_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete Leave Document.
• delete_loan_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete Loan Document.
• delete_nicDeletesPermanently delete a nic by unique id. Destructive action; may require approval. API summary: Delete NicSummary.
• delete_note_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete Note Document.
• delete_paycodesMoves moneyPermanently delete a paycode by employer id. Financial or irreversible action; may require approval. API summary: Delete PayCode.
• delete_payrun_removepayrunentriesMoves moneyPermanently delete a removepayrunentry by period number. Financial or irreversible action; may require approval. API summary: Remove PayRunEntries (deprecated).
• delete_payscheduleMoves moneyPermanently delete a schedule by ordinal. Financial or irreversible action; may require approval. API summary: Delete PaySchedule.
• download_downloadmaternityscheduleDownload the document for a downloadmaternityschedule. API summary: Download Maternity Payment Schedule.
• download_example_pdfChanges dataDownload the pdf document for a example. API summary: Example Payslip.
• get_aeoGet one aeo by aeo id. API summary: AEO Statement.
• get_assessmentGet one assessment by assessment id. API summary: Get AE Assessment.
• get_attachmentorder_documentGet one document for a attachmentorder by document id. API summary: Get AttachmentOrder Document.
• get_employeeGet one employee's full record by `employee_id`: personal details, employment, pay options, tax and NI, and leave settings.
• get_employee_benefitGet one benefit for a employee by benefit id. API summary: Get Benefit.
• get_employee_cost_centresList employees for a employee. API summary: Get Employee Cost Centres.
• get_employee_leaveGet one leave for a employee by leave id. API summary: Get Leave.
• get_employee_loanGet one loan for a employee by loan id. API summary: Get Loan.
• get_employee_messageGet one message for a employee by message id. API summary: Get Note.
• get_employee_orderGet one order for a employee by order id. API summary: Get AttachmentOrder.
• get_employee_pensionGet one pension for a employee by pension id. API summary: Get Pension.
• get_employerGet an employer's payroll settings and details by `employer_id`.
• get_employer_costcentreGet one costcentre for a employer by costcentre code. API summary: Get Cost Centre (deprecated).
• get_employer_departmentGet one department for a employer by department code. API summary: Get Department (deprecated).
• get_employer_hmrcpaymentGet one hmrcpayment for a employer by tax year. API summary: List HmrcLiabilities.
• get_employer_paycodeGet one paycode for a employer by paycode code. API summary: Get PayCode (deprecated).
• get_employer_payeeGet one payee for a employer by payee id. API summary: Get Payee.
• get_employer_pensionschemeGet one pensionscheme for a employer by pensionscheme id. API summary: Get a PensionScheme.
• get_epGet one ep by tax year. API summary: List EPS.
• get_epsGet one ep by ep id. API summary: Get EPS.
• get_fpGet one fp by tax year. API summary: List FPS.
• get_fp_employeeGet one employee for a fp by employee id. API summary: Get all FPS for Employee.
• get_fp_mostrecentforemployeeGet one mostrecentforemployee for a fp by employee id. API summary: Get most recent FPS for Employee.
• get_fpsGet one fp by fp id. API summary: Get FPS.
• get_gross_to_net_reportGet the gross-to-net report for a `tax_year` and `pay_period`, showing each employee's gross pay, tax, NI, pension and net pay, optionally between `from_period` and `to_period`.
• get_hmrcliabilityGet one hmrcpayment for a employer by period ending. API summary: Get HmrcLiability.
• get_holiday_reportGet the holiday report showing each employee's holiday allowance, days taken and days remaining.
• get_job_errorsList projects for a project. Optional filters: page num. Results are paginated. API summary: Get Job Errors.
• get_last_payrunentry_for_a_pension_deprecatedList pensionytds for a pension. API summary: Get last PayRunEntry for a Pension (deprecated).
• get_leave_documentGet one document for a leave by document id. API summary: Get Leave Document.
• get_list_of_employees_for_supplementary_payrunSearch employees for a employee by page num or query. Use this to find existing employees before creating a new employee. Results are paginated. API summary: Get List of Employees for Supplementary PayRun.
• get_list_of_employees_with_holiday_accrual_schemeList employees. API summary: Get List of Employees with Holiday Accrual Scheme.
• get_loan_documentGet one document for a loan by document id. API summary: Get Loan Document.
• get_navigationGet one navigation by pay run entry id. API summary: Get PayRunEntryNavigation for a specific PayRunEntry.
• get_nicGet one nic by tax year. API summary: Get NicSummaries.
• get_nicsummaryGet one nic by unique id. API summary: Get NicSummary.
• get_note_documentGet one document for a note by document id. API summary: Get Note Document.
• get_occupationalmaternityscheduleGet one occupationalmaternityschedule by occupationalmaternityschedule id. API summary: List Occupational Maternity Leave History.
• get_openingbalanceGet one openingbalance by tax year. API summary: Totals of employee opening balances for a tax year.
• get_pay_runGet one pay run by `tax_year`, `pay_period` and `period_number`, with each employee's gross pay, deductions and net pay. Filter with `search_term` or `department_code`.
• get_pay_run_entryGet one employee's entry in a pay run by `tax_year`, `pay_period`, `period_number` and `payrun_id` (the entry ID), with the full pay breakdown.
• get_pay_run_summary_reportMoves moneyGet a summary report of pay run totals for a `tax_year` and `pay_period`, optionally between `from_period` and `to_period`.
• get_paymentGet one payment by tax year. API summary: Get Payments.
• get_payscheduleGet one schedule for a employer by ordinal. API summary: Get PaySchedule.
• get_payschedule_deprecatedGet one schedule for a employer by pay period. API summary: Get PaySchedule (deprecated).
• get_payslipGet an employee's payslip for a pay run by `tax_year`, `pay_period`, `period_number` and `report_id` (the pay run entry ID).
• get_pendingGet one pending by employer id. API summary: Pending Letters Count.
• get_pensionscheme_contributionGet one contribution for a pensionscheme by tax year. API summary: List Contributions.
• get_pensionscheme_contribution_contributions_for_payrun_pension_Get one contribution for a pensionscheme by period number. API summary: Contributions for Payrun.
• get_pensionscheme_contribution_contributions_pension_schemeGet one contribution for a pensionscheme by submission id. API summary: Contributions Data.
• get_pensionscheme_noticeGet one notice for a pensionscheme by notice id. API summary: Get Pension Notice Detail (Beta).
• get_projectGet one project by project id. API summary: Get Job.
• get_report_cis300Get one cis300 for a report by cis300 id.
• get_report_cisstatementGet one cisstatement for a report by tax month. API summary: CIS Statement.
• get_report_exbGet one exb for a report by exb id.
• get_report_fpGet one fp for a report by fp id. API summary: FPS.
• get_report_p11dGet one p11d for a report by employee id. API summary: P11D For Employee.
• get_report_p30Get one p30 for a report by period ending.
• get_report_p60Get one p60 for a report by employee id. API summary: P60 For Employee.
• get_user_employer_optionsList users. API summary: Get User Employer Options.
• get_xml_requestList requests. Optional filters: compressed. API summary: Get XML Request.
• list_advancedvariancesList advancedvariances. Optional filters: pay period, ordinal, tax year, period, tax year compare or period compare. API summary: Advanced Variance Report.
• list_ae_assessmentsList ae assessments. API summary: AutoEnrolment Assessments.
• list_allsList alls. API summary: Get PaySchedules for Employer (for active tax years).
• list_assessment_lettersList letters for a assessment. API summary: Get Letter.
• list_changesList changes. Optional filters: from date or to date. API summary: Gets audit changes of all employees within a company.
• list_check_if_fps_late_reason_applicablesList check if fps late reason applicables. Optional filters: pay period, period number, tax year or ordinal. API summary: Check if the FPS late reason is applicable.
• list_cissummariesList cissummaries. API summary: CIS Subcontractor Summary.
• list_costcentresList costcentres. Optional filters: code. API summary: Get Cost Centre.
• list_cyclicreenrolmentsList cyclicreenrolments. Optional filters: reenrolment date. API summary: Export Cyclic Re-enrolments.
• list_departmentsList the employer's departments with their codes.
• list_departments_2List departments. Optional filters: code. API summary: Get Department.
• list_employee_autoenrolmentsList autoenrolments for a employee. API summary: Get AE Assessments.
• list_employee_averageholidaypayratesList averageholidaypayrates for a employee. Optional filters: start date or is daily. API summary: Calculate Average Holiday Pay Rate.
• list_employee_awesList awes for a employee. Optional filters: date, leave type, secondary date or tertiary date. API summary: Average Weekly Earnings.
• list_employee_basedailyratesList basedailyrates for a employee. Optional filters: pay period, pay basis or pay amount. API summary: Calculate Base Daily Rate (deprecated).
• list_employee_basehourlyratesList basehourlyrates for a employee. Optional filters: pay period, pay basis or pay amount. API summary: Calculate Base Hourly Rate (deprecated).
• list_employee_benefitsList benefits for a employee.
• list_employee_departmentsList departments for a employee. API summary: Get Employee Departments.
• list_employee_evcsettingsList evcsettings for a employee. API summary: Get EvcSettings.
• list_employee_lastsList lasts for a employee. Optional filters: is closed. API summary: Gets the last closed pay run entry for an employee.
• list_employee_leaveList an employee's leave records (holiday, sickness, parental leave) by `employee_id`.
• list_employee_loansList loans for a employee.
• list_employee_minimum_wagesList minimum wages for a employee. Optional filters: date.
• list_employee_notesList the notes kept on an employee's record by `employee_id`.
• list_employee_opening_balancesList opening balances for a employee. API summary: Get Opening Balances.
• list_employee_ordersList orders for a employee. API summary: List AttachmentOrders.
• list_employee_pay_run_entriesMoves moneyList all of an employee's pay run entries for a `tax_year`, by `employee_id`.
• list_employee_pensionsList pensions for a employee. API summary: Get Pension (deprecated).
• list_employee_rehiresList rehires for a employee. API summary: Rehire an Employee.
• list_employeerolesList employeeroles. Optional filters: employer id. API summary: Employee Export Roles Details.
• list_employeesList employees, filtered by `status` (Current, Former, Upcoming) or `dept_code`, with paging via `page_num` and `limit`.
• list_employees_2List employees for a employee. Optional filters: employee status, dept code, sort by or sort descending. API summary: Get employee navigation details for a specific employee.
• list_employees_employee_export_reportsList employees. Optional filters: employer id, tax year, include bank account details, include ytd, inc pension info or include pay info. API summary: Employee Export Details.
• list_employees_employee_leave_reportsList employees. Optional filters: tax year. API summary: Employee Leave.
• list_employer_automationsList automations for a employer. API summary: Get Automation Settings.
• list_employer_calendarsList calendars for a employer. Optional filters: from or to. API summary: Get Employer Calendar.
• list_employer_costcentresList costcentres for a employer. API summary: List Cost Centres.
• list_employer_custompayslipsList custompayslips for a employer. API summary: Get Payslip Customisations.
• list_employer_evcsList evcs for a employer. API summary: Get EVC OptIn History.
• list_employer_groupsList groups for a employer. API summary: Get Employer Groups.
• list_employer_openingbalancesList openingbalances for a employer. API summary: Get EmployerOpeningBalances.
• list_employer_payeesList payees for a employer.
• list_employer_pensionschemesList pensionschemes for a employer.
• list_employer_suggest_payroll_codesList suggest payroll codes for a employer.
• list_employer_usersList users for a employer.
• list_employer_year_endsList year ends for a employer. API summary: Review Year End Changes.
• list_employerchangesList employerchanges. Optional filters: from date or to date. API summary: Gets audit changes for a company.
• list_employersList the employers (companies) you run payroll for. Filter with `search_term`; returns employer IDs and employee counts.
• list_employers_2List employers. API summary: Employer Export.
• list_ep_apprenticeship_levytodatesList apprenticeship levytodates for a ep.
• list_ep_recoverableamountsList recoverableamounts for a ep. API summary: Recoverable Amounts.
• list_expiring_rtwsList expiring rtws. Optional filters: number of days. API summary: Expiring RightToWork.
• list_hmrcpayment_paymentsList payments for a hmrcpayment. Optional filters: bank holiday. API summary: HMRC Bank Payment.
• list_lastsList lasts. API summary: Get Last AE Assessment.
• list_leaversList employees who have left, with the option to show only those whose P45 has not been sent.
• list_ni_letter_validation_reportsList ni letter validation reports. Optional filters: pay date or pay period. API summary: NI Letter Validation (Employees).
• list_niytdsList niytds. Optional filters: employer id. API summary: NI Year To Date Values.
• list_nominalcodesList nominalcodes. API summary: Get Nominal Code Mappings.
• list_opensList opens. Optional filters: employer id. API summary: Get list of open payruns.
• list_p45_availabilitiesList p45 availabilities. API summary: Get P45 Download Availability.
• list_p45sList p45s. Optional filters: employee id. API summary: P45 For Employee.
• list_pay_codesList the employer's pay codes (e.g. BASIC, overtime, bonus) used on pay lines.
• list_pay_run_warningsList warnings on a pay run (e.g. missing bank details, below minimum wage) by `tax_year`, `pay_period` and `period_number`. Check before a pay run is finalised.
• list_pay_runsList pay runs for a `tax_year` (e.g. Year2026) and `pay_period` (e.g. Monthly, Weekly).
• list_pay_schedulesList the employer's pay schedules for a `tax_year` (e.g. Year2026), showing pay frequency, current period and payment dates.
• list_paycodesList paycodes. Optional filters: code. API summary: Get PayCode.
• list_paymentsList payments. Optional filters: payment date, bank holiday, ordinal, inc pensions, inc hmrc or inc aeos. API summary: Bank Payment Instructions.
• list_payrun_aeosList aeos for a payrun. Optional filters: ordinal. API summary: List AttachmentOrders related to a PayRun.
• list_payrun_changesList changes for a payrun. Optional filters: ordinal or version. API summary: List PayRun Changes.
• list_payrun_changes_for_payrunentryList changes for a payrun. Optional filters: ordinal, significant changes only or version. API summary: List PayRun Changes for PayRunEntry.
• list_payrun_eventsList events for a payrun. Optional filters: ordinal. API summary: Get PayPeriodEvents.
• list_payrun_journalsList journals for a payrun. Optional filters: ordinal, dept breakdown, include apprentice levy or all schedules. API summary: Get Journal for PayRun.
• list_payrun_leavesList leaves for a payrun. Optional filters: ordinal. API summary: List Leave related to a PayRun.
• list_payrun_paycodesList paycodes for a payrun. Optional filters: ordinal. API summary: Get PayCodes for a PayRun.
• list_payrun_state_historiesList state histories for a payrun. Optional filters: ordinal. API summary: List PayRunStateHistory.
• list_pendingsList pendings. API summary: Pending Letters.
• list_pension_pensionytdsList pensionytds for a pension. API summary: Gets last PayRunEntry for a Pension.
• list_pensionsList employees. API summary: List Pensions.
• list_pensionscheme_employeesList employees for a pensionscheme. API summary: Get Employees.
• list_pensionscheme_noticesList notices for a pensionscheme. Optional filters: page num. Results are paginated. API summary: List Pension Notices (Beta).
• list_postponementsList postponements. API summary: Pending Postponement Letters.
• list_project_documentsList documents for a project. API summary: Get Job file.
• list_projectsList projects. Optional filters: employer id, job type or page num. Results are paginated. API summary: List Jobs.
• list_reenrolmentstatusesList reenrolmentstatuses. Optional filters: id. API summary: Gets the re-enrolment status for the employer.
• list_renrolsList renrols. Optional filters: cyclical reenrolment date. API summary: Cyclical Re-enrolment.
• list_report_analysisList analysis for a report. Optional filters: from period, to period, ordinal, dept code or show pay period breakdown.
• list_report_analysiscostbreakdownsList analysiscostbreakdowns for a report. Optional filters: from period, to period, ordinal or dept code. API summary: Analysis Cost Breakdown.
• list_report_apprenticeshipleviesList apprenticeshiplevies for a report. API summary: Apprenticeship Levy Details.
• list_report_averageholidaypayratesList averageholidaypayrates for a report. Optional filters: period or ordinal. API summary: Average Holiday Pay Rate.
• list_report_costanalysisList costanalysis for a report. Optional filters: from period, to period or ordinal. API summary: Cost Analysis.
• list_report_costofemploymentsList costofemployments for a report. Optional filters: from period, to period or ordinal. API summary: Cost Of Employment.
• list_report_documentsList documents for a report. Optional filters: scheme id, ordinal or csv format. API summary: PAPDIS File.
• list_report_employeesList employees for a report. Optional filters: from period, to period, ordinal or dept code. API summary: Payroll Analysis with Employee Role Breakdown.
• list_report_employees_employee_benefits_reportsList employees for a report. Optional filters: report type. API summary: Employee Benefits.
• list_report_employees_employee_loan_export_reportsList employees for a report. Optional filters: ordinal. API summary: Employee Loan Export.
• list_report_fullsummaryofpaysList fullsummaryofpays for a report. Optional filters: period or ordinal. API summary: Cost Of Employment.
• list_report_furloughsList furloughs for a report. Optional filters: ordinal. API summary: FurloughReport.
• list_report_gender_pay_gapsList gender pay gaps for a report. Optional filters: gender pay gap snap shot date, ordinary pay code set id or bonus pay code set id.
• list_report_hourly_paysList hourly pays for a report. Optional filters: from period, to period or ordinal.
• list_report_loanbalancesList loanbalances for a report. Optional filters: ordinal or outstanding only. API summary: Loan Balances.
• list_report_ni_letter_validation_reportsList ni letter validation reports for a report. Optional filters: ordinal. API summary: NI Letter Validation (Payrun).
• list_report_niytdsList niytds for a report. Optional filters: ordinal. API summary: NI Year To Date Values.
• list_report_ordersList orders for a report. Optional filters: from period, to period or ordinal. API summary: Attachment Orders.
• list_report_p11detailedsList p11detaileds for a report. API summary: P11 (Detailed).
• list_report_p11detaileds_p11_detailed_multiple_reportsList p11detaileds for a report. API summary: All Detailed P11s For TaxYear.
• list_report_p11dsList p11ds for a report. Optional filters: exclude employees with p11d email sent. API summary: All P11Ds For TaxYear.
• list_report_p11sList p11s for a report.
• list_report_p32sList p32s for a report.
• list_report_p45_multiplesList p45 multiples for a report. API summary: P45 for Multiple Employees.
• list_report_p60sList p60s for a report. Optional filters: exclude employees with p60 email sent. API summary: All P60s For TaxYear.
• list_report_payroll_run_warningsList payroll run warnings for a report. Optional filters: ordinal. API summary: Export Payroll Run Warnings.
• list_report_payrolljournalcsvsList payrolljournalcsvs for a report. Optional filters: ordinal, dept breakdown, include apprentice levy or all schedules. API summary: Payroll Journal CSV.
• list_report_payruncsvsList payruncsvs for a report. Optional filters: ordinal, csv type or mapping id. API summary: Get PayRun CSV.
• list_report_payslips_payslips_reportsList payslips for a report. Optional filters: ordinal, unemailed, dept code, starters leavers filter, page num or sort by. Results are paginated.
• list_report_pensionmembershipsList pensionmemberships for a report. Optional filters: pay period or ordinal. API summary: Export Multiple Pension Memberships Report.
• list_report_statutory_paysList statutory pays for a report. Optional filters: from period, to period, statutory pay types or ordinal.
• list_report_taxcodesList taxcodes for a report. API summary: Taxcode Change.
• list_report_teachers_pension_eoysList teachers pension eoys for a report. Optional filters: local authority number or school employer type. API summary: Teachers Pension Eoy Report.
• list_report_umbrella_reconciliationsList umbrella reconciliations for a report. Optional filters: from period, to period, ordinal or employee id.
• list_report_variancesList variances for a report. Optional filters: ordinal, from period, to period, pay period compare, ordinal compare or tax year compare. API summary: Variance Report.
• list_report_ytdsList ytds for a report. Optional filters: ordinal. API summary: Year To Date Values.
• list_requestsList requests. API summary: Get XML Request.
• list_requiringattentionsList requiringattentions. API summary: RTI Documents Requiring Attention.
• list_requiringattentions_requiring_attention_epsList requiringattentions. API summary: EPS Requiring Attention.
• list_requiringattentions_requiring_attention_fpsList requiringattentions. API summary: FPS Requiring Attention.
• list_retrievestatesList retrievestates. API summary: Get Pension Notice Retrieve State (Beta).
• list_right_to_worksList right to works. API summary: RightToWork.
• list_role_assumedpensionablepaysList assumedpensionablepays for a role. Optional filters: pay period, leave type, leave pay type or from. API summary: Get Role Assumed Pensionable Pay.
• list_schedule_periodsList periods for a schedule. Optional filters: period number or include events. API summary: Get PaySchedulePeriods.
• list_spinepointsList spinepoints. Optional filters: pay spine id, effective date from or effective date to. API summary: Spine Point.
• list_statutorymaternityschedulesList statutorymaternityschedules. Optional filters: baby due date, leave from, leave to, leave type, leave pay type or pay frequency. API summary: List Statutory Maternity Leave History.
• list_usersList users. API summary: Get User Employer.
• list_ytdsList ytds. Optional filters: employer id. API summary: Year To Date Values.
• pay_employeeMoves moneyPay a employee (period number). Financial or irreversible action; may require approval. API summary: PayRun Payments.
• pay_paycodeMoves moneyPay a paycode (employer id). Financial or irreversible action; may require approval. API summary: Pay Code Export Details.
• pay_paymentMoves moneyPay a payment (payrun id). Financial or irreversible action; may require approval. API summary: PayRunEntry Umbrella Payment.
• pay_payrun_csvMoves moneyPay a payrun csv (period number). Financial or irreversible action; may require approval. API summary: PayRun CSV (deprecated).
• pay_payspineMoves moneyPay a payspine (employer id). Financial or irreversible action; may require approval. API summary: Pay Spine.
• pay_report_elementMoves moneyPay a report (pay period). Financial or irreversible action; may require approval. API summary: Pay Element.
• pay_report_gradesMoves moneyPay a report (employer id). Financial or irreversible action; may require approval. API summary: Pay Grade.
• search_employeesSearch employees by name or payroll code in `query`. Returns employee IDs for other lookups.
• search_employees_searchSearch employees by query or exlude cis sub contactors. Use this to find existing employees before creating a new employee.
• search_employers_searchSearch employers by query. Use this to find existing employers before creating a new employer.
• search_findlinkedpiwsSearch findlinkedpiws by leave type, leave pay type, from or to. Use this to find existing findlinkedpiws before creating a new findlinkedpiw. API summary: Find Linked Piw.
• search_payrollcodesSearch payrollcodes by code. Use this to find existing payrollcodes before creating a new payrollcode. API summary: Get Employee by Payroll Code.
• send_letterVisible to othersEmail a letter (assessment id). Has effects visible outside this system. API summary: Email Letter.
• send_letter_emailVisible to othersEmail a letter (employer id). Has effects visible outside this system. API summary: Email All Letters.
• send_messageVisible to othersSend a message (employee id). Has effects visible outside this system. API summary: Email P60 to an Employee.
• send_message_email_p11_d_reportsVisible to othersSend a message (employee id). Has effects visible outside this system. API summary: Email P11D to an Employee.
• send_p11dVisible to othersEmail a p11d (employer id). Has effects visible outside this system. API summary: Email P11D to all Employees.
• send_p45Visible to othersEmail a p45 (period number). Has effects visible outside this system. API summary: (Re)send P45 Emails.
• send_p45_emailVisible to othersEmail a p45 (employer id). Has effects visible outside this system. API summary: Email P45 to Employee.
• send_p45_email_multipleMoves moneySend a p45 email multiple (ordinal). Financial or irreversible action; may require approval. API summary: Email P45 to multiple employees.
• send_p60Visible to othersEmail a p60 (employer id). Has effects visible outside this system. API summary: Email P60 to all Employees.
• send_payrunMoves moneyEmail a payrun (period number). Financial or irreversible action; may require approval. API summary: (Re)send Payslip Emails.
• submit_epVisible to othersSubmit a ep (ep id). Has effects visible outside this system. API summary: Submit EPS.
• submit_fpVisible to othersSubmit a fp (fp id). Has effects visible outside this system. API summary: Submit FPS.
• submit_payrunMoves moneyFinalise a payrun (period number). Financial or irreversible action; may require approval. API summary: Finalise a PayRun (deprecated).
• submit_payrun_reopenMoves moneyReopen a payrun (period number). Financial or irreversible action; may require approval. API summary: Re-open a PayRun (deprecated).
• update_a_payrunentryMoves moneyUpdate an existing payrun identified by payrun id. Financial or irreversible action; may require approval. API summary: Update a PayRunEntry.
• update_departmentsVisible to othersUpdate an existing department identified by employer id. Has effects visible outside this system. API summary: Update Department.
• update_employee_benefitChanges dataUpdate an existing benefit identified by benefit id. API summary: Update Benefit.
• update_employee_departmentsVisible to othersUpdate an existing department identified by employee id. Has effects visible outside this system. API summary: Set Employee Departments.
• update_employee_evcsettingsVisible to othersUpdate an existing evcsetting identified by employee id. Has effects visible outside this system. API summary: Update EvcSettings.
• update_employee_leaveChanges dataChange an existing leave record by `employee_id` and `leave_id`, passing the updated fields in `body`. This can change the employee's pay.
• update_employee_loanChanges dataUpdate an existing loan identified by loan id. API summary: Update Loan.
• update_employee_messageChanges dataUpdate an existing message identified by message id. API summary: Update Note.
• update_employee_opening_balancesVisible to othersUpdate an existing opening balance identified by employee id. Has effects visible outside this system. API summary: Update Opening Balances.
• update_employee_orderChanges dataUpdate an existing order identified by order id. API summary: Update AttachmentOrder.
• update_employee_pensionChanges dataUpdate an existing pension identified by pension id. API summary: Update Pension.
• update_employee_pensionsVisible to othersUpdate an existing pension identified by employee id. Has effects visible outside this system. API summary: Update Pension (deprecated).
• update_employeesVisible to othersUpdate an existing employee identified by employee id. Has effects visible outside this system. API summary: Set Employee Cost Centres.
• update_employerChanges dataUpdate an existing employer identified by employer id. API summary: Update an Employer.
• update_employer_automationsVisible to othersUpdate an existing automation identified by employer id. Has effects visible outside this system. API summary: Update Automation Settings.
• update_employer_can_use_premium_connectorsVisible to othersUpdate an existing can use premium connector identified by employer id. Has effects visible outside this system. API summary: Update Can Use Premium Connectors Setting.
• update_employer_costcentreChanges dataUpdate an existing costcentre identified by costcentre code. API summary: Update Cost Centre (deprecated).
• update_employer_costcentresVisible to othersUpdate an existing costcentre identified by employer id. Has effects visible outside this system. API summary: Update Cost Centre.
• update_employer_departmentChanges dataUpdate an existing department identified by department code. API summary: Update Department (deprecated).
• update_employer_employeeChanges dataUpdate an existing employee identified by employee id. API summary: Update an Employee.
• update_employer_evcsVisible to othersUpdate an existing evc identified by employer id. Has effects visible outside this system. API summary: Update EVC OptIn.
• update_employer_groupsVisible to othersUpdate an existing group identified by employer id. Has effects visible outside this system. API summary: Set Employer Groups.
• update_employer_hmrcpaymentChanges dataUpdate an existing hmrcpayment identified by period ending. API summary: Update HmrcLiability.
• update_employer_openingbalancesVisible to othersUpdate an existing openingbalance identified by employer id. Has effects visible outside this system. API summary: Update EmployerOpeningBalances.
• update_employer_paycodeMoves moneyUpdate an existing paycode identified by paycode code. Financial or irreversible action; may require approval. API summary: Update PayCode (deprecated).
• update_employer_payeeChanges dataUpdate an existing payee identified by payee id. API summary: Update Payee.
• update_employer_payrunMoves moneyUpdate an existing payrun identified by pay period. Financial or irreversible action; may require approval. API summary: Starts the next PayRun (deprecated).
• update_employer_pensionschemeChanges dataUpdate an existing pensionscheme identified by pensionscheme id. API summary: Update a PensionScheme.
• update_employer_scheduleMoves moneyUpdate an existing schedule identified by pay period. Financial or irreversible action; may require approval. API summary: Update PaySchedule (deprecated).
• update_employer_year_endsVisible to othersUpdate an existing year end identified by employer id. Has effects visible outside this system. API summary: Make Year End Changes.
• update_epChanges dataUpdate an existing ep identified by tax year. API summary: Create EPS.
• update_fpChanges dataUpdate an existing fp identified by tax year. API summary: Create FPS.
• update_leaversVisible to othersUpdate an existing leaver identified by employer id. Has effects visible outside this system. API summary: Mark as Leavers.
• update_multipleChanges dataUpdate an existing multiple identified by tax year. API summary: Create FPS with multiple employees.
• update_nicChanges dataUpdate an existing nic identified by tax year. API summary: Update NicSummaries.
• update_nominalcodesMoves moneyUpdate an existing nominalcode identified by employer id. Financial or irreversible action; may require approval. API summary: Updates Nominal Code Mappings.
• update_onholdsVisible to othersUpdate an existing onhold identified by employer id. Has effects visible outside this system. API summary: Mark as On Hold.
• update_ownersVisible to othersUpdate an existing owner identified by employer id. Has effects visible outside this system. API summary: Set Owner.
• update_p45sVisible to othersUpdate an existing p45 identified by employee id. Has effects visible outside this system. API summary: Update P45 Value.
• update_paycodesMoves moneyUpdate an existing paycode identified by employer id. Financial or irreversible action; may require approval. API summary: Update PayCode.
• update_payincreasesMoves moneyUpdate an existing payincrease identified by employer id. Financial or irreversible action; may require approval. API summary: Apply Pay Increase.
• update_payoptionsMoves moneyUpdate an existing payoption identified by employer id. Financial or irreversible action; may require approval. API summary: Apply PayOptions.
• update_payrun_ytdsMoves moneyUpdate an existing ytd identified by period number. Financial or irreversible action; may require approval. API summary: Update YTD.
• update_pensionscheme_contributionChanges dataUpdate an existing contribution identified by submission id. API summary: Re-submit Contributions.
• update_periodMoves moneyUpdate an existing period identified by period number. Financial or irreversible action; may require approval. API summary: Update PaySchedulePeriod.
• update_photoChanges dataCreate a new employee for a employee. Search employees first to avoid duplicates. API summary: Update Photo.
• update_reset_holiday_schemesVisible to othersUpdate an existing reset holiday scheme identified by employer id. Has effects visible outside this system. API summary: Resets employee accrual scheme.
• update_sentsVisible to othersUpdate an existing sent identified by assessment id. Has effects visible outside this system. API summary: Mark Letter as Sent.
• update_statesVisible to othersUpdate an existing state identified by employee id. Has effects visible outside this system. API summary: Update State.
• update_terminationpaymentsVisible to othersUpdate an existing terminationpayment identified by employee id. Has effects visible outside this system. API summary: Update Termination Pay.
• upload_employeeChanges dataImport a employee (employer id). API summary: Import CSV.
• upload_employerChanges dataImport a employer. API summary: Import CSV.
• upload_importpayMoves moneyUpload a importpay (pay period). Financial or irreversible action; may require approval. API summary: Import Pay.
• upload_importtimeandattendanceMoves moneyUpload a importtimeandattendance (pay period). Financial or irreversible action; may require approval. API summary: Import Time And Attendance.
• upload_importumbrellapayMoves moneyUpload a importumbrellapay (pay period). Financial or irreversible action; may require approval. API summary: Import Umbrella Pay.

Questions