Moorepay HCM Support
API Reference

Add an employee

post
https://api02.naturalhr.net/api/v1/employee
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

For information on how to use Custom Employee Fields in the employee endpoint see https://apidocs.naturalhr.com/docs/custom-employee-fields

Body Params
string

Employee works ID - i.e. your reference for them

string

Employee title

string
required

Employee first name

string

Employee known as name

string

Employee middle / other name(s)

string
required

Employee last name / surname

string

Employee address line 1

string

Employee address line 2

string

Employee town / city

string

Employee county / state

string

Employee postcode/zip code

string

Employee country Expected value

string

Employee home telephone number

string

Employee home mobile number

string

Employee home email address

string

Employee work telephone number

string

Employee work mobile number

string

Employee work email address

string

Employee Skype ID

string

Employee gender Genders

string

Employee marital status Marital status

string

Employee nationality Expected value

string

Employee ethnicity Expected value

string

Employee sexuality Lookup value

string

Employee religion Lookup value

string

Does this employee consider themselves disabled? Yes/No/Prefer not to say

string

Is this employee registered as disabled? Yes/No text

date
required

Employee date of birth

string
required

Employee national insurance / social security number

int32

Is this employee a first aider? Yes/No

int32

Is this employee a fire warden? Yes/No

int32
required

Is this employee active or archived? Employee active

date

Date the employee was added

date

Employee start date

double

The amount employee is paid

string

The employee's pay period Pay period

string

Employee bank sort code

string

Employee bank account number

string

Employee bank account name

string

The name of the employee's bank

string

Employee bank address

string

Employee bank IBAN number

string

Employee bank SWIFT number

string

Employee bank account currency Expected value

string

Employee bank beneficiary name

string

Employee bank country Expected value

int32

Natural HR system ID for the employee job title Lookup value

int32

Natural HR system ID for the employee job status Lookup value

date
required

Date the employee job details were last updated

date
required

Date the employee salary details were last updated

int32

Natural HR system ID for the reason code for the salary details update Lookup value

int32

Natural HR system ID for the employee'e employee status

date
required

Date the employee allowance details were last updated

int32

Natural HR system ID for the reason code for the allowance details update Lookup value

int32

Natural HR system ID for the employee headcount classification Lookup value

int32

Natural HR system ID for the employee region Lookup value

int32

Natural HR system ID for the employee department Lookup value

int32

Natural HR system ID for the employee sub department Lookup value

int32

Natural HR system ID for the employee division Lookup value

int32

Natural HR system ID for the employee company Lookup value

int32

Natural HR system ID for the employee business unit Lookup value

int32

Natural HR system ID for the employee cost centre Lookup value

string

Employee desk number / location

int32

Natural HR system ID for the employee job grade Lookup value

int32

Natural HR system ID for the employee manager Lookup value

int32

Natural HR system ID for the employee approver Lookup value

double

Employee annual holiday entitlement - ONLY if using pool allowance

double

Employee hours per week

date

Employee probationary period end date

date

Employee leave date

date

Employee contract end date

int32

Is this employee a key employee? Yes/No

int32

Natural HR system ID for the employee head of department Lookup value

date

The employee's resignation date

date

The date of the employee's last working day

int32

Natural HR system ID for the employee super approver Lookup value

int64

General comments regarding the employee

int64

The employee's educational history

string

Your finance ID for the employee

int64

Leave comments for the employee if they have a leave date set

int32

Natural HR system ID for the employee leave reason Lookup value

string

The notice period the employee is required to give

string

QR code for the employee

int32

Is the employee a regretted leaver? Yes/No

string

Natural HR system ID for the employee site Lookup value

double
required

Employee FTE

int64

The employee's skills

string

The meter used for the employee time off Time off meter

int32

The days the employee works, used if timeoff_meter is days Working days

string

The hours the employee works, used if timeoff_meter is hours Working hours

int32

Natural HR system ID for the accrual/length of service time off type Lookup value

string

Building Society Reference

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago