CHcheckhq

Get payroll journal

Changed on

Returns the specified payroll journal.

get/companies/{company}/reports/payroll_journal

Request

Path parameters

companystring required

ID of the company with the payroll journal to return

Query parameters

startstring date

Return payrolls with a payday on or after this date.

endstring date

Return payrolls with a payday before or on this date.

payrollstring

Return the payroll with this ID. To specify multiple payrolls, repeat this query parameter. (For example: "&payroll=pay_123&payroll=pay_456&...")

include_taxable_wagesboolean

Return payrolls with taxable wages.

include_gross_taxable_wagesboolean

Return payrolls with gross taxable wages (wages subject to a tax before pre-tax deductions, irrespective of wage base).

include_employee_idboolean

Return employees with their ID.

include_contractorsboolean

Return payments made to contractors on payrolls

include_contractor_idboolean

Return contractors with their ID.

group_by'workplace'

Determines how to breakdown pay. If workplace is provided, employees will have one line item per payroll and workplace combination.

Headers

Acceptstring

Either application/json or text/csv

Response

200

nextstring
previousstring

Example response

{
  "results": [
    {
      "payroll": "pay_oOcg16KDmdljaqmitP00",
      "company": "com_H4eYDq9imaA5Ur3qwKA0",
      "payday": "2025-10-31",
      "period_start": "2025-10-11",
      "period_end": "2025-10-17",
      "payment_method": "Manual",
      "summary": {
        "totals": {
          "employee_gross": "1200.00",
          "employee_reimbursements": "0.00",
          "employee_net": "998.14",
          "company_taxes": "121.80",
          "employee_taxes": "201.86",
          "company_benefits": "0.00",
          "employee_benefits": "0.00",
          "post_tax_deductions": "0.00"
        },
        "earning_totals": [
          {
            "type": "hourly",
            "amount": "1200.00",
            "hours": 40
          }
        ],
        "employee_taxes": [
          {
            "id": "tax_UJrIQbtVErbdez0bYTVN",
            "description": "New York Paid Family Leave Insurance",
            "amount": "4.66"
          }
        ],
        "company_taxes": [
          {
            "id": "tax_yoCLGjynONf4xRcpqDv3",
            "description": "New York MCTMT Employer Payroll Tax",
            "amount": "0.00"
          }
        ]
      },
      "item_records": [
        {
          "totals": {
            "employee_gross": "1200.00",
            "employee_reimbursements": "0.00",
            "employee_net": "998.14",
            "company_taxes": "121.80",
            "employee_taxes": "201.86",
            "company_benefits": "0.00",
            "employee_benefits": "0.00",
            "post_tax_deductions": "0.00"
          },
          "earning_totals": [
            {
              "type": "hourly",
              "amount": "1200.00",
              "hours": 40
            }
          ],
          "employee_taxes": [
            {
              "id": "tax_UJrIQbtVErbdez0bYTVN",
              "description": "New York Paid Family Leave Insurance",
              "amount": "4.66"
            }
          ],
          "company_taxes": [
            {
              "id": "tax_yoCLGjynONf4xRcpqDv3",
              "description": "New York MCTMT Employer Payroll Tax",
              "amount": "0.00"
            }
          ],
          "payroll_item": "itm_v9DWDXMGt9YyzWfM58dv",
          "employee": "emp_VBTzt5oVdR31wDXGb1o2"
        }
      ]
    }
  ]
}

Changes