Get a single payroll

GET {{baseUrl}}/v1/companies/:company_id/payrolls/:payroll_id?include=<string>&show_calculation=<string>

Returns a payroll.

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 ).

scope: payrolls:read

Request Params

KeyDatatypeRequiredDescription
includestringInclude the requested attribute in the response, for multiple attributes comma separate the values, i.e. ?include=benefits,deductions,taxes
show_calculationstringWith show_calculation = true, the calculated values specified by the include parameter will be shown if the payroll is in an unprocessed, but calculated state.
If a payroll is in an unprocessed, but calculated state and a call is made to this endpoint without show_calculation = true, the calculation will be “cleared.”

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Acceptstring

RESPONSES

status: OK

{&quot;version&quot;:&quot;19289df18e6e20f797de4a585ea5a91535c7ddf7&quot;,&quot;payroll_deadline&quot;:&quot;2021-02-18&quot;,&quot;check_date&quot;:&quot;2021-02-22&quot;,&quot;external&quot;:false,&quot;processed&quot;:true,&quot;processed_date&quot;:&quot;2021-02-18&quot;,&quot;payroll_uuid&quot;:&quot;b50e611d-8f3d-4f24-b001-46675f7b5777&quot;,&quot;company_uuid&quot;:&quot;6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb&quot;,&quot;created_at&quot;:&quot;2021-02-01T22:00:00Z&quot;,&quot;pay_period&quot;:{&quot;start_date&quot;:&quot;2021-02-01&quot;,&quot;end_date&quot;:&quot;2021-02-15&quot;,&quot;pay_schedule_uuid&quot;:&quot;00ebc4a4-ec88-4435-8f45-c505bb63e501&quot;},&quot;totals&quot;:{&quot;company_debit&quot;:&quot;121747.71&quot;,&quot;net_pay_debit&quot;:&quot;79283.80&quot;,&quot;tax_debit&quot;:&quot;42463.91&quot;,&quot;reimbursement_debit&quot;:&quot;0.00&quot;,&quot;child_support_debit&quot;:&quot;0.00&quot;,&quot;reimbursements&quot;:&quot;0.00&quot;,&quot;net_pay&quot;:&quot;81752.94&quot;,&quot;gross_pay&quot;:&quot;130635.89&quot;,&quot;employee_bonuses&quot;:&quot;0.00&quot;,&quot;employee_commissions&quot;:&quot;18536.37&quot;,&quot;employee_cash_tips&quot;:&quot;0.00&quot;,&quot;employee_paycheck_tips&quot;:&quot;0.00&quot;,&quot;additional_earnings&quot;:&quot;0.00&quot;,&quot;owners_draw&quot;:&quot;0.00&quot;,&quot;check_amount&quot;:&quot;2469.14&quot;,&quot;employer_taxes&quot;:&quot;6917.19&quot;,&quot;employee_taxes&quot;:&quot;35546.72&quot;,&quot;benefits&quot;:&quot;0.00&quot;,&quot;employee_benefits_deductions&quot;:&quot;13336.23&quot;,&quot;deferred_payroll_taxes&quot;:&quot;0.00&quot;,&quot;other_deductions&quot;:&quot;80.00&quot;},&quot;payroll_status_meta&quot;:{&quot;cancellable&quot;:false,&quot;expected_check_date&quot;:&quot;2022-05-25&quot;,&quot;initial_check_date&quot;:&quot;2022-05-31&quot;,&quot;expected_debit_time&quot;:&quot;2022-05-23T16:00:00.000-05:00&quot;,&quot;payroll_late&quot;:false,&quot;initial_debit_cutoff_time&quot;:&quot;2022-05-26T16:00:00.000-07:00&quot;},&quot;company_taxes&quot;:[{&quot;name&quot;:&quot;MO Compensation Deduction&quot;,&quot;amount&quot;:&quot;-0.92&quot;,&quot;employer&quot;:true},{&quot;name&quot;:&quot;NY MCTMT&quot;,&quot;amount&quot;:&quot;5.00&quot;,&quot;employer&quot;:true}],&quot;employee_compensations&quot;:[{&quot;employee_uuid&quot;:&quot;187412e1-3dbe-491a-bb2f-2f40323a7067&quot;,&quot;excluded&quot;:false,&quot;gross_pay&quot;:&quot;2791.25&quot;,&quot;net_pay&quot;:&quot;1953.31&quot;,&quot;check_amount&quot;:&quot;1953.31&quot;,&quot;payment_method&quot;:&quot;Direct Deposit&quot;,&quot;fixed_compensations&quot;:[{&quot;name&quot;:&quot;Bonus&quot;,&quot;amount&quot;:&quot;100.00&quot;,&quot;job_uuid&quot;:&quot;94e0d15e-9ed2-4077-98f6-64554f242ba5&quot;},{&quot;name&quot;:&quot;Reimbursement&quot;,&quot;amount&quot;:&quot;100.00&quot;,&quot;job_uuid&quot;:&quot;91bc3b43-ded0-4ee7-98fe-215499e909ba&quot;}],&quot;hourly_compensations&quot;:[{&quot;name&quot;:&quot;Regular Hours&quot;,&quot;hours&quot;:&quot;40.000&quot;,&quot;job_uuid&quot;:&quot;bd378298-3e0c-4145-904a-baadf8a91fa3&quot;,&quot;compensation_multiplier&quot;:1},{&quot;name&quot;:&quot;Overtime&quot;,&quot;hours&quot;:&quot;15.000&quot;,&quot;job_uuid&quot;:&quot;9d3760f0-d1f9-4700-8817-0fe2dce5cf23&quot;,&quot;compensation_multiplier&quot;:1.5},{&quot;name&quot;:&quot;Double overtime&quot;,&quot;hours&quot;:&quot;0.000&quot;,&quot;job_uuid&quot;:&quot;b5eef9a9-4a87-4649-a80d-14878c05f44e&quot;,&quot;compensation_multiplier&quot;:2},{&quot;name&quot;:&quot;Regular Hours&quot;,&quot;hours&quot;:&quot;40.000&quot;,&quot;job_uuid&quot;:&quot;332bd171-9efc-432b-abbb-a75c9dba706a&quot;,&quot;compensation_multiplier&quot;:1},{&quot;name&quot;:&quot;Overtime&quot;,&quot;hours&quot;:&quot;5.000&quot;,&quot;job_uuid&quot;:&quot;ca9b3dc1-57ac-4736-901a-9b1c9634b9d5&quot;,&quot;compensation_multiplier&quot;:1.5},{&quot;name&quot;:&quot;Double overtime&quot;,&quot;hours&quot;:&quot;0.000&quot;,&quot;job_uuid&quot;:&quot;1bad01e2-140c-49ed-9542-2388ce4a19b3&quot;,&quot;compensation_multiplier&quot;:2}],&quot;paid_time_off&quot;:[{&quot;name&quot;:&quot;Vacation Hours&quot;,&quot;hours&quot;:&quot;20.000&quot;},{&quot;name&quot;:&quot;Sick Hours&quot;,&quot;hours&quot;:&quot;0.000&quot;},{&quot;name&quot;:&quot;Holiday Hours&quot;,&quot;hours&quot;:&quot;0.000&quot;}],&quot;benefits&quot;:[{&quot;name&quot;:&quot;Group Term Life&quot;,&quot;employee_deduction&quot;:&quot;100.00&quot;,&quot;company_contribution&quot;:&quot;50.00&quot;,&quot;imputed&quot;:true},{&quot;name&quot;:&quot;401K&quot;,&quot;employee_deduction&quot;:&quot;100.00&quot;,&quot;company_contribution&quot;:&quot;50.00&quot;,&quot;imputed&quot;:false}],&quot;deductions&quot;:[{&quot;name&quot;:&quot;Child Support&quot;,&quot;amount&quot;:&quot;80.00&quot;}],&quot;taxes&quot;:[{&quot;name&quot;:&quot;Federal Income Tax&quot;,&quot;employer&quot;:false,&quot;amount&quot;:&quot;646.69&quot;},{&quot;name&quot;:&quot;Social Security&quot;,&quot;employer&quot;:true,&quot;amount&quot;:&quot;191.25&quot;}]}]}