1. Home
  2. Docs
  3. Employee Sync
  4. Read Employee Wage Data
  5. Understanding the /wages Response

Understanding the /wages Response

Now that you know how to make a basic request to retrieve wage data for a specific user, let’s explore some example responses:

Example Response 1

{
    "status": "success",
    "data": {
        "current": [
            {
                "effective_date": "2020-12-01",
                "user_id": 1199471,
                "role_id": null,
                "wage_type": "weekly_salary",
                "wage_cents": 120000
            },
            {
                "effective_date": "2019-10-28",
                "user_id": 1199471,
                "role_id": 144064,
                "wage_type": "hourly",
                "wage_cents": 3000
            }
        ],
        "upcoming": []
    },
    "message": ""
}

Example Response 2

{
    "status": "success",
    "data": {
        "current": [
            {
                "effective_date": "2020-12-24",
                "user_id": 1199304,
                "role_id": null,
                "wage_type": "hourly",
                "wage_cents": 1200
            },
            {
                "effective_date": "2020-12-24",
                "user_id": 1199304,
                "role_id": 157327,
                "wage_type": "hourly",
                "wage_cents": 1700
            },
            {
                "effective_date": "2020-12-24",
                "user_id": 1199304,
                "role_id": 157329,
                "wage_type": "hourly",
                "wage_cents": 1500
            }
        ],
        "upcoming": []
    },
    "message": ""
}

You’ll mostly be working with only a few fields in each user object in the response. Here are some details on them:

wages FieldTypeExplanation
effective_dateDateDate that this wage object comes into effect
user_idNumericID of the user that this wage object is for
role_idNumericID of the role that this wage object is for. May be set to null for weekly salaries and role-agnostic wages
wage_typeStringMay be set to weekly_salary for salaried users and hourly for hourly wage users
wage_centsNumericAmount for the wage object in cents