Welcome to the Civica Self Service Web API

Our Web API allows you to consume a number of services to fully integrate with our core products directly over HTTP.

To learn more about the Web API or other Civica products visit the Civica Website to get in touch or contact our Support team. This page will provide an overview on the API and methods as well as sample invocations to help you get the most from the interface.

Payload Information:

All payloads must contain a header with the required information for validation and authentication when invoking any of the methods available via the Civica HRP Web API. The standard XML format of a payload for all methods, is detailed below. Please note that the header section must be included for all methods, followed by the parameters section which expects relevant information to process a method call, all which are detailed in more depth both below and within the example invocation pages.

<CivicaHRPWebApi>
  <Header>
      <InvokeType>Test</InvokeType>
      <Application>HR Unity Online</Application>
      <Licence>Valid Developer Licence</Licence>
      <LoggedInUser></LoggedInUser>
      <UserKey></UserKey>
  </Header>
  <Parameters>
    Appropriate parameters
  </Paramters>
</CivicaHRPWebApi>

API Supported Methods:

Absence Methods

AddAnAbsence()
The AddAnAbsence method was designed to let other developers interface with our core products by adding an absence for an existing employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
    <Personnel_Number></Personnel_Number>
    <Date_From></Date_From>
    <Date_To></Date_To>
    <Certified></Certified>
    <Industrial_Injury></Industrial_Injury>
    <Duration></Duration>
    <Hours_Mins></Hours_Mins>
    <Absence_Code></Absence_Code>
    <Absence_Notes></Absence_Notes>
    <Time_From></Time_From>
    <Time_To></Time_To>
    <OtherID></OtherID>
</Parameters>

Learn more…
DeleteAnAbsence()
The DeleteAnAbsence method was designed to let other developers interface with our core products by using this method to delete an absence record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <UniqueID>[One of UniqueID or OtherID must be provided]</UniqueID>
  <OtherID></OtherID>
</Parameters>

Learn more…
EditAnAbsence()
The EditAnAbsence method was designed to let other developers interface with our core products by editing an absence for an existing employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
    <Personnel_Number></Personnel_Number>
  <UniqueID>[One of UniqueID or OtherID must be provided]</UniqueID>
  <OtherID></OtherID>
    <AbsenceCode></AbsenceCode>
    <Date_From></Date_From>
    <Date_To></Date_To>
    <Time_From></Time_From>
    <Time_To></Time_To>
    <Duration></Duration>
    <HoursMins></HoursMins>
    <AbsenceNotes></AbsenceNotes>
</Parameters>

Learn more…
GetAbsenceDuration()
The GetAbsenceDuration method was designed to let other developers interface with our core products by using this method to calculate the duration of an absence. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Date_From></Date_From>
  <Date_To></Date_To>
  <Time_From></Time_From>
  <Time_To></Time_To>
</Parameters>

Learn more…
GetEmployeeAbsencesForDay()
The GetEmployeeAbsencesForDay method was designed to let other developers interface with our core products by using this method to select a collection of an Employee's Absences for a day. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Date></Date>
</Parameters>

Learn more…
GetAbsenceHistory()
The GetAbsenceHistory method was designed to let other developers interface with our core products by using this method to get an absence history for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <HistoryStartDate></HistoryStartDate>
  <HistoryEndDate></HistoryEndDate>
</Parameters>

Learn more…
GetAbsenceMap()
The GetAbsenceMap method was designed to let other developers interface with our core products by using this method to get an employee's absence map. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <Company></Company>
  <Filter1>['By Team', 'By Department', 'By Location', 'By Company', 'By Grade', 'By Subordinates' or 'By Cost Centre']</Filter1>
  <Filter2>[Code for the filter you've selected (Not required for 'By Company' or 'By Subordinates')]</Filter2>
</Parameters>

Learn more…
GetAbsenceRemovableAbsences()
The GetAbsenceRemovableAbsences method was designed to let other developers interface with our core products by using this method to get an employee's removable absences. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
CreateAbsenceRequest()
The CreateAbsenceRequest method was designed to let other developers interface with our core products by using this method to create an absence request for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <StartTime></StartTime>
  <EndTime></EndTime>
  <Duration></Duration>
  <HoursMins></HoursMins>
  <AbsenceCode></AbsenceCode>
  <Notes></Notes>
</Parameters>

Learn more…
CreateAbsenceRetractionRequest()
The CreateAbsenceRetractionRequest method was designed to let other developers interface with our core products by using this method to create an absence retraction request for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <AbsenceID></AbsenceID>
  <Notes></Notes>
</Parameters>

Learn more…
GetAbsenceEmployeeAvailabilityExceptions()
The GetAbsenceEmployeeAvailabilityExceptions method was designed to let other developers interface with our core products by using this method to get an employee's availability exceptions. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetAbsenceEmployeeUnavailabilityExceptions()
The GetAbsenceEmployeeUnavailabilityExceptions method was designed to let other developers interface with our core products by using this method to get an employee's unavailability exceptions. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetAbsenceHolidayYearStart()
The GetAbsenceHolidayYearStart method was designed to let other developers interface with our core products by using this method to get an employee's holiday year start. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetAbsenceEmployeeAvailabilityWeek()
The GetAbsenceEmployeeAvailabilityWeek method was designed to let other developers interface with our core products by using this method to get an employee's availability for the week. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeAbsenceCalendar()
The GetEmployeeAbsenceCalendar method was designed to let other developers interface with our core products by using this method to get absence calendar entries for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Calendar_Start_Date></Calendar_Start_Date>
</Parameters>

Learn more…
GetHolidaySchemeStatutoryHolidays()
The GetHolidaySchemeStatutoryHolidays method was designed to let other developers interface with our core products by using this method to get statutory holidays in a holiday scheme for a date range. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <HolidaySchemeNumber></HolidaySchemeNumber>
  <StartDate></StartDate>
  <EndDate></EndDate>
</Parameters>

Learn more…
AbsenceStageCheck()
The AbsenceStageCheck method was designed to let other developers interface with our core products by using this method to see if an employee's sickness absence exceeds an absence stage. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<EndDate></EndDate>
</Parameters>

Learn more…
GetAbsenceRequestCodes()
The GetAbsenceRequestCodes method was designed to let other developers interface with our core products by using this method to get a list of absence request codes. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
</Parameters>

Learn more…
GetAbsenceSummaryCodes()
The GetAbsenceSummaryCodes method was designed to let other developers interface with our core products by using this method to get a list of absence summary codes. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
</Parameters>

Learn more…

Administration Methods

CreateCostCentre()
The CreateCostCentre method was designed to let other developers interface with our core products by using this method to create a new Cost Centre. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Company></Company>
  <Cost_Centre_Code></Cost_Centre_Code>
  <Description></Description>
  <Nominal_Code></Nominal_Code>
</Parameters>

Learn more…
GetAdministrationApprovalLevels()
The GetAdministrationApprovalLevels method was designed to let other developers interface with our core products by using this method to get approval levels. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetAdministrationAccessRights()
The GetAdministrationAccessRights method was designed to let other developers interface with our core products by using this method to get an employee's access rights. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetAdministrationAccessRightsSubLevel()
The GetAdministrationAccessRightsSubLevel method was designed to let other developers interface with our core products by using this method to get an employee's access rights for a sub menu. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Menu_Name></Menu_Name>
</Parameters>

Learn more…
GetAdministrationOtherAccess()
The GetAdministrationOtherAccess method was designed to let other developers interface with our core products by using this method to get an employee's other access rights. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetAdministrationAuditTrail()
The GetAdministrationAuditTrail method was designed to let other developers interface with our core products by using this method to get a list of employee audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time. The Application parameter filters by application:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
  <Application>HRU Online</Application>
</Parameters>

Learn more…
GetAdministrationAuditTrailAbsences()
The GetAdministrationAuditTrailAbsences method was designed to let other developers interface with our core products by using this method to get a list of absence audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailAbsences2()
The GetAdministrationAuditTrailAbsences2 method was designed to let other developers interface with our core products by using this method to get a list of absence audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
  <ExcludeSummaryCodes></ExcludeSummaryCodes>
  <Personnel_Number></Personnel_Number>
  <ApprovedOnly></ApprovedOnly>
  <FilterType></FilterType>
  <FilterValue></FilterValue>
</Parameters>

Learn more…
GetAdministrationAuditTrailCostCentres()
The GetAdministrationAuditTrailCostCentres method was designed to let other developers interface with our core products by using this method to get a list of cost centre audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailCountries()
The GetAdministrationAuditTrailCountries method was designed to let other developers interface with our core products by using this method to get a list of country audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailDepartments()
The GetAdministrationAuditTrailDepartments method was designed to let other developers interface with our core products by using this method to get a list of department audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailEmployees()
The GetAdministrationAuditTrailEmployees method was designed to let other developers interface with our core products by using this method to get a list of employee audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailEmployees2()
The GetAdministrationAuditTrailEmployees2 method was designed to let other developers interface with our core products by using this method to get a list of employee audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
  <FilterType></FilterType>
  <FilterValue></FilterValue>
</Parameters>

Learn more…
GetAdministrationAuditTrailLocations()
The GetAdministrationAuditTrailLocations method was designed to let other developers interface with our core products by using this method to get a list of location audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailSections()
The GetAdministrationAuditTrailSections method was designed to let other developers interface with our core products by using this method to get a list of 'Section' lookup audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
</Parameters>

Learn more…
GetAdministrationAuditTrailSkills()
The GetAdministrationAuditTrailSkills method was designed to let other developers interface with our core products by using this method to get a list of employee skill audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
  <Personnel_Number></Personnel_Number>
  <FilterType></FilterType>
  <FilterValue></FilterValue>
</Parameters>

Learn more…
GetAdministrationAuditTrailTraining()
The GetAdministrationAuditTrailTraining method was designed to let other developers interface with our core products by using this method to get a list of employee training audit trail records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory) - the IsUTC parameter indicates whether the start and end are UTC or local time:
<Parameters>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <IsUTC>False</IsUTC>
  <Personnel_Number></Personnel_Number>
  <FilterType></FilterType>
  <FilterValue></FilterValue>
