v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Get a contractor pay statement

Returns the specified pay statement for the given contractor 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/contractors/{contractor}/payments/{payroll}

Path parameters

contractorstring required

Return paystub for this contractor 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

{"stackTrail":"paths:/contractors/{contractor}/payments/{payroll}:get:responses:200:content:application/json:schema:properties:void_of","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/contractors/{contractor}/payments/{payroll}:get:responses:200:content:application/json:schema:properties:voided_by","oasType":"schema","type":"unknown"}

net_paystring

net_pay_ytdstring

amountstring

amount_ytdstring

reimbursement_amountstring

reimbursement_amount_ytdstring

Example response

{
  "payroll": "pay_ZJySEmsnnRVerLTcRNYx",
  "payday": "2020-12-01",
  "period_start": "2020-12-01",
  "period_end": "2020-12-15",
  "company": {
    "trade_name": "Stark Industries",
    "legal_name": "Stark Industries, Inc.",
    "address": {
      "line1": "100 Crosby Street",
      "line2": "Suite 306",
      "city": "New York",
      "state": "NY",
      "postal_code": "10012",
      "country": "US"
    }
  },
  "contractor": {
    "first_name": "Tony",
    "last_name": "Stark",
    "type": "individual",
    "email": "tonystark@gmail.com",
    "address": {
      "line1": "801 N Brand Blvd #700",
      "city": "Glendale",
      "state": "CA",
      "postal_code": "91203",
      "country": "US"
    }
  },
  "net_pay": "1015.00",
  "net_pay_ytd": "1015.00",
  "amount": "1000.00",
  "amount_ytd": "1000.00",
  "reimbursement_amount": "15.00",
  "reimbursement_amount_ytd": "15.00"
}