# Query Payrolls

Endpoint: GET /companies/{companyId}/payrolls
Version: 1.0

## Path parameters:

  - `companyId` (string, required)

## Query parameters:

  - `id` (array, required)

  - `page` (integer)

  - `pageSize` (integer)

## Response 200 fields (application/json):

  - `hasResources` (boolean)

  - `totalResources` (integer)

  - `totalPages` (integer)

  - `pageSize` (integer)

  - `currentPage` (integer,null)

  - `previousPage` (integer,null)

  - `nextPage` (integer,null)

  - `results` (array,null)

  - `results.id` (string)

  - `results.companyId` (string)

  - `results.paymentScheduleId` (string,null)

  - `results.periodStart` (string)

  - `results.periodEnd` (string)

  - `results.deadline` (string)

  - `results.payday` (string)

  - `results.approvedAt` (string,null)

  - `results.status` (string)
    Enum: "Draft", "Pending", "Processing", "Paid", "PartiallyPaid", "Failed"

  - `results.type` (string)
    Enum: "Regular", "OffCycle", "Adjustment", "ThirdPartySickPay"

  - `results.frequency` (string)
    Enum: "Weekly", "Biweekly", "Semimonthly", "Monthly", "Quarterly", "Annually"

  - `results.processingPeriod` (string)
    Enum: "FourDay", "TwoDay", "OneDay", "ThreeDay"

  - `results.fundingMethod` (string)
    Enum: "Ach", "Wire"

  - `results.totals` (object)

  - `results.totals.employeeGross` (number)

  - `results.totals.employeeReimbursements` (number)

  - `results.totals.employeeTaxes` (number)

  - `results.totals.employeeBenefits` (number)

  - `results.totals.deductions` (number)

  - `results.totals.employeeNet` (number)

  - `results.totals.contractorGross` (number)

  - `results.totals.contractorReimbursements` (number)

  - `results.totals.contractorNet` (number)

  - `results.totals.companyTaxes` (number)

  - `results.totals.companyBenefits` (number)

  - `results.totals.liability` (number)

  - `results.totals.cashRequirement` (number)

  - `results.offCycleOptions` (object)

  - `results.offCycleOptions.forceSupplementalWithholdings` (boolean)

  - `results.offCycleOptions.applyBenefits` (boolean)

  - `results.offCycleOptions.applyDeductions` (boolean)

  - `results.employeeItems` (array,null)

  - `results.employeeItems.employeeItemId` (string)

  - `results.employeeItems.employeeId` (string)

  - `results.employeeItems.netPay` (number,null)

  - `results.employeeItems.ptoBalanceHours` (number,null)

  - `results.employeeItems.sickBalanceHours` (number,null)

  - `results.employeeItems.stateCovidSickBalanceHours` (number,null)

  - `results.employeeItems.paperCheckNumber` (string,null)

  - `results.employeeItems.paymentMethod` (string)
    Enum: "DirectDeposit", "Manual"

  - `results.employeeItems.flsaOvertimeExemption` (string)
    Enum: "NonExempt", "Exempt"

  - `results.employeeItems.supplementalTaxMethod` (string)
    Enum: "Flat", "Aggregate"

  - `results.employeeItems.payments` (array,null)

  - `results.employeeItems.payments.employeePaymentId` (string)

  - `results.employeeItems.payments.workplaceId` (string,null)

  - `results.employeeItems.payments.isSalaryRate` (boolean)

  - `results.employeeItems.payments.payRate` (number,null)

  - `results.employeeItems.payments.regularHours` (number,null)

  - `results.employeeItems.payments.overtimeHours` (number,null)

  - `results.employeeItems.payments.doubleOvertimeHours` (number,null)

  - `results.employeeItems.payments.paidHolidayHours` (number,null)

  - `results.employeeItems.payments.ptoHours` (number,null)

  - `results.employeeItems.payments.regularOverride` (number,null)

  - `results.employeeItems.payments.overtimeOverride` (number,null)

  - `results.employeeItems.payments.doubleOvertimeOverride` (number,null)

  - `results.employeeItems.payments.paidHolidayOverride` (number,null)

  - `results.employeeItems.payments.ptoOverride` (number,null)

  - `results.employeeItems.payments.sickHours` (number,null)

  - `results.employeeItems.payments.nonHourlyRegular` (number,null)

  - `results.employeeItems.payments.bonus` (number,null)

  - `results.employeeItems.payments.commission` (number,null)

  - `results.employeeItems.payments.cashTips` (number,null)

  - `results.employeeItems.payments.paycheckTips` (number,null)

  - `results.employeeItems.payments.severance` (number,null)

  - `results.employeeItems.payments.groupTermLife` (number,null)

  - `results.employeeItems.payments.otherImputed` (number,null)

  - `results.employeeItems.payments.shareholderBenefits` (number,null)

  - `results.employeeItems.payments.shareholderHsa` (number,null)

  - `results.employeeItems.payments.earningCodeEarnings` (array,null)

  - `results.employeeItems.payments.earningCodeEarnings.earningCodeId` (string)

  - `results.employeeItems.payments.earningCodeEarnings.value` (number,null)

  - `results.employeeItems.payments.earningCodeEarnings.valueOverride` (number,null)

  - `results.employeeItems.reimbursements` (array,null)

  - `results.employeeItems.reimbursements.employeeReimbursementId` (string)

  - `results.employeeItems.reimbursements.amount` (number,null)

  - `results.employeeItems.reimbursements.description` (string,null)

  - `results.employeeItems.paidEarnings` (array,null)

  - `results.employeeItems.paidEarnings.hours` (number,null)

  - `results.employeeItems.paidReimbursements` (array,null)

  - `results.employeeItems.benefits` (array,null)

  - `results.employeeItems.benefits.employeeContribution` (number)

  - `results.employeeItems.benefits.companyContribution` (number)

  - `results.employeeItems.miscellaneousDeductions` (array,null)

  - `results.employeeItems.childSupportDeductions` (array,null)

  - `results.employeeItems.childSupportDeductions.isManaged` (boolean)

  - `results.employeeItems.taxes` (array,null)

  - `results.employeeItems.taxes.payer` (string)
    Enum: "Company", "Employee"

  - `results.employeeItems.taxes.shortDescription` (string,null)

  - `results.employeeItems.warnings` (array,null)

  - `results.employeeItems.warnings.code` (string)
    Enum: "Skipped", "PartiallyApplied"

  - `results.employeeItems.warnings.reason` (string)
    Enum: "NegativeNetPay", "ExceedsMaxPercent"

  - `results.employeeItems.warnings.deductionType` (string)
    Enum: "Deduction", "Benefit", "Tax"

  - `results.employeeItems.warnings.deductionId` (string,null)

  - `results.employeeItems.warnings.actualDeductionAmount` (number)

  - `results.employeeItems.warnings.expectedDeductionAmount` (number)

  - `results.contractorItems` (array,null)

  - `results.contractorItems.contractorId` (string)

  - `results.contractorItems.reimbursement` (number,null)

  - `results.isVoid` (boolean)