Open, scableable, transparent payroll API.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.test.payrun.io
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Open, scableable, transparent payroll API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /Employer/{EmployerId} | Gets the employer Get the specified employer object Employer |
PUT | /Employer/{EmployerId} | Updates the Employer Updates the existing specified employer object Employer |
PATCH | /Employer/{EmployerId} | Patches the employer Patches the specified employer with the supplied values Employer |
DELETE | /Employer/{EmployerId} | Delete an Employer Delete the specified employer Employer |
GET | /Employer/{EmployerId}/CisLineType/{CisLineTypeId} | Get CIS line type from employer Gets the specified CIS line type from employer. CIS |
PUT | /Employer/{EmployerId}/CisLineType/{CisLineTypeId} | Updates the CIS line type Updates the existing specified CIS line type object CIS |
DELETE | /Employer/{EmployerId}/CisLineType/{CisLineTypeId} | Delete an CIS line type Delete the specified CIS line type CIS |
GET | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} | Get CIS line type tag Gets the tag from the CIS line type Tagging CIS |
PUT | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} | Insert CIS line type tag Inserts a new tag on the CIS line type Tagging CIS |
DELETE | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} | Delete CIS line type tag Deletes a tag from the CIS line type Tagging CIS |
GET | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tags | Get all tags from the CIS line type Gets all the tags from the CIS line type Tagging CIS |
GET | /Employer/{EmployerId}/CisLineTypes | Get CIS line types from employer. Get links to all CIS line types for the specified employer. CIS |
POST | /Employer/{EmployerId}/CisLineTypes | Create a new CIS line type Create a new CIS line type object CIS |
GET | /Employer/{EmployerId}/CisLineTypes/Tag/{TagId} | Get CIS line types with tag Gets the CIS line type with the tag Tagging CIS |
GET | /Employer/{EmployerId}/CisLineTypes/Tags | Get all CIS line type tags Gets all the CIS line type tags Tagging CIS |
GET | /Employer/{EmployerId}/CisTransaction/{CisTransactionId} | Get the CIS transaction Returns the specified CIS transaction CIS |
DELETE | /Employer/{EmployerId}/CisTransaction/{CisTransactionId} | Delete the CIS transaction Deletes the specified CIS transaction CIS |
GET | /Employer/{EmployerId}/CisTransactions | Get all CIS transactions for the employer Get links for all CIS transactions for the specified employer CIS |
GET | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Gets the DPS message Gets the DPS message DpsMessage |
PUT | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Puts the DPS message Puts the DPS message DpsMessage |
PATCH | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Patches the DPS message Patches the specified DPS message with the supplied values DpsMessage |
DELETE | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Deletes the DPS message Deletes the DPS message DpsMessage |
GET | /Employer/{EmployerId}/DpsMessages | Gets the DPS messages Gets the DPS message links DpsMessage |
POST | /Employer/{EmployerId}/DpsMessages | Posta the DPS message Insert new DPS message DpsMessage |
GET | /Employer/{EmployerId}/Employee/{EmployeeId} | Get employee from employer Gets the specified employee from employer by employee code. Employee |
PUT | /Employer/{EmployerId}/Employee/{EmployeeId} | Updates the Employee Updates the existing specified employee object Employee |
PATCH | /Employer/{EmployerId}/Employee/{EmployeeId} | Patches the employee Patches the specified employee with the supplied values Employee |
DELETE | /Employer/{EmployerId}/Employee/{EmployeeId} | Delete an Employee Delete the specified employee Employee |
GET | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} | Get the auto enrolment assessment Gets the auto enrolment assessment from the specified employee AEAssessment |
PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} | Insert new auto enrolment assessment Creates a new auto enrolment assessment for the employee. Used to insert |
DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} | Delete auto enrolment assessment Deletes an existing auto enrolment assessment for the employee. Used to remov |
GET | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments | Get the auto enrolment assessments Gets all auto enrolment assessments from the specified employee AEAssessmen |
POST | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments | Insert new auto enrolment assessment Creates a new auto enrolment assessment for the employee. Used to insert |
GET | /Employer/{EmployerId}/Employee/{EmployeeId}/Commentaries | Get links to all commentaries for the specified employee Get links to all commentaries for the specified emplo |
GET | /Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId} | Get commentary from employee Gets the specified commentary report from the employee Employee |
GET | /Employer/{EmployerId}/Employee/{EmployeeId}/JournalLines | Gets the journal Lines from the specified employee Get links to all journal lines for the specified employee J |
GET | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Gets the specified pay instruction from the employee Returns the specified pay instruction from employee PayIn |
PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Update a Pay Instruction Updates the existing specified pay instruction object PayInstruction |
PATCH | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Sparse Update of a Pay Instruction Patches the specified pay instruction with the supplied values PayInstructi |
DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Deletes a pay instruction Delete the specified pay instruction PayInstruction |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://api.test.payrun.io/swagger/json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.