</Parameters>

Learn more…
GetAdministrationEmailNotificationList()
The GetAdministrationEmailNotificationList method was designed to let other developers interface with our core products by using this method to get a list of email notifications. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetAdministrationFormItems()
The GetAdministrationFormItems method was designed to let other developers interface with our core products by using this method to get a list of form items. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetAdministrationSSUsageLogs()
The GetAdministrationSSUsageLogs method was designed to let other developers interface with our core products by using this method to get the SS usage log. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<StartDate></StartDate>
<EndDate></EndDate>
</Parameters>

Learn more…
GetAdministrationSSUsageLogsUser()
The GetAdministrationSSUsageLogsUser method was designed to let other developers interface with our core products by using this method to get the SS usage log for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <StartDate></StartDate>
  <EndDate></EndDate>
</Parameters>

Learn more…
GetAdministrationSSModuleStats()
The GetAdministrationSSModuleStats method was designed to let other developers interface with our core products by using this method to get a list of SS module statistics. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetAdministrationSSUserLog()
The GetAdministrationSSUserLog method was designed to let other developers interface with our core products by using this method to get a list of user logins for a date. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Date></Date>
</Parameters>

Learn more…
GetAdministrationUserProfileList()
The GetAdministrationUserProfileList method was designed to let other developers interface with our core products by using this method to get a list of users and their profiles. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetAdministrationWindowsLogons()
The GetAdministrationWindowsLogons method was designed to let other developers interface with our core products by using this method to get a list of windows logons. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<OnlyPasswordResets>['true' or 'false']</OnlyPasswordResets>
</Parameters>

Learn more…

Common Methods

HelloWorld()
The HelloWorld method was designed to let other developers test connectivity and assess invocation of the Civica Self Service Web API. This method requires no payload. Learn more…
GetDashboardApprovalsList()
The GetDashboardApprovalsList method was designed to let other developers interface with our core products by using this method to get a list of an employee's approvals to action. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetDashboardTaskList()
The GetDashboardTaskList method was designed to let other developers interface with our core products by using this method to get a list of an employee's tasks to action. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetDashboardClaimList()
The GetDashboardClaimList method was designed to let other developers interface with our core products by using this method to get a list of an employee's claims. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonDatabaseVersion()
The GetCommonDatabaseVersion method was designed to let other developers interface with our core products by using this method to get a the database version. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonCompanies()
The GetCommonCompanies method was designed to let other developers interface with our core products by using this method to get a list of companies. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonUserCount()
The GetCommonUserCount method was designed to let other developers interface with our core products by using this method to get the user count. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonConfigurationForCompany()
The GetCommonConfigurationForCompany method was designed to let other developers interface with our core products by using this method to get a list of configuration for a specific company or all companies (leave company parameter empty), the method takes the following modes: location, posts, scp, costcentre, department and grade. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Mode></Mode>
<Company></Company>
</Parameters>

Learn more…
GetCommonCostCentresForCompany()
The GetCommonCostCentresForCompany method was designed to let other developers interface with our core products by using this method to get a list of cost centres in a company. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
</Parameters>

Learn more…
GetCommonDepartmentsForCompany()
The GetCommonDepartmentsForCompany method was designed to let other developers interface with our core products by using this method to get a list of departments in a company. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
</Parameters>

Learn more…
GetCommonGradesForCompany()
The GetCommonGradesForCompany method was designed to let other developers interface with our core products by using this method to get a list of grades in a company. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
</Parameters>

Learn more…
GetCommonSCPCodesForCompany()
The GetCommonSCPCodesForCompany method was designed to let other developers interface with our core products by using this method to get a list of SCP codes in a company. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
</Parameters>

Learn more…
GetCommonLocationsForCompany()
The GetCommonLocationsForCompany method was designed to let other developers interface with our core products by using this method to get a list of locations in a company. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
</Parameters>

Learn more…
GetCommonPostsForCompany()
The GetCommonPostsForCompany method was designed to let other developers interface with our core products by using this method to get a list of posts in a company. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
</Parameters>

Learn more…
GetCommonPayrollGroups()
The GetCommonPayrollGroups method was designed to let other developers interface with our core products by using this method to get a list of payroll groups. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonPayrollGroupDetails()
The GetCommonPayrollGroups method was designed to let other developers interface with our core products by using this method to get a list of payroll group records including extended details. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonSubordinates()
The GetCommonSubordinates method was designed to let other developers interface with our core products by using this method to get a list of an employee's subordinates. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonSubordinateNames()
The GetCommonSubordinateNames method was designed to let other developers interface with our core products by using this method to get a list of an employee's subordinates' names. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonShiftPatternForWeek()
The GetCommonShiftPatternForWeek method was designed to let other developers interface with our core products by using this method to get an employee's shift patterns for a week. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<StartDate></StartDate>
</Parameters>

Learn more…
GetCommonIsEmployeeLeaver()
The GetCommonIsEmployeeLeaver method was designed to let other developers interface with our core products by using this method to get if an employee is a leaver. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonMostUsedDepartment()
The GetCommonMostUsedDepartment method was designed to let other developers interface with our core products by using this method to get the most used Department in Self Service. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonMostUsedCompany()
The GetCommonMostUsedCompany method was designed to let other developers interface with our core products by using this method to get the most used Company in Self Service. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonManagers()
The GetCommonManagers method was designed to let other developers interface with our core products by using this method to get a list of managers. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetCommonSupervisorSubordinates()
The GetCommonSupervisorSubordinates method was designed to let other developers interface with our core products by using this method to get a list of an employee's supervisor subordinates. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonEmployeeName()
The GetCommonEmployeeName method was designed to let other developers interface with our core products by using this method to get an employee's name. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonLastCalcRun()
The GetCommonLastCalcRun method was designed to let other developers interface with our core products by using this method to get when an employee last ran a calculation. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonCalcHoursForWeek()
The GetCommonCalcHoursForWeek method was designed to let other developers interface with our core products by using this method to get the calculated hours for an employee for a week. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<WeekStart></WeekStart>
</Parameters>

Learn more…
GetCommonNormalHours()
The GetCommonNormalHours method was designed to let other developers interface with our core products by using this method to get the normal hours for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonExcessHoursForWeek()
The GetCommonExcessHoursForWeek method was designed to let other developers interface with our core products by using this method to get the excess hours for an employee for a week. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<WeekStart></WeekStart>
</Parameters>

Learn more…
GetCommonLastPeriodEnd()
The GetCommonLastPeriodEnd method was designed to let other developers interface with our core products by using this method to get the last period end for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonFlexiPeriodEnd()
The GetCommonFlexiPeriodEnd method was designed to let other developers interface with our core products by using this method to get the flexi period end for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonHoursForThisPeriod()
The GetCommonHoursForThisPeriod method was designed to let other developers interface with our core products by using this method to get an employee's hours for the current period. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonFlexiBalanceBForward()
The GetCommonFlexiBalanceBForward method was designed to let other developers interface with our core products by using this method to get an employee's balance b forward. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonCurrentFlexiBalance()
The GetCommonCurrentFlexiBalance method was designed to let other developers interface with our core products by using this method to get an employee's current flexi balance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonCurrentAnnualisedBankedBalance()
The GetCommonCurrentAnnualisedBankedBalance method was designed to let other developers interface with our core products by using this method to get an employee's current annualised banked balance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonFirstAndLastClockForDay()
The GetCommonFirstAndLastClockForDay method was designed to let other developers interface with our core products by using this method to get an employee's first and last clock for a day. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Date></Date>
</Parameters>

Learn more…
GetCommonIsReturnToWork()
The GetCommonIsReturnToWork method was designed to let other developers interface with our core products by using this method to get an employee's return to work details. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…

Document Methods

DeleteDocument()
The DeleteDocument method was designed to let other developers interface with our core products by deleting a linked document. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<DocumentGUID></DocumentGUID>
</Parameters>

Learn more…
EditEmployeeDocumentUpload()
The EditEmployeeDocumentUpload method was designed to let other developers interface with our core products by uploading an employee document. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <File_Data></File_Data>
  <File_Name></File_Name>
  <Linked_ID></Linked_ID>
  <Linked_Type></Linked_Type>
</Parameters>

Learn more…
GetDocuments()
The GetDocuments method was designed to let other developers interface with our core products by retrieving a list of documents of a specified type. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Linked_ID></Linked_ID>
  <Linked_Type></Linked_Type>
</Parameters>

Learn more…

Employee Methods

EditEmployeeDetails()
The EditEmployeeDetails method was designed to let other developers interface with our core products by editing existing employee details. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Employee_Identifier></Employee_Identifier>
  <Table_Name></Table_Name>
  <Field_Name></Field_Name>
  <New_Value></New_Value>
