v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List employee paystubs

Returns a list of paystubs for the specified employee.

get/employees/{employee}/paystubs

Path parameters

employeestring required

Return paystubs for this employee ID

Query parameters

payrollstring

Return the paystub for this payroll ID.

limitinteger

Number of paystubs returned per page. The maximum value is 25.

statusstring

Filters to only show paystubs for payrolls with the specified status. If multiple status params are provided, paystubs with any of the statuses will be returned. Accepted values are pending, processing, failed, or paid.

startstring date

Return paystubs from payrolls with a payday on or after this date (YYYY-MM-DD)

endstring date

Return paystubs from payrolls with a payday on or before this date (YYYY-MM-DD)

typestring

Returns paystubs from payrolls with a specific type. Accepted values are regular (the default), balancing, and amendment.

Response

200

{"stackTrail":"paths:/employees/{employee}/paystubs:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/employees/{employee}/paystubs:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "results": [
    {
      "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,
          "hours_ytd": 40,
          "name": "Hourly (Regular)",
          "current_earnings": [
            {
              "description": "Work on day 1",
              "amount": "300.00",
              "hours": 40,
              "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"
      }
    }
  ]
}