Retrieve an income and employment report

To explore the response body, click "Response" below.
To see an example in JSON, click the "201" icon on the right.
To see live data, fill out "Body params" and click "Try it".

Earnings Object

The earnings or earnings_ytd field is an array that contains all earnings.
Below is an example of what the earnings object could look like. Supported categories are: regular, bonus, commission, overtime, other_pay.

[
  {
    "name": "Regular",
    "amount": "38072.0",
    "category": "regular",
    "rate": "475.9",
    "units": "80"
  },
  {
    "name": "Bonus",
    "amount": "10000.0",
    "category": "bonus",
    "rate": null,
    "units": null
  }
]

Deductions Object

The deductions or deductions_ytd field is an array that contains all deductions.
Below is an example of what the deductions object could look like. Supported categories are: memo, medicare, retirement, benefit, socialsec, federal, state, garnishment, local, other.

[
  {
    "amount": "127.01",
    "category": "socialsec",
    "name": "Social Security Tax"
  },
  {
    "amount": "46.23",
    "category": "state",
    "name": "VA State Income Tax"
  },
  {
    "amount": "29.7",
    "category": "medicare",
    "name": "Medicare Tax"
  }
]