</Parameters>

Learn more…
CreateEmployeeDeviceRecord()
The CreateEmployeeDeviceRecord method was designed to let other developers interface with our core products by adding a new employee device such as a mobile phone. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Device_Type></Device_Type>
  <OS_Version></OS_Version>
  <Device_ID></Device_ID>
</Parameters>

Learn more…
CreateEmployeePolicy()
The CreateEmployeePolicy method was designed to let other developers interface with our core products by adding a new employee policy. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Topic></Topic>
  <Version></Version>
  <Description></Description>
  <InformEmployees></InformEmployees>
  <ForceRead></ForceRead>
  <Category_ID></Category_ID>
  <Company_ID></Company_ID>
</Parameters>

Learn more…
GetEmployeeBankedHoursRemaining()
The GetEmployeeBankedHoursRemaining method was designed to let other developers interface with our core products by using this method to select an Employee's Banked Hours balance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeDefaultPost()
The GetEmployeeDefaultPost method was designed to let other developers interface with our core products by using this method to select an Employee's default Post. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeDefaultSite()
The GetEmployeeDefaultSite method was designed to let other developers interface with our core products by using this method to select an Employee's default Site. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeDetails()
The GetEmployeeDetails method was designed to let other developers interface with our core products by using this method to select an existing Employee's details. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeHolidayBalance()
The GetEmployeeHolidayBalance method was designed to let other developers interface with our core products by using this method to select an Employee's Holiday balance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeIsManager()
The GetEmployeeIsManager method was designed to let other developers interface with our core products by using this method to select whether an Employee is marked as a Manager. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeLastHoliday()
The GetEmployeeLastHoliday method was designed to let other developers interface with our core products by using this method to select an Employee's last Holiday occurrence. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeLastSickness()
The GetEmployeeLastSickness method was designed to let other developers interface with our core products by using this method to select an Employee's next Sickness occurrence. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeNextHoliday()
The GetEmployeeNextHoliday method was designed to let other developers interface with our core products by using this method to select an Employee's next Holiday occurrence. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeNextTraining()
The GetEmployeeNextTraining method was designed to let other developers interface with our core products by using this method to select an Employee's next Training occurrence. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeNextYearsHolidayBooked()
The GetEmployeeNextYearsHolidayBooked method was designed to let other developers interface with our core products by using this method to select an Employee's Holiday taken next year value. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeePosts()
TThe GetEmployeePosts method was designed to let other developers interface with our core products by using this method to select an Employee's Posts. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<IncludeLeavers></IncludeLeavers>
</Parameters>

Learn more…
GetEmployeeSkills()
The GetEmployeeSkills method was designed to let other developers interface with our core products by using this method to retrieve a list of employee skill records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeTodaysActivityCode()
The GetEmployeeTodaysActivityCode method was designed to let other developers interface with our core products by using this method to select an Employee's Activity code. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeToilBalance()
The GetEmployeeToilBalance method was designed to let other developers interface with our core products by using this method to select an Employee's TOIL balance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeTOIL()
The GetEmployeeTOIL method was designed to let other developers interface with our core products by using this method to get TOIL entries for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Tax_Year></Tax_Year>
</Parameters>

Learn more…
GetEmployeeNextAppraisalDate()
The GetEmployeeNextAppraisalDate method was designed to let other developers interface with our core products by using this method to get the next appraisal date for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
AddNewEmployeeAccident()
The AddNewEmployeeAccident method was designed to let other developers interface with our core products by using this method to add an accident entry for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Date></Date>
  <Time></Time>
  <Accident_Type></Accident_Type>
  <Description></Description>
  <Location></Location>
  <Investigators></Investigators>
  <Internal_HSE_Notified></Internal_HSE_Notified>
  <External_HSE_Notified></External_HSE_Notified>
  <Statements_Taken></Statements_Taken>
  <Photos_Taken></Photos_Taken>
  <Injuries></Injuries>
  <Follow_Up></Follow_Up>
  <Complete></Complete>
</Parameters>

Learn more…
GetEmployeeCarDetails()
The GetEmployeeCarDetails method was designed to let other developers interface with our core products by using this method to get car details for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeMail()
The GetEmployeeMail method was designed to let other developers interface with our core products by using this method to get the contents of the internal mail box for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetEmployeeTelephoneList()
The GetEmployeeTelephoneList method was designed to let other developers interface with our core products by using this method to get the contents of the internal phone list contacts for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Surname_Filter></Surname_Filter>
</Parameters>

Learn more…
CreateEmployeeNOK()
The CreateEmployeeNOK method was designed to let other developers interface with our core products by using this method to create a NOK entry for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Title></Title>
  <Forename></Forename>
  <Middlename></Middlename>
  <Surname></Surname>
  <Relationship></Relationship>
  <Address_1></Address_1>
  <Address_2></Address_2>
  <Address_3></Address_3>
  <Address_4></Address_4>
  <Postcode></Postcode>
  <Phone_Home></Phone_Home>
  <Phone_Work></Phone_Work>
  <Phone_Mobile></Phone_Mobile>
  <Phone_Emergency></Phone_Emergency>
  <Email_Address></Email_Address>
  <DOB></DOB>
  <Sex></Sex>
  <Is_Dependant></Is_Dependant>
  <Is_Emergency_Contact></Is_Emergency_Contact>
    </NOK>
</Parameters>

Learn more…
GetEmployeeNOK()
The GetEmployeeNOK method was designed to let other developers interface with our core products by using this method to get NOK details for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
CreateEmployeeTOIL()
The CreateEmployeeTOIL method was designed to let other developers interface with our core products by using this method to insert a TOIL entry for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Start_Date></Start_Date>
  <End_Date></End_Date>
  <Start_Time></Start_Time>
  <End_Time></End_Time>
  <Duration></Duration>
  <Notes></Notes>
      <Detail>
    </CreateEmployeeTOIL>
</Parameters>

Learn more…
GetEmployeePhotos()
The GetEmployeePhotos method was designed to let other developers interface with our core products by using this method to get a list of employee photos. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <EmployeeNumbers></EmployeeNumbers>
  <Width></Width>
  <Height></Height>
</Parameters>

Learn more…
GetEmployeeKeyIDS()
The GetEmployeeKeyIDS method was designed to let other developers interface with our core products by using this method to get a list of all employees and their key identifiers to help identify a person across disparate systems. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Filter_Type>Any Key ID type eg Location</Filter_Type>
<Filter_Value>Key ID value eg London</Filter_Value>
</Parameters>

Learn more…

Management Methods

MakeEmployeeLeaver()
The MakeEmployeeLeaver method was designed to let other developers interface with our core products by making a live employee a leaver. Developers invoking this method will need to provide an xml byte array in the following format (Note: all items in bold are mandatory, items in italic mean at least one of the elements marked with an * needs to be provided):
<Parameters>
  <Personnel_Number>1</Personnel_Number>
  <Date_Notified>01/01/2016</Date_Notified>
        *<Date_Departure>01/02/2016</Date_Departure>*
        *<Expected_Departure>01/02/2016</Expected_Departure>*
  <Leave_Reason>DIS</Leave_Reason>
  <Notes>Dismissed from employment</Notes>
  <Exit_Interview>true</Exit_Interview>
  <Re_Employ>false</Re_Employ>
  <Join_Date_When_Left>01/10/2015</Join_Date_When_Left>
</Parameters>

