Update a payroll by ID

PUT {{baseUrl}}/v1/companies/:company_id/payrolls/:payroll_id

This endpoint allows you to update information for one or more employees for a specific unprocessed payroll. You can think of the unprocessed payroll object as a template of fields that you can update. You cannot modify the structure of the payroll object through this endpoint, only values of the fields included in the payroll. If you do not include specific employee compensations or fixed/hourly compensations in your request body, they will not be removed from the payroll.

scope: payrolls:write

Request Body

{"employee_compensations"=>[{"employee_uuid"=>"<string>", "version"=>"<string>", "excluded"=>"<boolean>", "payment_method"=>"<string>", "memo"=>"<string>", "fixed_compensations"=>[{"name"=>"<string>", "amount"=>"<string>", "job_uuid"=>"<string>"}, {"name"=>"<string>", "amount"=>"<string>", "job_uuid"=>"<string>"}], "hourly_compensations"=>[{"name"=>"<string>", "hours"=>"<string>", "job_uuid"=>"<string>"}, {"name"=>"<string>", "hours"=>"<string>", "job_uuid"=>"<string>"}], "paid_time_off"=>[{"name"=>"<string>", "hours"=>"<string>", "policy_uuid"=>"<string>", "final_payout_unused_hours_input"=>"<string>"}, {"name"=>"<string>", "hours"=>"<string>", "policy_uuid"=>"<string>", "final_payout_unused_hours_input"=>"<string>"}]}, {"employee_uuid"=>"<string>", "version"=>"<string>", "excluded"=>"<boolean>", "payment_method"=>"<string>", "memo"=>"<string>", "fixed_compensations"=>[{"name"=>"<string>", "amount"=>"<string>", "job_uuid"=>"<string>"}, {"name"=>"<string>", "amount"=>"<string>", "job_uuid"=>"<string>"}], "hourly_compensations"=>[{"name"=>"<string>", "hours"=>"<string>", "job_uuid"=>"<string>"}, {"name"=>"<string>", "hours"=>"<string>", "job_uuid"=>"<string>"}], "paid_time_off"=>[{"name"=>"<string>", "hours"=>"<string>", "policy_uuid"=>"<string>", "final_payout_unused_hours_input"=>"<string>"}, {"name"=>"<string>", "hours"=>"<string>", "policy_uuid"=>"<string>", "final_payout_unused_hours_input"=>"<string>"}]}]}

HEADERS

RESPONSES

status: OK

{"payroll_deadline":"2022-02-18T22:00:00Z","check_date":"2021-02-22","off_cycle":false,"external":false,"processed":false,"processed_date":null,"calculated_at":null,"payroll_uuid":"b50e611d-8f3d-4f24-b001-46675f7b5777","company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","created_at":"2022-02-01T22:00:00Z","pay_period":{"start_date":"2021-02-01","end_date":"2021-02-15","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"},"payroll_status_meta":{"cancellable":false,"expected_check_date":"2022-02-22","initial_check_date":"2022-02-22","expected_debit_time":"2022-02-18T22:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2022-02-18T22:00:00Z"},"employee_compensations":[{"employee_uuid":"187412e1-3dbe-491a-bb2f-2f40323a7067","version":"4ba36d23a78c7393b4900ef38019d8ff","excluded":false,"payment_method":"Direct Deposit","fixed_compensations":[{"name":"Bonus","amount":"100.00","job_uuid":"94e0d15e-9ed2-4077-98f6-64554f242ba5"},{"name":"Reimbursement","amount":"100.00","job_uuid":"91bc3b43-ded0-4ee7-98fe-215499e909ba"}],"hourly_compensations":[{"name":"Regular Hours","hours":"40.000","job_uuid":"bd378298-3e0c-4145-904a-baadf8a91fa3","compensation_multiplier":1,"flsa_status":"Nonexempt"},{"name":"Overtime","hours":"15.000","job_uuid":"9d3760f0-d1f9-4700-8817-0fe2dce5cf23","compensation_multiplier":1.5,"flsa_status":"Nonexempt"},{"name":"Double overtime","hours":"0.000","job_uuid":"b5eef9a9-4a87-4649-a80d-14878c05f44e","compensation_multiplier":2,"flsa_status":"Nonexempt"},{"name":"Regular Hours","hours":"40.000","job_uuid":"332bd171-9efc-432b-abbb-a75c9dba706a","compensation_multiplier":1,"flsa_status":"Nonexempt"},{"name":"Overtime","hours":"5.000","job_uuid":"ca9b3dc1-57ac-4736-901a-9b1c9634b9d5","compensation_multiplier":1.5,"flsa_status":"Nonexempt"},{"name":"Double overtime","hours":"0.000","job_uuid":"1bad01e2-140c-49ed-9542-2388ce4a19b3","compensation_multiplier":2,"flsa_status":"Nonexempt"}],"paid_time_off":[{"name":"Vacation Hours","hours":"20.000"},{"name":"Sick Hours","hours":"0.000"},{"name":"Holiday Hours","hours":"0.000"}]},{"employee_uuid":"187412e1-3dbe-491a-bb2f-2f40323a7012","version":"ff083257a5583291fb86656ad0df1b42","excluded":false,"payment_method":"Direct Deposit","fixed_compensations":[{"name":"Bonus","amount":"100.00","job_uuid":"94e0d15e-9ed2-4077-98f6-64554f242b34"},{"name":"Reimbursement","amount":"100.00","job_uuid":"91bc3b43-ded0-4ee7-98fe-215499e90955"}],"hourly_compensations":[{"name":"Regular Hours","hours":"40.000","job_uuid":"bd378298-3e0c-4145-904a-baadf8a91fa3","compensation_multiplier":1,"flsa_status":"Commission Only Exempt"}],"paid_time_off":[{"name":"Vacation Hours","hours":"20.000"},{"name":"Sick Hours","hours":"0.000"},{"name":"Holiday Hours","hours":"0.000"}]},{"employee_uuid":"187412e1-3dbe-491a-bb2f-2f40323a7781","version":"259816479e3729bf855318af9b9adddf","excluded":false,"payment_method":"Direct Deposit","fixed_compensations":[{"name":"Bonus","amount":"100.00","job_uuid":"94e0d15e-9ed2-4077-98f6-64554f242bab"},{"name":"Reimbursement","amount":"100.00","job_uuid":"91bc3b43-ded0-4ee7-98fe-215499e909cd"}],"hourly_compensations":[{"name":"Regular Hours","hours":"40.000","job_uuid":"bd378298-3e0c-4145-904a-baadf8a91fa3","compensation_multiplier":1,"flsa_status":"Exempt"}],"paid_time_off":[{"name":"Vacation Hours","hours":"20.000"},{"name":"Sick Hours","hours":"0.000"},{"name":"Holiday Hours","hours":"0.000"}]}],"fixed_compensation_types":[{"name":"Bonus"},{"name":"Commission"},{"name":"Paycheck Tips"},{"name":"Cash Tips"},{"name":"Correction Payment"},{"name":"Anniversary Bonus"},{"name":"Internet Stipend"},{"name":"Reimbursement"}]}