POST
/
api
/
hris
/
v1
/
employee-payroll-runs

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Body

application/json
employee
string | null
required

The employee whose payroll is being run.

payroll_run
string | null
default:

The payroll being run.

payroll_process_name
string | null
default:

The payroll process name to be displayed.

payroll_file
string | null
default:

Employee's Payroll File Number for which earnings are made

gross_pay
default: 0

The total earnings throughout a given period for an employee before any deductions are made.

net_pay
default: 0

The take-home pay throughout a given period for an employee after deductions are made.

start_date
string | null
default:

The day and time the benefit started.

end_date
string | null
default:

The day and time the benefit ended.

check_date
string | null
default:

The day and time the payroll run was checked.

earnings
object[] | null

The earnings of the Employee

deductions
object[] | null

The deductions of the Employee

taxes
object[] | null

The taxes of the Employee

Response

201 - application/json

The response is of type any.