Learn more…
MakeLiveEmployee()
The MakeLiveEmployee method was designed to let other developers interface with our core products by adding a new employee into the Live system.
- If both Personnel_Number & Employee number elements are left blank, it will be assumed that this is a completely new employee and the new employee’s personnel number and employee number will be automatically assigned. In this scenario, data provided in the payload will insert ALL appropriate records for the new employee.
- If an Employee_Number element is provided, the Personnel_Number element is ignored and a new record will be added for the existing employee number with an auto calculated Personnel Number and the Priority of the employee will be incremented.
- If a Personnel_Number element is provided, a new record will be added with the provided Personnel Number - checking to see if the employee already exists and setting the Employee Number and Priority as appropriate.
- If a Clock_Number element is provided, a new record will be added with the provided Clock Number rather than automatically setting the Clock Number using the employee's new Personnel Number.
- Please Note: Providing both Employee_Number and Personnel_Number, the method will default to ignoring the Personnel_Number and will increment the Priority.
Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
      <Personal>
  <Personnel_Number></Personnel_Number>
  <Employee_Number></Employee_Number>
  <Clock_Number></Clock_Number>
  <Title>Mr</Title>
  <Forename_1>John</Forename_1>
  <Forename_2>Jeff</Forename_2>
  <Surname>Smith</Surname>
  <NI_Number>AB123456C</NI_Number>
  <Sex>Male</Sex>
  <Address1>1</Address1>
  <Address2>The Road</Address2>
  <Address3>The Street</Address3>
  <Address4>The County</Address4>
  <Postcode>AB12 5CD</Postcode>
  <Home_Telephone>01234 567890</Home_Telephone>
  <Home_Email>home@email.co.uk</Home_Email>
  <Mobile_Telephone>07234 567890</Mobile_Telephone>
  <Company_Email>company@email.co.uk</Company_Email>
  <Work_Phone>123456</Work_Phone>
  <Join_Date>01-01-2017</Join_Date>
  <Date_Of_Birth>16-07-1987</Date_Of_Birth>
      </Personal>

      <EmploymentDetails>
    <Location>PLYM</Location>
    <Company>1</Company>
    <Manager>10</Manager>
    <Cost_Centre>PLYM</Cost_Centre>
    <Department>SALES</Department>
    <Pay_Group>1</Pay_Group>
    <Post_Number>SALES</Post_Number>
    <Basic_Hours>37</Basic_Hours>
    <Working_Weeks>52</Working_Weeks>
    <Director>No</Director>
      </EmploymentDetails>

      <Bank>
    <Bank_Name>The Bank</Bank_Name>
    <Bank_Address1>Bank Road 1</Bank_Address1>
    <Bank_Address2>Bank Street</Bank_Address2>
    <Bank_Address3></Bank_Address3>
    <Bank_Address4></Bank_Address4>
    <Bank_Sort_Code>11-22-33</Bank_Sort_Code>
    <Bank_Account_Number>12345678</Bank_Account_Number>
    <Bank_Account_Name>Mr J Smith</Bank_Account_Name>
    <Building_Society_Details></Building_Society_Details>
    <IBAN></IBAN>
      </Bank>

      <Pay>
    <Annual_Salary>20000</Annual_Salary>
    <Rate_Of_Pay1></Rate_Of_Pay1>
    <Tax_Code>42L</Tax_Code>
    <Tax_Basis>Normal</Tax_Basis>
    <Payslip_Type>1</Payslip_Type>
    <P60_Type>1</P60_Type>
    <P11D_Type>1</P11D_Type>
    <Email_Payslip_To>1</Email_Payslip_To>
      </Pay>

      <NextOfKin>
    <Nok_Title>Mrs</Nok_Title>
    <Nok_Forename_1>Jane</Nok_Forename_1>
    <Nok_Forename_2>Louise</Nok_Forename_2>
    <Nok_Surname>Surname</Nok_Surname>
    <Nok_Address1>1</Nok_Address1>
    <Nok_Address2>The Road</Nok_Address2>
    <Nok_Address3>The Street</Nok_Address3>
    <Nok_Address4>The County</Nok_Address4>
    <Nok_Postcode>AB12 5CD</Nok_Postcode>
    <Nok_Telephone_Emergency>01234567899</Nok_Telephone_Emergency>
    <Nok_Relation>Spouse</Nok_Relation>
      </NextOfKin>
</Parameters>

Learn more…

AddNewEmployee()

The AddNewEmployee method was designed to let other developers interface with our core products by adding a new employee into the Live system.

If both Personnel_Number & Employee number elements are left blank, it will be assumed that this is a completely new employee and the new employee’s personnel number and employee number will be automatically assigned. In this scenario, data provided in the payload will insert ALL appropriate records for the new employee.
If an Employee_Number element is provided, the Personnel_Number element is ignored and a new record will be added for the existing employee number with an auto calculated Personnel Number and the Priority of the employee will be incremented.
If a Personnel_Number element is provided, a new record will be added with the provided Personnel Number - checking to see if the employee already exists and setting the Employee Number and Priority as appropriate.
If a Clock_Number element is provided, a new record will be added with the provided Clock Number rather than automatically setting the Clock Number using the employee's new Personnel Number.
Please Note: Providing both Employee_Number and Personnel_Number, the method will default to ignoring the Personnel_Number and will increment the Priority.

Developers invoking this method will need to provide a JSON byte array in the following format (all items in bold are mandatory):

            
            {
                
                    "Personnel_Number": null,
                    "Employee_Number": null,
                    "Clock_Number": null,
                    "Title": "Mr",
                    "Forename_1": "John",
                    "Forename_2": "Jeff",
                    "Surname": "Smith",
                    "NI_Number": "AB123456C",
                    "Sex": "Male",
                    "Address1": "1",
                    "Address2": "The Road",
                    "Address3": "The Street",
                    "Address4": "The County",
                    "Postcode": "AB12 5CD",
                    "Home_Telephone": "01234 567890",
                    "Home_Email": "home@email.co.uk",
                    "Mobile_Telephone": "07234 567890",
                    "Company_Email": "company@email.co.uk",
                    "Work_Phone": "123456",
                    "Join_Date": "01-01-2017",
                    "Date_Of_Birth": "16-07-1987",
                    "Location": "PLYM",
                    "Company": "1",
                    "Manager": "10",
                    "Cost_Centre": "PLYM",
                    "Department": "SALES",
                    "Pay_Group": "1",
                    "Post_Number": "SALES",
                    "Basic_Hours": "37",
                    "Working_Weeks": "52",
                    "Director": "No",
                    "Bank_Name": "The Bank",
                    "Bank_Address1": "Bank Road 1",
                    "Bank_Address2": "Bank Street",
                    "Bank_Address3": null,
                    "Bank_Address4": null,
                    "Bank_Sort_Code": "11-22-33",
                    "Bank_Account_Number": "12345678",
                    "Bank_Account_Name": "Mr J Smith",
                    "Building_Society_Details": null,
                    "IBAN": null,
                    "Annual_Salary": "20000",
                    "Rate_Of_Pay1": null,
                    "Tax_Code": "42L",
                    "Tax_Basis": "Normal",
                    "Payslip_Type": "1",
                    "P60_Type": "1",
                    "P11D_Type": "1",
                    "Email_Payslip_To": "1",
                    "Nok_Title": "Mrs",
                    "Nok_Forename_1": "Jane",
                    "Nok_Forename_2": "Louise",
                    "Nok_Surname": "Surname",
                    "Nok_Address1": "1",
                    "Nok_Address2": "The Road",
                    "Nok_Address3": "The Street",
                    "Nok_Address4": "The County",
                    "Nok_Postcode": "AB12 5CD",
                    "Nok_Telephone_Emergency": "01234567899",
                    "Nok_Relation": "Spouse"
                
            }

Learn more…

GetAbsenceHolidayReport()
The GetAbsenceHolidayReport method was designed to let other developers interface with our core products by using this method to get an absence holiday report for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementVacancyPosts()
The GetManagementVacancyPosts method was designed to let other developers interface with our core products by using this method to get a list of vacancies. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetManagementVacancyPostReviewers()
The GetManagementVacancyPostReviewers method was designed to let other developers interface with our core products by using this method to get a list of vacancy reviewers for a post. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<PostID></PostID>
</Parameters>

Learn more…
CreateManagementVacancyReviewer()
The CreateManagementVacancyReviewer method was designed to let other developers interface with our core products by using this method to create a vacancy reviewer for a post. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<PostID></PostID>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementTODOList()
The GetManagementTODOList method was designed to let other developers interface with our core products by using this method to select a list of an employee's TODO items. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementSubstitutions()
The GetManagementSubstitutions method was designed to let other developers interface with our core products by using this method to select a list of substitutions. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <ShowInactive></ShowInactive>
  <ShowSubordinatesOnly></ShowSubordinatesOnly>
</Parameters>

Learn more…
GetManagementSubstitutionReport()
The GetManagementSubstitutionReport method was designed to let other developers interface with our core products by using this method to select a list of transactions made by a substitute. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<SubstitutionID></SubstitutionID>
</Parameters>

Learn more…
EditManagementSubstitutionEndDate()
The EditManagementSubstitutionEndDate method was designed to let other developers interface with our core products by using this method to edit a substitution's end date. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <SubstitutionID></SubstitutionID>
  <EndDate></EndDate>
  <IncludeManagerInNotifications></IncludeManagerInNotifications>
</Parameters>

Learn more…
CreateManagementSubstitution()
The CreateManagementSubstitution method was designed to let other developers interface with our core products by using this method to create a new substitution. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Nominee></Nominee>
  <Nominator></Nominator>
  <ItemInformation></ItemInformation>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <SendToNominator></SendToNominator>
  <Global></Global>
  <SetupBy></SetupBy>
  <ManagerNominated></ManagerNominated>
  <ManagerAuthorised></ManagerAuthorised>
  <IncludeManagerInNotifications></IncludeManagerInNotifications>
</Parameters>

Learn more…
GetManagementSubstitutionPages()
The GetManagementSubstitutionPages method was designed to let other developers interface with our core products by using this method to select a list of pages that a substitution can be set up for. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetManagementTrainingSchedule()
The GetManagementTrainingSchedule method was designed to let other developers interface with our core products by using this method to select an employee's training schedule. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Year></Year>
  <Month></Month>
</Parameters>

Learn more…
EditManagementTrainingReschedule()
The EditManagementTrainingReschedule method was designed to let other developers interface with our core products by using this method to reschedule a training record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <TrainingRequestID></TrainingRequestID>
  <TrainingInputID></TrainingInputID>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <NewStartDate></NewStartDate>
  <NewEndDate></NewEndDate>
  <Action></Action>
  <Description></Description>
  <CourseRunID></CourseRunID>
  <NewCourseRunID></NewCourseRunID>
  <CourseIDCode></CourseIDCode>
  <Reason></Reason>
  <ManagerID></ManagerID>
</Parameters>

Learn more…
EditManagementTrainingWaiting()
The EditManagementTrainingWaiting method was designed to let other developers interface with our core products by using this method to set a training record to 'Waiting'. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <TrainingRequestID></TrainingRequestID>
  <TrainingInputID></TrainingInputID>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <Action></Action>
  <Description></Description>
  <CourseRunID></CourseRunID>
  <CourseIDCode></CourseIDCode>
  <Reason></Reason>
  <ManagerID></ManagerID>
</Parameters>

