Update a payroll

PUT {{baseUrl}}/v1/companies/:company_id/payrolls/:pay_period_start_date/:pay_period_end_date

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.

The payrolls are identified by their pay periods’ startdate and enddate. Both are required and must correspond with an existing, unprocessed payroll. If the dates do not match, the entire request will be rejected. This was an explicit design decision to remove any assumptions around the time span for data sent.

scope: payrolls:write

Request Body

{"version"=>"<string>", "employee_compensations"=>[{"employee_uuid"=>"<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>"}, {"name"=>"<string>", "hours"=>"<string>", "policy_uuid"=>"<string>"}]}, {"employee_uuid"=>"<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>"}, {"name"=>"<string>", "hours"=>"<string>", "policy_uuid"=>"<string>"}]}], "employee_uuid"=>16142760.61775142}

HEADERS

RESPONSES

status: OK

{"version":"19289df18e6e20f797de4a585ea5a91535c7ddf7","payroll_deadline":"2021-02-18","check_date":"2021-02-22","external":false,"processed":true,"processed_date":"2021-02-18","payroll_uuid":"b50e611d-8f3d-4f24-b001-46675f7b5777","company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","created_at":"2021-02-01T22:00:00Z","pay_period":{"start_date":"2021-02-01","end_date":"2021-02-15","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"},"totals":{"company_debit":"121747.71","net_pay_debit":"79283.80","tax_debit":"42463.91","reimbursement_debit":"0.00","child_support_debit":"0.00","reimbursements":"0.00","net_pay":"81752.94","gross_pay":"130635.89","employee_bonuses":"0.00","employee_commissions":"18536.37","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","check_amount":"2469.14","employer_taxes":"6917.19","employee_taxes":"35546.72","benefits":"0.00","employee_benefits_deductions":"13336.23","deferred_payroll_taxes":"0.00","other_deductions":"80.00"},"payroll_status_meta":{"cancellable":false,"expected_check_date":"2022-05-25","initial_check_date":"2022-05-31","expected_debit_time":"2022-05-23T16:00:00.000-05:00","payroll_late":false,"initial_debit_cutoff_time":"2022-05-26T16:00:00.000-07:00"},"company_taxes":[{"name":"MO Compensation Deduction","amount":"-0.92","employer":true},{"name":"NY MCTMT","amount":"5.00","employer":true}],"employee_compensations":[{"employee_uuid":"187412e1-3dbe-491a-bb2f-2f40323a7067","excluded":false,"gross_pay":"2791.25","net_pay":"1953.31","check_amount":"1953.31","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"}],"benefits":[{"name":"Group Term Life","employee_deduction":"100.00","company_contribution":"50.00","imputed":true},{"name":"401K","employee_deduction":"100.00","company_contribution":"50.00","imputed":false}],"deductions":[{"name":"Child Support","amount":"80.00"}],"taxes":[{"name":"Federal Income Tax","employer":false,"amount":"646.69"},{"name":"Social Security","employer":true,"amount":"191.25"}]},{"employee_uuid":"187412e1-3dbe-491a-bb2f-2f40323a7012","excluded":false,"gross_pay":"2791.25","net_pay":"1953.31","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"}],"benefits":[{"name":"Group Term Life","employee_deduction":"100.00","company_contribution":"50.00","imputed":true},{"name":"401K","employee_deduction":"100.00","company_contribution":"50.00","imputed":false}],"deductions":[{"name":"Child Support","amount":"80.00"}],"taxes":[{"name":"Federal Income Tax","employer":false,"amount":"646.69"},{"name":"Social Security","employer":true,"amount":"191.25"}]},{"employee_uuid":"187412e1-3dbe-491a-bb2f-2f40323a7781","excluded":false,"gross_pay":"2791.25","net_pay":"1953.31","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"}],"benefits":[{"name":"Group Term Life","employee_deduction":"100.00","company_contribution":"50.00","imputed":true},{"name":"401K","employee_deduction":"100.00","company_contribution":"50.00","imputed":false}],"deductions":[{"name":"Child Support","amount":"80.00"}],"taxes":[{"name":"Federal Income Tax","employer":false,"amount":"646.69"},{"name":"Social Security","employer":true,"amount":"191.25"}]}]}