^
MK logo Login

Guides

Getting Started
  Introduction
  Your business settings
  Export from other systems
  Add an employee
  Clock on/off
  Timesheet Software
  Grouping Employees
  Locations

Rostering
  The roster process
  Roster templates
  Roster calendar
  Calendar View
  SMS Rosters

Timesheets
  The timesheet process
  Timesheet
  Timesheet vs roster
  Timesheet from roster

Payroll
  The payroll process
  A payrun
  Rate rules
  Shift rules
  Break rules
  Deduction rules
  Extra rules
  Time in lieu
  Public Holiday

Leave request
  The leave request process
  Leave request review
  Leave payroll process

Reports
  Group Certificates
  Xero Integration

Other features
  Messaging

SuperChoice
  Processing super

SuperChoice (Old process)
  Super clearing house
  SuperChoice setup
  Adding super fund
  Adding employees
  Super payment

Employees
  Employee console
  iPhone login
  Push notification
  Requesting leave

Developers
  Partner Logo
  API Hello World
  API Add employee

  Print Guide
Guide - api add employee payroll

Add employee via developer API


Add a new employee to Microkeeper, this guide explains how to create a new employee profile using the developer API.




Step 1

Before starting this tutorial make sure you have completed the Hello World tutorial.

Complete the hello_world tutorial Hello World




Step 2

Set the mk_action variable and mk_data variable

Variable nameValue - Minimum requirement
mk_action

add_employees

mk_data

{ "Employees":[{"firstname":"John", "lastname":"Smith"}] }




Step 3

List of available fields

The minimum fields required to add a new employee to Microkeeper are the first name and last name, if missing no employees will be added.

Here is a full list of variables that can be added to mk_data to fill an employees profile.

If a field is missing a default or blank value will be set.

If an unknown format is supplier, the employees profile will still be created, but that field will be missing and no error will be displayed.

Verify the data has been passed successfully by inspecting the employee profile in Microkeeper.


Variable name

Description

Excepted formats

Example

firstname

Given name

Alpha

John

lastname

Surname

Alpha

Smith

email

Email

Email

update@me.com

phoneno

Mobile number

Numeric

0401 321 321

home_no

Home number

Numeric

03 5211 2233

kin_name

Next of kin name

Alpha

Roger

kin_no

Next of kin phone number

Numeric

03 5244 0011

address

Address line 1

Alphanumeric

Unit 2

address2

Address line 2

Alphanumeric

1 Smith St

city

Suburb

Alpha

Belmont

state

State (OTH for overseas)

VIC,NSW,NT,QLD,SA,TAS,WA,OTH

VIC

timezone

Time zone

Australia/Victoria etc

If missing will default to state

Australia/Victoria

postcode

Postcode

Numeric

3216

country

Country

Alpha

Australia

dob

Date of birth

dd/mm/yyyy or yyyy-mm-dd

23/11/1970

startdate2

Hire date

dd/mm/yyyy or yyyy-mm-dd

20/10/2014

terdate2

Termination date

dd/mm/yyyy or yyyy-mm-dd

20/10/2014

sex

Gender

F,Female,1

M,Male,2

M

rate

Pay rate

Decimal - Dollar value

16.1943

tax

Tax scale

1=Tax-free threshold

3=No tax-free threshold

4=No tax

5=Foreign Resident

1

help

HELP PAYG tax

Boolean

1

tax_per

Fixed Tax percentage

Integer - Percentage

20

tax_add

Tax offset

-1000 to +1000 - Dollar value

50

etfn

Tax file number

Numeric

321 321 321

super_fundSuper fund

String

USI / SPIN / Fund Name

A search is made to try 
and find a match, if found the 
ID of the fund will be set, if a
unique match can not be found this 
will need to be manually corrected.

82004832237178

or

RES0101AU

or

REST

super_no

Super member numberAplanumeric655655655

basichours

Basic hours

Decimal - Hours

38

salary

Salary

T=True

F=False

T

status

Employment status

F,f,FT,FULLTIME,Full Time

C,c,CA,CASUAL,Casual

P,p,PT,PARTTIME,Part Time

Sub-Contractor

Full Time

entitledal

Entitled annual leave weeks

Decimal - Weeks

4

rdo

Rostered day off hours deducted

Integer - Hours

2

leaveloading

Annual leave loading

Decimal - Percentage

17.5

entitledsickleave

Entitled personal leave

Decimal - Weeks

2

entitled_long

Entitled long service leave

Decimal - 1 week in x

60

preacal

Pre-accumulated annual leave

Decimal - Hours

123.32

pre_long

Pre-accumulated long service leave

Decimal - Hours

123.32

pre_sick

Pre-accumulated personal leave

Decimal - Hours

123.32

prerdo

Pre-accumulated RDO

Decimal - Hours

123.32

prenet

Pre-accumulated net

Decimal - Dollar

10000.22

presuper

Pre-accumulated super above 9.5

Decimal - Dollar

10000.22

pretax

Pre-accumulated tax

Decimal - Dollar

10000.22

pregross

Pre-accumulated gross

Decimal - Dollar

10000.22

eTitle

Bank title account 1

String

Mr John Smith

eBSB

Bank BSB account 1

xxx-xxx

111-222

eAccountNo

Bank account no account 1

Numeric

123123123

split_pay

Split pay to account 2

nul,{blank}=NA

fix=Fix amount

per=Percentage

fix

split_amount

Split amount to account 2

Decimal - Percentage or Amount

200

eTitle2

Bank title account 2

String

Mr John Smith

eBSB2

Bank BSB account 2

xxx-xxx

111-222

eAccountNo2

Bank account number account 2

Numeric

111222333

split_pay3

Split pay to account 3

nul,{blank}=NA

fix=Fix amount

per=Percentage

nul

split_amount3

Split amount to account 3

Decimal - Percentage or Amount

0

eTitle3

Bank title account 3

String


eBSB3

Bank BSB account 3

xxx-xxx


eAccountNo3

Bank account number account 3

Numeric


EmployeeIDYour systems employee IDAlphanumeric

55555




Step 4

The reponse will be in JSON and in the format outlined in the Hello World example.

When the employee is added to the Microkeeper database an EID (Employee ID) is created, the EID is included in the JSON response.

If you pass your EmployeeID this will be returned in the response from Microkeeper.

Successfull example

{ "success":"1", "authenticated":"1", "message":"2 employees added to Microkeeper", "data":{"EID":{"55555":68782,"55556":68783}} }