Learn more…
EditManagementTrainingCancelled()
The EditManagementTrainingCancelled method was designed to let other developers interface with our core products by using this method to cancel training. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <TrainingRequestID></TrainingRequestID>
  <TrainingInputID></TrainingInputID>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <Action></Action>
  <Description></Description>
  <CourseRunID></CourseRunID>
  <CourseIDCode></CourseIDCode>
  <Reason></Reason>
  <ManagerID></ManagerID>
</Parameters>

Learn more…
EditManagementConfirmAbsence()
The EditManagementConfirmAbsence method was designed to let other developers interface with our core products by using this method to approve absence requests. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Unique_ID></Unique_ID>
  <Duration></Duration>
  <Notes></Notes>
  <Absence_Code></Absence_Code>
</Parameters>

Learn more…
EditManagementRejectAbsence()
The EditManagementRejectAbsence method was designed to let other developers interface with our core products by using this method to reject absence requests. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Unique_ID></Personnel_Number>
<Rejection_Reason></Rejection_Reason>
</Parameters>

Learn more…
CreateManagementVacancyRequestNew()
The CreateManagementVacancyRequestNew method was designed to let other developers interface with our core products by using this method to create a vacancy request. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <PostDescription></PostDescription>
  <Personnel_Number></Personnel_Number>
  <Company></Company>
  <Department></Department>
  <CostCentre></CostCentre>
  <Location></Location>
  <Hours></Hours>
  <FT></FT>
  <Grade></Grade>
  <SCP></SCP>
  <AnnualSalary></AnnualSalary>
  <PeriodSalary></PeriodSalary>
  <HourlyRate></HourlyRate>
  <ContractExpiry></ContractExpiry>
  <RequiredBy></RequiredBy>
</Parameters>

Learn more…
CreateManagementVacancyRequestExisting()
The CreateManagementVacancyRequestExisting method was designed to let other developers interface with our core products by using this method to create a vacancy request. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <PostDescription></PostDescription>
  <Personnel_Number></Personnel_Number>
  <RequiredBy></RequiredBy>
  <Company></Company>
</Parameters>

Learn more…
GetManagementCarFromReg()
The GetManagementCarFromReg method was designed to let other developers interface with our core products by using this method to get a car's details from its registration. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Registration></Registration>
</Parameters>

Learn more…
GetManagementPaymentRequests()
The GetManagementPaymentRequests method was designed to let other developers interface with our core products by using this method to get a list of Payment Requests. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Filter>['All', 'Saved', 'Approvals' or 'Rejected']</Filter>
  <RequestType>['I', 'D' or 'S']</RequestType>
</Parameters>

Learn more…
GetManagementWebLookupCodes()
The GetManagementWebLookupCodes method was designed to let other developers interface with our core products by using this method to get a list of Web Lookup Codes. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<LookupType>['I', 'D' or 'S']</LookupType>
</Parameters>

Learn more…
GetManagementInputCodes()
The GetManagementInputCodes method was designed to let other developers interface with our core products by using this method to get a list of Input Codes. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Payroll_Group_Number></Payroll_Group_Number>
</Parameters>

Learn more…
GetManagementDeductionCodes()
The GetManagementDeductionCodes method was designed to let other developers interface with our core products by using this method to get a list of Deductions Codes. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementDeductionCodeType()
The GetManagementDeductionCodeType method was designed to let other developers interface with our core products by using this method to get the type of a deduction code. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Code></Code>
<PayrollGroup></PayrollGroup>
</Parameters>

Learn more…
GetManagementDeductionCodeCountdown()
The GetManagementDeductionCodeCountdown method was designed to let other developers interface with our core products by using this method to see if a deduction code is a 'Countdown' type. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Code></Code>
<PayrollGroup></PayrollGroup>
</Parameters>

Learn more…
GetManagementSalaryCodes()
The GetManagementSalaryCodes method was designed to let other developers interface with our core products by using this method to get a list of salary codes. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementOvertimeFlexiAllowance()
The GetManagementOvertimeFlexiAllowance method was designed to let other developers interface with our core products by using this method to get a company's overtime flexi allowance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Company></Company>
  <CostCentre></CostCentre>
  <RequestedDate></RequestedDate>
</Parameters>

Learn more…
CreateManagementOvertimeFlexiAllowance()
The CreateManagementOvertimeFlexiAllowance method was designed to let other developers interface with our core products by using this method to create a company's overtime flexi allowance. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Company></Company>
  <CostCentre></CostCentre>
  <StartDate></StartDate>
  <OverTime></OverTime>
  <UnSocial></UnSocial>
</Parameters>

Learn more…
GetManagementOrgChart()
The GetManagementOrgChart method was designed to let other developers interface with our core products by using this method to get the company's organisation chart. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetManagementNominalAnalysisApprovals()
The GetManagementNominalAnalysisApprovals method was designed to let other developers interface with our core products by using this method to get Nominal Analysis records that need approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementSicknessAbsences()
The GetManagementSicknessAbsences method was designed to let other developers interface with our core products by using this method to get sickness absences for a particular employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Filter></Filter>
</Parameters>

Learn more…
GetManagementSicknessAbsencesAll()
The GetManagementSicknessAbsencesAll method was designed to let other developers interface with our core products by using this method to get sickness absences for all subordinates. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Filter></Filter>
</Parameters>

Learn more…
GetManagementJobApplicants()
The GetManagementJobApplicants method was designed to let other developers interface with our core products by using this method to get applicants for a vacancy. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Company></Company>
  <Post></Post>
  <FilterType>['Name', 'Skill', 'Shortlist', 'Application' or leave blank]</FilterType>
  <FilterValue>[The value you want to filter by]</FilterValue>
</Parameters>

Learn more…
GetManagementVacancyRequests()
The GetManagementVacancyRequests method was designed to let other developers interface with our core products by using this method to get vacancy requests. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementTimesheetsToApprove()
The GetManagementTimesheetsToApprove method was designed to let other developers interface with our core products by using this method to get timesheets that need approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementTrainingConfirmations()
The GetManagementTrainingConfirmations method was designed to let other developers interface with our core products by using this method to get training that needs approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementToilToApprove()
The GetManagementToilToApprove method was designed to let other developers interface with our core products by using this method to get toil that needs approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementShiftSwapApprovals()
The GetManagementShiftSwapApprovals method was designed to let other developers interface with our core products by using this method to get a list of shift swaps that need approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementMileageToApprove()
The GetManagementMileageToApprove method was designed to let other developers interface with our core products by using this method to get a list of mileage that needs approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementExpensesToApprove()
The GetManagementExpensesToApprove method was designed to let other developers interface with our core products by using this method to get a list of expenses that need approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementAbsenceRequests()
The GetManagementAbsenceRequests method was designed to let other developers interface with our core products by using this method to get a list of absence requests that need approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementAbsenceRetractions()
The GetManagementAbsenceRetractions method was designed to let other developers interface with our core products by using this method to get a list of absence retractions that need approving. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementCommendReport()
The GetManagementCommendReport method was designed to let other developers interface with our core products by using this method to get a commend report for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementGrievances()
The GetManagementGrievances method was designed to let other developers interface with our core products by using this method to get a list of grievances to review for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementAppraisalList()
The GetManagementAppraisalList method was designed to let other developers interface with our core products by using this method to get a list of appraisals for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementEmployeeOvertimeRecord()
The GetManagementEmployeeOvertimeRecord method was designed to let other developers interface with our core products by using this method to get an employee's overtime record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementEmployeeTrainingCourses()
The GetManagementEmployeeTrainingCourses method was designed to let other developers interface with our core products by using this method to get an employee's training courses. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetManagementRosterSwapRequests()
The GetManagementRosterSwapRequests method was designed to let other developers interface with our core products by using this method to get an employee's roster swap requests to approve. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetSupervisorEnquiry()
The GetSupervisorEnquiry method was designed to let other developers interface with our core products by using this method to get a manager's supervisor enquiry for a given date. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<EnquiryDate></EnquiryDate>
</Parameters>

Learn more…
GetSingleCentralRecord()
The GetSingleCentralRecord method was designed to let other developers interface with our core products by using this method to get the Single Central Record report. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <OutputFormat></OutputFormat> - 0 = Excel, 1 = CSV
  <ForceDefaultFormat></ForceDefaultFormat>
</Parameters>

Learn more…

Pay Details Methods

AddPayrollInput()
The AddPayrollInput method was designed to let other developers interface with our core products by using this method to submit a payroll input record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <InputCode></InputCode>
  <InputValue></InputValue>
  <RateOfPay></RateOfPay>
  <Department></Department>
  <CostCentre></CostCentre>
  <WeekStartDate>[Mandatory if employee is zero-hours]</WeekStartDate>
  <Reference></Reference>
  <LatePayment></LatePayment>
</Parameters>

Learn more…
DeletePayrollInput()
The DeletePayrollInput method was designed to let other developers interface with our core products by using this method to delete a payroll input record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <UniqueID>[One of UniqueID or Reference must be provided]</UniqueID>
  <Reference></Reference>
</Parameters>

Learn more…
EditPayDetailsMileageSubmit()
The EditPayDetailsMileageSubmit method was designed to let other developers interface with our core products by using this method to submit a pay details mileage record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <MileageID></MileageID>
  <Personnel_Number></Personnel_Number>
  <IsMulti>[Must be 'true' if submitting more than one record, otherwise 'false']</IsMulti>
