--- title: "Get all payrolls for a company" method: GET path: "/v1/companies/{company_id}/payrolls" tags: ["Payrolls"] --- # Get all payrolls for a company `GET /v1/companies/{company_id}/payrolls` Returns a list of payrolls for a company. You can change the payrolls returned by updating the processing_status, payroll_types, start_date, & end_date 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. * end_date can be at most 3 months in the future and start_date and end_date can't be more than 1 year apart. * Results are paginated. Maximum page size is 100 payrolls per request; the default page size is 25. scope: `payrolls:read` ## Path parameters - `company_id` string, required ## Query parameters - `processing_statuses` string[] - `payroll_types` string[] - `processed` boolean - `include_off_cycle` boolean - `include` string[] - `start_date` string - `end_date` string - `date_filter_by` 'check_date' - `page` integer - `per` integer - `sort_order` 'asc' | 'desc' ## Headers - `X-Gusto-API-Version` '2026-06-15' ## Response `200` Successful - Payroll[] — A list of payrolls for a company. - `payroll_deadline` string, date-time — A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met. - `check_date` string — The date on which employees will be paid for the payroll. - `processed` boolean — Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline. - `processed_date` string, nullable — The date at which the payroll was processed. Null if the payroll isn't processed yet. - `calculated_at` string, date-time, nullable — A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation. - `uuid` string — The UUID of the payroll. - `payroll_uuid` string — The UUID of the payroll. - `company_uuid` string — The UUID of the company for the payroll. - `off_cycle` boolean — Indicates whether the payroll is an off-cycle payroll - `off_cycle_reason` 'Adhoc' | 'Benefit reversal' | 'Bonus' | 'Correction' | 'Dismissed employee' | 'Hired employee' | 'Wage correction' | 'Tax reconciliation' | 'Reversal' | 'Disability insurance distribution' | 'Transition from old pay schedule', nullable — The off-cycle reason. Only included for off-cycle payrolls. - `auto_payroll` boolean — Indicates whether the payroll has automatic payroll enabled - `external` boolean — Indicates whether the payroll is an external payroll - `final_termination_payroll` boolean — Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls. - `withholding_pay_period` 'Every week' | 'Every other week' | 'Twice per month' | 'Monthly' | 'Quarterly' | 'Semiannually' | 'Annually', nullable — The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls. - `skip_regular_deductions` boolean, nullable — Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls. - `fixed_withholding_rate` boolean, nullable — Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls. - `pay_period` PayrollPayPeriodType - `start_date` string — The start date, inclusive, of the pay period. - `end_date` string — The start date, inclusive, of the pay period. - `pay_schedule_uuid` string, nullable — The UUID of the pay schedule for the payroll. - `payroll_status_meta` PayrollPayrollStatusMetaType — Information about the payroll's status and expected dates - `cancellable` boolean — true if the payroll may be cancelled. - `expected_check_date` string — The date an employee will be paid if the payroll is submitted now. - `initial_check_date` string, nullable — The normal check date for the associated pay period. Returns `null` for off-cycle payrolls (not meaningful for off-cycle). - `expected_debit_time` string — The time the employer's account will be debited if the payroll is submitted now. - `payroll_late` boolean, nullable — expected_check_date > initial_check_date. Returns `null` for off-cycle payrolls (not meaningful for off-cycle). - `initial_debit_cutoff_time` string — Payroll must be submitted at or before this time to avoid late payroll. - `totals` PayrollTotalsType — The subtotals for the payroll. - `company_debit` string — The total company debit for the payroll. - `net_pay_debit` string — The total company net pay for the payroll. - `tax_debit` string — The total tax debit for the payroll. - `reimbursement_debit` string — The total reimbursement debit for the payroll. - `child_support_debit` string — The total child support debit for the payroll. - `reimbursements` string — The total reimbursements for the payroll. - `net_pay` string — The net pay amount for the payroll. - `gross_pay` string — The gross pay amount for the payroll. - `employee_bonuses` string — The total employee bonuses amount for the payroll. - `employee_commissions` string — The total employee commissions amount for the payroll. - `employee_cash_tips` string — The total employee cash tips amount for the payroll. - `employee_paycheck_tips` string — The total employee paycheck tips amount for the payroll. - `additional_earnings` string — The total additional earnings amount for the payroll. - `owners_draw` string — The total owner's draw for the payroll. - `check_amount` string — The total check amount for the payroll. - `employer_taxes` string — The total amount of employer paid taxes for the payroll. - `employee_taxes` string — The total amount of employee paid taxes for the payroll. - `benefits` string — The total amount of company contributed benefits for the payroll. - `employee_benefits_deductions` string — The total amount of employee deducted benefits for the payroll. - `imputed_pay` string — The total amount of imputed pay for the payroll. - `deferred_payroll_taxes` string — The total amount of payroll taxes deferred for the payroll, such as allowed by the CARES act. - `other_deductions` string — The total amount of deductions for the payroll. - `company_taxes` object[] — An array of taxes applicable to this payroll in addition to taxes included in `employee_compensations`. Only included for processed or calculated payrolls when `taxes` is present in the `include` parameter. - `name` string — The tax name - `employer` boolean — Whether this tax is an employer or employee tax - `amount` string — The amount of this tax for the payroll - `payroll_taxes` object[] — An array of tax totals applicable to this payroll. Only included for processed or calculated payrolls when `payroll_taxes` is present in the `include` parameter. - `name` string — The tax name - `employer` boolean — Whether this tax is an employer or employee tax - `amount` number — The total tax for the payroll - `payment_speed_changed` PayrollPaymentSpeedChangedType — Only applicable when a payroll is moved to four day processing instead of fast ach. - `original_check_date` string — Original check date when fast ach applies. - `current_check_date` string — Current check date. - `original_debit_date` string — Original debit date when fast ach applies. - `current_debit_date` string — Current debit date. - `reason` string — The reason why the payroll is moved to four day. - `created_at` string, date-time — Datetime for when the resource was created. - `submission_blockers` PayrollSubmissionBlockerType[] — Only included for processed or calculated payrolls - `blocker_type` string — The type of blocker that's blocking the payment submission. - `blocker_name` string — The name of the submission blocker. - `unblock_options` object[] — The available options to unblock a submission blocker. - `unblock_type` string — The type of unblock option for the submission blocker. - `check_date` string — The payment check date associated with the unblock option. - `metadata` object — Additional data associated with the unblock option. - `selected_option` string, nullable — The unblock option that's been selected to resolve the submission blocker. - `status` 'unresolved' | 'resolved' — The status of the submission blocker. - `credit_blockers` PayrollCreditBlockerType[] — Only included for processed payrolls - `blocker_type` string — The type of blocker that's blocking the payment from being credited. - `blocker_name` string — The name of the credit blocker. - `unblock_options` union[] — The available options to unblock a credit blocker. - union - PayrollCreditBlockerUnblockOptionSubmitWire — Unblock option to resolve a credit blocker by submitting a wire transfer - `unblock_type` 'submit_wire', required — The type of unblock option for the credit blocker - `check_date` string, required — The payment check date associated with the unblock option - `metadata` object, required - `wire_in_amount` string, required — The amount to be wired in (decimal string) - `wire_in_deadline` string, date-time, required — Deadline for the wire transfer to be received - `wire_in_request_uuid` string, required — UUID of the wire in request - PayrollCreditBlockerUnblockOptionSubmitBankScreenshot — Unblock option to resolve a credit blocker by submitting a bank screenshot - `unblock_type` 'submit_bank_screenshot', required — The type of unblock option for the credit blocker - `check_date` string, required — The payment check date associated with the unblock option - `metadata` object, required - `information_request_uuid` string, required — UUID of the information request - `bank_account_last_four_digits` string, nullable — Last 4 digits of the bank account number for the bank screenshot RFI - PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi — Unblock option to resolve a credit blocker by responding to high risk fraud RFI - `unblock_type` 'respond_to_high_risk_fraud_rfi', required — The type of unblock option for the credit blocker - `check_date` string, required — The payment check date associated with the unblock option - `metadata` object, required - `information_request_uuid` string, required — UUID of the information request - PayrollCreditBlockerUnblockOptionWaitForReverseWire — Unblock option to resolve a credit blocker by waiting for reverse wire - `unblock_type` 'wait_for_reverse_wire', required — The type of unblock option for the credit blocker - `check_date` string, required — The payment check date associated with the unblock option - `metadata` object, required - `selected_option` string, nullable — The unblock option that's been selected to resolve the credit blocker. - `status` 'unresolved' | 'pending_review' | 'resolved' | 'failed' — The status of the credit blocker - `processing_request` PayrollProcessingRequest, nullable - `status` 'calculating' | 'calculate_success' | 'submitting' | 'submit_success' | 'processing_failed' — The status of the payroll processing request - `errors` EntityErrorObject[] — Errors that occurred during async payroll processing - `error_key` string, required — Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error. - `category` string, required — Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration. If category is `nested_errors`, the object will contain a nested `errors` property with entity errors. - `message` string — Provides details about the error - generally this message can be surfaced to an end user. - `metadata` union — Contains relevant data to identify the resource in question when applicable. For example, to identify an entity `entity_type` and `entity_uuid` will be provided. - object — multiple entities - `entities` MetadataWithOneEntity[], required - `entity_type` string — Name of the entity that the error corresponds to. - `entity_uuid` string — Unique identifier for the entity. - `valid_from` string, nullable - `valid_up_to` string, nullable - `key` string, nullable - `state` string, nullable - object — single entity - `entity_type` string — Name of the entity that the error corresponds to. - `entity_uuid` string — Unique identifier for the entity. - `valid_from` string, nullable - `valid_up_to` string, nullable - `key` string, nullable - `state` string, nullable - `errors` object[] — Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors. - `error_key` string — Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error. - `category` string — Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration. If category is `nested_errors`, the object will contain a nested `errors` property with entity errors. - `message` string — Provides details about the error - generally this message can be surfaced to an end user. - `metadata` object — Contains relevant data to identify the resource in question when applicable. For example, to identify an entity `entity_type` and `entity_uuid` will be provided. - `partner_owned_disbursement` boolean, nullable — Will money movement for the payroll be performed by the partner rather than by Gusto? ## Other responses - `404` — Not Found --- [API](https://skmtc.net/gusto/apis/gusto-api.md) · [All operations](https://skmtc.net/gusto/apis/gusto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gusto/gusto-api/revisions/826dfa57fb3b/schema)