CHcheckhq

Get payroll summary

Changed on

Returns the specified payroll summary.

get/companies/{company}/reports/payroll_summary

Request

Path parameters

companystring required

Return payroll summaries for this company ID

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.

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.

include_taxable_wagesboolean

Return taxable wages for each tax in the payroll summary

include_gross_taxable_wagesboolean

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

Headers

Acceptstring

Either application/json or text/csv

Response

200

nextstring
previousstring

Example response

{
  "results": [
    {
      "totals": {
        "employee_gross": "2400.00",
        "employee_reimbursements": "0.00",
        "employee_net": "2021.84",
        "company_taxes": "242.84",
        "employee_taxes": "363.16",
        "company_benefits": "10.00",
        "employee_benefits": "10.00",
        "post_tax_deductions": "5.00"
      },
      "earning_totals": [
        {
          "type": "hourly",
          "amount": "2400.00",
          "hours": 80
        }
      ],
      "employee_taxes": [
        {
          "id": "tax_UJrIQbtVErbdez0bYTVN",
          "description": "New York Paid Family Leave Insurance",
          "amount": "9.32"
        }
      ],
      "company_taxes": [
        {
          "id": "tax_yoCLGjynONf4xRcpqDv3",
          "description": "New York MCTMT Employer Payroll Tax",
          "amount": "0.00"
        }
      ],
      "employee_benefits": [
        {
          "type": "125_medical",
          "description": "Test Benefit",
          "amount": "10.00"
        }
      ],
      "company_benefits": [
        {
          "type": "125_medical",
          "description": "Test Benefit",
          "amount": "10.00"
        }
      ],
      "post_tax_deductions": [
        {
          "type": "miscellaneous",
          "description": "Test Deduction",
          "amount": "5.00"
        }
      ],
      "employee": "emp_VBTzt5oVdR31wDXGb1o2"
    }
  ]
}

Changes