</Parameters>

Learn more…
GetPayDetailsMileages()
The GetPayDetailsMileages method was designed to let other developers interface with our core products by using this method to get an employee's pay details mileages. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Rejected>[Can be 'true', 'false' or left blank]</Rejected>
  <Submitted>[Can be 'true', 'false' or left blank]</Submitted>
</Parameters>

Learn more…
EditPayDetailsMileage()
The EditPayDetailsMileage method was designed to let other developers interface with our core products by using this method to edit a pay details mileage record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <MileageID></MileageID>
  <MileageDate></MileageDate>
  <Passengers></Passengers>
  <Miles></Miles>
  <Description></Description>
  <AllowanceCode></AllowanceCode>
  <VehicleType></VehicleType>
  <StartPostcode></StartPostcode>
  <EndPostcode></EndPostcode>
</Parameters>

Learn more…
CreatePayDetailsMileage()
The CreatePayDetailsMileage method was designed to let other developers interface with our core products by using this method to create a pay details mileage record. On successful record insertion the method returns the integer ID of the new mileage record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <MileageDate></MileageDate>
  <Passengers></Passengers>
  <Miles></Miles>
  <Description></Description>
  <AllowanceCode></AllowanceCode>
  <VehicleType></VehicleType>
  <StartPostcode></StartPostcode>
  <EndPostcode></EndPostcode>
</Parameters>

Learn more…
EditPayDetailsExpense()
The EditPayDetailsExpense method was designed to let other developers interface with our core products by using this method to edit a pay details expense record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <ExpenseID></ExpenseID>
  <ExpenseDate></ExpenseDate>
  <Description></Description>
  <Value></Value>
  <VAT></VAT>
  <ExpenseCode></ExpenseCode>
  <Receipt></Receipt>
</Parameters>

Learn more…
CreatePayDetailsExpense()
The CreatePayDetailsExpense method was designed to let other developers interface with our core products by using this method to create a pay details expense record. On successful record insertion the method returns the integer ID of the new expense record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <ExpenseDate></ExpenseDate>
  <Description></Description>
  <Value></Value>
  <VAT></VAT>
  <ExpenseCode></ExpenseCode>
  <Receipt></Receipt>
</Parameters>

Learn more…
EditPayDetailsExpenseSubmit()
The EditPayDetailsExpenseSubmit method was designed to let other developers interface with our core products by using this method to submit a pay details expense record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<ExpenseID></ExpenseID>
<PersonnelID></PersonnelID>
</Parameters>

Learn more…
GetPayDetailsExpenses()
The GetPayDetailsExpenses method was designed to let other developers interface with our core products by using this method to get an employee's pay details expenses. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Rejected>[Can be 'true', 'false' or left blank]</Rejected>
  <Submitted>[Can be 'true', 'false' or left blank]</Submitted>
</Parameters>

Learn more…
GetPayDetailsRewardStatement()
The GetPayDetailsRewardStatement method was designed to let other developers interface with our core products by using this method to get an employee's pay details reward statement. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetPayDetailsP11DDetails()
The GetPayDetailsP11DDetails method was designed to let other developers interface with our core products by using this method to get an employee's P11 Details from a tax year. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<TaxYear></TaxYear>
</Parameters>

Learn more…
GetPayDetailsPayslip()
The GetPayDetailsPayslip method was designed to let other developers interface with our core products by using this method to get an employee's archived payslip for a tax year and pay period. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory - a valid LoggedInUser element is also mandatory for this endpoint.):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Tax_Year></Tax_Year>
  <Pay_Period></Pay_Period>
</Parameters>

Learn more…
GetPayDetailsPayslipPeriods()
The GetPayDetailsPayslipPeriods method was designed to let other developers interface with our core products by using this method to get an employee's valid payslip periods. A tax year may be specified, otherwise all available tax years will be returned. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory - a valid LoggedInUser element is also mandatory for this endpoint.):
<Parameters>
<Personnel_Number></Personnel_Number>
<Tax_Year></Tax_Year>
</Parameters>

Learn more…
GetPayDetailsNominalAnalysis()
The GetPayDetailsNominalAnalysis method was designed to let other developers interface with our core products by using this method to get an employee's nominal analysis. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
CreatePayDetailsNominalAnalysis()
The CreatePayDetailsNominalAnalysis method was designed to let other developers interface with our core products by using this method to create a nominal analysis record for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Department></Department>
  <CostCentre></CostCentre>
  <Percentage></Percentage>
  <Authorised></Authorised>
</Parameters>

Learn more…
GetNominalAnalysis()
The GetNominalAnalysis method was designed to let other developers interface with our core products by using this method to get a full nominal analysis breakdown for a given payroll group, tax year and period. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory. A valid entry in LoggedInUser must be provided for this method.):
<Parameters>
  <Payroll_Group_Number></Payroll_Group_Number>
  <Tax_Year></Tax_Year>
  <Tax_Period></Tax_Period>
</Parameters>

Learn more…
GetPayDetailsAuthorisedMileage()
The GetPayDetailsAuthorisedMileage method was designed to let other developers interface with our core products by using this method to get an employee's authorised mileage entries from a tax year. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<TaxYear></TaxYear>
</Parameters>

Learn more…
GetPayDetailsAuthorisedExpenses()
The GetPayDetailsAuthorisedExpenses method was designed to let other developers interface with our core products by using this method to get an employee's authorised expense entries from a tax year. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<TaxYear></TaxYear>
</Parameters>

Learn more…
GetEmployeeMileages()
The GetEmployeeMileages method was designed to let other developers interface with our core products by using this method to get the mileage entries for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Year></Year>
</Parameters>

Learn more…
GetEmployeeExpenses()
The GetEmployeeExpenses method was designed to let other developers interface with our core products by using this method to get the expense entries for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Tax_Year></Tax_Year>
</Parameters>

Learn more…
AddExpenseForApproval()
The AddExpenseForApproval method was designed to let other developers interface with our core products by using this method to add an employee expense for approval. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Expense_Date></Expense_Date>
  <Description></Description>
  <Expense_Value></Expense_Value>
  <Expense_VAT></Expense_VAT>
  <Notes></Notes>
  <Expense_Code></Expense_Code>
  <Receipt></Receipt>
</Parameters>

Learn more…

Time Details Methods

GetCommonAnnualisedSummary()
The GetCommonAnnualisedSummary method was designed to let other developers interface with our core products by using this method to get an employee's annualised summary. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetCommonIsClockedIn()
The GetCommonIsClockedIn method was designed to let other developers interface with our core products by using this method to get if an employee clocked in on a day. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Date></Date>
</Parameters>

Learn more…
GetTimeDetailsWeeklyAuthorisedOT()
The GetTimeDetailsWeeklyAuthorisedOT method was designed to let other developers interface with our core products by using this method to get a list of an employee's authorised overtime. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<WeekStartDate></WeekStartDate>
</Parameters>

Learn more…
GetCommonEmployeeRota()
The GetCommonEmployeeRota method was designed to let other developers interface with our core products by using this method to get an employee's rota. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <StartDate></StartDate>
  <EndDate></EndDate>
</Parameters>

Learn more…
GetTimeDetailsEmployeeLastClock()
The GetTimeDetailsEmployeeLastClock method was designed to let other developers interface with our core products by using this method to get an employee's last clock. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTimeDetailsClockingSubsDailyPatterns()
The GetTimeDetailsClockingSubsDailyPatterns method was designed to let other developers interface with our core products by using this method to get an employee's clocking subordinates' daily patterns. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<WeekStartDate></WeekStartDate>
</Parameters>

Learn more…
GetTimeDetailsEmployeeDailyPatterns()
The GetTimeDetailsEmployeeDailyPatterns method was designed to let other developers interface with our core products by using this method to get an employee's daily patterns. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<WeekStartDate></WeekStartDate>
</Parameters>

Learn more…
GetTimeDetailsEmployeeDailyClockings()
The GetTimeDetailsEmployeeDailyClockings method was designed to let other developers interface with our core products by using this method to get an employee's daily clockings. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Date></Date>
</Parameters>

Learn more…
GetTimeDetailsEmployeeShiftSwapRequests()
The GetTimeDetailsEmployeeShiftSwapRequests method was designed to let other developers interface with our core products by using this method to get an employee's shift swap requests. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTimeDetailsEmployeeRosterSwapRequests()
The GetTimeDetailsEmployeeRosterSwapRequests method was designed to let other developers interface with our core products by using this method to get an employee's roster swap requests. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTimeDetailsEmployeeWeeklyClockings()
The GetTimeDetailsEmployeeWeeklyClockings method was designed to let other developers interface with our core products by using this method to get an employee's weekly clocking activity. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Week_Start_Date></Week_Start_Date>
</Parameters>

Learn more…
EditTimeDetailsEmployeeDailyPattern()
The EditTimeDetailsEmployeeDailyPattern method was designed to let other developers interface with our core products by using this method to edit an employee's daily shift. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Date_From></Date_From>
  <Date_To></Date_To>
  <Shift_Pattern></Shift_Pattern>
</Parameters>

Learn more…
EditTimeDetailsDailyShiftOverride()
The EditTimeDetailsDailyShiftOverride method was designed to let other developers interface with our core products by using this method to insert or edit an employee's daily shift clocking details. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <ClockingDate></ClockingDate>
  <ShiftStartTime></ShiftStartTime>
  <ShiftEndTime></ShiftEndTime>
  <ShiftBasic></ShiftBasic>
  <BreakStart></BreakStart>
  <BreakEnd></BreakEnd>
  <BreakHours></BreakHours>
  <IsNightShift></IsNightShift>
  <NightLimitTime></NightLimitTime>
