Lookup value
A lookup field is a field which expects a Natural HR system ID for the value.
This means that this value should be an integer and it should reference the system ID of the data it is referring to.
For example, if you are trying to specify a department ID and you wanted to enter "Sales" which has an ID of 123 you would enter 123 which we would then lookup and validate that 123 is a valid department ID for your company.
If it is not then this will cause an error and the action will fail and you will get an error.
Expected value
An expected value field is a field which expects a valid text representation to be entered - for example, when entering a country you enter the name of the country but it must be a valid country according to the list we maintain.
Below in the menu there are the expected values for 5 fields which currently use this:
Countries
Currencies
Ethnicities
Nationalities
Languages
Active
Default value: 0
| API value | Context |
|---|
| 0 | Archived/Inactive |
| 1 | Active |
Employee active
| API value | Context |
|---|
| 1 | Current / active employee |
| 2 | Archived / leaver employee |
Employee status
| API value | Context |
|---|
| Current | Current / active employee |
| Archived | Archived / leaver employee |
Approved
Default value: 0
| API value | Context |
|---|
| 0 | Pending approval - not in workflow |
| 99 | Pending approval - in workflow |
| 1 | Approved |
| 2 | Declined |
Yes/No
Default value: 0
Yes/No/Not given
Default value: 0
| API value | Context |
|---|
| 0 | Not given |
| 1 | Yes |
| 2 | No |
Yes/No/Prefer not to say
| API value | Context |
|---|
| Yes | Yes |
| No | No |
| Prefer not to say | Prefer not to say |
Yes/No text
| API value | Context |
|---|
| Yes | Yes |
| No | No |
Genders
| API value | Context |
|---|
| Female | Female |
| Male | Male |
| Not | Not given |
Marital status
| API value | Context |
|---|
| Single | Single |
| Married | Married |
| Engaged | Engaged |
| Civil partnership | Civil partnership |
| Co habiting | Co habiting |
| Living with partner | Living with partner |
| Divorced | Divorced |
| Separated | Separated |
| Widowed | Widowed |
| Not specified | Not specified |
Pay period
| API value | Context |
|---|
| Per hour | Per hour |
| Per day | Per day |
| Per week | Per week |
| Per month | Per month |
| Per annum | Per annum |
Working days
This should only be used if the time off meter is set to DAYS.
This field expects a string indicating the days the employee works per week - this is shown as 12345, for example, for someone who works Monday to Friday or 45 for someone who works Thursday and Friday.
| Value | Context |
|---|
| 1 | Monday |
| 2 | Tuesday |
| 3 | Wednesday |
| 4 | Thursday |
| 5 | Friday |
| 6 | Saturday |
| 7 | Sunday |
Working hours
This should only be used if the time off meter is set to HOURS.
This field expects a comma separated string indicating the hours the employee works per week broken down by day.
Unlike working days, this requires an entry for each day even if the employee is not working that day - for example if someone works 8 hours per day every day then it should read 8,8,8,8,8,,,
Notice the double comma at the end indicating they do not work on those days.
Date format
All dates are expected to be in the format yyyy-mm-dd regardless of the system setting for localisation - this is both when using POST and GET.
Time
When entering a time, the format should be HH:ii:ss
For example, 22:14:54
Time off meter
Default value: blank
| API value | Context |
|---|
| days / blank | Days |
| hours | Hours |
Deducting values
| API value | Context |
|---|
| 0 | Does not deduct from any allowance |
| 1 | Yes from pool |
| 2 | Yes from individual allowance |
| 3 | Accrued on length of service |
| 4 | Limited allowance |
| 5 | Accrued on length of service (alternate) |
| 6 | Summary |
AM/PM
You should only enter AM or PM if the duration of the request is less than 1
Default value: all / blank
| |
|---|
| all / blank | All day |
| am | AM |
| pm | PM |
User groups
| API value | Context |
|---|
| Employee | Employee |
| Manager | Manager |
| HR | HR |
| Finance | Finance |
| Facilities | Facilities |
| Trainer | Trainer |
| Recruiter | Recruiter |
| Approver | Approver |
| admin | Admin - NOTE THE LOWER CASE a in the API VALUE |
User group 2
This can only be used if user group is Manager
| API value | Context |
|---|
| Finance | Finance |
| Facilities | Facilities |
| Trainer | Trainer |
| Recruiter | Recruiter |
User status
| API value | Context |
|---|
| Enabled | Enabled/Active |
| Disabled | Disabled/Inactive |
Training internal/external
| API value | Context |
|---|
| int | Internal |
| ext | External |
Training results
| API value | Context |
|---|
| Attended | Attended |
| Cancelled | Cancelled |
| Completed | Completed |
| Did not show | Did not show |
| Failed | Failed |
| Passed | Passed |
Job role manager
Contract type
| API value | Context |
|---|
| Permanent | Permanent |
| Temporary | Temporary |
| Contractor | Contractor |
| Zero hour | Zero hours |
| Other | Other |
Full time / part time
| API value | Context |
|---|
| Full time | Full time |
| Part time | Part time |
Traffic light
| API value | Context |
|---|
| 0 | No value |
| 1 | Green |
| 2 | Orange |
| 3 | Red |
Issued
| API value | Context |
|---|
| 0 | Draft |
| 1 | Approved - not issued |
| 2 | Declined |
| 5 | Issued |
| 99 | Pending approval |
Company holiday types
| API value | Context |
|---|
| 1 | Mandatory day |
| 2 | Shutdown day |
Array
| API value | Context |
|---|
| ["Site name 1", "Site name 2", "Site name 3"] | Site with the name of "Site name 1", site with the site name of "Site name 2" etc |
