PayRun.IO
Open, scableable, transparent payroll API.
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Open, scableable, transparent payroll API.
Endpoints 389
Employer
- GETGets the employer
/Employer/:EmployerIdGet the specified employer object - PUTUpdates the Employer
/Employer/:EmployerIdUpdates the existing specified employer object - DELETEDelete an Employer
/Employer/:EmployerIdDelete the specified employer - PATCHPatches the employer
/Employer/:EmployerIdPatches the specified employer with the supplied values - GETGets the employer by revision number
/Employer/:EmployerId/Revision/:RevisionNumberGet the employer revision matching the specified revision number - DELETEDelete an Employer revision matching the specified revision number.
/Employer/:EmployerId/Revision/:RevisionNumberDeletes the specified employer revision for the matching revision number - GETGets the employer summary by revision number
/Employer/:EmployerId/Revision/:RevisionNumber/SummaryGet the employer revision summary matching the specified revision number - GETGets the employer revisions
/Employer/:EmployerId/RevisionsGets links to all the employer revisions - GETGet all employer revision summaries
/Employer/:EmployerId/Revisions/SummaryGets links to all employer revision summaries - GETGet employer secret
/Employer/:EmployerId/Secret/:SecretIdGet the public visible employer secret object - PUTCreate a new employer secret
/Employer/:EmployerId/Secret/:SecretIdCreate / update an employer secret at the given resource location - DELETEDeletes employer secret
/Employer/:EmployerId/Secret/:SecretIdDeletes an employer secret from the given resource location - GETGet all employer secret links
/Employer/:EmployerId/SecretsGet all the employer secret links - POSTCreate a new employer secret
/Employer/:EmployerId/SecretsCreate new employer secret using auto generated resource location key - GETGet employer summary
/Employer/:EmployerId/SummaryGets the specified employer summary data. - GETGets the employer at the specified effective
/Employer/:EmployerId/:EffectiveDateReturns the employer's state at the specified effective date. - DELETEDelete an Employer revision matching the specified revision date.
/Employer/:EmployerId/:EffectiveDateDeletes the specified employer revision for the matching revision date - GETGet employer summary by effective date.
/Employer/:EmployerId/:EffectiveDate/SummaryGets the employer summary for the specified effective date. - GETGets all employers
/EmployersGets links to all employers contained under the authorised application scope - POSTCreate a new Employer
/EmployersCreate a new employer object - GETGet employer summaries.
/Employers/SummaryGet links to all employer summaries. - GETGets all employers at the specified effective date
/Employers/:EffectiveDateGets links to all employers contained under the authorised application scope for the specified effective date. - GETGet employer summaries at a given effective date.
/Employers/:EffectiveDate/SummaryGet links to all employer summaries on specified effective date.
CIS
- GETGet CIS line type from employer
/Employer/:EmployerId/CisLineType/:CisLineTypeIdGets the specified CIS line type from employer. - PUTUpdates the CIS line type
/Employer/:EmployerId/CisLineType/:CisLineTypeIdUpdates the existing specified CIS line type object - DELETEDelete an CIS line type
/Employer/:EmployerId/CisLineType/:CisLineTypeIdDelete the specified CIS line type - GETGet CIS line types from employer.
/Employer/:EmployerId/CisLineTypesGet links to all CIS line types for the specified employer. - POSTCreate a new CIS line type
/Employer/:EmployerId/CisLineTypesCreate a new CIS line type object - GETGet the CIS transaction
/Employer/:EmployerId/CisTransaction/:CisTransactionIdReturns the specified CIS transaction - DELETEDelete the CIS transaction
/Employer/:EmployerId/CisTransaction/:CisTransactionIdDeletes the specified CIS transaction - GETGet all CIS transactions for the employer
/Employer/:EmployerId/CisTransactionsGet links for all CIS transactions for the specified employer - GETGet CIS instruction from sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionIdGets the specified CIS instruction from sub contractor. - PUTUpdates the CIS instruction
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionIdInsert or update existing CIS instruction object - DELETEDelete a CIS instruction
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionIdDelete the specified CIS instruction - PATCHPatches the CIS instruction
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionIdUpdate an existing CIS instruction object - GETGet CIS instructions from sub contractor.
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstructionsGet links to all CIS instructions for the specified sub contractor. - POSTCreate a new CIS instruction
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstructionsCreate a new CIS instruction object - GETGet CIS line from sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLine/:CisLineIdGets the specified CIS line from sub contractor. - DELETEDelete a CIS line
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLine/:CisLineIdDelete the specified CIS line - GETGet CIS lines from sub contractor.
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLinesGet links to all CIS lines for the specified sub contractor.
Tagging
- GETGet CIS line type tag
/Employer/:EmployerId/CisLineType/:CisLineTypeId/Tag/:TagIdGets the tag from the CIS line type - PUTInsert CIS line type tag
/Employer/:EmployerId/CisLineType/:CisLineTypeId/Tag/:TagIdInserts a new tag on the CIS line type - DELETEDelete CIS line type tag
/Employer/:EmployerId/CisLineType/:CisLineTypeId/Tag/:TagIdDeletes a tag from the CIS line type - GETGet all tags from the CIS line type
/Employer/:EmployerId/CisLineType/:CisLineTypeId/TagsGets all the tags from the CIS line type - GETGet CIS line types with tag
/Employer/:EmployerId/CisLineTypes/Tag/:TagIdGets the CIS line type with the tag - GETGet all CIS line type tags
/Employer/:EmployerId/CisLineTypes/TagsGets all the CIS line type tags - GETGet pay instruction tag
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionId/Tag/:TagIdGets the tag from the pay instruction - PUTInsert pay instruction tag
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionId/Tag/:TagIdInserts a new tag on the pay instruction - DELETEDelete pay instruction tag
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionId/Tag/:TagIdDeletes a tag from the pay instruction - GETGet all tags from the pay instruction
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionId/TagsGets all the tags from the pay instruction - GETGet pay instructions with tag
/Employer/:EmployerId/Employee/:EmployeeId/PayInstructions/Tag/:TagIdGets the pay instructions with the tag - GETGet all pay instruction tags
/Employer/:EmployerId/Employee/:EmployeeId/PayInstructions/TagsGets all the pay instruction tags - GETGet pay line tag
/Employer/:EmployerId/Employee/:EmployeeId/PayLine/:PayLineId/Tag/:TagIdGets the tag from the pay line - PUTInsert pay line tag
/Employer/:EmployerId/Employee/:EmployeeId/PayLine/:PayLineId/Tag/:TagIdInserts a new tag on the pay line - DELETEDelete pay line tag
/Employer/:EmployerId/Employee/:EmployeeId/PayLine/:PayLineId/Tag/:TagIdDeletes a tag from the pay line - GETGet all tags from the pay line
/Employer/:EmployerId/Employee/:EmployeeId/PayLine/:PayLineId/TagsGets all the tags from the pay line - GETGet pay lines with tag
/Employer/:EmployerId/Employee/:EmployeeId/PayLines/Tag/:TagIdGets the pay line with the tag - GETGet all pay line tags
/Employer/:EmployerId/Employee/:EmployeeId/PayLines/TagsGets all the pay line tags - GETGet employee tag
/Employer/:EmployerId/Employee/:EmployeeId/Tag/:TagIdGets the tag from the employee - PUTInsert employee tag
/Employer/:EmployerId/Employee/:EmployeeId/Tag/:TagIdInserts a new tag on the employee - DELETEDelete employee tag
/Employer/:EmployerId/Employee/:EmployeeId/Tag/:TagIdDeletes a tag from the employee - GETGet employee revision tag
/Employer/:EmployerId/Employee/:EmployeeId/Tag/:TagId/:EffectiveDateGets the tag from the employee revision - GETGet all employee tags
/Employer/:EmployerId/Employee/:EmployeeId/TagsGets all the tags from the employee - GETGet all employee revision tags
/Employer/:EmployerId/Employee/:EmployeeId/Tags/:EffectiveDateGets all the tags from the employee revision - GETGet employees with tag
/Employer/:EmployerId/Employees/Tag/:TagIdGets the employees with the tag - GETGet all employee tags
/Employer/:EmployerId/Employees/TagsGets all the employee tags - GETGet holiday scheme tag
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Tag/:TagIdGets the tag from the holiday scheme - PUTInsert holiday scheme tag
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Tag/:TagIdInserts a new tag on the holiday scheme - DELETEDelete holiday scheme tag
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Tag/:TagIdDeletes a tag from the holiday scheme - GETGet holiday scheme revision tag
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Tag/:TagId/:EffectiveDateGets the tag from the holiday scheme revision - GETGet all tags from the holiday scheme
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/TagsGets all the tags from the holiday scheme - GETGet all holiday scheme revision tags
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Tags/:EffectiveDateGets all the tags from the holiday scheme revision - GETGet holiday schemes with tag
/Employer/:EmployerId/HolidaySchemes/Tag/:TagIdGets the holiday scheme with the tag - GETGet all holiday scheme tags
/Employer/:EmployerId/HolidaySchemes/TagsGets all the holiday scheme tags - GETGet journal line tag
/Employer/:EmployerId/JournalLine/:JournalLineId/Tag/:TagIdGets a tag from the journal line - PUTInsert journal line tag
/Employer/:EmployerId/JournalLine/:JournalLineId/Tag/:TagIdInserts a tag on the journal line - DELETEDelete journal line tag
/Employer/:EmployerId/JournalLine/:JournalLineId/Tag/:TagIdDeletes a tag from the journal line - GETGet tags from journal line
/Employer/:EmployerId/JournalLine/:JournalLineId/TagsGets all tags from the journal line - GETGet links to tagged journal lines
/Employer/:EmployerId/JournalLines/Tag/:TagIdGets the journal lines with the specified tag - GETGet all journal line tags
/Employer/:EmployerId/JournalLines/TagsGets all the journal line tags - GETGet pay code tag
/Employer/:EmployerId/PayCode/:PayCodeId/Tag/:TagIdGets the tag from the pay code - PUTInsert pay code tag
/Employer/:EmployerId/PayCode/:PayCodeId/Tag/:TagIdInserts a new tag on the pay code - DELETEDelete pay code tag
/Employer/:EmployerId/PayCode/:PayCodeId/Tag/:TagIdDeletes a tag from the pay code - GETGet all pay code tags
/Employer/:EmployerId/PayCode/:PayCodeId/TagsGets all the tags from the pay code - GETGet pay codes with tag
/Employer/:EmployerId/PayCodes/Tag/:TagIdGets the pay codes with the tag - GETGet all pay code tags
/Employer/:EmployerId/PayCodes/TagsGets all the pay code tags - GETGet pay run tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/Tag/:TagIdGets the tag from the pay run - PUTInsert pay run tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/Tag/:TagIdInserts a new tag on the pay run - DELETEDelete pay run tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/Tag/:TagIdDeletes a tag from the pay run - GETGet all pay run tags
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/TagsGets all the tags from the pay run - GETGet pay runs with tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRuns/Tag/:TagIdGets the pay runs with the tag - GETGet all pay run tags
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRuns/TagsGets all the pay run tags - GETGet pay schedule tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/Tag/:TagIdGets the tag from the pay schedule - PUTInsert pay schedule tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/Tag/:TagIdInserts a new tag on the pay schedule - DELETEDelete pay schedule tag
/Employer/:EmployerId/PaySchedule/:PayScheduleId/Tag/:TagIdDeletes a tag from the pay schedule - GETGet all pay schedule tags
/Employer/:EmployerId/PaySchedule/:PayScheduleId/TagsGets all the tags from the pay schedule - GETGet pay schedule with tag
/Employer/:EmployerId/PaySchedules/Tag/:TagIdGets the pay schedules with the tag - GETGet all pay schedule tags
/Employer/:EmployerId/PaySchedules/TagsGets all the pay schedule tags - GETGet RTI transaction tag
/Employer/:EmployerId/RtiTransaction/:RtiTransactionId/Tag/:TagIdGets the tag from the RTI transaction - PUTInsert RTI transaction tag
/Employer/:EmployerId/RtiTransaction/:RtiTransactionId/Tag/:TagIdInserts a new tag on the RTI transaction - DELETEDelete RTI transaction tag
/Employer/:EmployerId/RtiTransaction/:RtiTransactionId/Tag/:TagIdDeletes a tag from the RTI transaction - GETGet all tags from RTI transaction
/Employer/:EmployerId/RtiTransaction/:RtiTransactionId/TagsGets all the tags from the RTI transaction - GETGet RTI transactions with tag
/Employer/:EmployerId/RtiTransactions/Tag/:TagIdGets the RTI transactions with the tag - GETGet all RTI transaction tags
/Employer/:EmployerId/RtiTransactions/TagsGets all the RTI transaction tags - GETGet CIS instruction tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionId/Tag/:TagIdGets the tag from the CIS instruction - PUTInsert CIS instruction tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionId/Tag/:TagIdInserts a new tag on the CIS instruction - DELETEDelete CIS instruction tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionId/Tag/:TagIdDeletes a tag from the CIS instruction - GETGet all tags from the CIS instruction
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstruction/:CisInstructionId/TagsGets all the tags from the CIS instruction - GETGet CIS instructions with tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstructions/Tag/:TagIdGets the CIS instruction with the tag - GETGet all CIS instruction tags
/Employer/:EmployerId/SubContractor/:SubContractorId/CisInstructions/TagsGets all the CIS instruction tags - GETGet CIS line tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLine/:CisLineId/Tag/:TagIdGets the tag from the CIS line - PUTInsert CIS line tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLine/:CisLineId/Tag/:TagIdInserts a new tag on the CIS line - DELETEDelete CIS line tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLine/:CisLineId/Tag/:TagIdDeletes a tag from the CIS line - GETGet all tags from the CIS line
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLine/:CisLineId/TagsGets all the tags from the CIS line - GETGet CIS lines with tag
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLines/Tag/:TagIdGets the CIS line with the tag - GETGet all CIS line tags
/Employer/:EmployerId/SubContractor/:SubContractorId/CisLines/TagsGets all the CIS line tags - GETGet sub contractor tag
/Employer/:EmployerId/SubContractor/:SubContractorId/Tag/:TagIdGets the tag from the sub contractor - PUTInsert sub contractor tag
/Employer/:EmployerId/SubContractor/:SubContractorId/Tag/:TagIdInserts a new tag on the sub contractor - DELETEDelete sub contractor tag
/Employer/:EmployerId/SubContractor/:SubContractorId/Tag/:TagIdDeletes a tag from the sub contractor - GETGet sub contractor revision tag
/Employer/:EmployerId/SubContractor/:SubContractorId/Tag/:TagId/:EffectiveDateGets the tag from the sub contractor revision - GETGet all tags from the sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorId/TagsGets all the tags from the sub contractor - GETGet all sub contractor revision tags
/Employer/:EmployerId/SubContractor/:SubContractorId/Tags/:EffectiveDateGets all the tags from the sub contractor revision - GETGet sub contractors with tag
/Employer/:EmployerId/SubContractors/Tag/:TagIdGets the sub contractor with the tag - GETGet all sub contractor tags
/Employer/:EmployerId/SubContractors/TagsGets all the sub contractor tags - GETGet employer tag
/Employer/:EmployerId/Tag/:TagIdGets the tag from the employer - PUTInsert employer tag
/Employer/:EmployerId/Tag/:TagIdInserts a new tag on the employer - DELETEDelete employer tag
/Employer/:EmployerId/Tag/:TagIdDeletes a tag from the employer - GETGet employer revision tag
/Employer/:EmployerId/Tag/:TagId/:EffectiveDateGets the tag from the employer revision - GETGet all employer tags
/Employer/:EmployerId/TagsGets all the tags from the employer - GETGet all employer revision tags
/Employer/:EmployerId/Tags/:EffectiveDateGets all the tags from the employer revision - GETGet third party transaction tag
/Employer/:EmployerId/ThirdPartyTransaction/:ThirdPartyTransactionId/Tag/:TagIdGets a tag from the third party transaction - PUTinsert third party transaction tag
/Employer/:EmployerId/ThirdPartyTransaction/:ThirdPartyTransactionId/Tag/:TagIdInserts a tag on the third party transaction - DELETEDelete third party transaction tag
/Employer/:EmployerId/ThirdPartyTransaction/:ThirdPartyTransactionId/Tag/:TagIdDeletes a tag from the third party transaction - GETGet tags from third party transaction
/Employer/:EmployerId/ThirdPartyTransaction/:ThirdPartyTransactionId/TagsGets all tags from the third party transaction - GETGet links to tagged third party transactions
/Employer/:EmployerId/ThirdPartyTransactions/Tag/:TagIdGets the third party transactions with the specified tag - GETGet all third party transaction tags
/Employer/:EmployerId/ThirdPartyTransactions/TagsGets all the third party transaction tags - GETGet employers with tag
/Employers/Tag/:TagIdGets the employers with the tag - GETGet all employer tags
/Employers/TagsGets all the employer tags - GETGet Permission tag
/Permission/:PermissionId/Tag/:TagIdGets a tag from the Permission - PUTInsert Permission tag
/Permission/:PermissionId/Tag/:TagIdInserts a tag on the Permission - DELETEDelete Permission tag
/Permission/:PermissionId/Tag/:TagIdDeletes a tag from the Permission - GETGet tags from Permission
/Permission/:PermissionId/TagsGets all tags from the Permission - GETGet links to tagged Permissions
/Permissions/Tag/:TagIdGets the Permissions with the specified tag - GETGet all Permission tags
/Permissions/TagsGet all tags from all Permissions - GETGet user tag
/User/:UserId/Tag/:TagIdGets a tag from the user - PUTInsert user tag
/User/:UserId/Tag/:TagIdInserts a tag on the user - DELETEDelete user tag
/User/:UserId/Tag/:TagIdDeletes a tag from the user - GETGet tags from user
/User/:UserId/TagsGets all tags from the user - GETGet links to tagged users
/Users/Tag/:TagIdGets the users with the specified tag - GETGet all user tags
/Users/TagsGet all tags from all users
DpsMessage
- GETGets the DPS message
/Employer/:EmployerId/DpsMessage/:DpsMessageIdGets the DPS message - PUTPuts the DPS message
/Employer/:EmployerId/DpsMessage/:DpsMessageIdPuts the DPS message - DELETEDeletes the DPS message
/Employer/:EmployerId/DpsMessage/:DpsMessageIdDeletes the DPS message - PATCHPatches the DPS message
/Employer/:EmployerId/DpsMessage/:DpsMessageIdPatches the specified DPS message with the supplied values - GETGets the DPS messages
/Employer/:EmployerId/DpsMessagesGets the DPS message links - POSTPosta the DPS message
/Employer/:EmployerId/DpsMessagesInsert new DPS message
Employee
- GETGet employee from employer
/Employer/:EmployerId/Employee/:EmployeeIdGets the specified employee from employer by employee code. - PUTUpdates the Employee
/Employer/:EmployerId/Employee/:EmployeeIdUpdates the existing specified employee object - DELETEDelete an Employee
/Employer/:EmployerId/Employee/:EmployeeIdDelete the specified employee - PATCHPatches the employee
/Employer/:EmployerId/Employee/:EmployeeIdPatches the specified employee with the supplied values - GETGet links to all commentaries for the specified employee
/Employer/:EmployerId/Employee/:EmployeeId/CommentariesGet links to all commentaries for the specified employee. - GETGet commentary from employee
/Employer/:EmployerId/Employee/:EmployeeId/Commentary/:CommentaryIdGets the specified commentary report from the employee - GETGets the employee by revision number
/Employer/:EmployerId/Employee/:EmployeeId/Revision/:RevisionNumberGet the employee revision matching the specified revision number - DELETEDelete an Employee revision matching the specified revision number.
/Employer/:EmployerId/Employee/:EmployeeId/Revision/:RevisionNumberDeletes the specified employee revision for the matching revision number - GETGets the employee summary by revision number
/Employer/:EmployerId/Employee/:EmployeeId/Revision/:RevisionNumber/SummaryGet the employee revision summary matching the specified revision number - GETGet all employee revisions
/Employer/:EmployerId/Employee/:EmployeeId/RevisionsGets links to all employee revisions - GETGet all employee revision summaries
/Employer/:EmployerId/Employee/:EmployeeId/Revisions/SummaryGets links to all employee revision summaries - GETGet employee secret
/Employer/:EmployerId/Employee/:EmployeeId/Secret/:SecretIdGet the public visible employee secret object - PUTCreate a new employee secret
/Employer/:EmployerId/Employee/:EmployeeId/Secret/:SecretIdCreate / update an employee secret at the given resource location - DELETEDeletes employee secret
/Employer/:EmployerId/Employee/:EmployeeId/Secret/:SecretIdDeletes an employee secret from the given resource location - GETGet all employee secret links
/Employer/:EmployerId/Employee/:EmployeeId/SecretsGet all the employee secret links - POSTCreate a new employee secret
/Employer/:EmployerId/Employee/:EmployeeId/SecretsCreate new employee secret using auto generated resource location key - GETGet employee summary from employer
/Employer/:EmployerId/Employee/:EmployeeId/SummaryGets the specified employee summary data from employer by employee code. - GETGet employee by effective date.
/Employer/:EmployerId/Employee/:EmployeeId/:EffectiveDateReturns the employee's state at the specified effective date. - DELETEDelete an Employee revision matching the specified revision date.
/Employer/:EmployerId/Employee/:EmployeeId/:EffectiveDateDeletes the specified employee revision for the matching revision date - GETGet employee summary by effective date.
/Employer/:EmployerId/Employee/:EmployeeId/:EffectiveDate/SummaryGets the employee summary for the specified effective date. - GETGet employees from employer.
/Employer/:EmployerId/EmployeesGet links to all employees for the specified employer. - POSTCreate a new Employee
/Employer/:EmployerId/EmployeesCreate a new employee object - GETGet employee summaries from employer.
/Employer/:EmployerId/Employees/SummaryGet links to all employee summaries for the specified employer. - GETGet employees from employer at a given effective date.
/Employer/:EmployerId/Employees/:EffectiveDateGet links to all employees for the employer on specified effective date. - GETGet employee summaries from employer at a given effective date.
/Employer/:EmployerId/Employees/:EffectiveDate/SummaryGet links to all employee summaries for the employer on specified effective date. - GETGet all employees revisions from a pay schedule.
/Employer/:EmployerId/PaySchedule/:PayScheduleId/EmployeesGets links to all employee revisions that have ever existed in the specified pay schedule. - GETGet employees from a pay schedule on effective date.
/Employer/:EmployerId/PaySchedule/:PayScheduleId/Employees/:EffectiveDateGets links to all employee revisions in the specified pay schedule for the given effective date. - GETGet commentary from payrun by specified employee.
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/Employee/:EmployeeId/CommentaryGet commentary from payrun by specified employee. - GETGet employees from the pay run
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/EmployeesGets links to all employees included in the specified pay run.
AEAssessment
- GETGet the auto enrolment assessment
/Employer/:EmployerId/Employee/:EmployeeId/AEAssessment/:AEAssessmentIdGets the auto enrolment assessment from the specified employee - PUTInsert new auto enrolment assessment
/Employer/:EmployerId/Employee/:EmployeeId/AEAssessment/:AEAssessmentIdCreates a new auto enrolment assessment for the employee. Used to insert historical assessments - DELETEDelete auto enrolment assessment
/Employer/:EmployerId/Employee/:EmployeeId/AEAssessment/:AEAssessmentIdDeletes an existing auto enrolment assessment for the employee. Used to remove historical assessments - GETGet the auto enrolment assessments
/Employer/:EmployerId/Employee/:EmployeeId/AEAssessmentsGets all auto enrolment assessments from the specified employee - POSTInsert new auto enrolment assessment
/Employer/:EmployerId/Employee/:EmployeeId/AEAssessmentsCreates a new auto enrolment assessment for the employee. Used to insert historical assessments - GETGet the auto enrolment assessments
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/AEAssessmentsGets all auto enrolment assessments from the specified pay run
Journals
- GETGets the journal Lines from the specified employee
/Employer/:EmployerId/Employee/:EmployeeId/JournalLinesGet links to all journal lines for the specified employee - GETGets the specified journal instruction from the employer
/Employer/:EmployerId/JournalInstruction/:JournalInstructionIdReturns the specified journal instruction from employer - PUTUpdate a Journal Instruction
/Employer/:EmployerId/JournalInstruction/:JournalInstructionIdUpdates the existing specified Journal instruction object - DELETEDeletes a Journal instruction
/Employer/:EmployerId/JournalInstruction/:JournalInstructionIdDelete the specified Journal instruction - GETGets the Journal instructions from the specified employer
/Employer/:EmployerId/JournalInstructionsGet links to all journal instructions for the specified employer - POSTCreates a new Journal Instruction
/Employer/:EmployerId/JournalInstructionsCreates a new Journal instruction object - GETGets the specified journal Line from the employer
/Employer/:EmployerId/JournalLine/:JournalLineIdReturns the specified journal Line from employer - GETGets the Journal Lines from the specified employer
/Employer/:EmployerId/JournalLinesGet links to all journal Lines for the specified employer - GETGets the journal Lines from the specified pay run
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/JournalLinesGet links to all journal lines for the specified pay run - GETGets the journal Lines from the specified sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorId/JournalLinesGet links to all journal lines for the specified sub contractor - GETGets the Journal instructions template for the application
/JournalInstruction/:JournalInstructionIdRetrurns the specified journal instruction from the application - PUTUpdate a Journal Instruction template
/JournalInstruction/:JournalInstructionIdUpdates the existing specified Journal instruction template object - DELETEDeletes a Journal instruction template
/JournalInstruction/:JournalInstructionIdDelete the specified Journal instruction template object - GETGets the Journal instructions templates for the application
/JournalInstructionsGet links to all journal instruction templates for the application - POSTCreates a new Journal Instruction template
/JournalInstructionsCreates a new Journal instruction teamplte object
PayInstruction
- GETGets the specified pay instruction from the employee
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionIdReturns the specified pay instruction from employee - PUTUpdate a Pay Instruction
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionIdUpdates the existing specified pay instruction object - DELETEDeletes a pay instruction
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionIdDelete the specified pay instruction - PATCHSparse Update of a Pay Instruction
/Employer/:EmployerId/Employee/:EmployeeId/PayInstruction/:PayInstructionIdPatches the specified pay instruction with the supplied values - GETGets the pay instructions from the specified employee
/Employer/:EmployerId/Employee/:EmployeeId/PayInstructionsGet links to all pay instructions for the specified employee - POSTCreates a new Pay Instruction
/Employer/:EmployerId/Employee/:EmployeeId/PayInstructionsCreates a new pay instruction object
PayLine
- GETGets the specified pay line from the employee
/Employer/:EmployerId/Employee/:EmployeeId/PayLine/:PayLineIdReturns the specified pay line from employee - GETGets the pay lines from the specified employee
/Employer/:EmployerId/Employee/:EmployeeId/PayLinesGet links to all pay lines for the specified employee - GETGets the pay lines from the specified pay run
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/PayLinesGet links to all pay lines for the specified pay run
PayRun
- GETGets the pay runs from the employee
/Employer/:EmployerId/Employee/:EmployeeId/PayRunsGet links to all pay runs for the specified employee. - GETGets the pay run from the pay schedule
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunIdReturns the pay run from the pay schedule - DELETEDeletes a pay run
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunIdDelete the specified pay run - GETGet links to all commentaries for the specified pay run
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/CommentariesGet links to all commentaries for the specified pay run. - DELETEDeletes a pay run employee
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/Employee/:EmployeeIdDelete pay run results for a single employee - GETGets the pay runs from the pay schedule
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRunsGet links to all pay runs for the specified pay schedule
HolidayScheme
- GETGet holiday scheme from employer
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeIdGets the specified holiday scheme from employer. - PUTUpdates the holiday scheme
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeIdUpdates the existing specified holiday scheme object - DELETEDelete an holiday scheme
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeIdDelete the specified holiday scheme - PATCHPatches the holiday scheme
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeIdPatches the specified holiday scheme with the supplied values - GETGets the holiday scheme revision by revision number
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Revision/:RevisionNumberGet the holiday scheme revision matching the specified revision number - DELETEDelete an HolidayScheme revision matching the specified revision number.
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/Revision/:RevisionNumberDeletes the specified holiday scheme revision for the matching revision number - GETGet all holiday scheme revisions
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/RevisionsGets links to all the holiday scheme revisions - GETGet holiday scheme by effective date.
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/:EffectiveDateReturns the holiday scheme's state at the specified effective date. - DELETEDelete an holiday scheme revision matching the specified revision date.
/Employer/:EmployerId/HolidayScheme/:HolidaySchemeId/:EffectiveDateDeletes the specified holiday scheme revision for the matching revision date - GETGet holiday schemes from employer.
/Employer/:EmployerId/HolidaySchemesGet links to all holiday schemes for the specified employer. - POSTCreate a new holiday scheme
/Employer/:EmployerId/HolidaySchemesCreate a new holiday scheme object - GETGet holiday schemes from employer at a given effective date.
/Employer/:EmployerId/HolidaySchemes/:EffectiveDateGet links to all holiday schemes for the employer on specified effective date.
NominalCode
- GETGets the nominal code
/Employer/:EmployerId/NominalCode/:NominalCodeIdGets the nominal code - PUTInsert nominal code
/Employer/:EmployerId/NominalCode/:NominalCodeIdInserts a new nominal code at the specified resource location - DELETEDeletes the nominal codes
/Employer/:EmployerId/NominalCode/:NominalCodeIdDeletes the nominal code - GETGets the nominal codes
/Employer/:EmployerId/NominalCodesGets the nominal code links - POSTInsert nominal code
/Employer/:EmployerId/NominalCodesInserts a new nominal code
PayCode
- GETGets the pay codes by nominal code
/Employer/:EmployerId/NominalCode/:NominalCodeId/PayCodesGet the pay codes that share the specified nominal code - GETGets the specified pay code from the employer
/Employer/:EmployerId/PayCode/:PayCodeIdReturns the specified pay code from the employer - PUTUpdates a pay code
/Employer/:EmployerId/PayCode/:PayCodeIdUpdates the existing specified pay code object - DELETEDeletes a pay code
/Employer/:EmployerId/PayCode/:PayCodeIdDelete the specified pay code - PATCHPatches the pay code
/Employer/:EmployerId/PayCode/:PayCodeIdPatches the specified pay code object with the supplied values - GETGets the pay code by revision number
/Employer/:EmployerId/PayCode/:PayCodeId/Revision/:RevisionNumberGet the pay code revision matching the specified revision number - DELETEDelete an PayCode revision matching the specified revision number.
/Employer/:EmployerId/PayCode/:PayCodeId/Revision/:RevisionNumberDeletes the specified pay code revision for the matching revision number - GETGet all revisions of the Pay Code
/Employer/:EmployerId/PayCode/:PayCodeId/RevisionsReturns links to all revisions of the pay code - GETGets pay code for specified date
/Employer/:EmployerId/PayCode/:PayCodeId/:EffectiveDateGets the pay code revision for the specified effective date - DELETEDeletes a pay code revision
/Employer/:EmployerId/PayCode/:PayCodeId/:EffectiveDateDelete the pay code revision for the specified date - GETGets the pay codes from the employer
/Employer/:EmployerId/PayCodesGet links to all the pay codes for the specified employer - POSTCreate a new pay code
/Employer/:EmployerId/PayCodesCreate a new pay code object - GETGets all pay codes for specified date
/Employer/:EmployerId/PayCodes/:EffectiveDateGets the effective pay code revision for the specified date
PaySchedule
- GETGets the specified pay schedule from the employer
/Employer/:EmployerId/PaySchedule/:PayScheduleIdReturns the specified pay schedule object from employer - PUTUpdates a pay schedule
/Employer/:EmployerId/PaySchedule/:PayScheduleIdUpdates the existing specified pay schedule object - DELETEDeletes a pay schedule
/Employer/:EmployerId/PaySchedule/:PayScheduleIdDelete the specified pay schedule - GETGets the pay schedule from the specified employer
/Employer/:EmployerId/PaySchedulesGet links to all pay schedules for the specified employer - POSTCreate a new pay schedule
/Employer/:EmployerId/PaySchedulesCreate a new pay schedule object
ReportLine
- GETGets the report lines from the specified pay run
/Employer/:EmployerId/PaySchedule/:PayScheduleId/PayRun/:PayRunId/ReportLinesReturns all report lines associated with the specified pay run - GETGets the specified report line from the employer
/Employer/:EmployerId/ReportLine/:ReportLineIdReturns the specified pay line from employee - GETGets the report lines from the specified employer
/Employer/:EmployerId/ReportLinesGet links to all report lines for the specified employee
Pension
- GETGet pension from employer
/Employer/:EmployerId/Pension/:PensionIdGets the specified pension from employer by pension code. - PUTUpdates the Pension
/Employer/:EmployerId/Pension/:PensionIdUpdates existing or inserts the specified pension object - DELETEDelete a Pension
/Employer/:EmployerId/Pension/:PensionIdDelete the specified ppension - PATCHPatches the pension
/Employer/:EmployerId/Pension/:PensionIdPatches the specified pension with the supplied values - GETGets the pension by revision number
/Employer/:EmployerId/Pension/:PensionId/Revision/:RevisionNumberGet the pension revision matching the specified revision number - DELETEDelete an Pension revision matching the specified revision number.
/Employer/:EmployerId/Pension/:PensionId/Revision/:RevisionNumberDeletes the specified pension revision for the matching revision number - GETGet all pension revisions
/Employer/:EmployerId/Pension/:PensionId/RevisionsReturns links to all revisions of the pension - GETGet pension by effective date.
/Employer/:EmployerId/Pension/:PensionId/:EffectiveDateReturns the penion's state at the specified effective date. - DELETEDelete an Pension revision matching the specified revision date.
/Employer/:EmployerId/Pension/:PensionId/:EffectiveDateDeletes the specified pension revision for the matching revision date - GETGet pensions from employer.
/Employer/:EmployerId/PensionsGet links to all pensions for the specified employer. - POSTCreate a new Pension
/Employer/:EmployerId/PensionsCreate a new pension object - GETGet pensions from employer at a given effective date.
/Employer/:EmployerId/Pensions/:EffectiveDateGet links to all pensions for the employer on specified effective date.
ReportLineInstruction
- GETGets the specified reporting instruction from the employer
/Employer/:EmployerId/ReportingInstruction/:ReportingInstructionIdReturns the specified pay instruction from employee - PUTUpdate a reporting Instruction
/Employer/:EmployerId/ReportingInstruction/:ReportingInstructionIdUpdates the existing specified reporting instruction object - DELETEDeletes a reporting instruction
/Employer/:EmployerId/ReportingInstruction/:ReportingInstructionIdDelete the specified reporting instruction - GETGets the reporting instructions from the specified employer
/Employer/:EmployerId/ReportingInstructionsGet links to all pay instructions for the specified employee - POSTCreates a new Reporting Instruction
/Employer/:EmployerId/ReportingInstructionsCreates a new reporting instruction object
RTI
- GETGet the RTI transaction
/Employer/:EmployerId/RtiTransaction/:RtiTransactionIdReturns the specified RTI transaction - DELETEDelete the RTI transaction
/Employer/:EmployerId/RtiTransaction/:RtiTransactionIdDeletes the specified RTI transaction - GETGet the RTI transaction summary
/Employer/:EmployerId/RtiTransaction/:RtiTransactionId/SummaryReturns the specified RTI transaction summary data excluding some poroperties - GETGet all RTI transactions for the employer
/Employer/:EmployerId/RtiTransactionsGet links for all RTI transactions for the specified employer - GETGet all RTI transaction summaries for the employer
/Employer/:EmployerId/RtiTransactions/SummaryGet links for all RTI transaction summaries for the specified employer
SubContractor
- GETGet sub contractor from employer
/Employer/:EmployerId/SubContractor/:SubContractorIdGets the specified sub contractor from employer. - PUTUpdates the sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorIdUpdates the existing specified sub contractor object - DELETEDelete an sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorIdDelete the specified sub contractor - PATCHPatches the sub contractor
/Employer/:EmployerId/SubContractor/:SubContractorIdPatches the specified sub contractor with the supplied values - GETGets the sub contractor by revision number
/Employer/:EmployerId/SubContractor/:SubContractorId/Revision/:RevisionNumberGet the sub contractor revision matching the specified revision number - DELETEDelete an SubContractor revision matching the specified revision number.
/Employer/:EmployerId/SubContractor/:SubContractorId/Revision/:RevisionNumberDeletes the specified sub contractor revision for the matching revision number - GETGet all sub contractor revisions
/Employer/:EmployerId/SubContractor/:SubContractorId/RevisionsGets links to all the sub contractor revisions - GETGet sub contractor by effective date.
/Employer/:EmployerId/SubContractor/:SubContractorId/:EffectiveDateReturns the sub contractor's state at the specified effective date. - DELETEDelete an sub contractor revision matching the specified revision date.
/Employer/:EmployerId/SubContractor/:SubContractorId/:EffectiveDateDeletes the specified sub contractor revision for the matching revision date - GETGet sub contractors from employer.
/Employer/:EmployerId/SubContractorsGet links to all sub contractors for the specified employer. - POSTCreate a new sub contractor
/Employer/:EmployerId/SubContractorsCreate a new sub contractor object - GETGet sub contractors from employer at a given effective date.
/Employer/:EmployerId/SubContractors/:EffectiveDateGet links to all sub contractors for the employer on specified effective date.
ThirdPartyTransmission
- GETGet a third party transaction
/Employer/:EmployerId/ThirdPartyTransaction/:ThirdPartyTransactionIdGet a third party transaction - DELETEDelete third party transaction
/Employer/:EmployerId/ThirdPartyTransaction/:ThirdPartyTransactionIdDeletes a third party transaction record from the given resource location - GETGet all third party transaction links
/Employer/:EmployerId/ThirdPartyTransactionsGet all third party transaction links
Healthcheck
- GETGet health check status
/HealthcheckReturns the health status of the application
Jobs
- GETGet all Batch jobs
/Jobs/BatchGets all the Batch jobs - POSTCreate new Batch job
/Jobs/BatchAdds a new Batch job to the queue and returns the job info - DELETEDelete the Batch job
/Jobs/Batch/:JobIdDeletes the the Batch job
Showing 300 of 389 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.test.payrun.io- Authentication
- None declared in the description
- Operations
- 389 operations on 252 pathsGET 244DELETE 64PUT 40POST 30PATCH 11
- Main resources
- Tagging 110CIS 43Jobs 37Employee 34Reports 31Employer 25HolidayScheme 20Journals 15PayCode 15Permission 13
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
22.23.10.42 - Links
- Documentation · OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the PayRun.IO in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the PayRun.IO collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Gets the employer” (GET /Employer/:EmployerId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the PayRun.IO?
Open, scableable, transparent payroll API. It is listed under Finance & banking and has 389 endpoints.
Who publishes the PayRun.IO?
It is listed from Payrun's public API description (an OpenAPI document), not published by Payrun on Swastik Codes. Anyone who controls payrun.io can claim the profile by adding a DNS TXT record.
What is the base URL of the PayRun.IO?
Requests go to https://api.test.payrun.io. Endpoint paths are added to this base URL.
How do I authenticate with the PayRun.IO?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the PayRun.IO have?
389 operations on 252 paths (244 GET, 64 DELETE, 40 PUT, 30 POST, 11 PATCH). The largest groups are Tagging, CIS, Jobs, Employee.
Is forking the PayRun.IO free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.