</Parameters>

Learn more…
EditTimeDetailsEmployeeWeeklyPattern()
The EditTimeDetailsEmployeeWeeklyPattern method was designed to let other developers interface with our core products by using this method to edit an employee's weekly shift pattern. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Week_Start_Date></Week_Start_Date>
  <Shift_Pattern></Shift_Pattern>
</Parameters>

Learn more…
GetTimeDetailsEmployeeWeeklyPatterns()
The GetTimeDetailsEmployeeWeeklyPatterns method was designed to let other developers interface with our core products by using this method to get available weekly shift patterns for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
CreateClockIn()
The CreateClockIn method was designed to let other developers interface with our core products by using this method to insert a clock in for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Clocking_Date></Clocking_Date>
  <Clocking_Time></Clocking_Time>
  <Clocking_Flag></Clocking_Flag>
  <Clocking_Terminal></Clocking_Terminal>
</Parameters>

Learn more…
GetTimeDetailsDailyPatterns()
The GetTimeDetailsDailyPatterns method was designed to let other developers interface with our core products by using this method to get available daily shift patterns for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTimeDailyShiftForDate()
The GetTimeDailyShiftForDate method was designed to let other developers interface with our core products by using this method to get the daily shift code for an employee on a specific date. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Shift_Date></Shift_Date>
</Parameters>

Learn more…
GetTimeDailyShiftDetails()
The GetTimeDailyShiftDetails method was designed to let other developers interface with our core products by using this method to get the details of a daily shift pattern. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Company></Company>
<Daily_Shift></Daily_Shift>
</Parameters>

Learn more…
GetTimeDetailsWeeklyPatterns()
The GetTimeDetailsWeeklyPatterns method was designed to let other developers interface with our core products by using this method to get available weekly shift patterns for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTimeWeeklyShiftForDate()
The GetTimeWeeklyShiftForDate method was designed to let other developers interface with our core products by using this method to get the weekly shift code for an employee in a specific week. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<Week_Start_Date></Week_Start_Date>
</Parameters>

Learn more…
GetTimeDetailsMobileTerminals()
The GetTimeDetailsMobileTerminals method was designed to let other developers interface with our core products by using this method to get a list of mobile terminals in the system. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
</Parameters>

Learn more…
GetTimeDetailsClockingTerminals()
The GetTimeDetailsClockingTerminals method was designed to let other developers interface with our core products by using this method to get a list of all clocking terminals in the system. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
</Parameters>

Learn more…

Timesheet Methods

GetTimesheetRowsMultiple()
The GetTimesheetRowsMultiple method was designed to let other developers interface with our core products by using this method to select an employee's timesheet hours, expenses or mileage. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Date></Date>
  <Type>[Must be 'Hours', 'Expenses' or 'Mileage']</Type>
</Parameters>

Learn more…
GetTimesheetSavedActivity()
The GetTimesheetSavedActivity method was designed to let other developers interface with our core products by using this method to select an employee's timesheet for a particular activity on a certain date. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <ActivityDesc></ActivityDesc>
  <ActivityDate></ActivityDate>
</Parameters>

Learn more…
GetTimesheetSummary()
The GetTimesheetSummary method was designed to let other developers interface with our core products by using this method to select a summary of an employee's timesheet hours, expenses or mileage. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Type>[Must be 'Hours', 'Expenses' or 'Mileage']</Type>
  <DateFrom></DateFrom>
  <DateTo></DateTo>
</Parameters>

Learn more…
GetTimesheetProjects()
The GetTimesheetProjects method was designed to let other developers interface with our core products by using this method to select a list of Timesheet Projects. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
CreateTimesheetProject()
The CreateTimesheetProject method was designed to let other developers interface with our core products by using this method to create a new Timesheet Project. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <ProjectName></ProjectName>
  <Description></Description>
  <InternalExternal></InternalExternal>
  <ProjectCostRate></ProjectCostRate>
  <ProjectChargeRate></ProjectChargeRate>
  <ClientCode></ClientCode>
  <Notes></Notes>
  <ModifiedBy></ModifiedBy>
</Parameters>

Learn more…
EditTimesheetProject()
The EditTimesheetProject method was designed to let other developers interface with our core products by using this method to update a Timesheet Project. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <ProjectID></ProjectID>
  <ProjectName></ProjectName>
  <Description></Description>
  <InternalExternal></InternalExternal>
  <ProjectCostRate></ProjectCostRate>
  <ProjectChargeRate></ProjectChargeRate>
  <ClientCode></ClientCode>
  <Notes></Notes>
  <ModifiedBy></ModifiedBy>
</Parameters>

Learn more…
CreateTimesheetElement()
The CreateTimesheetElement method was designed to let other developers interface with our core products by using this method to enter a Timesheet record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <BusinessID></BusinessID>
  <ProjectID></ProjectID>
  <ActivityID></ActivityID>
  <Date></Date>
  <StartTime></StartTime>
  <EndTime></EndTime>
  <Hours></Parameters>
  <ClientCode></ClientCode>
  <ModifiedBy></ModifiedBy>
  <CashValue></CashValue>
  <NoOfItems></NoOfItems>
  <UserNotes></UserNotes>
</Parameters>

Learn more…
GetTimesheetSavedMileage()
The GetTimesheetSavedMileage method was designed to let other developers interface with our core products by using this method to select details for a timesheet mileage record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<UniqueID></UniqueID>
</Parameters>

Learn more…
GetTimesheetSavedExpense()
The GetTimesheetSavedExpense method was designed to let other developers interface with our core products by using this method to select details for an timesheet expense record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<UniqueID></UniqueID>
</Parameters>

Learn more…
CreateTimesheetExpense()
The CreateTimesheetExpense method was designed to let other developers interface with our core products by using this method to create a Timesheet Expense. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <BusinessID></BusinessID>
  <ClientID></ClientID>
  <ProjectID></ProjectID>
  <ActivityDate></ActivityDate>
  <ExpenseCode></ExpenseCode>
  <ExpenseTotal></ExpenseTotal>
  <ExpenseVAT></ExpenseVAT>
  <Description></Description>
  <UserNotes></UserNotes>
</Parameters>

Learn more…
EditTimesheetExpense()
The EditTimesheetExpense method was designed to let other developers interface with our core products by using this method to edit a Timesheet Expense. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <UniqueID></UniqueID>
  <ExpenseCode></ExpenseCode>
  <ExpenseTotal></ExpenseTotal>
  <ExpenseVAT></ExpenseVAT>
  <Description></Description>
  <UserNotes></UserNotes>
</Parameters>

Learn more…
CreateTimesheetMileage()
The CreateTimesheetMileage method was designed to let other developers interface with our core products by using this method to create a Timesheet Mileage. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <BusinessID></BusinessID>
  <ClientID></ClientID>
  <ProjectID></ProjectID>
  <ActivityDate></ActivityDate>
  <TransportType></TransportType>
  <AllowanceCode></AllowanceCode>
  <MilesClaimed></MilesClaimed>
  <EngineSize></EngineSize>
  <Passengers></Passengers>
  <MilesClaimed></MilesClaimed>
  <Description></Description>
  <FromPostcode></FromPostcode>
  <ToPostcode></ToPostcode>
  <UserNotes></UserNotes>
</Parameters>

Learn more…
EditTimesheetMileage()
The EditTimesheetMileage method was designed to let other developers interface with our core products by using this method to edit a Timesheet Mileage. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <UniqueID></UniqueID>
  <TransportType></TransportType>
  <AllowanceCode></AllowanceCode>
  <MilesClaimed></MilesClaimed>
  <EngineSize></EngineSize>
  <Passengers></Passengers>
  <MilesClaimed></MilesClaimed>
  <Description></Description>
  <UserNotes></UserNotes>
</Parameters>

Learn more…
GetTimesheetActivities()
The GetTimesheetActivities method was designed to let other developers interface with our core products by using this method to select a list of an employee's timesheet activities. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Activity>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
CreateTimesheetActivity()
The CreateTimesheetActivity method was designed to let other developers interface with our core products by using this method to create a timesheet activity. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Description></Description>
  <AbsenceCode></AbsenceCode>
  <InputCode></Parameters>
  <TypeCode></TypeCode>
  <Notes></Notes>
  <ProjectID></ProjectID>
  <AbsenceID></AbsenceID>
  <ModifiedBy></ModifiedBy>
  <ActivityCodeUser></ActivityCodeUser>
</Parameters>

Learn more…
EditTimesheetActivity()
The EditTimesheetActivity method was designed to let other developers interface with our core products by using this method to edit a timesheet activity. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <ActivityID></ActivityID>
  <Description></Description>
  <AbsenceCode></AbsenceCode>
  <InputCode></Parameters>
  <TypeCode></TypeCode>
  <Notes></Notes>
  <ProjectID></ProjectID>
  <AbsenceID></AbsenceID>
  <ModifiedBy></ModifiedBy>
  <ActivityCodeUser></ActivityCodeUser>
</Parameters>

Learn more…
GetDashboardTimesheetDetails()
The GetDashboardTimesheetDetails method was designed to let other developers interface with our core products by using this method to get an employee's dashboard timesheet details. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…

Training Methods

