Get all payrolls for a company
GET {{baseUrl}}/v1/companies/:company_id/payrolls?processed=<boolean>&include_off_cycle=<boolean>&include=<string>&include=<string>&start_date=<string>&end_date=<string>
Returns all payrolls, current and past for a company.
Notes:
* Hour and dollar amounts are returned as string representations of numeric decimals.
* Hours are represented to the thousands place; dollar amounts are represented to the cent.
* Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ).
* To return future payrolls, you must include an end_date
in the future.
scope: payrolls:read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
processed | string | Whether to return processed or unprocessed payrolls | |
include_off_cycle | string | Whether to include off cycle payrolls in the response | |
include | string | Include the requested attribute in the response | |
include | string | Include the requested attribute in the response | |
start_date | string | Return payrolls whose pay period is after the start date | |
end_date | string | Return payrolls whose pay period is before the end date. If left empty, defaults to today's date. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
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_id":7786400908986532,"payroll_uuid":"b50e611d-8f3d-4f24-b001-46675f7b5777","company_id":7756341740978008,"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_id":7757500908984137,"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"},"company_taxes":[{"name":"MO Compensation Deduction","amount":"-0.92","employer":true},{"name":"NY MCTMT","amount":"5.00","employer":true}],"employee_compensations":[{"employee_id":1123581321345589,"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_id":1,"job_uuid":"94e0d15e-9ed2-4077-98f6-64554f242ba5"},{"name":"Reimbursement","amount":"100.00","job_id":1,"job_uuid":"91bc3b43-ded0-4ee7-98fe-215499e909ba"}],"hourly_compensations":[{"name":"Regular Hours","hours":"40.000","job_id":1,"job_uuid":"bd378298-3e0c-4145-904a-baadf8a91fa3","compensation_multiplier":1},{"name":"Overtime","hours":"15.000","job_id":1,"job_uuid":"9d3760f0-d1f9-4700-8817-0fe2dce5cf23","compensation_multiplier":1.5},{"name":"Double overtime","hours":"0.000","job_id":1,"job_uuid":"b5eef9a9-4a87-4649-a80d-14878c05f44e","compensation_multiplier":2},{"name":"Regular Hours","hours":"40.000","job_id":2,"job_uuid":"332bd171-9efc-432b-abbb-a75c9dba706a","compensation_multiplier":1},{"name":"Overtime","hours":"5.000","job_id":2,"job_uuid":"ca9b3dc1-57ac-4736-901a-9b1c9634b9d5","compensation_multiplier":1.5},{"name":"Double overtime","hours":"0.000","job_id":2,"job_uuid":"1bad01e2-140c-49ed-9542-2388ce4a19b3","compensation_multiplier":2}],"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"}]}]}]