CHcheckhq

Get a paystub

Changed on

Returns the specified paystub for the given employee and payroll.

By default get the response as JSON. Use an Accept: application/pdf request header to download the paystub as a PDF document.

get/employees/{employee}/paystubs/{payroll}

Request

Path parameters

employeestring required

Return paystub for this employee ID

payrollstring required

Return the paystub for this payroll ID

Headers

Acceptstring

Either application/pdf or application/json

Response

200

payrollstring
paydaystring
period_startstring
period_endstring
void_ofunknown
voided_byunknown
payment_methodstring

Example response

{
  "payroll": "pay_xUNanwDkP1o8TE6qC77L",
  "payday": "2021-04-26",
  "period_start": "2021-03-20",
  "period_end": "2021-04-02",
  "company": {
    "legal_name": "Stark Industries",
    "address": {
      "line1": "4954 Berkeley Run Crossing",
      "city": "Norcross",
      "state": "GA",
      "postal_code": "30092",
      "country": "US"
    },
    "phone": "2067138013"
  },
  "employee": {
    "first_name": "Tony",
    "last_name": "Stark",
    "residence": {
      "line1": "4954 Berkeley Run Crossing",
      "city": "Norcross",
      "state": "GA",
      "postal_code": "30092",
      "country": "US"
    }
  },
  "earnings": [
    {
      "type": "hourly",
      "amount": "300.00",
      "amount_ytd": "300.00",
      "hours": "40.00",
      "hours_ytd": "40.00",
      "name": "Hourly (Regular)",
      "current_earnings": [
        {
          "description": "Work on day 1",
          "amount": "300.00",
          "hours": "40.00",
          "workplace": "wrk_mhHjtmJh6TBSuhTXpMcp",
          "rate": "7.500"
        }
      ]
    }
  ],
  "employee_taxes": [
    {
      "amount": "24.80",
      "amount_ytd": "24.80",
      "description": "FICA"
    }
  ],
  "company_taxes": [
    {
      "amount": "24.80",
      "amount_ytd": "24.80",
      "description": "Employer FICA Tax"
    }
  ],
  "summary": {
    "earnings": "400.00",
    "earnings_ytd": "400.00",
    "reimbursements": "0.00",
    "reimbursements_ytd": "0.00",
    "employee_taxes": "69.32",
    "employee_taxes_ytd": "69.32",
    "company_taxes": "44.04",
    "company_taxes_ytd": "44.04",
    "employee_benefit_contributions": "0.00",
    "employee_benefit_contributions_ytd": "0.00",
    "company_benefit_contributions": "0.00",
    "company_benefit_contributions_ytd": "0.00",
    "post_tax_deductions": "0.00",
    "post_tax_deductions_ytd": "0.00",
    "net_pay": "330.68",
    "net_pay_ytd": "330.68"
  },
  "payment_method": "manual"
}

Changes