POST
/
api
/
hris
/
v1
/
employee-payroll-runs
curl --request POST \
  --url https://api.bindbee.dev/api/hris/v1/employee-payroll-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '{
  "employee": "018b168d-70f9-7043-a796-56d66a4f8f07",
  "payroll_run": "018b709e-b6ef-7db4-902a-a064157bdba2",
  "payroll_process_name": "Hours, Earning Codes",
  "paystatement_type_id": 53123324,
  "payroll_file": "000099",
  "gross_pay": 772277.77,
  "net_pay": 577221.27,
  "start_date": "2023-07-01T00:00:00Z",
  "end_date": "2023-07-31T00:00:00Z",
  "check_date": "2023-08-31T00:00:00Z",
  "earnings": [
    {
      "amount": "27151",
      "name": "SALARY"
    }
  ],
  "deductions": [
    {
      "company_deduction": "77.57",
      "employee_deduction": "27.22",
      "name": "Social Security"
    }
  ],
  "taxes": [
    {
      "amount": "175.22",
      "name": "California State Income Tax"
    }
  ]
}'
"<any>"

Authorizations

​
Authorization
string
header
required

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.

Example:

"018b168d-70f9-7043-a796-56d66a4f8f07"

​
payroll_run
string | null
default:

The payroll being run.

Example:

"018b709e-b6ef-7db4-902a-a064157bdba2"

​
payroll_process_name
string | null
default:

The payroll process name to be displayed.

Example:

"Hours, Earning Codes"

​
paystatement_type_id
integer | null

Id of Employee's Paystatement Type

Example:

53123324

​
payroll_file
string | null
default:

Employee's Payroll File Number for which earnings are made

Example:

"000099"

​
gross_pay
default:0

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

Example:

772277.77

​
net_pay
default:0

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

Example:

577221.27

​
start_date
string | null
default:

The day and time the benefit started.

Example:

"2023-07-01T00:00:00Z"

​
end_date
string | null
default:

The day and time the benefit ended.

Example:

"2023-07-31T00:00:00Z"

​
check_date
string | null
default:

The day and time the payroll run was checked.

Example:

"2023-08-31T00:00:00Z"

​
earnings
object[] | null

The earnings of the Employee

Example:
[{ "amount": "27151", "name": "SALARY" }]
​
deductions
object[] | null

The deductions of the Employee

Example:
[
  {
    "company_deduction": "77.57",
    "employee_deduction": "27.22",
    "name": "Social Security"
  }
]
​
taxes
object[] | null

The taxes of the Employee

Example:
[
  {
    "amount": "175.22",
    "name": "California State Income Tax"
  }
]

Response

201
application/json
Successful Response

The response is of type any.