NameDescriptionTypeAdditional information
LeavePlanningId

integer

None.

ChangeType

The ChangeType for the LeavePlan. Only Add (Insert) is currently supported.

string

Required

Matching: ([^'"])*

Max length: 20

ChangeStatus

The ChangeStatus for the LeavePlan. Do not supply

string

Matching: ([^'"])*

Max length: 20

EmpCode

The EmpCode for the LeavePlan.

string

Matching: ([^'"])*

Max length: 20

LeaveType

The LeaveType for the LeavePlan. Values SickLeave, AnnualLeave, LongServiceLeave, UserDefinedLeave,

string

Required

Matching: ([^'"])*

Max length: 20

LeaveCode

The UserDefinedLeave LeaveCode for the LeavePlan.

string

Matching: ([^'"])*

LeaveReason

The Leave Reason for the LeavePlan. Leave Reason codes may be found using api/Lookups?type=LeaveReason

string

Required

Matching: ([^'"])*

Max length: 50

StartDate

The Start Date for the LeavePlan.

date

Required

EndDate

The End Date for the LeavePlan.

date

Required

Override

The Override for the LeavePlan. Must be true to for value in HoursTaken to be accepted.

boolean

Required

PayInAdvance

The Pay In Advance flag for the LeavePlan.

boolean

None.

HoursTaken

The Hours Taken for the LeavePlan required if Override is set

decimal number

None.

DaysTaken

The Days Taken for the LeavePlan may be supplied if Override is set

decimal number

None.

ReferenceNumber

A reference, ideally unique, supplied by the client to identify the leave plan

string

Matching: ([^'"])*

Max length: 20

ApiUserName

string

None.

ApiUserType

string

None.

ApiUserId

integer

None.

DatabaseType

string

None.

PayrollLink
 Token

globally unique identifier

None.

ErrorMessage

string

None.