Skip to content

PayRun.IO API

by payrun.io

No authHTTPSFinance
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
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.test.payrun.io/Employer/EMPLOYERID" \
  -H "Accept: application/json"
JavaScript
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);
Python
import requests

response = requests.request(
    "GET",
    "https://api.test.payrun.io/Employer/EMPLOYERID",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat 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}/TagsGet all tags from the CIS line type
GET/Employer/{EmployerId}/CisLineTypesGet CIS line types from employer.
POST/Employer/{EmployerId}/CisLineTypesCreate a new CIS line type
GET/Employer/{EmployerId}/CisLineTypes/Tag/{TagId}Get CIS line types with tag
GET/Employer/{EmployerId}/CisLineTypes/TagsGet 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}/CisTransactionsGet 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}/DpsMessagesGets the DPS messages
POST/Employer/{EmployerId}/DpsMessagesPosta 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}/AEAssessmentsGet the auto enrolment assessments
POST/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessmentsInsert new auto enrolment assessment
GET/Employer/{EmployerId}/Employee/{EmployeeId}/CommentariesGet links to all commentaries for the specified employee
GET/Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId}Get commentary from employee
GET/Employer/{EmployerId}/Employee/{EmployeeId}/JournalLinesGets 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}/TagsGet all tags from the pay instruction
GET/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructionsGets the pay instructions from the specified employee
POST/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructionsCreates a new Pay Instruction
GET/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tag/{TagId}Get pay instructions with tag
GET/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/TagsGet 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}/TagsGet all tags from the pay line
GET/Employer/{EmployerId}/Employee/{EmployeeId}/PayLinesGets 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/TagsGet all pay line tags
GET/Employer/{EmployerId}/Employee/{EmployeeId}/PayRunsGets 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}/SummaryGets the employee summary by revision number
GET/Employer/{EmployerId}/Employee/{EmployeeId}/RevisionsGet all employee revisions
GET/Employer/{EmployerId}/Employee/{EmployeeId}/Revisions/SummaryGet 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}/SecretsGet all employee secret links
POST/Employer/{EmployerId}/Employee/{EmployeeId}/SecretsCreate a new employee secret
GET/Employer/{EmployerId}/Employee/{EmployeeId}/SummaryGet 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}/TagsGet 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}/SummaryGet employee summary by effective date.
GET/Employer/{EmployerId}/EmployeesGet employees from employer.
POST/Employer/{EmployerId}/EmployeesCreate a new Employee
GET/Employer/{EmployerId}/Employees/SummaryGet employee summaries from employer.
GET/Employer/{EmployerId}/Employees/Tag/{TagId}Get employees with tag
GET/Employer/{EmployerId}/Employees/TagsGet all employee tags
GET/Employer/{EmployerId}/Employees/{EffectiveDate}Get employees from employer at a given effective date.
GET/Employer/{EmployerId}/Employees/{EffectiveDate}/SummaryGet 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}/RevisionsGet 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}/TagsGet 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}/HolidaySchemesGet 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.

Compare alternatives →

Listed from APIs.guru (CC0).