Employee rates

The employee rate object provides information about compensation for a specified employee and date range. The rate can be either hourly or annual.

List employee rates

get/objects/company-config/employee-rate

Returns a collection with a key, ID, and link for each employee rate. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/employee-rate/1"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/employee-rate/3"
      },
    • {
      • "key": "5",
      • "id": "5",
      • "href": "/objects/company-config/employee-rate/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an employee rate
get/objects/company-config/employee-rate/{key}
Returns detailed information for a specified employee rate.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an employee rate.


 
 Example:  111
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "28",
    • "key": "28",
    • "employee": {
      • "key": "7",
      • "id": "MGR3",
      • "name": "PM Dept - Manager",
      • "href": "/objects/company-config/employee/7"
      },
    • "hourlyRate": null,
    • "annualSalary": "2080",
    • "startDate": "2000-01-01",
    • "endDate": "2010-12-31",
    • "audit": {
      • "createdDateTime": "2016-06-28T20:44:38Z",
      • "modifiedDateTime": "2016-06-28T20:44:38Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "href": "/objects/company-config/employee-rate/28"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an employee rate
delete/objects/company-config/employee-rate/{key}
Deletes an employee rate.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an employee rate.


 
 Example:  111
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}