Get all payrolls for a company
GET {{baseUrl}}/v1/companies/:company_id/payrolls?processing_statuses=<string>&processing_statuses=<string>&payroll_types=<string>&payroll_types=<string>&include=<string>&include=<string>&start_date=<string>&end_date=<string>
Returns a list of payrolls for a company. You can change the payrolls returned by updating the processingstatus, payrolltypes, startdate, & enddate params.
By default, will return processed, regular payrolls for the past 6 months.
Notes: * Dollar amounts are returned as string representations of numeric decimals, are represented to the cent. * enddate can be at most 3 months in the future and startdate and end_date can't be more than 1 year apart.
scope: payrolls:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
processing_statuses | string | Whether to include processed and/or unprocessed payrolls in the response, defaults to processed, for multiple attributes comma separate the values, i.e. ?processing_statuses=processed,unprocessed | |
processing_statuses | string | Whether to include processed and/or unprocessed payrolls in the response, defaults to processed, for multiple attributes comma separate the values, i.e. ?processing_statuses=processed,unprocessed | |
payroll_types | string | Whether to include regular and/or off_cycle payrolls in the response, defaults to regular, for multiple attributes comma separate the values, i.e. ?payroll_types=regular,off_cycle | |
payroll_types | string | Whether to include regular and/or off_cycle payrolls in the response, defaults to regular, for multiple attributes comma separate the values, i.e. ?payroll_types=regular,off_cycle | |
include | string | Include the requested attribute in the response. The risk_blockers option will include submission_blockers and credit_blockers if applicable. In v2023-04-01 totals are no longer included by default. For multiple attributes comma separate the values, i.e. ?include=totals,payroll_status_meta | |
include | string | Include the requested attribute in the response. The risk_blockers option will include submission_blockers and credit_blockers if applicable. In v2023-04-01 totals are no longer included by default. For multiple attributes comma separate the values, i.e. ?include=totals,payroll_status_meta | |
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
[{"payroll_deadline":"2021-02-18T22:00:00Z","check_date":"2021-02-22","off_cycle":false,"external":false,"processed":true,"processed_date":"2021-02-18","calculated_at":"2021-02-18T12:00:00Z","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":"240.00"}},{"payroll_deadline":"2021-02-28","check_date":"2021-03-01","off_cycle":false,"external":false,"processed":false,"processed_date":"nil","calculated_at":"nil","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-16","end_date":"2021-03-01","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"}}]