get
https://sandbox.checkhq.com/companies//reports/payroll_journal
Returns the specified payroll journal.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns a detailed payroll journal for a company within a given date range, including per-payroll summaries and per-employee breakdowns of earnings, taxes, benefits, and deductions.
Response Columns/Fields
Payroll-Level Fields
| Field | Description |
|---|---|
| payroll | The public ID of the payroll |
| company | The public ID of the company |
| payday | The date employees are paid |
| period_start | The start date of the pay period |
| period_end | The end date of the pay period |
| payment_method | How employees are paid (Direct Deposit or Manual) |
Summary Totals (available at both payroll and employee level)
| Field | Description |
|---|---|
| employee_gross | Total gross earnings for employees |
| employee_reimbursements | Total reimbursements paid to employees |
| employee_net | Total net pay to employees after all deductions |
| company_taxes | Total employer-paid taxes |
| employee_taxes | Total employee-paid taxes withheld |
| company_benefits | Total employer-paid benefit contributions |
| employee_benefits | Total employee-paid benefit deductions |
| post_tax_deductions | Total post-tax deductions from employee pay |
Earning Totals
| Field | Description |
|---|---|
| type | The earning type (e.g., hourly, salary, bonus) |
| amount | The total amount for this earning type |
| hours | Hours worked (for hourly earnings) |
| piece_units | Piece units (for piece-rate earnings) |
Tax Details (employee_taxes and company_taxes arrays)
| Field | Description |
|---|---|
| id | The public ID of the tax |
| description | The name/description of the tax |
| amount | The tax amount |
Benefit Details (employee_benefits and company_benefits arrays)
| Field | Description |
|---|---|
| type | The benefit type (e.g., 125_medical, 401k) |
| description | The name/description of the benefit |
| amount | The benefit amount |
Post-Tax Deduction Details
| Field | Description |
|---|---|
| type | The deduction type (e.g., miscellaneous, child_support) |
| description | The name/description of the deduction |
| amount | The deduction amount |
Item Records (per-employee breakdown)
| Field | Description |
|---|---|
| payroll_item | The public ID of the payroll item |
| employee | The public ID of the employee |
| totals | Same structure as summary totals, but for this specific employee |
Notes
- Results are grouped by payroll, with each payroll containing a
summaryanditem_recordsarray - The
summarycontains aggregate totals across all employees for that payroll - Each entry in
item_recordsrepresents one employee's pay details for that payroll - Use
include_taxable_wages=trueto include taxable wage information in the response - Use
include_gross_taxable_wages=trueto include gross taxable wage information in the response - Use
include_employee_id=trueto include employee IDs in the response - Use
include_contractors=trueto include contractor payments in the results - Use
group_by=workplaceto break down employee pay by workplace location - Supports both JSON (
Accept: application/json) and CSV (Accept: text/csv) response formats