PayRun.IO

Open, scableable, transparent payroll API.

Claim this API

Are you the operator of PayRun.IO? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with PayRun.IO? Let us know about broken links, changed auth, deprecated endpoints, or other issues.

Base URL: https://api.test.payrun.io
Auth: unknown
Endpoints: 231
Reachable: unknown
CORS: unknown

Endpoints

Method Path Summary Auth Last Status Latency
GET /Employer/{EmployerId} Gets the employer
GET /Employer/{EmployerId}/CisLineType/{CisLineTypeId} Get CIS line type from employer
GET /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} Get CIS line type tag
GET /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tags Get all tags from the CIS line type
GET /Employer/{EmployerId}/CisLineTypes Get CIS line types from employer.
GET /Employer/{EmployerId}/CisLineTypes/Tag/{TagId} Get CIS line types with tag
GET /Employer/{EmployerId}/CisLineTypes/Tags Get all CIS line type tags
GET /Employer/{EmployerId}/CisTransaction/{CisTransactionId} Get the CIS transaction
GET /Employer/{EmployerId}/CisTransactions Get all CIS transactions for the employer
GET /Employer/{EmployerId}/DpsMessage/{DpsMessageId} Gets the DPS message
GET /Employer/{EmployerId}/DpsMessages Gets the DPS messages
GET /Employer/{EmployerId}/Employee/{EmployeeId} Get employee from employer
GET /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} Get the auto enrolment assessment
GET /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments Get the auto enrolment assessments
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Commentaries Get links to all commentaries for the specified employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId} Get commentary from employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/JournalLines Gets the journal Lines from the specified employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} Gets the specified pay instruction from the employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId} Get pay instruction tag
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tags Get all tags from the pay instruction
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions Gets the pay instructions from the specified employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tag/{TagId} Get pay instructions with tag
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tags Get all pay instruction tags
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId} Gets the specified pay line from the employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId} Get pay line tag
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tags Get all tags from the pay line
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLines Gets the pay lines from the specified employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tag/{TagId} Get pay lines with tag
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tags Get all pay line tags
GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayRuns Gets the pay runs from the employee
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber} Gets the employee by revision number
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}/Summary Gets the employee summary by revision number
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revisions Get all employee revisions
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revisions/Summary Get all employee revision summaries
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId} Get employee secret
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Summary Get employee summary from employer
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId} Get employee tag
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}/{EffectiveDate} Get employee revision tag
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tags Get all employee tags
GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tags/{EffectiveDate} Get all employee revision tags
GET /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate} Get employee by effective date.
GET /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}/Summary Get employee summary by effective date.
GET /Employer/{EmployerId}/Employees Get employees from employer.
GET /Employer/{EmployerId}/Employees/Summary Get employee summaries from employer.
GET /Employer/{EmployerId}/Employees/Tag/{TagId} Get employees with tag
GET /Employer/{EmployerId}/Employees/Tags Get all employee tags
GET /Employer/{EmployerId}/Employees/{EffectiveDate} Get employees from employer at a given effective date.
GET /Employer/{EmployerId}/Employees/{EffectiveDate}/Summary Get employee summaries from employer at a given effective date.
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId} Get holiday scheme from employer
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber} Gets the holiday scheme revision by revision number
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revisions Get all holiday scheme revisions
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId} Get holiday scheme tag
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}/{EffectiveDate} Get holiday scheme revision tag
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags Get all tags from the holiday scheme
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags/{EffectiveDate} Get all holiday scheme revision tags
GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate} Get holiday scheme by effective date.
GET /Employer/{EmployerId}/HolidaySchemes Get holiday schemes from employer.
GET /Employer/{EmployerId}/HolidaySchemes/Tag/{TagId} Get holiday schemes with tag
GET /Employer/{EmployerId}/HolidaySchemes/Tags Get all holiday scheme tags
GET /Employer/{EmployerId}/HolidaySchemes/{EffectiveDate} Get holiday schemes from employer at a given effective date.
GET /Employer/{EmployerId}/JournalInstruction/{JournalInstructionId} Gets the specified journal instruction from the employer
GET /Employer/{EmployerId}/JournalInstructions Gets the Journal instructions from the specified employer
GET /Employer/{EmployerId}/JournalLine/{JournalLineId} Gets the specified journal Line from the employer
GET /Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId} Get journal line tag
GET /Employer/{EmployerId}/JournalLine/{JournalLineId}/Tags Get tags from journal line
GET /Employer/{EmployerId}/JournalLines Gets the Journal Lines from the specified employer
GET /Employer/{EmployerId}/JournalLines/Tag/{TagId} Get links to tagged journal lines
GET /Employer/{EmployerId}/JournalLines/Tags Get all journal line tags
GET /Employer/{EmployerId}/NominalCode/{NominalCodeId} Gets the nominal code
GET /Employer/{EmployerId}/NominalCode/{NominalCodeId}/PayCodes Gets the pay codes by nominal code
GET /Employer/{EmployerId}/NominalCodes Gets the nominal codes
GET /Employer/{EmployerId}/PayCode/{PayCodeId} Gets the specified pay code from the employer
GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Revision/{RevisionNumber} Gets the pay code by revision number
GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Revisions Get all revisions of the Pay Code
GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId} Get pay code tag
GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Tags Get all pay code tags
GET /Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate} Gets pay code for specified date
GET /Employer/{EmployerId}/PayCodes Gets the pay codes from the employer
GET /Employer/{EmployerId}/PayCodes/Tag/{TagId} Get pay codes with tag
GET /Employer/{EmployerId}/PayCodes/Tags Get all pay code tags
GET /Employer/{EmployerId}/PayCodes/{EffectiveDate} Gets all pay codes for specified date
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId} Gets the specified pay schedule from the employer
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees Get all employees revisions from a pay schedule.
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees/{EffectiveDate} Get employees from a pay schedule on effective date.
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId} Gets the pay run from the pay schedule
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/AEAssessments Get the auto enrolment assessments
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Commentaries Get links to all commentaries for the specified pay run
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}/Commentary Get commentary from payrun by specified employee.
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employees Get employees from the pay run
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/JournalLines Gets the journal Lines from the specified pay run
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/PayLines Gets the pay lines from the specified pay run
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/ReportLines Gets the report lines from the specified pay run
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId} Get pay run tag
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tags Get all pay run tags
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns Gets the pay runs from the pay schedule
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tag/{TagId} Get pay runs with tag
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tags Get all pay run tags
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId} Get pay schedule tag
GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tags Get all pay schedule tags
GET /Employer/{EmployerId}/PaySchedules Gets the pay schedule from the specified employer
GET /Employer/{EmployerId}/PaySchedules/Tag/{TagId} Get pay schedule with tag
GET /Employer/{EmployerId}/PaySchedules/Tags Get all pay schedule tags
GET /Employer/{EmployerId}/Pension/{PensionId} Get pension from employer
GET /Employer/{EmployerId}/Pension/{PensionId}/Revision/{RevisionNumber} Gets the pension by revision number
GET /Employer/{EmployerId}/Pension/{PensionId}/Revisions Get all pension revisions
GET /Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate} Get pension by effective date.
GET /Employer/{EmployerId}/Pensions Get pensions from employer.
GET /Employer/{EmployerId}/Pensions/{EffectiveDate} Get pensions from employer at a given effective date.
GET /Employer/{EmployerId}/ReportLine/{ReportLineId} Gets the specified report line from the employer
GET /Employer/{EmployerId}/ReportLines Gets the report lines from the specified employer
GET /Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId} Gets the specified reporting instruction from the employer
GET /Employer/{EmployerId}/ReportingInstructions Gets the reporting instructions from the specified employer
GET /Employer/{EmployerId}/Revision/{RevisionNumber} Gets the employer by revision number
GET /Employer/{EmployerId}/Revision/{RevisionNumber}/Summary Gets the employer summary by revision number
GET /Employer/{EmployerId}/Revisions Gets the employer revisions
GET /Employer/{EmployerId}/Revisions/Summary Get all employer revision summaries
GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId} Get the RTI transaction
GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Summary Get the RTI transaction summary
GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId} Get RTI transaction tag
GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tags Get all tags from RTI transaction
GET /Employer/{EmployerId}/RtiTransactions Get all RTI transactions for the employer
GET /Employer/{EmployerId}/RtiTransactions/Summary Get all RTI transaction summaries for the employer
GET /Employer/{EmployerId}/RtiTransactions/Tag/{TagId} Get RTI transactions with tag
GET /Employer/{EmployerId}/RtiTransactions/Tags Get all RTI transaction tags
GET /Employer/{EmployerId}/Secret/{SecretId} Get employer secret
GET /Employer/{EmployerId}/SubContractor/{SubContractorId} Get sub contractor from employer
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId} Get CIS instruction from sub contractor
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId} Get CIS instruction tag
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tags Get all tags from the CIS instruction
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions Get CIS instructions from sub contractor.
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tag/{TagId} Get CIS instructions with tag
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tags Get all CIS instruction tags
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId} Get CIS line from sub contractor
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId} Get CIS line tag
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tags Get all tags from the CIS line
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines Get CIS lines from sub contractor.
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tag/{TagId} Get CIS lines with tag
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tags Get all CIS line tags
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/JournalLines Gets the journal Lines from the specified sub contractor
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Revision/{RevisionNumber} Gets the sub contractor by revision number
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Revisions Get all sub contractor revisions
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId} Get sub contractor tag
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}/{EffectiveDate} Get sub contractor revision tag
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags Get all tags from the sub contractor
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags/{EffectiveDate} Get all sub contractor revision tags
GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/{EffectiveDate} Get sub contractor by effective date.
GET /Employer/{EmployerId}/SubContractors Get sub contractors from employer.
GET /Employer/{EmployerId}/SubContractors/Tag/{TagId} Get sub contractors with tag
GET /Employer/{EmployerId}/SubContractors/Tags Get all sub contractor tags
GET /Employer/{EmployerId}/SubContractors/{EffectiveDate} Get sub contractors from employer at a given effective date.
GET /Employer/{EmployerId}/Summary Get employer summary
GET /Employer/{EmployerId}/Tag/{TagId} Get employer tag
GET /Employer/{EmployerId}/Tag/{TagId}/{EffectiveDate} Get employer revision tag
GET /Employer/{EmployerId}/Tags Get all employer tags
GET /Employer/{EmployerId}/Tags/{EffectiveDate} Get all employer revision tags
GET /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId} Get a third party transaction
GET /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId} Get third party transaction tag
GET /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tags Get tags from third party transaction
GET /Employer/{EmployerId}/ThirdPartyTransactions Get all third party transaction links
GET /Employer/{EmployerId}/ThirdPartyTransactions/Tag/{TagId} Get links to tagged third party transactions
GET /Employer/{EmployerId}/ThirdPartyTransactions/Tags Get all third party transaction tags
GET /Employer/{EmployerId}/{EffectiveDate} Gets the employer at the specified effective
GET /Employer/{EmployerId}/{EffectiveDate}/Summary Get employer summary by effective date.
GET /Employers Gets all employers
GET /Employers/Summary Get employer summaries.
GET /Employers/Tag/{TagId} Get employers with tag
GET /Employers/Tags Get all employer tags
GET /Employers/{EffectiveDate} Gets all employers at the specified effective date
GET /Employers/{EffectiveDate}/Summary Get employer summaries at a given effective date.
GET /Healthcheck Get health check status
GET /Jobs/Batch Get all Batch jobs
GET /Jobs/Batch/{JobId}/Info Get the Batch job information
GET /Jobs/Batch/{JobId}/Progress Get the Batch job progress
GET /Jobs/Batch/{JobId}/Status Get the Batch job status
GET /Jobs/Cis Get all CIS jobs
GET /Jobs/Cis/{JobId}/Info Get the CIS job information
GET /Jobs/Cis/{JobId}/Progress Get the CIS job progress
GET /Jobs/Cis/{JobId}/Status Get the CIS job status
GET /Jobs/Dps Get all DPS jobs
GET /Jobs/Dps/{JobId}/Info Get the DPS job information
GET /Jobs/Dps/{JobId}/Progress Get the DPS job progress
GET /Jobs/Dps/{JobId}/Status Get the DPS job status
GET /Jobs/Employer/{EmployerId} Gets all jobs relating to the employer.
GET /Jobs/PayRuns Get all PayRun jobs
GET /Jobs/PayRuns/{JobId}/Info Get the pay run job information
GET /Jobs/PayRuns/{JobId}/Progress Get the pay run job progress
GET /Jobs/PayRuns/{JobId}/Status Get the pay run job status
GET /Jobs/Rti Get all RTI jobs
GET /Jobs/Rti/{JobId}/Info Get the RTI job information
GET /Jobs/Rti/{JobId}/Progress Get the RTI job progress
GET /Jobs/Rti/{JobId}/Status Get the RTI job status
GET /Jobs/ThirdParty Get all Third Party jobs
GET /Jobs/ThirdParty/{JobId}/Info Get the Third Party job information
GET /Jobs/ThirdParty/{JobId}/Progress Get the Third Party job progress
GET /Jobs/ThirdParty/{JobId}/Status Get the Third Party job status
GET /JournalInstruction/{JournalInstructionId} Gets the Journal instructions template for the application
GET /JournalInstructions Gets the Journal instructions templates for the application
GET /Permission/{PermissionId} Gets the permission object
GET /Permission/{PermissionId}/Tag/{TagId} Get Permission tag
GET /Permission/{PermissionId}/Tags Get tags from Permission
POST /Query Get the query result
GET /ReferenceData/JournalExpressionDataTable Gets the journal expression data schema
GET /Report/ACTPAYINS/run Runs the active pay instructions report
GET /Report/AOELIABILITY/run Runs the AOE liability report
GET /Report/DPSMSG/run Runs the DPS message report
GET /Report/EMPSUM/run Runs the employer summary report
GET /Report/GRO2NET/run Runs the gross to net report
GET /Report/HOLBAL/run Runs the holiday balance report
GET /Report/JOURNAL/run Runs the journal report
GET /Report/LASTPAYDATE/run Runs the last pay date report
GET /Report/NETPAY/run Runs the net pay report
GET /Report/NEXTPERIOD/run Runs the next pay period report
GET /Report/P11SUM/run Runs the P11 summary report
GET /Report/P32/run Runs the P32 report
GET /Report/P32SUM/run Runs the P32 summary report
GET /Report/P45/run Runs the P45 report
GET /Report/P60/run Runs the P60 report
GET /Report/PAPDIS/run Runs the PAPDIS report
GET /Report/PASS/run Runs the PASS report
GET /Report/PAYDASHBOARD/run Runs the Pay Dashboard payslips report
GET /Report/PAYSLIP3/run Runs the verbose payslip report
GET /Report/PENLIABILITY/run Runs the pension liability report
GET /Report/{ReportDefinitionId} Get the report definition
GET /Report/{ReportDefinitionId}/run Runs the specified report definition
GET /Reports Gets all reports
GET /Schemas Get a list of all available schemas
GET /Schemas/{DtoDataType} Get XSD schema
GET /Secret/{SecretId} Get Application secret
GET /Template/{DtoDataType} Get the object template
GET /Templates Get a list of all available data object tempaltes
GET /Transform/{TransformDefinitionId} Get the transform definition
GET /Transforms Gets all transform definitions