Description HTTP Request
GET /api/v2/business/{businessId}/payrun/{payRunId}/details
Add Statutory Maternity Pay
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/smp/employee/{employeeId}
Add Statutory Sick Pay
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId}
Apply statutory adoption payments to pay run
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId}
Bulk Apply Leave Requests
POST /api/v2/business/{businessId}/payrun/{payRunId}/bulkapplyleaverequests
Create Deductions
POST /api/v2/business/{businessId}/payrun/{payRunId}/deductions
Create Earnings Lines
POST /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Create Employee Expenses
POST /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
Create Employer Liabilities
POST /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
Create HMRC Adjustments
POST /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments
Create Note for Employee
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId}
Create PAYE Adjustments
POST /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
Create Pay Run
POST /api/v2/business/{businessId}/payrun
Create Pay Run (Async)
POST /api/v2/business/{businessId}/payrun/async
Delete Deduction
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/deductions
Delete Earnings Line
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Delete Employee Expense
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
Delete Employer Liability
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
Delete HMRC Adjustment
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments
Delete Leave Accrual
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Delete Note for Employee
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId}
Delete PAYE Adjustment
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
Delete Pay Run
DELETE /api/v2/business/{businessId}/payrun/{payRunId}
Delete Pay Run Notation
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation
Exclude employee from pay run
POST /api/v2/business/{businessId}/payrun/{payRunId}/exclude/{employeeId}
Finalise Pay Run
POST /api/v2/business/{businessId}/payrun/{payRunId}/finalise
Get BACS File
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/bacs/{bacsDetailsId}
Get Benefits
GET /api/v2/business/{businessId}/payrun/{payRunId}/benefits/{employeeId}
Get Creation Status
GET /api/v2/business/{businessId}/payrun/creationstatus/{jobId}
Get Deductions by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions/{employeeId}
Get Earnings Lines by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}
Get Employee Expenses by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses/{employeeId}
Get Employer Liabilities by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities/{employeeId}
Get HMRC Adjustments by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments/{employeeId}
Get Journal Details
GET /api/v2/business/{businessId}/journal/{payRunId}
Get Leave Accruals
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Get Leave Accruals for Employee
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued/{employeeId}
Get PAYE Adjustments by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{employeeId}
Get Pay Run
GET /api/v2/business/{businessId}/payrun/{payRunId}
Get Pay Run Summary
GET /api/v2/business/{businessId}/payrun/{payRunId}/summary
Get Pay Run Totals by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}
Get Pay Slip Data by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}
Get Pay Slip File
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/payslip/{employeeId}
Get Statutory Sick Pay By Employee Id
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId}
Get Statutory Sick Pay By Id
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/{sspId}
Get pay run payments
GET /api/v2/business/{businessId}/payrun/{payRunId}/payments
Get statutory adoption pay calculation for pay run
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId}
Include Employee
POST /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId}
List Benefits
GET /api/v2/business/{businessId}/payrun/{payRunId}/benefits
List Deductions
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions
List Earnings Lines
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
List Employee Expenses
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
List Employer Liabilities
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
List HMRC Adjustments
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments
List PAYE Adjustments
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
List Pay Run Totals
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals
List Pay Run Totals for Employee
GET /api/v2/business/{businessId}/employee/{employeeId}/payruntotals
List Pay Run Warnings
GET /api/v2/business/{businessId}/payrun/{payRunId}/warnings
List Pay Runs
GET /api/v2/business/{businessId}/payrun
List Pay Runs Summaries
GET /api/v2/business/{businessId}/payrun/summary
List Pay Slip Data
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips
Net to Gross
POST /api/v2/business/{businessId}/payrun/{payRunId}/nettogross
Recalculate
POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate
Remove Employee from Pay Run
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId}
Save Leave Accruals
POST /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Set Pay Run Notation
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation
Set UI Unlock enabled
POST /api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate
Start Approval Process
POST /api/v2/business/{businessId}/payrun/{payRunId}/approval/start
Terminate Employee in Pay Run
POST /api/v2/business/{businessId}/payrun/{payRunId}/terminate
Unlock Pay Run
POST /api/v2/business/{businessId}/payrun/{payRunId}/unlock