Toggle navigation
Home
Features
Pricing
Auto Enrolment
RTI
API
Blog
Contact
Try It
Guides
Introduction
Introduction
Authentication
Observability
The Basics
Items
Paging
Reports
Async Jobs
Webhooks
Getting Started
Create Employer
Create an Employee
Understanding PayOptions
The Ordinal property
Using Tags
Completing a Pay Run
Set a Schedule
Start the PayRun
Review the PayRun
Finalise the PayRun
Review and Submit the FPS
Get Accounting Entries
Payslips
Get Payslips
Customise Payslips
Year End Process
Review Year End Changes
Apply Year End Changes
Operations
Account
Activate an Account
Create Demo Employer
Change Email Address
Get Account Details
Update Photo
Update Profile
Get Invitations
Re-send Verification Email
Verify Email Address
Get Tenant
Get EmployerDefaults
Set EmployerDefaults
List User Employers
List ApiKeys
Create ApiKey
Get ApiKey
Delete ApiKey
AeAssessment
Assess an employee
AeEmployeeAssessment
Create employee auto enrolment assessment
List employee auto enrolment assessment
Get letters for an employee based on tax year
Get pending letters for an employer
Get count of pending pension letters for an employer
Process AE Assessment for Employee during PayRun
Gets a list of re-enrolment dates for the employer
Email AeLetter
Mark Letter as Sent
Mark All Letters as Sent
Get AeLetter
Get Ae Assessments for an employee.
Gets employee AE assessment for a specific role.
AnalysisCategory
List AnalysisCategories
Create AnalysisCategory
Get AnalysisCategory
Update AnalysisCategory
Delete AnalysisCategory
List AnalysisCategoryCodes
Create AnalysisCategoryCode
Get AnalysisCategoryCode
Delete AnalysisCategoryCode
Update AnalysisCategoryCode
AttachmentOrder
Create AttachmentOrder
List AttachmentOrders
Get AttachmentOrder
Update AttachmentOrder
Delete AttachmentOrder
Get Payments
Add Document
Delete AttachmentOrder Document
Get AttachmentOrder Document
Audit
Employer Audit Log
AutoEnrolment
Get AE Assessments
Assess Employee for AutoEnrolment
Get AE Assessment
Delete AE Assessment
Get Last AE Assessment
Get Letter
Email Letter
Email All Letters
Mark Letter as Sent
Mark All Letters as Sent
Update State
Pending Letters Count
Pending Letters
Pending Postponement Letters
Cyclical Re-enrolment
AverageHolidayPayHistory
Create multiple AverageHolidayPayHistory for an Employer
Get AverageHolidayPayHistory for Employer
Update multiple AverageHolidayPayHistory for an Employer
List AverageHolidayPayHistory for Employee
Get previous payment date for an employee before a given date
Delete an AverageHolidayPayHistory record
Delete all AverageHolidayPayHistory for an Employee
Import AverageHistoryPayHistory from csv file
Benefits
Create Benefit
List Benefits
Get Benefit
Update Benefit
Delete Benefit
Billing
Get DirectDebitMandate
Delete DirectDebitMandate
Setup DirectDebitMandate
Confirm Direct Debit Setup
List Bills
Get Bill
Get Bill CSV
Get UsageStats Report
Bureau
List Allocated Processors
List Employers
Get BureauSettings
Update BureauSettings
Get BureauSettings ReportPack
Get Processor
Cis300
List Cis300
Create Cis300
Update Cis300
Get Cis300
Delete Cis300
Get XML Request
Submit Cis300
Mark as Sent
Cis300 Requiring Attention
CisVerification
List CisVerificationRequest
Create CisVerificationRequest
Update CisVerificationRequest
Get CisVerificationRequest
Delete CisVerificationRequest
Get XML Request
Submit CisVerificationRequest
Mark as Sent
CisVerificationRequest Requiring Attention
CostCentre
List Cost Centres
Create Cost Centre
Update Cost Centre
Delete Cost Centre
Get Cost Centre
(deprecated)
Update Cost Centre
(deprecated)
Delete Cost Centre
(deprecated)
Get Cost Centre
Department
List Departments
Create Department
Get Department
(deprecated)
Update Department
(deprecated)
Delete Department
(deprecated)
Get Department
Update Department
Delete Department
Dps
Check for new Notices
List Notices
Delete All Notices
Parse notices from XML
Get Notice
Apply Notice
Delete Notice
Get DPS Settings
Update DPS Settings
Reapply DpsNotices
List Employee Notices
Email
List Emails
Get Email
Re-send Email
Get MailSettings
Update MailSettings
Send Test Email
Email Verification (Request)
Email Verification (Respond)
Microsoft login for authorization
Update token details by Authorization code
Employee
Create a new Employee
List Employees
Import CSV
Get an Employee
Update an Employee
Delete an Employee
Get employee navigation details for a specific employee
Get list of FPS Employees for EYFPS for the given Ids
Rehire an Employee
Delete Employees
Mark as Leavers
List Leavers
Mark as On Hold
Update Photo
Delete Photo
Search Employer for Employees
Expiring RightToWork
Get Employee by Payroll Code
PayRunEntries for Employee
Average Weekly Earnings
Calculate Base Hourly Rate
(deprecated)
Calculate Base Daily Rate
(deprecated)
Minimum Wage
Apply PayOptions
Apply Pay Increase
Get Employee Departments
Set Employee Departments
Get EvcSettings
Update EvcSettings
Get Employee Cost Centres
Set Employee Cost Centres
Resets employee accrual scheme
Get List of Employees for Supplementary PayRun
EmployeeRole
List Employee Roles
Create Employee Role
Get Employee Role
Update Employee Role
Delete Employee Role
Set Employee Role Departments
Get Employee Role Departments
Calculate Base Hourly Rate
Calculate Base Daily Rate
Get Employee Role Cost Centres
Set Employee Role Cost Centres
Get Employee Role Working Pattern
Delete Employee Role Working Pattern
List Working Patterns for an Employee Role
Create Employee Role Working Pattern
Update Employee Role Working Pattern
Set Employee Role AnalysisCategorycode
Get Employee Role AnalysisCategoryCode
Calculate Assumed Pensionable Pay
Employer
Create an Employer
List Employers
Import CSV
Search Employers
Search Employees
Get an Employer
Update an Employer
Delete an Employer
Get Employer Calendar
List Users
Get User Employer
Get User Employer Options
Set User Employer Options
Set Owner
Remove User
Suggest Payroll Code
Update Employer Logo
Get Payslip Customisations
Update Payslip Customisations
Review Year End Changes
Make Year End Changes
RTI Documents Requiring Attention
Get Automation Settings
Update Automation Settings
Get Employer Groups
Set Employer Groups
Get EmployerOpeningBalances
Update EmployerOpeningBalances
Update EVC OptIn
Get EVC OptIn History
Get List of Employees with Holiday Accrual Scheme
Get Can Use Premium Connectors Setting
Update Can Use Premium Connectors Setting
Gets the re-enrolment status for the employer
EmployerGroup
List EmployerGroups
Create EmployerGroup
Get EmployerGroup
Update EmployerGroup
Delete EmployerGroup
EmployerNote
List Employer Notes
Create Employer Note
Get Employer Note
Update Employer Note
Delete Employer Note
Add Document to Employer Note
Delete Document from Employer Note
Get Document for Employer Note
EmployerTemplate
List EmployerTemplates
Get EmployerTemplate
Update EmployerTemplate
Engine
Get Configuration
Get National Insurance Thresholds
Calculate Tax due
Calculate NI due.
Tenant Branding
Eps
List EPS
Create EPS
Update EPS
Get EPS
Delete Eps
Get XML Request
Submit EPS
Mark as Sent
EPS Requiring Attention
Recoverable Amounts
Apprenticeship Levy
Exb
List EXB
Create EXB
Update EXB
Get EXB
Delete EXB
Get XML Request
Submit EXB
Mark as Sent
EXB Requiring Attention
Annual Values
ExternalData
List Providers
List Companies
List Nominal Codes
Post Journal
Post Payments
List Employees
Import Employees
Push Employees
Push Payslips
Push P45
Push P45s
Push P60
Push P60s
Push P11D
Push P11Ds
Push Pension Letter
Push Pension Letters
Get Employee
Update Employee
Sync Employees
Sync Employee
Get Employee Logs
Sync Leave
Contributions CSV File
Get Time And Attendance Data
Get Authorization Url
Set Credentials
Get Config Data
Set Config Data
Disconnect
3rd Party Response
Get StackOne session token
Fps
Create FPS
List FPS
Create FPS with multiple employees
Update FPS
Get FPS
Delete FPS
Update FPS with multiple employees
Get XML Request
Get most recent FPS for Employee
Get most recent FPS for Employees
Get all FPS for Employee
Submit FPS
Mark as Sent
FPS Requiring Attention
HmrcPayment
List HmrcLiabilities
Get HmrcLiability
Update HmrcLiability
HMRC Bank Payment
HolidayScheme
Get holiday scheme
Create holiday scheme
Get holiday scheme by Id
Update holiday scheme
Delete holiday scheme
Import
List PaymentsCsvMappings
Create PaymentsCsvMapping
Get PaymentsCsvMapping
Update PaymentsCsvMapping
Delete PaymentsCsvMapping
Get PaymentsCsvMapping CSV File
Import Pay To Employee
Import Employees Asynchronously
Import EmployeeRoles from csv file
Import PensionMemberships from csv file
Import PensionMemberships from csv file (async)
Import Benefits
Import Average Holiday Days for Payment from a CSV file (synchronous).
Import Leave Asynchronously
Import Permanent Addition and Deductions Payments
Import Pay Run Overrides
ImportResult
Export Import Errors (Beta)
Get Import Results (beta)
Invitation
List Invitations
Create Invitation
Get Invitation
Delete Invitation
Accept Invitation
Job
Get Job
List Jobs
Get Job file
Delete Completed Jobs
Get Job Errors
JournalTemplate
Get Journal Template
Create Journal Template
Update Journal Template
JournalToken
List Journal Tokens
Create Journal Token
Get Journal Token
Update Journal Token
Delete Journal Token
List Department Journal Overrides
Create Department Journal Overrides
Update Department Journal Overrides
List CostCentre Journal Overrides
Create CostCentre Journal Overrides
Update CostCentre Journal Overrides
Leave
Create Leave
List Leave
Get Leave
Update Leave
Delete Leave
Find Linked Piw
Add Document
Delete Leave Document
Get Leave Document
List Statutory Maternity Leave History
List Occupational Maternity Leave History
Get Role Assumed Pensionable Pay
Loan
Create Loan
List Loans
Get Loan
Update Loan
Delete Loan
Add Document
Delete Loan Document
Get Loan Document
Note
Create Note
List Notes
Get Note
Update Note
Delete Note
Add Document
Delete Note Document
Get Note Document
Nvr
List NVR
Create NVR
Update NVR
Get NVR
Delete NVR
Get XML Request
Submit an existing NVR
Mark as Sent
NVR Requiring Attention
OccupationalPolicy
List Occupational Policies
Create Occupational Policy
Get Occupational Policy
Update Occupational Policy
Delete Occupational Policy
OccupationalSickLeaveHistory
List OccupationalSickLeaveHistory
Create OccupationalSickLeaveHistory
Get OccupationalSickLeaveHistory
Update OccupationalSickLeaveHistory
Delete OccupationalSickLeaveHistory
Upload OccupationalSickLeaveHistory
Import OccupationalSickLeaveHistory from csv file
OpeningBalances
Get Opening Balances
Update Opening Balances
Create NicSummary
Get NicSummaries
Update NicSummaries
Get NicSummary
Update NicSummary
Delete NicSummary
Update P45 Value
Update Termination Pay
Totals of employee opening balances for a tax year
P11History
Create P11 Historical data
Retrieve P11 Historical data
Delete P11 Historical data
Update P11 Historical entry
PayCode
List PayCodes
Create PayCode
Get PayCode
(deprecated)
Update PayCode
(deprecated)
Delete PayCode
(deprecated)
Get PayCode
Update PayCode
Delete PayCode
Get Nominal Code Mappings
Updates Nominal Code Mappings
PayCodeSet
List PayCodeSets
Create PayCodeSet
Get PayCodeSet
Update PayCodeSet
Delete PayCodeSet
Payee
List Payees
Create Payee
Get Payee
Update Payee
Delete Payee
PayRun
List PayRuns
Starts the next PayRun
Starts the next PayRun
(deprecated)
Get a PayRun
Delete a PayRun
Update PayRun
Get PayRun Warnings
Get PayPeriodEvents
Update YTD
List Leave related to a PayRun
List AttachmentOrders related to a PayRun
List PayRun Changes
List PayRun Changes for PayRunEntry
Get Journal for PayRun
Finalise a PayRun
(deprecated)
Re-open a PayRun
(deprecated)
(Re)send Payslip Emails
(Re)send P45 Emails
Get PayCodes for a PayRun
Creates a supplementary PayRun
Get a PayRunEntry
Update a PayRunEntry
PayRunEntry Umbrella Payment
Import Pay
Import Umbrella Pay
Import Time And Attendance
Set PaymentDate
Zeroise PayRunEntries
Remove PayRunEntries
(deprecated)
Add PayRunEntries
(deprecated)
Recalculate PayRunEntries
Gets the last closed pay run entry for an employee.
Calculate Average Holiday Pay Rate
List PayRunStateHistory
Gets last PayRunEntry for a Pension
Get list of open payruns
Get PayRunEntryNavigation for a specific PayRunEntry
Check if the FPS late reason is applicable
PayRunAsync
Registers a request to delete a PayRun (beta)
Registers a request to update the PayRun (beta)
Registers a request to start the next PayRun (beta)
Import Pay (beta)
PaySchedule
Get PaySchedules
Get PaySchedules for Employer (for active tax years)
Get PaySchedule
(deprecated)
Create a PaySchedule
(deprecated)
Update PaySchedule
(deprecated)
Delete PaySchedule
(deprecated)
Get PaySchedule
Create a PaySchedule
Update PaySchedule
Delete PaySchedule
Get PaySchedulePeriods
Update PaySchedulePeriod
PaySpine
List PaySpine
Create PaySpine
Get PaySpine
Update PaySpine
Delete PaySpine
Import PaySpine from csv file
List SpinalPoints
Create SpinalPoint
Delete All SpinalPoints Associated with a PaySpine
Get SpinalPoint
Update SpinalPoint
Delete SpinalPoint
Create Multiple SpinalPoints
Update Multiple SpinalPoints
Import SpinalPoints from csv file
Create SpineAllowance
List SpineAllowances
Delete All SpineAllowances Associated with a PaySpine
Update SpineAllowance
Get SpineAllowance
Delete SpineAllowance
Create Multiple SpineAllowances
Update Multiple SpineAllowances
List LondonAllowances
Create LondonAllowance
Get LondonAllowance
Update LondonAllowance
Delete LondonAllowance
List PaySpine Grade
Create PaySpine Grade
Get PaySpine Grade
Update PaySpine Grade
Delete PaySpine Grade
Get AllowanceGrade
Update AllowanceGrade
Delete AllowanceGrade
Create AllowanceGrade
List AllowanceGrades
Delete All AllowanceGrades Associated with a PaySpine
Create Multiple AllowanceGrades
Update Multiple AllowanceGrades
Import SpineGrades from csv file
Get Annual Value from pay spines formula
Get Spinal Point With Final Annual Salary
Pension
List Pensions
Get Pension
Update Pension
Remove Pension
Create Pension
Get Pension
(deprecated)
Update Pension
(deprecated)
Remove Pension
(deprecated)
Get last PayRunEntry for a Pension
(deprecated)
PensionRefund
Create Pension Refund
List Pension Refunds
Get Pension Refund
Update Pension Refund
Delete Pension Refund
Issue Pension Refund
(deprecated)
Issue Pension Refund
PensionScheme
List PensionSchemes
Create a PensionScheme
Get a PensionScheme
Update a PensionScheme
Delete a PensionScheme
Get Employees
List Pension Notices (Beta)
Get Pension Notice Retrieve State (Beta)
Manually Retrieve Pension Notices (Beta)
Get Pension Notice Detail (Beta)
Retry Pension Notice (Beta)
Mark Pension Notice as Actioned (Beta)
List Contributions
Contributions for Payrun
Re-submit Contributions
Contributions Data
Mark as Sent
ProcessingNote
Create ProcessingNote
List ProcessingNotes for a PayRun
Get a ProcessingNote
Set a ProcessingNote status
Add Document
Delete ProcessingNote Document
Get ProcessingNote Document
ReportBuilder
List PaySchedules
List PaySchedules By Date Range
ReportPack
List ReportPacks
Create ReportPack
Get ReportPack
Update ReportPack
Delete ReportPack
Reports
Apprenticeship Levy Details
P60 For Employee
All P60s For TaxYear
Email P60 to an Employee
Email P60 to all Employees
P11D For Employee
All P11Ds For TaxYear
Email P11D to an Employee
Email P11D to all Employees
PAPDIS File
CIS300
FPS
EXB
AutoEnrolment Assessments
P45 For Employee
P45 for Multiple Employees
Email P45 to Employee
Email P45 to multiple employees
P11 (Detailed)
All Detailed P11s For TaxYear
P11
P30
P32
PayRun Payments
PayRun CSV
(deprecated)
Get PayRun CSV
AEO Statement
Gross To Net
Year To Date Values
NI Year To Date Values
Teachers Pension Eoy Report
Cost Analysis
Cost Of Employment
Cost Of Employment
Statutory Pay
Variance Report
Umbrella Reconciliation
FurloughReport
Hourly Pay
Holiday
RightToWork
Bank Payment Instructions
CIS Statement
CIS Subcontractor Summary
PayRunSummary
Analysis
Analysis Cost Breakdown
Payroll Analysis with Employee Role Breakdown
Payslip
Payslips
Example Payslip
Employee Export Details
Year To Date Values
NI Year To Date Values
Taxcode Change
Employer Export
NI Letter Validation (Payrun)
NI Letter Validation (Employees)
Employee Benefits
Attachment Orders
Gets audit changes of all employees within a company.
Gets audit changes for a company.
Pay Code Export Details
Pay Grade
Spine Point
Pay Spine
Average Holiday Pay Rate
Employee Export Roles Details
Download Maternity Payment Schedule
Gender Pay Gap
Export Multiple Pension Memberships Report
Pay Element
Loan Balances
Export Payroll Run Warnings
Payroll Journal CSV
Employee Leave
Advanced Variance Report
Employee Payments Report
Get P45 Download Availability
Employee Loan Export
Export Cyclic Re-enrolments
ReportsAsync
Execute report template
Execute Combined Pension Contributions Report
All P60s For TaxYear (Beta)
All P45s For Pay Schedule Period
Required Payments PDF for Pay Schedule Period (Beta)
Execute Employee Payslips by Date Range Report
ReportTemplate
Get Content Dictionary For Report Template Column Type(beta)
Validate Report Template Columns(beta)
List Report Templates (beta)
Create Report Template (beta)
Get Report Template (beta)
Update Report Template (beta)
Delete Report Template (beta)
Tag
List Tags
Create Tag
Get Tag
(deprecated)
Update Tag
(deprecated)
Delete Tag
(deprecated)
Get Tag
Update Tag
Delete Tag
Tenant
Create a Tenant
Get a Tenant
Update a Tenant
Update CSS
Update CSS Colors
Upload Logo
Upload Favicon
List Users
List Admin Users
Remove Admin User
Add Admin User
Search Users
Get a User
Update a User
Get User Bills
Get User Employers
Disable User Account
Enable Employer Creation
Set User Tenant
Set User Accounting Id
Set User PricingTableId
Set Monthly Minimum
Set Bureau Redirect
Get Bills
Get Bill
Update Bill
Get Usage
Get Employer Usage
Get Employer Users
Get Users with no Billable Activity.
Weekly Activity Report
NetSuite Billing Report
Create Bills for Period
Get RtiSubmissionSettings
Update RtiSubmissionSettings
Get PricingTables
Create PricingTable
Get PricingTable
Update PricingTable
Delete PricingTable
Set User Business Name
Set Industry
Set Employee Count
Set Country
Set Address
Api Mailing List Report
Api Mailing List Report
Get Employers
Get Bureau Members
Get Payroll Squads
Create Payroll Squad
Get Payroll Squad
Delete Payroll Squad and it's Members and Employers.
Update Payroll Squad Employers
Add Payroll Squad Member
Delete Payroll Squad Member
Get UsageStats Report
Set Evc
Get Payroll Squad Members for Employer
Automation Usage Data Report
TenantEmail
List Emails
Get Email
Re-send Email
Get MailSettings
Update MailSettings
Send test email
TermCalendar
List Term Calendars
Create Term Calendar
Get Term Calendar
Update Term Calendar
Delete Term Calendar
TermCalendarYear
List Term Calendar Years
Create Term Calendar Year
Get Term Calendar Year
Update Term Calendar Year
Delete Term Calendar Year
TierablePay
Calculate tierable pay
Tools
Calculate Net of On Costs
Webhook
List Webhooks
Create Webhook
Get Webhook
Update Webhook
Delete Webhook
Sample Value
List WebhookPayloads
Get WebhookPayload
WorkingPattern
List WorkingPatterns
Create WorkingPattern
Get WorkingPattern
Update WorkingPattern
Delete WorkingPattern
Models
Account Models
DirectDebitMandate
Invitation
Tenant
TenantItem
User
UserAuthorization
CIS Models
CisContractor
CisDetails
CisPartnership
CisVerificationDetails
Config Models
CarCharge
CarChargeRate
FixedCode
GovTalk
LoanCharge
MileageAllowancePaymentsRate
NationalInsuranceCode
NationalMinimumWage
StatutoryPay
TaxBracket
TaxCodeChange
TaxYearConfig
TieredPension
TieredPensionRate
Email Models
EmailAttachment
EmployerEmail
HtmlEmailSettings
MailSettings
SmtpSettings
TenantEmail
Papdis Models
PapdisDocument
PapdisEmployee
PapdisEmployeeAssessment
PapdisEmployeeContact
PapdisEmployeeContactPostalAddress
PapdisEmployeeContribution
PapdisEmployeeExit
PapdisEmployeeIdentity
PapdisEmployeeName
PapdisEmployeePay
PapdisEmployer
PapdisPayrollPeriod
PapdisPensionProvider
PayRun Models
NationalInsuranceCalculation
PayCode
PayLine
PayOptionsImport
PayRun
PayRunEntry
PayRunJournal
PayRunSummaryLine
PayRunTotals
PaySchedule
PensionSummary
ValueOverride
Pension Models
Pension
PensionAdministrator
PensionProvider
PensionScheme
TeachersPensionDetails
WorkerGroup
Report Models
AttachmentOrderReportResponse
BankPaymentInstruction
BankPaymentInstructionReportResponse
Cis300ReportResponse
CisStatement
ExbReportResponse
FpsReportResponse
FurloughReport
FurloughReportLine
FurloughReportReportResponse
GrossToNetReport
GrossToNetReportCisLine
GrossToNetReportLine
GrossToNetReportReportResponse
HolidayReport
HolidayReportLine
HolidayReportReportResponse
HourlyPayReport
HourlyPayReportLine
HourlyPayReportReportResponse
P11
P11Detailed
P11DetailedNiValues
P11DetailedReportResponse
P11Line
P11NiAndStatPaymentsLine
P11NiAndStatPaymentsTotalsLine
P11NiValues
P11PayeLine
P11PayeSummary
P11PayeTotalsLine
P11ReportResponse
P32
P32ReportResponse
PapdisDocumentReportResponse
PayRunPayment
PayrunPaymentsReport
PayrunPaymentsReportReportResponse
Payslip
PayslipCustomisation
PayslipLine
PayslipReportResponse
PdfPaperMargins
ReportResponse
RightToWorkReportLine
RightToWorkReportReportResponse
StatutoryPayReportLine
StatutoryPayReportReportResponse
UmbrellaReconciliationReportReportResponse
VarianceReport
VarianceReportReportResponse
RTI Models
Cis300
Cis300Declarations
CisRequest
CisReturn
CisSubContractor
CisVerification
EmpRefs
Eps
EpsAccount
EpsApprenticeshipLevy
EpsFinalSubmission
Exb
ExbDeclarations
ExbEmployer
ExbP11d
ExbP11db
ExbP11dbClass1A
ExbP11dbClass1AAdjustment
ExbP11dbClass1AAdjustments
ExbP11dbClass1ATotalBenefit
ExbP11dEmployee
ExpensesAndBenefits
FlexibleDrawdown
Fps
FpsBenefit
FpsCar
FpsCarFuel
FpsEmployee
FpsEmployeeDetails
FpsEmployeeDetailsPartnerDetails
FpsEmployeeFigsToDate
FpsEmployeeFlexibleDrawdown
FpsEmployeeNIlettersAndValues
FpsEmployeePayment
FpsEmployeeStarter
FpsEmployeeTaxCode
FpsEmployeeTrivialCommutationPayment
FpsEmployerPayIdChanged
FpsEmployment
FpsFields
FromToDates
FullPaymentSubmission
GovTalkError
GovTalkSubmission
Nvr
NvrEmployee
NvrEmployeeDetails
NvrEmployment
NvrRequest
P11DAssetAvailable
P11DAssetAvailableCollection
P11DAssetTransferredCollection
P11DCar
P11DCarCollection
P11dCarFreeFuelWithdrawn
P11DDescOther
P11dExpenses
P11DLoan
P11DLoanCollection
P11DOther
P11DPaymentCollection
P11DSingleItem
P11dVans
RecoverableAmounts
RtiAgent
RtiContact
RtiEmployeeAddress
RtiEmployeeName
RtiSubmissionSettings
StudentLoanRecovered
Other Models
Address
AdvancedVarianceReport
AdvancedVarianceReportLine
AdvancedVarianceReportReportResponse
AeAssessment
AeAssessmentAction
AeEmployee
AeEmployeeAssessment
AePension
AePensionScheme
AePeriod
AeRole
AnalysisCategory
AnalysisCategoryCode
AnalysisCategoryCodes
AnalysisCategoryIndex
AnalysisReport
AnalysisReportLine
AnalysisReportLineValue
AnalysisReportReportResponse
AttachmentOrder
AttachmentOrderPayment
AttachmentOrdersReport
AttachmentOrdersReportReportResponse
AutoEnrolment
AutomationSettings
AverageHolidayPayRateReport
AverageHolidayPayRateReportLine
AverageHolidayPayRateReportReportResponse
AveragePayGradesReportLine
AverageWeeklyEarnings
BankDetails
Benefit
BenefitDetailsCar
BenefitDetailsLoan
BenefitPayrolled
BureauSettings
CalendarEntry
ChangeSummary
ChangeSummaryListReportResponse
CisStatementListReportResponse
CisSubContractorSummary
CisSubContractorSummaryListReportResponse
Contract.Address
Contract.AeAssessmentAction
Contract.AeAssessmentRequest
Contract.AeAssessmentResponse
Contract.AeEmployeeAssessmentHistoryRequest
Contract.AeEmployeeAssessmentHistoryResponse
Contract.AeEmployeeAssessmentRequest
Contract.AeEmployeeAssessmentResponse
Contract.AeEmployeeLetterResponse
Contract.AllowanceGradesRequest
Contract.AllowanceGradesResponse
Contract.AllowanceGradesUpdateRequest
Contract.AnalysisCategoryCodeRequest
Contract.AnalysisCategoryCodeResponse
Contract.AnalysisCategoryRequest
Contract.AnalysisCategoryResponse
Contract.AutoEnrolmentRequest
Contract.AutoEnrolmentResponse
Contract.AutoEnrolmentSettingsRequest
Contract.AutoEnrolmentSettingsResponse
Contract.BankDetails
Contract.BenefitCarImportRequest
Contract.BenefitImportRequest
Contract.BenefitLoanImportRequest
Contract.CisDetailsRequest
Contract.CisDetailsResponse
Contract.CisPartnership
Contract.CisSubContractor
Contract.CisSubContractorItem
Contract.CisVerificationDetailsRequest
Contract.CisVerificationDetailsResponse
Contract.CombinedPensionContributionsReportRequest
Contract.CostCentreJournalOverridesRequest
Contract.CostCentreJournalOverridesResponse
Contract.CostCentreJournalOverridesResponseItem
Contract.CostCentreJournalOverridesUpdateRequest
Contract.CreateEmployeeRequest
Contract.CustomReportRequest
Contract.DepartmentJournalOverridesRequest
Contract.DepartmentJournalOverridesResponse
Contract.DepartmentJournalOverridesResponseItem
Contract.DepartmentJournalOverridesUpdateRequest
Contract.DepartmentRequest
Contract.DepartmentResponse
Contract.DirectorshipDetails
Contract.EmployeeItem
Contract.EmployeeLeaveSettingsRequest
Contract.EmployeeLeaveSettingsResponse
Contract.EmployeeNavigationResponse
Contract.EmployeePaymentsReportRequest
Contract.EmployeePayslipsByDateRangeReportRequest
Contract.EmployeeResponse
Contract.EmployeeRoleAnalysisCategoryCodeRequest
Contract.EmployeeRoleAnalysisCategoryCodeResponse
Contract.EmployeeRoleItem
Contract.EmployeeRoleResponse
Contract.EmployeeRoleWorkingPatternRequest
Contract.EmployeeRoleWorkingPatternResponse
Contract.EmployeeRoleWorkingPatternResponseItem
Contract.EmployeeSupplementaryPayRunResponse
Contract.EmployerBase
Contract.EmployerLeaveSettingsRequest
Contract.EmployerLeaveSettingsResponse
Contract.EmployerRequest
Contract.EmployerResponse
Contract.EmployerSettingsRequest
Contract.EmployerSettingsResponse
Contract.EmploymentDetailsRequest
Contract.EmploymentDetailsResponse
Contract.ExternalDataCompanyRequest
Contract.ExternalDataCompanyResponse
Contract.FpsFields
Contract.HmrcDetailsRequest
Contract.HmrcDetailsResponse
Contract.HolidayEntitlementRequest
Contract.HolidayEntitlementResponse
Contract.HolidayEntitlementUpdateRequest
Contract.HolidaySchemeRequest
Contract.HolidaySchemeResponse
Contract.JobErrorResponse
Contract.JobResponse
Contract.JobResultFileResponse
Contract.JobResultResponse
Contract.JournalTemplateRequest
Contract.JournalTemplateResponse
Contract.JournalTokenRequest
Contract.JournalTokenResponse
Contract.JournalTokenResponseItem
Contract.LeaveImportRequest
Contract.LeaverDetails
Contract.LondonAllowanceRequest
Contract.LondonAllowanceResponse
Contract.NetOfOnCostsResponse
Contract.NetOfOnCostsSimulationResponse
Contract.OverseasEmployerDetails
Contract.P11HistoryRequest
Contract.P11HistoryResponse
Contract.P45AvailabilityResponse
Contract.PartnerDetails
Contract.PayHistoryRequest
Contract.PayHistoryResponse
Contract.PayHistoryUpdateRequest
Contract.PaylineAnalysisCategoriesCodes
Contract.PaylineRequest
Contract.PayLineRequest
Contract.PayLineResponse
Contract.PaymentImportRequest
Contract.PayOptionsBaseResponse
Contract.PayOptionsImportRequest
Contract.PayOptionsRequest
Contract.PayOptionsResponse
Contract.PayPeriodOrdinalSelection
Contract.PayrollSquadEmployerRequest
Contract.PayrollSquadEmployerResponse
Contract.PayrollSquadMemberRequest
Contract.PayrollSquadMemberResponse
Contract.PayrollSquadRequest
Contract.PayrollSquadResponse
Contract.PayRunOverridesImportRequest
Contract.PayRunResponseItem
Contract.PayRunStateHistoryResponse
Contract.PayScheduleByDateRangeRequest
Contract.PayScheduleRequest
Contract.PayScheduleResponseItem
Contract.PaySpineGradeRequest
Contract.PaySpineGradeResponse
Contract.PaySpineRequest
Contract.PaySpineResponse
Contract.PaySpineUpdateRequest
Contract.PendingLettersCountResponse
Contract.PensionAdministratorRequest
Contract.PensionAdministratorResponse
Contract.PensionerPayroll
Contract.PensionNoticeDetailResponse
Contract.PensionNoticePagedResponse
Contract.PensionNoticeResponse
Contract.PensionNoticeRetrieveStateResponse
Contract.PensionNoticeSettingsRequest
Contract.PensionNoticeSettingsResponse
Contract.PensionProviderRequest
Contract.PensionProviderResponse
Contract.PensionSchemeNominalCodeMappingRequest
Contract.PensionSchemeNominalCodeMappingResponse
Contract.PensionSchemeReportOptionsLgpsCivicaUpmRequest
Contract.PensionSchemeReportOptionsLgpsCivicaUpmResponse
Contract.PensionSchemeReportOptionsLgpsIConnectRequest
Contract.PensionSchemeReportOptionsLgpsIConnectResponse
Contract.PensionSchemeRequest
Contract.PensionSchemeResponse
Contract.PensionSelectionRequest
Contract.PensionSelectionResponse
Contract.PersonalDetailsRequest
Contract.PersonalDetailsResponse
Contract.ReapplyDpsNoticeResponse
Contract.RecalculatePayRunEntriesResponse
Contract.RecalculatePayRunEntryResult
Contract.ReportTemplateColumnRequest
Contract.ReportTemplateColumnResponse
Contract.ReportTemplateContentDictionaryResponse
Contract.ReportTemplateContentResponse
Contract.ReportTemplateRequest
Contract.ReportTemplateResponse
Contract.RightToWork
Contract.RtiAgentRequest
Contract.RtiAgentResponse
Contract.RtiContactRequest
Contract.RtiContactResponse
Contract.RtiEmployeeAddress
Contract.RtiEmployeeName
Contract.RtiSubmissionSettingsRequest
Contract.RtiSubmissionSettingsResponse
Contract.SharedBankDetails
Contract.ShiftWorkingPatternDayRequest
Contract.ShiftWorkingPatternDayResponse
Contract.SpinalPointRequest
Contract.SpinalPointResponse
Contract.SpinalPointUpdateRequest
Contract.SpineAllowanceRequest
Contract.SpineAllowanceResponse
Contract.SpineAllowanceUpdateRequest
Contract.StarterDetails
Contract.TaxAndNi
Contract.TermCalendarRequest
Contract.TermCalendarResponse
Contract.TermCalendarYearRequest
Contract.TermCalendarYearResponse
Contract.UmbrellaSettingsRequest
Contract.UmbrellaSettingsResponse
Contract.UpdateEmployeeRequest
Contract.UserEmployerOptionsRequest
Contract.UserEmployerOptionsResponse
Contract.VeteranDetails
Contract.WorkerGroupRequest
Contract.WorkerGroupResponse
Contract.WorkingPatternRequest
Contract.WorkingPatternResponse
Contract.YearsServiceEntitlementRequest
Contract.YearsServiceEntitlementResponse
Contract.YearsServiceEntitlementUpdateRequest
CostAnalysisReport
CostAnalysisReportReportResponse
CostCentre
CostOfEmploymentReport
CostOfEmploymentReportLine
CostOfEmploymentReportReportResponse
CyclicReenrolmentReport
CyclicReenrolmentReportGroup
CyclicReenrolmentReportLine
CyclicReenrolmentReportReportResponse
DecimalDecimalBooleanPensionRuleValueTuple
DecimalTaxYearConfigPrimitiveValue
Department
DepartmentMembership
DirectorshipDetails
DpsNotice
DpsSettings
Employee
EmployeeBenefitsReport
EmployeeBenefitsReportReportResponse
EmployeeCostCentre
EmployeeLeaveReport
EmployeeLeaveReportLine
EmployeeLeaveReportReportResponse
EmployeeLoanExportReport
EmployeeLoanExportReportLine
EmployeeLoanExportReportReportResponse
EmployeeNiYtdValues
EmployeePaymentsReportLine
EmployeePaymentsReportLineListReportResponse
EmployeePayRunTotal
EmployeeRole
EmployeeRoleAnalysisCategoryCode
EmployeeRolePayItem
EmployeeRolePayOptions
EmployeeYtdValues
EmployerDefaults
EmployerEvcOptInHistory
EmployerGroup
EmployerGroupMembership
EmployerItem
EmployerNote
EmployerOpeningBalances
EmployerPensionContribution
EmployerTemplate
EmploymentDetails
EntitlementBand
EpsDeMinimisStateAid
Establishment
EvcSettings
ExternalDataCompany
ExternalDataProvider
ExternalEmployeeMapping
ExternalProviderConversation
FieldModification
FpsEmployeeSeconded
FpsEmployeeStarterOccPension
FpsPriorVersion
FullSummaryOfPayReport
FullSummaryOfPayReportLine
FullSummaryOfPayReportReportResponse
GenderPayGapLine
GenderPayGapReport
GenderPayGapReportReportResponse
HmrcDetails
HmrcLiability
HmrcPayment
ImportResultDetails
ImportRowError
Item
ItemListReportResponse
JournalTemplate
Leave
LeaveAssumedPensionablePay
LeaveCustomPayment
LeaveCustomProRataRule
LeaveNotionalPayDetails
LeaverDetails
LeaveSettings
LinkedPiw
Loan
LoanBalancesReport
LoanBalancesReportLine
LoanBalancesReportReportResponse
LogEntry
LondonAllowance
MonthlyMinimum
NationalInsuranceCalculationBase
NationalInsuranceCalculationPeriodValues
NicSummary
NiLetterValidationReport
NiLetterValidationReportLine
NiLetterValidationReportReportResponse
NiYtdReport
NiYtdReportReportResponse
NiYtdValue
NominalCodeMapping
Note
NotionalPayPeriodBreakdown
OccupationalPolicy
OccupationalSickLeaveHistory
OpeningBalances
OpeningBalancesTotals
OverseasEmployerDetails
PapdisEmployerContactPostalAddress
PartnerDetails
PayCodeSet
PayCodeVarianceLine
Payee
PayElementReport
PayElementReportLine
PayElementReportReportResponse
PayGradesReport
PayGradesReportReportResponse
PayImportPayCodeSummary
PayImportPayCodeTotals
PaylineCalculationData
PaymentsCsvMapping
PaymentsCsvMappingColumn
PayOptions
PayrollAnalysisCostBreakdownReport
PayrollAnalysisCostBreakdownReportLine
PayrollAnalysisCostBreakdownReportReportResponse
PayrollAnalysisCostBreakdownReportValue
PayrollAnalysisEmployeeRoleBreakdownReport
PayrollAnalysisEmployeeRoleBreakdownReportLine
PayrollAnalysisEmployeeRoleBreakdownReportLineValue
PayrollAnalysisEmployeeRoleBreakdownReportReportResponse
PayRunChanges
PayrunEmail
PayRunEntryNavigation
PayRunStateChange
PayRunSummaryLineIEnumerableReportResponse
PaySchedulePeriod
PaySchedulePeriodEvent
PaySpineReport
PaySpineReportLine
PaySpineReportReportResponse
PensionContributionsSubmission
PensionerPayroll
PensionMembershipReportLine
PensionMembershipsReport
PensionMembershipsReportReportResponse
PensionNoticeSettings
PensionOpeningBalances
PensionRefund
PensionSchemeNominalCodeMapping
PensionSchemeReportOptionsLgpsCivicaUpm
PensionSchemeReportOptionsLgpsIConnect
PensionSummaryCostBreakdown
PeriodValue
PersonalDetails
PricingBand
PricingTable
ProcessingNote
ReportPack
RightToWork
RightToWorkReport
RtiValidationWarning
ServiceBand
ShiftWorkingPatternDay
SpinePointReport
SpinePointReportLine
SpinePointReportReportResponse
StarterDetails
StatutoryPayReport
StringDecimalKeyValuePair
StringStringDecimalValueTuple
StringStringKeyValuePair
SupplementaryPayRunDetails
Tag
TaxAndNi
TaxCodeChangeReport
TaxCodeChangeReportReportResponse
TaxCodeChangeValues
TeachersPensionEoyLineItem
TeachersPensionEoyReport
TeachersPensionEoyReportReportResponse
TenantBillingSettings
TenantHtmlInsertion
UmbrellaPayment
UmbrellaReconciliationReport
UmbrellaReconciliationReportLine
UsageBill
UserDisplayPreferences
UserEmployer
UtmInfo
VeteranDetails
WarningsReport
WarningsReportLine
WarningsReportReportResponse
Webhook
WebhookPayload
WorkingPattern
YearEnd
YearEndTaxCodeChange
YtdReport
YtdReportReportResponse
YtdValue
Introduction
Authentication
Observability
The Basics
Items
Paging
Reports
Async Jobs
Webhooks
Create Employer
Create an Employee
Understanding PayOptions
The Ordinal property
Using Tags
Set a Schedule
Start the PayRun
Review the PayRun
Finalise the PayRun
Review and Submit the FPS
Get Accounting Entries
Get Payslips
Customise Payslips
Review Year End Changes
Apply Year End Changes
Activate an Account
Create Demo Employer
Change Email Address
Get Account Details
Update Photo
Update Profile
Get Invitations
Re-send Verification Email
Verify Email Address
Get Tenant
Get EmployerDefaults
Set EmployerDefaults
List User Employers
List ApiKeys
Create ApiKey
Get ApiKey
Delete ApiKey
Assess an employee
Create employee auto enrolment assessment
List employee auto enrolment assessment
Get letters for an employee based on tax year
Get pending letters for an employer
Get count of pending pension letters for an employer
Process AE Assessment for Employee during PayRun
Gets a list of re-enrolment dates for the employer
Email AeLetter
Mark Letter as Sent
Mark All Letters as Sent
Get AeLetter
Get Ae Assessments for an employee.
Gets employee AE assessment for a specific role.
List AnalysisCategories
Create AnalysisCategory
Get AnalysisCategory
Update AnalysisCategory
Delete AnalysisCategory
List AnalysisCategoryCodes
Create AnalysisCategoryCode
Get AnalysisCategoryCode
Delete AnalysisCategoryCode
Update AnalysisCategoryCode
Create AttachmentOrder
List AttachmentOrders
Get AttachmentOrder
Update AttachmentOrder
Delete AttachmentOrder
Get Payments
Add Document
Delete AttachmentOrder Document
Get AttachmentOrder Document
Employer Audit Log
Get AE Assessments
Assess Employee for AutoEnrolment
Get AE Assessment
Delete AE Assessment
Get Last AE Assessment
Get Letter
Email Letter
Email All Letters
Mark Letter as Sent
Mark All Letters as Sent
Update State
Pending Letters Count
Pending Letters
Pending Postponement Letters
Cyclical Re-enrolment
Create multiple AverageHolidayPayHistory for an Employer
Get AverageHolidayPayHistory for Employer
Update multiple AverageHolidayPayHistory for an Employer
List AverageHolidayPayHistory for Employee
Get previous payment date for an employee before a given date
Delete an AverageHolidayPayHistory record
Delete all AverageHolidayPayHistory for an Employee
Import AverageHistoryPayHistory from csv file
Create Benefit
List Benefits
Get Benefit
Update Benefit
Delete Benefit
Get DirectDebitMandate
Delete DirectDebitMandate
Setup DirectDebitMandate
Confirm Direct Debit Setup
List Bills
Get Bill
Get Bill CSV
Get UsageStats Report
List Allocated Processors
List Employers
Get BureauSettings
Update BureauSettings
Get BureauSettings ReportPack
Get Processor
List Cis300
Create Cis300
Update Cis300
Get Cis300
Delete Cis300
Get XML Request
Submit Cis300
Mark as Sent
Cis300 Requiring Attention
List CisVerificationRequest
Create CisVerificationRequest
Update CisVerificationRequest
Get CisVerificationRequest
Delete CisVerificationRequest
Get XML Request
Submit CisVerificationRequest
Mark as Sent
CisVerificationRequest Requiring Attention
List Cost Centres
Create Cost Centre
Update Cost Centre
Delete Cost Centre
Get Cost Centre (deprecated)
Update Cost Centre (deprecated)
Delete Cost Centre (deprecated)
Get Cost Centre
List Departments
Create Department
Get Department (deprecated)
Update Department (deprecated)
Delete Department (deprecated)
Get Department
Update Department
Delete Department
Check for new Notices
List Notices
Delete All Notices
Parse notices from XML
Get Notice
Apply Notice
Delete Notice
Get DPS Settings
Update DPS Settings
Reapply DpsNotices
List Employee Notices
List Emails
Get Email
Re-send Email
Get MailSettings
Update MailSettings
Send Test Email
Email Verification (Request)
Email Verification (Respond)
Microsoft login for authorization
Update token details by Authorization code
Create a new Employee
List Employees
Import CSV
Get an Employee
Update an Employee
Delete an Employee
Get employee navigation details for a specific employee
Get list of FPS Employees for EYFPS for the given Ids
Rehire an Employee
Delete Employees
Mark as Leavers
List Leavers
Mark as On Hold
Update Photo
Delete Photo
Search Employer for Employees
Expiring RightToWork
Get Employee by Payroll Code
PayRunEntries for Employee
Average Weekly Earnings
Calculate Base Hourly Rate (deprecated)
Calculate Base Daily Rate (deprecated)
Minimum Wage
Apply PayOptions
Apply Pay Increase
Get Employee Departments
Set Employee Departments
Get EvcSettings
Update EvcSettings
Get Employee Cost Centres
Set Employee Cost Centres
Resets employee accrual scheme
Get List of Employees for Supplementary PayRun
List Employee Roles
Create Employee Role
Get Employee Role
Update Employee Role
Delete Employee Role
Set Employee Role Departments
Get Employee Role Departments
Calculate Base Hourly Rate
Calculate Base Daily Rate
Get Employee Role Cost Centres
Set Employee Role Cost Centres
Get Employee Role Working Pattern
Delete Employee Role Working Pattern
List Working Patterns for an Employee Role
Create Employee Role Working Pattern
Update Employee Role Working Pattern
Set Employee Role AnalysisCategorycode
Get Employee Role AnalysisCategoryCode
Calculate Assumed Pensionable Pay
Create an Employer
List Employers
Import CSV
Search Employers
Search Employees
Get an Employer
Update an Employer
Delete an Employer
Get Employer Calendar
List Users
Get User Employer
Get User Employer Options
Set User Employer Options
Set Owner
Remove User
Suggest Payroll Code
Update Employer Logo
Get Payslip Customisations
Update Payslip Customisations
Review Year End Changes
Make Year End Changes
RTI Documents Requiring Attention
Get Automation Settings
Update Automation Settings
Get Employer Groups
Set Employer Groups
Get EmployerOpeningBalances
Update EmployerOpeningBalances
Update EVC OptIn
Get EVC OptIn History
Get List of Employees with Holiday Accrual Scheme
Get Can Use Premium Connectors Setting
Update Can Use Premium Connectors Setting
Gets the re-enrolment status for the employer
List EmployerGroups
Create EmployerGroup
Get EmployerGroup
Update EmployerGroup
Delete EmployerGroup
List Employer Notes
Create Employer Note
Get Employer Note
Update Employer Note
Delete Employer Note
Add Document to Employer Note
Delete Document from Employer Note
Get Document for Employer Note
List EmployerTemplates
Get EmployerTemplate
Update EmployerTemplate
Get Configuration
Get National Insurance Thresholds
Calculate Tax due
Calculate NI due.
Tenant Branding
List EPS
Create EPS
Update EPS
Get EPS
Delete Eps
Get XML Request
Submit EPS
Mark as Sent
EPS Requiring Attention
Recoverable Amounts
Apprenticeship Levy
List EXB
Create EXB
Update EXB
Get EXB
Delete EXB
Get XML Request
Submit EXB
Mark as Sent
EXB Requiring Attention
Annual Values
List Providers
List Companies
List Nominal Codes
Post Journal
Post Payments
List Employees
Import Employees
Push Employees
Push Payslips
Push P45
Push P45s
Push P60
Push P60s
Push P11D
Push P11Ds
Push Pension Letter
Push Pension Letters
Get Employee
Update Employee
Sync Employees
Sync Employee
Get Employee Logs
Sync Leave
Contributions CSV File
Get Time And Attendance Data
Get Authorization Url
Set Credentials
Get Config Data
Set Config Data
Disconnect
3rd Party Response
Get StackOne session token
Create FPS
List FPS
Create FPS with multiple employees
Update FPS
Get FPS
Delete FPS
Update FPS with multiple employees
Get XML Request
Get most recent FPS for Employee
Get most recent FPS for Employees
Get all FPS for Employee
Submit FPS
Mark as Sent
FPS Requiring Attention
List HmrcLiabilities
Get HmrcLiability
Update HmrcLiability
HMRC Bank Payment
Get holiday scheme
Create holiday scheme
Get holiday scheme by Id
Update holiday scheme
Delete holiday scheme
List PaymentsCsvMappings
Create PaymentsCsvMapping
Get PaymentsCsvMapping
Update PaymentsCsvMapping
Delete PaymentsCsvMapping
Get PaymentsCsvMapping CSV File
Import Pay To Employee
Import Employees Asynchronously
Import EmployeeRoles from csv file
Import PensionMemberships from csv file
Import PensionMemberships from csv file (async)
Import Benefits
Import Average Holiday Days for Payment from a CSV file (synchronous).
Import Leave Asynchronously
Import Permanent Addition and Deductions Payments
Import Pay Run Overrides
Export Import Errors (Beta)
Get Import Results (beta)
List Invitations
Create Invitation
Get Invitation
Delete Invitation
Accept Invitation
Get Job
List Jobs
Get Job file
Delete Completed Jobs
Get Job Errors
Get Journal Template
Create Journal Template
Update Journal Template
List Journal Tokens
Create Journal Token
Get Journal Token
Update Journal Token
Delete Journal Token
List Department Journal Overrides
Create Department Journal Overrides
Update Department Journal Overrides
List CostCentre Journal Overrides
Create CostCentre Journal Overrides
Update CostCentre Journal Overrides
Create Leave
List Leave
Get Leave
Update Leave
Delete Leave
Find Linked Piw
Add Document
Delete Leave Document
Get Leave Document
List Statutory Maternity Leave History
List Occupational Maternity Leave History
Get Role Assumed Pensionable Pay
Create Loan
List Loans
Get Loan
Update Loan
Delete Loan
Add Document
Delete Loan Document
Get Loan Document
Create Note
List Notes
Get Note
Update Note
Delete Note
Add Document
Delete Note Document
Get Note Document
List NVR
Create NVR
Update NVR
Get NVR
Delete NVR
Get XML Request
Submit an existing NVR
Mark as Sent
NVR Requiring Attention
List Occupational Policies
Create Occupational Policy
Get Occupational Policy
Update Occupational Policy
Delete Occupational Policy
List OccupationalSickLeaveHistory
Create OccupationalSickLeaveHistory
Get OccupationalSickLeaveHistory
Update OccupationalSickLeaveHistory
Delete OccupationalSickLeaveHistory
Upload OccupationalSickLeaveHistory
Import OccupationalSickLeaveHistory from csv file
Get Opening Balances
Update Opening Balances
Create NicSummary
Get NicSummaries
Update NicSummaries
Get NicSummary
Update NicSummary
Delete NicSummary
Update P45 Value
Update Termination Pay
Totals of employee opening balances for a tax year
Create P11 Historical data
Retrieve P11 Historical data
Delete P11 Historical data
Update P11 Historical entry
List PayCodes
Create PayCode
Get PayCode (deprecated)
Update PayCode (deprecated)
Delete PayCode (deprecated)
Get PayCode
Update PayCode
Delete PayCode
Get Nominal Code Mappings
Updates Nominal Code Mappings
List PayCodeSets
Create PayCodeSet
Get PayCodeSet
Update PayCodeSet
Delete PayCodeSet
List Payees
Create Payee
Get Payee
Update Payee
Delete Payee
List PayRuns
Starts the next PayRun
Starts the next PayRun (deprecated)
Get a PayRun
Delete a PayRun
Update PayRun
Get PayRun Warnings
Get PayPeriodEvents
Update YTD
List Leave related to a PayRun
List AttachmentOrders related to a PayRun
List PayRun Changes
List PayRun Changes for PayRunEntry
Get Journal for PayRun
Finalise a PayRun (deprecated)
Re-open a PayRun (deprecated)
(Re)send Payslip Emails
(Re)send P45 Emails
Get PayCodes for a PayRun
Creates a supplementary PayRun
Get a PayRunEntry
Update a PayRunEntry
PayRunEntry Umbrella Payment
Import Pay
Import Umbrella Pay
Import Time And Attendance
Set PaymentDate
Zeroise PayRunEntries
Remove PayRunEntries (deprecated)
Add PayRunEntries (deprecated)
Recalculate PayRunEntries
Gets the last closed pay run entry for an employee.
Calculate Average Holiday Pay Rate
List PayRunStateHistory
Gets last PayRunEntry for a Pension
Get list of open payruns
Get PayRunEntryNavigation for a specific PayRunEntry
Check if the FPS late reason is applicable
Registers a request to delete a PayRun (beta)
Registers a request to update the PayRun (beta)
Registers a request to start the next PayRun (beta)
Import Pay (beta)
Get PaySchedules
Get PaySchedules for Employer (for active tax years)
Get PaySchedule (deprecated)
Create a PaySchedule (deprecated)
Update PaySchedule (deprecated)
Delete PaySchedule (deprecated)
Get PaySchedule
Create a PaySchedule
Update PaySchedule
Delete PaySchedule
Get PaySchedulePeriods
Update PaySchedulePeriod
List PaySpine
Create PaySpine
Get PaySpine
Update PaySpine
Delete PaySpine
Import PaySpine from csv file
List SpinalPoints
Create SpinalPoint
Delete All SpinalPoints Associated with a PaySpine
Get SpinalPoint
Update SpinalPoint
Delete SpinalPoint
Create Multiple SpinalPoints
Update Multiple SpinalPoints
Import SpinalPoints from csv file
Create SpineAllowance
List SpineAllowances
Delete All SpineAllowances Associated with a PaySpine
Update SpineAllowance
Get SpineAllowance
Delete SpineAllowance
Create Multiple SpineAllowances
Update Multiple SpineAllowances
List LondonAllowances
Create LondonAllowance
Get LondonAllowance
Update LondonAllowance
Delete LondonAllowance
List PaySpine Grade
Create PaySpine Grade
Get PaySpine Grade
Update PaySpine Grade
Delete PaySpine Grade
Get AllowanceGrade
Update AllowanceGrade
Delete AllowanceGrade
Create AllowanceGrade
List AllowanceGrades
Delete All AllowanceGrades Associated with a PaySpine
Create Multiple AllowanceGrades
Update Multiple AllowanceGrades
Import SpineGrades from csv file
Get Annual Value from pay spines formula
Get Spinal Point With Final Annual Salary
List Pensions
Get Pension
Update Pension
Remove Pension
Create Pension
Get Pension (deprecated)
Update Pension (deprecated)
Remove Pension (deprecated)
Get last PayRunEntry for a Pension (deprecated)
Create Pension Refund
List Pension Refunds
Get Pension Refund
Update Pension Refund
Delete Pension Refund
Issue Pension Refund (deprecated)
Issue Pension Refund
List PensionSchemes
Create a PensionScheme
Get a PensionScheme
Update a PensionScheme
Delete a PensionScheme
Get Employees
List Pension Notices (Beta)
Get Pension Notice Retrieve State (Beta)
Manually Retrieve Pension Notices (Beta)
Get Pension Notice Detail (Beta)
Retry Pension Notice (Beta)
Mark Pension Notice as Actioned (Beta)
List Contributions
Contributions for Payrun
Re-submit Contributions
Contributions Data
Mark as Sent
Create ProcessingNote
List ProcessingNotes for a PayRun
Get a ProcessingNote
Set a ProcessingNote status
Add Document
Delete ProcessingNote Document
Get ProcessingNote Document
List PaySchedules
List PaySchedules By Date Range
List ReportPacks
Create ReportPack
Get ReportPack
Update ReportPack
Delete ReportPack
Apprenticeship Levy Details
P60 For Employee
All P60s For TaxYear
Email P60 to an Employee
Email P60 to all Employees
P11D For Employee
All P11Ds For TaxYear
Email P11D to an Employee
Email P11D to all Employees
PAPDIS File
CIS300
FPS
EXB
AutoEnrolment Assessments
P45 For Employee
P45 for Multiple Employees
Email P45 to Employee
Email P45 to multiple employees
P11 (Detailed)
All Detailed P11s For TaxYear
P11
P30
P32
PayRun Payments
PayRun CSV (deprecated)
Get PayRun CSV
AEO Statement
Gross To Net
Year To Date Values
NI Year To Date Values
Teachers Pension Eoy Report
Cost Analysis
Cost Of Employment
Cost Of Employment
Statutory Pay
Variance Report
Umbrella Reconciliation
FurloughReport
Hourly Pay
Holiday
RightToWork
Bank Payment Instructions
CIS Statement
CIS Subcontractor Summary
PayRunSummary
Analysis
Analysis Cost Breakdown
Payroll Analysis with Employee Role Breakdown
Payslip
Payslips
Example Payslip
Employee Export Details
Year To Date Values
NI Year To Date Values
Taxcode Change
Employer Export
NI Letter Validation (Payrun)
NI Letter Validation (Employees)
Employee Benefits
Attachment Orders
Gets audit changes of all employees within a company.
Gets audit changes for a company.
Pay Code Export Details
Pay Grade
Spine Point
Pay Spine
Average Holiday Pay Rate
Employee Export Roles Details
Download Maternity Payment Schedule
Gender Pay Gap
Export Multiple Pension Memberships Report
Pay Element
Loan Balances
Export Payroll Run Warnings
Payroll Journal CSV
Employee Leave
Advanced Variance Report
Employee Payments Report
Get P45 Download Availability
Employee Loan Export
Export Cyclic Re-enrolments
Execute report template
Execute Combined Pension Contributions Report
All P60s For TaxYear (Beta)
All P45s For Pay Schedule Period
Required Payments PDF for Pay Schedule Period (Beta)
Execute Employee Payslips by Date Range Report
Get Content Dictionary For Report Template Column Type(beta)
Validate Report Template Columns(beta)
List Report Templates (beta)
Create Report Template (beta)
Get Report Template (beta)
Update Report Template (beta)
Delete Report Template (beta)
List Tags
Create Tag
Get Tag (deprecated)
Update Tag (deprecated)
Delete Tag (deprecated)
Get Tag
Update Tag
Delete Tag
Create a Tenant
Get a Tenant
Update a Tenant
Update CSS
Update CSS Colors
Upload Logo
Upload Favicon
List Users
List Admin Users
Remove Admin User
Add Admin User
Search Users
Get a User
Update a User
Get User Bills
Get User Employers
Disable User Account
Enable Employer Creation
Set User Tenant
Set User Accounting Id
Set User PricingTableId
Set Monthly Minimum
Set Bureau Redirect
Get Bills
Get Bill
Update Bill
Get Usage
Get Employer Usage
Get Employer Users
Get Users with no Billable Activity.
Weekly Activity Report
NetSuite Billing Report
Create Bills for Period
Get RtiSubmissionSettings
Update RtiSubmissionSettings
Get PricingTables
Create PricingTable
Get PricingTable
Update PricingTable
Delete PricingTable
Set User Business Name
Set Industry
Set Employee Count
Set Country
Set Address
Api Mailing List Report
Api Mailing List Report
Get Employers
Get Bureau Members
Get Payroll Squads
Create Payroll Squad
Get Payroll Squad
Delete Payroll Squad and it's Members and Employers.
Update Payroll Squad Employers
Add Payroll Squad Member
Delete Payroll Squad Member
Get UsageStats Report
Set Evc
Get Payroll Squad Members for Employer
Automation Usage Data Report
List Emails
Get Email
Re-send Email
Get MailSettings
Update MailSettings
Send test email
List Term Calendars
Create Term Calendar
Get Term Calendar
Update Term Calendar
Delete Term Calendar
List Term Calendar Years
Create Term Calendar Year
Get Term Calendar Year
Update Term Calendar Year
Delete Term Calendar Year
Calculate tierable pay
Calculate Net of On Costs
List Webhooks
Create Webhook
Get Webhook
Update Webhook
Delete Webhook
Sample Value
List WebhookPayloads
Get WebhookPayload
List WorkingPatterns
Create WorkingPattern
Get WorkingPattern
Update WorkingPattern
Delete WorkingPattern
Address
AdvancedVarianceReport
AdvancedVarianceReportLine
AdvancedVarianceReportReportResponse
AeAction
AeAssessment
AeAssessmentAction
AeEmployee
AeEmployeeAssessment
AeEmployeeState
AeExclusionCode
AeLetter
AeLetterSentType
AePension
AePensionScheme
AePeriod
AeReason
AeRole
AeStatus
AeStatutoryLetter
AeUKWorker
AllowanceType
AnalysisCategory
AnalysisCategoryCode
AnalysisCategoryCodes
AnalysisCategoryIndex
AnalysisReport
AnalysisReportLine
AnalysisReportLineValue
AnalysisReportReportResponse
AnnualRoundingRule
AssumedPensionablePay
AttachmentOrder
AttachmentOrderPayment
AttachmentOrderReportResponse
AttachmentOrdersReport
AttachmentOrdersReportReportResponse
AttachmentOrderType
AuditEventAction
AuthScheme
AutoEnrolment
AutomationSettings
AutoPilotFinaliseTime
AverageHolidayPayRateReport
AverageHolidayPayRateReportLine
AverageHolidayPayRateReportReportResponse
AveragePayGradesReportLine
AverageWeeklyEarnings
AverageWeeklyEarningsResult
BackgroundTaskStatus
BankDetails
BankHolidayCollection
BankPaymentInstruction
BankPaymentInstructionReportResponse
BankPaymentInstructionsCsvFormat
Benefit
BenefitDeclarationType
BenefitDetailsAssetType
BenefitDetailsCar
BenefitDetailsCarPowerType
BenefitDetailsClass1AType
BenefitDetailsLoan
BenefitDetailsNonClass1AType
BenefitDetailsPaymentType
BenefitDetailsUseOfAssetType
BenefitPayrolled
BenefitType
BureauSettings
CalendarEntry
CalendarEntryType
CalendarMonth
CarCharge
CarChargeRate
ChangeSummary
ChangeSummaryListReportResponse
Cis300
Cis300Declarations
Cis300ReportResponse
CisContractor
CisDetails
CisPartnership
CisRequest
CisReturn
CisStatement
CisStatementListReportResponse
CisSubContractor
CisSubContractorSummary
CisSubContractorSummaryListReportResponse
CISSubContractorType
CISTaxStatus
CisVerification
CisVerificationDetails
Contract.Address
Contract.AeAssessmentAction
Contract.AeAssessmentRequest
Contract.AeAssessmentResponse
Contract.AeEmployeeAssessmentHistoryRequest
Contract.AeEmployeeAssessmentHistoryResponse
Contract.AeEmployeeAssessmentRequest
Contract.AeEmployeeAssessmentResponse
Contract.AeEmployeeLetterResponse
Contract.AllowanceGradesRequest
Contract.AllowanceGradesResponse
Contract.AllowanceGradesUpdateRequest
Contract.AnalysisCategoryCodeRequest
Contract.AnalysisCategoryCodeResponse
Contract.AnalysisCategoryRequest
Contract.AnalysisCategoryResponse
Contract.AutoEnrolmentRequest
Contract.AutoEnrolmentResponse
Contract.AutoEnrolmentSettingsRequest
Contract.AutoEnrolmentSettingsResponse
Contract.BankDetails
Contract.BenefitCarImportRequest
Contract.BenefitImportRequest
Contract.BenefitLoanImportRequest
Contract.CisDetailsRequest
Contract.CisDetailsResponse
Contract.CisPartnership
Contract.CisSubContractor
Contract.CisSubContractorItem
Contract.CisVerificationDetailsRequest
Contract.CisVerificationDetailsResponse
Contract.CombinedPensionContributionsReportRequest
Contract.CostCentreJournalOverridesRequest
Contract.CostCentreJournalOverridesResponse
Contract.CostCentreJournalOverridesResponseItem
Contract.CostCentreJournalOverridesUpdateRequest
Contract.CreateEmployeeRequest
Contract.CustomReportRequest
Contract.DepartmentJournalOverridesRequest
Contract.DepartmentJournalOverridesResponse
Contract.DepartmentJournalOverridesResponseItem
Contract.DepartmentJournalOverridesUpdateRequest
Contract.DepartmentRequest
Contract.DepartmentResponse
Contract.DirectorshipDetails
Contract.EmployeeItem
Contract.EmployeeLeaveSettingsRequest
Contract.EmployeeLeaveSettingsResponse
Contract.EmployeeNavigationResponse
Contract.EmployeePaymentsReportRequest
Contract.EmployeePayslipsByDateRangeReportRequest
Contract.EmployeeResponse
Contract.EmployeeRoleAnalysisCategoryCodeRequest
Contract.EmployeeRoleAnalysisCategoryCodeResponse
Contract.EmployeeRoleItem
Contract.EmployeeRoleResponse
Contract.EmployeeRoleWorkingPatternRequest
Contract.EmployeeRoleWorkingPatternResponse
Contract.EmployeeRoleWorkingPatternResponseItem
Contract.EmployeeSupplementaryPayRunResponse
Contract.EmployerBase
Contract.EmployerLeaveSettingsRequest
Contract.EmployerLeaveSettingsResponse
Contract.EmployerRequest
Contract.EmployerResponse
Contract.EmployerSettingsRequest
Contract.EmployerSettingsResponse
Contract.EmploymentDetailsRequest
Contract.EmploymentDetailsResponse
Contract.ExternalDataCompanyRequest
Contract.ExternalDataCompanyResponse
Contract.FpsFields
Contract.HmrcDetailsRequest
Contract.HmrcDetailsResponse
Contract.HolidayEntitlementRequest
Contract.HolidayEntitlementResponse
Contract.HolidayEntitlementUpdateRequest
Contract.HolidaySchemeRequest
Contract.HolidaySchemeResponse
Contract.JobErrorResponse
Contract.JobResponse
Contract.JobResultFileResponse
Contract.JobResultResponse
Contract.JournalTemplateRequest
Contract.JournalTemplateResponse
Contract.JournalTokenRequest
Contract.JournalTokenResponse
Contract.JournalTokenResponseItem
Contract.LeaveImportRequest
Contract.LeaverDetails
Contract.LondonAllowanceRequest
Contract.LondonAllowanceResponse
Contract.NetOfOnCostsResponse
Contract.NetOfOnCostsSimulationResponse
Contract.OverseasEmployerDetails
Contract.P11HistoryRequest
Contract.P11HistoryResponse
Contract.P45AvailabilityResponse
Contract.PartnerDetails
Contract.PayHistoryRequest
Contract.PayHistoryResponse
Contract.PayHistoryUpdateRequest
Contract.PaylineAnalysisCategoriesCodes
Contract.PaylineRequest
Contract.PayLineRequest
Contract.PayLineResponse
Contract.PaymentImportRequest
Contract.PayOptionsBaseResponse
Contract.PayOptionsImportRequest
Contract.PayOptionsRequest
Contract.PayOptionsResponse
Contract.PayPeriodOrdinalSelection
Contract.PayrollSquadEmployerRequest
Contract.PayrollSquadEmployerResponse
Contract.PayrollSquadMemberRequest
Contract.PayrollSquadMemberResponse
Contract.PayrollSquadRequest
Contract.PayrollSquadResponse
Contract.PayRunOverridesImportRequest
Contract.PayRunResponseItem
Contract.PayRunStateHistoryResponse
Contract.PayScheduleByDateRangeRequest
Contract.PayScheduleRequest
Contract.PayScheduleResponseItem
Contract.PaySpineGradeRequest
Contract.PaySpineGradeResponse
Contract.PaySpineRequest
Contract.PaySpineResponse
Contract.PaySpineUpdateRequest
Contract.PendingLettersCountResponse
Contract.PensionAdministratorRequest
Contract.PensionAdministratorResponse
Contract.PensionerPayroll
Contract.PensionNoticeDetailResponse
Contract.PensionNoticePagedResponse
Contract.PensionNoticeResponse
Contract.PensionNoticeRetrieveStateResponse
Contract.PensionNoticeSettingsRequest
Contract.PensionNoticeSettingsResponse
Contract.PensionProviderRequest
Contract.PensionProviderResponse
Contract.PensionSchemeNominalCodeMappingRequest
Contract.PensionSchemeNominalCodeMappingResponse
Contract.PensionSchemeReportOptionsLgpsCivicaUpmRequest
Contract.PensionSchemeReportOptionsLgpsCivicaUpmResponse
Contract.PensionSchemeReportOptionsLgpsIConnectRequest
Contract.PensionSchemeReportOptionsLgpsIConnectResponse
Contract.PensionSchemeRequest
Contract.PensionSchemeResponse
Contract.PensionSelectionRequest
Contract.PensionSelectionResponse
Contract.PersonalDetailsRequest
Contract.PersonalDetailsResponse
Contract.ReapplyDpsNoticeResponse
Contract.RecalculatePayRunEntriesResponse
Contract.RecalculatePayRunEntryResult
Contract.ReportTemplateColumnRequest
Contract.ReportTemplateColumnResponse
Contract.ReportTemplateContentDictionaryResponse
Contract.ReportTemplateContentResponse
Contract.ReportTemplateRequest
Contract.ReportTemplateResponse
Contract.RightToWork
Contract.RtiAgentRequest
Contract.RtiAgentResponse
Contract.RtiContactRequest
Contract.RtiContactResponse
Contract.RtiEmployeeAddress
Contract.RtiEmployeeName
Contract.RtiSubmissionSettingsRequest
Contract.RtiSubmissionSettingsResponse
Contract.SharedBankDetails
Contract.ShiftWorkingPatternDayRequest
Contract.ShiftWorkingPatternDayResponse
Contract.SpinalPointRequest
Contract.SpinalPointResponse
Contract.SpinalPointUpdateRequest
Contract.SpineAllowanceRequest
Contract.SpineAllowanceResponse
Contract.SpineAllowanceUpdateRequest
Contract.StarterDetails
Contract.TaxAndNi
Contract.TermCalendarRequest
Contract.TermCalendarResponse
Contract.TermCalendarYearRequest
Contract.TermCalendarYearResponse
Contract.UmbrellaSettingsRequest
Contract.UmbrellaSettingsResponse
Contract.UpdateEmployeeRequest
Contract.UserEmployerOptionsRequest
Contract.UserEmployerOptionsResponse
Contract.VeteranDetails
Contract.WorkerGroupRequest
Contract.WorkerGroupResponse
Contract.WorkingPatternRequest
Contract.WorkingPatternResponse
Contract.YearsServiceEntitlementRequest
Contract.YearsServiceEntitlementResponse
Contract.YearsServiceEntitlementUpdateRequest
CostAnalysisReport
CostAnalysisReportReportResponse
CostCentre
CostOfEmploymentReport
CostOfEmploymentReportLine
CostOfEmploymentReportReportResponse
Country
CountryCode
CsvFileFormat
CyclicReenrolmentReport
CyclicReenrolmentReportGroup
CyclicReenrolmentReportLine
CyclicReenrolmentReportReportResponse
DayOfWeek
DaysBeforePayday
DecimalDecimalBooleanPensionRuleValueTuple
DecimalTaxYearConfigPrimitiveValue
DeferalPeriodType
Department
DepartmentMembership
DirectDebitMandate
DirectorshipDetails
DpsDataType
DpsNotice
DpsSettings
EmailAttachment
Employee
EmployeeBenefitsReport
EmployeeBenefitsReportReportResponse
EmployeeCostCentre
EmployeeLeaveReport
EmployeeLeaveReportLine
EmployeeLeaveReportReportResponse
EmployeeLoanExportReport
EmployeeLoanExportReportLine
EmployeeLoanExportReportReportResponse
EmployeeNiYtdValues
EmployeePaymentsReportLine
EmployeePaymentsReportLineListReportResponse
EmployeePayRunTotal
EmployeeRole
EmployeeRoleAnalysisCategoryCode
EmployeeRolePayItem
EmployeeRolePayOptions
EmployeeSortBy
EmployeeStatus
EmployeeYtdValues
EmployerBetaFeatures
EmployerDefaults
EmployerEmail
EmployerEvcOptInHistory
EmployerGroup
EmployerGroupMembership
EmployerItem
EmployerListType
EmployerNote
EmployerOpeningBalances
EmployerPensionContribution
EmployerSortBy
EmployerTemplate
EmployerTemplateType
EmploymentDetails
EmpRefs
EntitlementBand
EntityType
Eps
EpsAccount
EpsApprenticeshipLevy
EpsDeMinimisStateAid
EpsFinalSubmission
ErrorType
Establishment
EvcSettings
Exb
ExbDeclarations
ExbEmployer
ExbP11d
ExbP11db
ExbP11dbClass1A
ExbP11dbClass1AAdjustment
ExbP11dbClass1AAdjustments
ExbP11dbClass1ATotalBenefit
ExbP11dEmployee
ExbReportResponse
ExpensesAndBenefits
ExternalDataCompany
ExternalDataProvider
ExternalDataProviderId
ExternalDataProviderType
ExternalEmployeeMapping
ExternalEmployeeMappingStatus
ExternalProviderConversation
FieldModification
FixedCode
FlexibleDrawdown
Fps
FpsBenefit
FpsCar
FpsCarFuel
FpsEmployee
FpsEmployeeDetails
FpsEmployeeDetailsPartnerDetails
FpsEmployeeFigsToDate
FpsEmployeeFlexibleDrawdown
FpsEmployeeNIlettersAndValues
FpsEmployeePayment
FpsEmployeeSeconded
FpsEmployeeStarter
FpsEmployeeStarterOccPension
FpsEmployeeTaxCode
FpsEmployeeTrivialCommutationPayment
FpsEmployerPayIdChanged
FpsEmployment
FpsFields
FpsLateReason
FpsPriorVersion
FpsReportResponse
FromToDates
FullPaymentSubmission
FullSummaryOfPayReport
FullSummaryOfPayReportLine
FullSummaryOfPayReportReportResponse
FurloughCalculationBasis
FurloughReport
FurloughReportLine
FurloughReportReportResponse
Gender
GenderPayGapLine
GenderPayGapReport
GenderPayGapReportReportResponse
GenderPayGapSnapShotDate
GovTalk
GovTalkError
GovTalkSubmission
GrossToNetReport
GrossToNetReportCisLine
GrossToNetReportLine
GrossToNetReportReportResponse
HmrcDetails
HmrcLiability
HmrcPayment
HolidayAccrual
HolidayAccrualDefaultRateType
HolidayReport
HolidayReportLine
HolidayReportReportResponse
HolidaySchemeDurationType
HolidayType
HourlyPayReport
HourlyPayReportLine
HourlyPayReportReportResponse
HoursNormallyWorked
HtmlEmailSettings
HtmlInsertionPoint
ImportResultDetails
ImportRowError
IncrementRule
Invitation
Item
ItemListReportResponse
JobStatus
JobType
JournalCsvFormat
JournalTemplate
JournalTokenType
Leave
LeaveAssumedPensionablePay
LeaveCalculationType
LeaveCustomPayment
LeaveCustomProRataRule
LeaveNotionalPayDetails
LeavePayType
LeaveProRataRule
LeaverDetails
LeaveSettings
LeaveType
LgpsCivicaCasualHours
LgpsCivicaPayrollNumber
LgpsFund
LgpsIConnectFileType
LgpsIConnectPayrollReference
LgpsIConnectSalaryType
LgpsPayCategory
LinkedPiw
LinkedPiwResult
Loan
LoanBalancesReport
LoanBalancesReportLine
LoanBalancesReportReportResponse
LoanCharge
LogEntry
LondonAllowance
LondonAllowanceType
LondonAllowanceValueType
MailSettings
MaritalStatus
McrPayCategory
MileageAllowancePaymentsRate
MileageVehicleType
MonthlyMinimum
NationalInsuranceCalculation
NationalInsuranceCalculationBase
NationalInsuranceCalculationPeriodValues
NationalInsuranceCode
NationalMinimumWage
NeonatalCarePaymentTier
NicSummary
NiLetterError
NiLetterValidationReport
NiLetterValidationReportLine
NiLetterValidationReportReportResponse
NiYtdReport
NiYtdReportReportResponse
NiYtdValue
NominalCodeMapping
Note
NoteType
NotionalPayPeriodBreakdown
Nvr
NvrEmployee
NvrEmployeeDetails
NvrEmployment
NvrRequest
OccupationalPolicy
OccupationalPolicyEntitlement
OccupationalPolicyEntitlementRecalculationBasis
OccupationalPolicyPayCalculatedOn
OccupationalPolicySicknessYear
OccupationalPolicyType
OccupationalSickLeaveHistory
OpeningBalances
OpeningBalancesTotals
OverseasEmployerDetails
OverseasSecondmentStatus
P11
P11DAssetAvailable
P11DAssetAvailableCollection
P11DAssetTransferredCollection
P11DCar
P11DCarCollection
P11dCarFreeFuelWithdrawn
P11DDescOther
P11Detailed
P11DetailedNiValues
P11DetailedReportResponse
P11dExpenses
P11DLoan
P11DLoanCollection
P11DOther
P11DPaymentCollection
P11DSingleItem
P11dVans
P11Line
P11NiAndStatPaymentsLine
P11NiAndStatPaymentsTotalsLine
P11NiValues
P11PayeLine
P11PayeSummary
P11PayeTotalsLine
P11ReportResponse
P32
P32ReportResponse
PapdisDocument
PapdisDocumentReportResponse
PapdisEmployee
PapdisEmployeeAssessment
PapdisEmployeeContact
PapdisEmployeeContactPostalAddress
PapdisEmployeeContribution
PapdisEmployeeExit
PapdisEmployeeIdentity
PapdisEmployeeName
PapdisEmployeePay
PapdisEmployer
PapdisEmployerContactPostalAddress
PapdisMessageFunctionCode
PapdisPayrollPeriod
PapdisPensionProvider
PapdisVersion
PartnerDetails
PayBasis
PayCode
PayCodeCalculationType
PayCodeMultiplierType
PayCodeSet
PayCodeVarianceLine
Payee
PayeeType
PayElementReport
PayElementReportLine
PayElementReportReportResponse
PayGradesReport
PayGradesReportReportResponse
PayImportPayCodeSummary
PayImportPayCodeTotals
PayLine
PaylineCalculationData
PaymentDateRule
PaymentDateType
PaymentMethodAfterLeaving
PaymentsCsvMapping
PaymentsCsvMappingColumn
PaymentsCsvMappingType
PayMethod
PayOptions
PayOptionsImport
PayPeriodEventType
PayPeriods
PayPeriodTypes
PayrollAnalysisCostBreakdownReport
PayrollAnalysisCostBreakdownReportLine
PayrollAnalysisCostBreakdownReportReportResponse
PayrollAnalysisCostBreakdownReportValue
PayrollAnalysisEmployeeRoleBreakdownReport
PayrollAnalysisEmployeeRoleBreakdownReportLine
PayrollAnalysisEmployeeRoleBreakdownReportLineValue
PayrollAnalysisEmployeeRoleBreakdownReportReportResponse
PayrollValueType
PayRun
PayRunChanges
PayRunCsvType
PayrunEmail
PayRunEntry
PayRunEntryNavigation
PayRunEntrySortBy
PayRunEntryWarningType
PayRunJournal
PayRunPayment
PayrunPaymentsReport
PayrunPaymentsReportReportResponse
PayRunState
PayRunStateChange
PayRunStateChangeReason
PayRunSummaryLine
PayRunSummaryLineIEnumerableReportResponse
PayRunTotals
PaySchedule
PaySchedulePeriod
PaySchedulePeriodEvent
Payslip
PayslipCustomisation
PayslipLine
PayslipLineType
PayslipReleasePaymentDateRule
PayslipReleaseTime
PayslipReleaseType
PayslipReportResponse
PaySpineReport
PaySpineReportLine
PaySpineReportReportResponse
PaySpineYearsServiceEntitlementBasis
PdfPaperMargins
PdfPaperOrientation
PdfPaperSize
PdfPasswordType
Pension
PensionablePayDefinition
PensionAdministrator
PensionContributionLevelType
PensionContributionsSubmission
PensionCsvFormat
PensionEndReason
PensionerPayroll
PensionInitialEnrolmentType
PensionJoinReason
PensionMembershipReportLine
PensionMembershipsReport
PensionMembershipsReportReportResponse
PensionNoticeSettings
PensionNoticeStatus
PensionNoticeType
PensionOpeningBalances
PensionPayCode
PensionProvider
PensionRefund
PensionReportingType
PensionRule
PensionScheme
PensionSchemeNominalCodeMapping
PensionSchemeReportOptionsLgpsCivicaUpm
PensionSchemeReportOptionsLgpsIConnect
PensionSingleEmploymentRelationship
PensionSummary
PensionSummaryCostBreakdown
PercentOfPayBand
PeriodValue
PersonalDetails
PricingBand
PricingTable
ProcessingNote
ProcessingNoteStatus
ProRataRule
RecoverableAmounts
ReenrolmentStatus
Report
ReportCustomCssOption
ReportFormat
ReportPack
ReportResponse
ReportSortBy
ReportTemplateColumnType
RightToWork
RightToWorkDocumentType
RightToWorkReport
RightToWorkReportLine
RightToWorkReportReportResponse
RoleBasis
RoleType
RtiAgent
RtiContact
RtiEmployeeAddress
RtiEmployeeName
RtiSenderType
RtiSubmissionSettings
RtiValidationWarning
RtiValidationWarningType
ServiceBand
ShiftWorkingPatternDay
SmtpEncryption
SmtpSettings
SpinePointReport
SpinePointReportLine
SpinePointReportReportResponse
StarterDeclaration
StarterDetails
StartersLeaversFilter
StatPayFrequency
StatutoryPay
StatutoryPayReport
StatutoryPayReportLine
StatutoryPayReportReportResponse
StringDecimalKeyValuePair
StringStringDecimalValueTuple
StringStringKeyValuePair
StudentLoan
StudentLoanRecovered
SubmissionStatus
SupplementaryPayRunDetails
Tag
TaxAndNi
TaxBracket
TaxCodeChange
TaxCodeChangeReport
TaxCodeChangeReportReportResponse
TaxCodeChangeValues
TaxYear
TaxYearConfig
TaxYearTypes
TeachersPensionAgeWarning
TeachersPensionDetails
TeachersPensionEmploymentType
TeachersPensionEoyLineItem
TeachersPensionEoyReport
TeachersPensionEoyReportReportResponse
Tenant
TenantBillingSettings
TenantEmail
TenantHtmlInsertion
TenantItem
TieredPension
TieredPensionRate
UmbrellaPayment
UmbrellaReconciliationReport
UmbrellaReconciliationReportLine
UmbrellaReconciliationReportReportResponse
UsageBill
User
UserAuthorization
UserCategory
UserDisplayPreferences
UserEmployer
UserIndustry
UserJobType
UserRole
UserstartPage
UtmInfo
ValueOverride
VarianceReport
VarianceReportReportResponse
VeteranDetails
WarningsReport
WarningsReportLine
WarningsReportReportResponse
Webhook
WebhookEvent
WebhookPayload
WorkerGroup
WorkingPattern
WorkingPatternHoursType
WorkingPatternType
YearEnd
YearEndTaxCodeChange
YtdReport
YtdReportReportResponse
YtdValue
ZeroPaidFilter
Get Opening Balances
Get
/employers/{employerId}/employees/{employeeId}/openingBalances
Store values
Parameters
employerId
string
employeeId
string
id
string
The Id of the Pension Refund you want to update.
body
sample value
Content Type
application/json-patch+json
application/json
text/json
application/*+json
PensionRefund
Try it
OAuth Token
Api Key
×
Update Pension Refund
Response Code
Response Body
Response Headers
Log in to your account
The OAuth token may not be valid.
Either log in to you account to fresh it or use an API Key.
The API Key you provided may not be valid.
Please check it or use the OAuth Token.
Possible Responses
200
Success
PensionRefund
application/json
404
Not Found
409
Conflict