Open documentation ↗Overview
Open, scableable, transparent payroll API.
PayRun.IO is a finance API from payrun.io. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 389 endpoints.
At a glance
- Authentication
- No auth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Finance
- Base URL
https://api.test.payrun.io- Version
- 22.23.10.42
- Endpoints
- 389
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.test.payrun.io/Employer/EMPLOYERID" \
-H "Accept: application/json"const response = await fetch("https://api.test.payrun.io/Employer/EMPLOYERID", {
method: "GET",
headers: {
"Accept": "application/json",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.test.payrun.io/Employer/EMPLOYERID",
headers={
"Accept": "application/json",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /Employer/{EmployerId} | Gets the employer |
| PUT | /Employer/{EmployerId} | Updates the Employer |
| PATCH | /Employer/{EmployerId} | Patches the employer |
| DELETE | /Employer/{EmployerId} | Delete an Employer |
| GET | /Employer/{EmployerId}/CisLineType/{CisLineTypeId} | Get CIS line type from employer |
| PUT | /Employer/{EmployerId}/CisLineType/{CisLineTypeId} | Updates the CIS line type |
| DELETE | /Employer/{EmployerId}/CisLineType/{CisLineTypeId} | Delete an CIS line type |
| GET | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} | Get CIS line type tag |
| PUT | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} | Insert CIS line type tag |
| DELETE | /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId} | Delete 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. |
| POST | /Employer/{EmployerId}/CisLineTypes | Create a new CIS line type |
| 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 |
| DELETE | /Employer/{EmployerId}/CisTransaction/{CisTransactionId} | Delete the CIS transaction |
| GET | /Employer/{EmployerId}/CisTransactions | Get all CIS transactions for the employer |
| GET | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Gets the DPS message |
| PUT | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Puts the DPS message |
| PATCH | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Patches the DPS message |
| DELETE | /Employer/{EmployerId}/DpsMessage/{DpsMessageId} | Deletes the DPS message |
| GET | /Employer/{EmployerId}/DpsMessages | Gets the DPS messages |
| POST | /Employer/{EmployerId}/DpsMessages | Posta the DPS message |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId} | Get employee from employer |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId} | Updates the Employee |
| PATCH | /Employer/{EmployerId}/Employee/{EmployeeId} | Patches the employee |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId} | Delete an Employee |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} | Get the auto enrolment assessment |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} | Insert new auto enrolment assessment |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId} | Delete auto enrolment assessment |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments | Get the auto enrolment assessments |
| POST | /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments | Insert new auto enrolment assessment |
| 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 |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Update a Pay Instruction |
| PATCH | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Sparse Update of a Pay Instruction |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId} | Deletes a pay instruction |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId} | Get pay instruction tag |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId} | Insert pay instruction tag |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId} | Delete 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 |
| POST | /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions | Creates a new Pay Instruction |
| 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 |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId} | Insert pay line tag |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId} | Delete 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 |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber} | Delete an Employee revision matching the specified 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 |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId} | Create a new employee secret |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId} | Deletes employee secret |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/Secrets | Get all employee secret links |
| POST | /Employer/{EmployerId}/Employee/{EmployeeId}/Secrets | Create a new employee secret |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/Summary | Get employee summary from employer |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId} | Get employee tag |
| PUT | /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId} | Insert employee tag |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId} | Delete 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. |
| DELETE | /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate} | Delete an Employee revision matching the specified revision date. |
| GET | /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}/Summary | Get employee summary by effective date. |
| GET | /Employer/{EmployerId}/Employees | Get employees from employer. |
| POST | /Employer/{EmployerId}/Employees | Create a new Employee |
| 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 |
| PUT | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId} | Updates the holiday scheme |
| PATCH | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId} | Patches the holiday scheme |
| DELETE | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId} | Delete an holiday scheme |
| GET | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber} | Gets the holiday scheme revision by revision number |
| DELETE | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber} | Delete an HolidayScheme revision matching the specified revision number. |
| GET | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revisions | Get all holiday scheme revisions |
| GET | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId} | Get holiday scheme tag |
| PUT | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId} | Insert holiday scheme tag |
| DELETE | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId} | Delete 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. |
| DELETE | /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate} | Delete an holiday scheme revision matching the specified revision date. |
| GET | /Employer/{EmployerId}/HolidaySchemes | Get holiday schemes from employer. |
Showing the first 100 of 389 endpoints; the full list is in the documentation.
Questions
Does the PayRun.IO API need an API key?
No. The PayRun.IO API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.
Does the PayRun.IO API support HTTPS?
Yes, the PayRun.IO API is served over HTTPS.
How many endpoints does the PayRun.IO API have?
Its OpenAPI description lists 389 endpoints in version 22.23.10.42. The first 100 are shown on this page.
What are alternatives to the PayRun.IO API?
Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.
Similar finance APIs
Compare alternatives →Stripe
FinancePayment processing, subscriptions, and financial management
SEC EDGAR Data
FinanceAPI to access annual reports of public US companies
Plaid
FinanceConnect with user's bank accounts and access transaction data
Fed Treasury
FinanceU.S. Department of the Treasury Data
Razorpay IFSC
FinanceIndian Financial Systems Code (Bank Branch Codes)
Klarna
FinanceKlarna payment and shopping service
Listed from APIs.guru (CC0).