Employee Payroll API

Get payroll statement for a month for an employee

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Specify either the month or startDate and endDate

You have two options to pass the time range:

  • month: For example, 2022-05. It would fetch the list of pay runs for that month
  • startDate and endDate: It would fetch the list of pay runs within the range

Supported Apps

Here are the list of apps that support this API.

Darwinbox (darwinbox)

You must provide the month parameter

Does not support startDate and endDate

Keka HR (keka)
GreytHR (greythr)

You must provide the month parameter

Does not support startDate and endDate

Zoho People (zoho-people)
RazorpayX Payroll (razorpayx-payroll)

You must provide the month parameter

Does not support startDate and endDate

Paychex (paychex)
SAP SuccessFactors (successfactors)
Workday (workday)
ADP Run (adp-run)
UKG Pro (ukgpro-hris)
Paycor (paycor)
Ceredian Dayforce (ceridianDayforce)
Oracle HCM (oracle-hcm)
People HR (peopleHR)
PrismHR (prismhr)

Refer api specific guides - PrismHR API Guide

Avionte (avionte)
Quickbooks Payroll (quickbooks-payroll)

Supported Request Fields:

  • employeeId - Required
  • startDate - Required
  • endDate - Required
  • originData

Supported Response Fields:

  • payroll
  • payroll.employeeId
  • payslips.grossPay
  • payslips.netPay
  • payslips.processedDate
  • payslips.payDate
  • payslips.payPeriodStartDate
  • payslips.payPeriodEndDate
  • payslips.earnings.type
  • payslips.earnings.amount
  • payslips.deductions.type
  • payslips.deductions.amount
  • originData
Query Params
string
required

The employee id

string
Defaults to 2022-05

Month in yyyy-mm format

string
string
boolean

If true, we will include origin API response in the return. Default value is false

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json