GetRequestableTrainingCourses()
The GetRequestableTrainingCourses method was designed to let other developers interface with our core products by using this method to select a collection of Requestable Training Courses. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTrainingCourseDetails()
The GetTrainingCourseDetails method was designed to let other developers interface with our core products by using this method to select a details of a training courses. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<CourseID></CourseID>
</Parameters>

Learn more…
GetTrainingCourseRemainingPlaces()
The GetTrainingCourseRemainingPlaces method was designed to let other developers interface with our core products by using this method to get the amount of places left on a training course run. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<CourseRunID></CourseRunID>
</Parameters>

Learn more…
GetTrainingExistingRequest()
The GetTrainingExistingRequest method was designed to let other developers interface with our core products by using this method to get if a request already exists for a training course. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<CourseID></CourseID>
</Parameters>

Learn more…
CreateTrainingRequest()
The CreateTrainingRequest method was designed to let other developers interface with our core products by using this method to add a new training request. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Date></Date>
  <Description></Description>
  <CourseID></CourseID>
  <CompanyObjectives>
       <Key></Key>
       <Value></Value>
  </CompanyObjectives>
  <PersonalObjectives>
       <Key></Key>
       <Value></Value>
  </PersonalObjectives>
</Parameters>

Learn more…
GetTrainingAvailableCourses()
The GettrainingAvailableCourses method was designed to let other developers interface with our core products by using this method to select available courses. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<CourseCode></CourseCode>
</Parameters>

Learn more…
CreateTrainingCourseBooking()
The CreateTrainingCourseBooking method was designed to let other developers interface with our core products by using this method to add a new Training Course Booking. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <CourseRunID></CourseRunID>
  <CourseIDCode></CourseIDCode>
</Parameters>

Learn more…
GetTrainingPlans()
The GetTrainingPlans method was designed to let other developers interface with our core products by using this method to select an employee's training plans. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTrainingPlanCourses()
The GetTrainingPlanCourses method was designed to let other developers interface with our core products by using this method to select an employee's training plan courses. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
<PlanID></PlanID>
</Parameters>

Learn more…
GetTrainingHistory()
The GetTrainingHistory method was designed to let other developers interface with our core products by using this method to select an employee's training history. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTrainingHistoryDetails()
The GetTrainingHistoryDetails method was designed to let other developers interface with our core products by using this method to select details of a particular Training History record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTrainingEvaluationList()
The GetTrainingEvaluationList method was designed to let other developers interface with our core products by using this method to select an employee's training evaluations. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTrainingBookings()
The GetTrainingBookings method was designed to let other developers interface with our core products by using this method to select an employee's training bookings. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
GetTrainingCPD()
The GetTrainingCPD method was designed to let other developers interface with our core products by using this method to select an employee's CPD records. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
CreateTrainingCPD()
The CreateTrainingCPD method was designed to let other developers interface with our core products by using this method to enter a Training CPD Record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <Activity></Activity>
  <Skill></Skill>
  <Method></Method>
  <CourseAttended></CourseAttended>
  <CourseID></CourseID>
  <Internal></Internal>
  <Comments></Comments>
  <Units></Units>
  <ProfessionalBody></ProfessionalBody>
  <ModifiedBy></ModifiedBy>
</Parameters>

Learn more…
EditTrainingCPDRecord()
The EditTrainingCPDRecord method was designed to let other developers interface with our core products by using this method to update an existing Training CPD Record. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <UniqueID></UniqueID>
  <Personnel_Number></Personnel_Number>
  <StartDate></StartDate>
  <EndDate></EndDate>
  <Activity></Activity>
  <Skill></Skill>
  <Method></Method>
  <CourseAttended></CourseAttended>
  <CourseID></CourseID>
  <Internal></Internal>
  <Comments></Comments>
  <Units></Units>
  <ProfessionalBody></ProfessionalBody>
  <ModifiedBy></ModifiedBy>
</Parameters>

Learn more…
GetTrainingRequiredConfirmations()
The GetTrainingRequiredConfirmations method was designed to let other developers interface with our core products by using this method to select training bookings that require confirmation by a particular employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…
EditTrainingApproveBooking()
The EditTrainingApproveBooking method was designed to let other developers interface with our core products by using this method to approve a training booking. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <RequesterID></RequesterID>
  <CourseRunID></CourseRunID>
  <ActionCode></ActionCode>
  <TrainingRequestID></TrainingRequestID>
  <RemainingPlaces></RemainingPlaces>
</Parameters>

Learn more…
EditTrainingRejectBooking()
The EditTrainingRejectBooking method was designed to let other developers interface with our core products by using this method to reject a training booking. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<TrainingRequestID></TrainingRequestID>
<RejectReason></RejectReason>
</Parameters>

Learn more…
GetTrainingSchedule()
The GetTrainingSchedule method was designed to let other developers interface with our core products by using this method to select an employee's training calendar. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Year></Year>
  <Month></Month>
  <StartDate></StartDate>
  <EndDate></EndDate>
</Parameters>

OR

<Parameters>
  <Personnel_Number></Personnel_Number>
  <Year></Year>
  <Month></Month>
  <StartDate></StartDate>
  <EndDate></EndDate>
</Parameters>

Learn more…

Vacancy Methods

AddApplicant()
The AddApplicant method was designed to let other developers interface with our core products by adding an Applicant for an active Vacancy. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
  <Personnel_Number></Personnel_Number>
  <Post_Number></Post_Number>
  <Title></Title>
  <Forename></Forename>
  <Middle_Name></Middle_Name>
  <Surname></Surname>
  <Marital_Status></Marital_Status>
  <DOB></DOB>
  <Email></Email>
  <Address_1></Address_1>
  <Address_2></Address_2>
  <Address_3></Address_3>
  <Address_4></Address_4>
  <Postcode></Postcode>
  <Home_Phone></Home_Phone>
  <Work_Phone></Work_Phone>
  <Mobile_Phone></Mobile_Phone>
</Parameters>

Learn more…
GetActiveVacancies()
The GetActiveVacancies method was designed to let other developers interface with our core products by using this method to select active Vacancies. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
None.
Learn more…
GetVacanciesActiveVacancies()
The GetVacanciesActiveVacancies method was designed to let other developers interface with our core products by using this method to get active vacancies for an employee. Developers invoking this method will need to provide an xml byte array in the following format (all items in bold are mandatory):
<Parameters>
<Personnel_Number></Personnel_Number>
</Parameters>

Learn more…

Deprecated Methods:

There are currently no deprecated methods in the Web API.

Welcome to the Civica Self Service Web API

Payload Information:

API Supported Methods:

Absence Methods

AddAnAbsence()

DeleteAnAbsence()

EditAnAbsence()

GetAbsenceDuration()

GetEmployeeAbsencesForDay()

GetAbsenceHistory()

GetAbsenceMap()

GetAbsenceRemovableAbsences()

CreateAbsenceRequest()

CreateAbsenceRetractionRequest()

GetAbsenceEmployeeAvailabilityExceptions()

GetAbsenceEmployeeUnavailabilityExceptions()

GetAbsenceHolidayYearStart()

GetAbsenceEmployeeAvailabilityWeek()

GetEmployeeAbsenceCalendar()

GetHolidaySchemeStatutoryHolidays()

AbsenceStageCheck()

GetAbsenceRequestCodes()

GetAbsenceSummaryCodes()

Administration Methods

CreateCostCentre()

GetAdministrationApprovalLevels()

GetAdministrationAccessRights()

GetAdministrationAccessRightsSubLevel()

GetAdministrationOtherAccess()

GetAdministrationAuditTrail()

GetAdministrationAuditTrailAbsences()

GetAdministrationAuditTrailAbsences2()

GetAdministrationAuditTrailCostCentres()

GetAdministrationAuditTrailCountries()

GetAdministrationAuditTrailDepartments()

GetAdministrationAuditTrailEmployees()

GetAdministrationAuditTrailEmployees2()

GetAdministrationAuditTrailLocations()

GetAdministrationAuditTrailSections()

GetAdministrationAuditTrailSkills()

GetAdministrationAuditTrailTraining()

GetAdministrationEmailNotificationList()

GetAdministrationFormItems()

GetAdministrationSSUsageLogs()

GetAdministrationSSUsageLogsUser()

GetAdministrationSSModuleStats()

GetAdministrationSSUserLog()

GetAdministrationUserProfileList()

GetAdministrationWindowsLogons()

Common Methods

HelloWorld()

GetDashboardApprovalsList()

GetDashboardTaskList()

GetDashboardClaimList()

GetCommonDatabaseVersion()

GetCommonCompanies()

GetCommonUserCount()

GetCommonConfigurationForCompany()

GetCommonCostCentresForCompany()

GetCommonDepartmentsForCompany()

GetCommonGradesForCompany()

GetCommonSCPCodesForCompany()

GetCommonLocationsForCompany()

GetCommonPostsForCompany()

GetCommonPayrollGroups()

GetCommonPayrollGroupDetails()

GetCommonSubordinates()

GetCommonSubordinateNames()

GetCommonShiftPatternForWeek()

GetCommonIsEmployeeLeaver()

GetCommonMostUsedDepartment()

GetCommonMostUsedCompany()

GetCommonManagers()

GetCommonSupervisorSubordinates()

GetCommonEmployeeName()

GetCommonLastCalcRun()

GetCommonCalcHoursForWeek()

GetCommonNormalHours()

GetCommonExcessHoursForWeek()

GetCommonLastPeriodEnd()