{"swagger":"2.0","info":{"version":"v1","title":"UK Employee API","description":"Use this API to create, update, and retrieve employee data in Fourth. For more information about how this API works, see the [UK Employee API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide). <br /> <br />To use this API, you will need: <br /> &nbsp; &nbsp; &bull; &nbsp; A UK Employee API account  <br /> &nbsp; &nbsp; &bull; &nbsp; An Organisation ID for identifying your requests  <br /> &nbsp; &nbsp; &bull; &nbsp; The root URL<br /><br />Your mutual Fourth customer must request these details on your behalf. Please ensure they do this as soon as possible. <br /> <br /> <br /><b>Testing:</b> A test environment is available. <br /><br /><b>Availability:</b> United Kingdom only. <br /> <br /><b>Updates:</b> See the [Release Notes page](https://developer.fourth.com/en-gb/docs/uk-employee-api/release-notes) for this API. <br />"},"host":"localhost:54541","schemes":["http"],"paths":{"/organisations/{organisationId}/Employees/Absences":{"get":{"tags":["Absences"],"summary":"Get absences for employees","description":"Returns the absence records of any employees absent during the specified time range. An employee may have multiple records returned.","operationId":"Absences_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Okay","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Absence"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee absence data"}}},"put":{"tags":["Absences"],"summary":"Update absences for employees","description":"Updates one or more employee absences. Holiday and statutory leave cannot be updated via this request.\r\n<br /> The response includes a `status` field for each absence record. This will tell you whether the request successfully updated the absence or if there was an error.","operationId":"Absences_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"absenceList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.AbsenceUpdate"}}}],"responses":{"200":{"description":"Request accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Absence"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee absence data"}}},"post":{"tags":["Absences"],"summary":"Create absences for employees","description":"Creates one or more employee absences. This API adds an absence into Fourth and authorises it at the same time. You can create absences for both past and future dates. Holiday and statutory leave cannot be created via this request.\r\n<br /> The response includes a `status` field for each absence record. This will tell you whether the request successfully created the absence or if there was an error.","operationId":"Absences_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"absenceList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.AbsenceImport"}}}],"responses":{"200":{"description":"Request accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Absence"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee absence data"}}},"delete":{"tags":["Absences"],"summary":"Delete absences for employees","description":"Deletes one or more existing absences. \r\nHoliday and statutory leave cannot be deleted via this request.","operationId":"Absences_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"absenceList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.AbsenceDelete"}}}],"responses":{"200":{"description":"Request accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Absence"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee absence data"}}}},"/organisations/{organisationId}/Employees/Accrual":{"get":{"tags":["Accrual"],"summary":"Get the current holiday accrual for flexible employees","description":"Returns the current amount of holiday that **flexible** employees have accrued. <br /> For other employee types (full-time, part-time, and casual), the calculation fields are set to \"0\".","operationId":"Accrual_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Accrual"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee accrual data"}}}},"/organisations/{organisationId}/Employees/Addresses":{"get":{"tags":["Addresses"],"summary":"Get addresses for employees","description":"Returns employee addresses. If the employee has had multiple addresses during the time period, then all addresses are returned as separate records. The `EffectiveDate` identifies when the address change came into effect.","operationId":"Addresses_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees address data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Address"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee address data"}}}},"/organisations/{organisationId}/Employees/CountrySpecific":{"get":{"tags":["CountrySpecific"],"summary":"Get country-specific fields for employees","description":"Returns any country-specific fields that are not included in other requests. These fields are determined by Fourth and include the following:<br />\r\n— National Insurance Number <br />\r\n— P45 Rec / P46 Completed <br />\r\n— WTD opt-out Date (working time directive) <br />\r\n— US social security number <br /><br />\r\nThe response will have a record for each field relevant in the country, for that employee. For example, a UK employee may have three separate records returned to cover the NI number, working time directive, and P45/46 information.","operationId":"CountrySpecific_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees country specific data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.CountrySpecific"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee country specific data"}}}},"/organisations/{organisationId}/Employees/Dependents":{"get":{"tags":["Dependents"],"summary":"Get dependents for employees","description":"Returns the dependents listed for each employee. \r\n\r\nAn employee may have multiple records returned.The identifier for each individual record is `reference`.","operationId":"Dependents_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees dependents data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Dependent"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee country specific data"}}}},"/organisations/{organisationId}/Divisions":{"get":{"tags":["Division"],"summary":"Get divisions for the organisation","description":"Returns the divisions for the business. A division is a department within a location, such as `Front of house`, `kitchen`, or `reception`. Divisions names are created by the customer.","operationId":"Division_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"}],"responses":{"200":{"description":"Gets an array of the divisions","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Division"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"}}}},"/organisations/{organisationId}/Employees/Documents":{"get":{"tags":["Documents"],"summary":"Get documents for employees","description":"Returns the details of any documents (seen and recorded) for each employee during the time period. The documents you require from employees are defined within your business.","operationId":"Documents_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees document data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Document"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee document data"}}}},"/organisations/{organisationId}/Employees":{"get":{"tags":["Employees"],"summary":"Get employees","description":"Returns the core information about each employee, including name, date-of-birth, nationality, marital status, education, and more.","operationId":"Employees_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"},{"name":"showFormer","in":"query","description":"Whether records for both former and current employees are included in the response. Results are still filtered by the time range or delta settings. <br /> Default is `true`. <br />  — `true`: Both current and former employee records are returned.<br />  — `false`: Only current employees are returned.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Export.Employee"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee data"}}},"put":{"tags":["Employees"],"summary":"Update employee","description":"Updates a single employee. This request can include a wide variety of information such as name, contact details, visa status, national insurance number, next of kin, and pay details.","operationId":"Employees_UpdateEmployeeDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"employeeList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.Employee"}}}],"responses":{"200":{"description":"OK","schema":{"description":"Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.","type":"object"}}}},"post":{"tags":["Employees"],"summary":"Create employee","description":"Creates a single employee. This request can include a wide variety of information such as name, contact details, visa status, national insurance number, next of kin, and pay details.\r\nThe `EmployeeNumber` must be unique, otherwise the request will fail.","operationId":"Employees_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"employeeList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.Employee"}}}],"responses":{"200":{"description":"OK","schema":{"description":"Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.","type":"object"}}}}},"/organisations/{organisationId}/EmployeeSource":{"get":{"tags":["EmployeeSource"],"summary":"Get a list of recruitment sources","description":"Returns a list of recruitment sources, such as \"walk-in\", \"website\", or \"staff referral\". The values are customer-defined.\r\n<Br /> At present, we do not return this information for specific employees.","operationId":"EmployeeSource_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"}],"responses":{"200":{"description":"Gets an array of the Employee Source","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.EmployeeSource"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"}}}},"/organisations/{organisationId}/Employees/Employments":{"get":{"tags":["Employments"],"summary":"Get employment details for employees","description":"Returns the employment details for each employee during the specified time period. Employees may have multiple employments. For more information about employments and assignments, see the [UK Employee API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide).","operationId":"Employments_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"Fourth ID for your business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"},{"name":"showFormer","in":"query","description":"Whether employment records for both former and current employees are included in the response. Results are still filtered by the time range or delta settings. <br /> Default is `true`. <br />  — `true`: Returns employment records for all employees.<br />  — `false`: Returns employment records for only current employees.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees employment data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Employment"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee employment data"}}}},"/organisations/{organisationId}/Holidays":{"post":{"tags":["Holidays"],"summary":"Create holidays","description":"Creates one or more holidays for specified employees. The holiday is authorised at the same time. You can create holidays for both past and future dates. \r\n<br /> You must request each day of a holiday separately. This means that to create a 2.5 day holiday for an employee, you would need to send an array holding three separate absence requests (or send each individually). \r\n<br /> The endpoint can accept holiday requests based on hours, days, and shifts. The type used must match how the employee is paid. For example requests, [please see the API Guide](https://developer.fourth.com/docs/uk-employee-api/guide#holidays).","operationId":"Holidays_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"holidayList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.HolidayRequest"}}}],"responses":{"200":{"description":"OK","schema":{"description":"Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.","type":"object"}}}},"delete":{"tags":["Holidays"],"summary":"Delete holidays","description":"Deletes one or more holidays for the specified employees. \r\n<br /> This request can delete future holidays without restriction. For past holidays, it can only delete those for salaried employees where the rota has been submitted.","operationId":"Holidays_SetDeleteAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"holidayList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.HolidayDelete"}}}],"responses":{"200":{"description":"OK","schema":{"description":"Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.","type":"object"}}}}},"/organisations/{organisationId}/ImportLogs":{"get":{"tags":["ImportLogs"],"summary":"Check POST Employee processing","description":"Used to check whether POST Employee requests were successfully processed. It returns a status and any relevant error message. We recommend using a request regularly (e.g. daily) to look at recent employee requests.","operationId":"ImportLogs_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"importType","in":"query","description":"Set this to `employee` or `holidayrequest`","required":true,"type":"string"},{"name":"resourceId","in":"query","description":"","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"submissionID","in":"query","required":false,"type":"string","format":"uuid"}],"responses":{"200":{"description":"Gets an array of an Employees import log data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.ImportLog"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee import log data"}}}},"/organisations/{organisationId}/Locations":{"get":{"tags":["Locations"],"summary":"Get locations for the organisation","description":"Returns an array of current (active) workplaces for the organisation.","operationId":"Locations_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Gets an array of the Locations","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Location"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"}}}},"/organisations/{organisationId}/Employees/MultipleEmployments":{"get":{"tags":["MultipleEmployments"],"summary":"Get multiple employments for an employee","description":"<b>This operation is currently in development. Use of this operation is currently restricted to selected customers and partners during this time.</b>","operationId":"MultipleEmployments_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"employeenumber","in":"query","description":"The employees id within the organisation.","required":true,"type":"string"}],"responses":{"200":{"description":"Gets an array of an employees current multiple employments data","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.MultipleEmployment"}}},"400":{"description":"Invalid organisation/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No data found"}}},"post":{"tags":["MultipleEmployments"],"summary":"Create multiple employments","description":"Creates one or more employments.\r\n <b>This operation is currently in development. Use of this operation is currently restricted to selected customers and partners during this time.</b>","operationId":"MultipleEmployments_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"multipleEmploymentList","in":"body","description":"The list of multiple employments to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.MultipleEmployment"}}}],"responses":{"200":{"description":"Create multiple employment for an employee","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.MultipleEmployment"}}},"400":{"description":"Invalid organisation/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"}}}},"/organisations/{organisationId}/Employees/NextOfKin":{"get":{"tags":["NextOfKin"],"summary":"Get next of kin for employees","description":"Returns the next of kin for each employee.","operationId":"NextOfKin_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees Next Of Kin data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.NextOfKin"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee Next Of Kin data"}}}},"/organisations/{organisationId}/Employees/Passports":{"get":{"tags":["Passports"],"summary":"Get passport details for employees","description":"Returns the passports details associated with an employee. An employee may have multiple records returned.","operationId":"Passports_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees passport data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Passport"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee passport data"}}}},"/organisations/{organisationId}/Employees/PaymentDetails":{"get":{"tags":["PaymentDetails"],"summary":"Get payment details for employees","description":"Returns the payment details of employees. If the employee updated these details during the specified time range, then all payment details are returned as separate records.\r\n\r\nIf you want only the most up-to-date details, set the start query parameter to `0d`.","operationId":"PaymentDetails_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees payment detail data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Export.PaymentDetail"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee payment detail data"}}},"post":{"tags":["PaymentDetails"],"summary":"Import employees payment details via a POST request","operationId":"PaymentDetails_SetDataAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"string"},{"name":"bankDetailList","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.PaymentDetail"}}}],"responses":{"200":{"description":"OK","schema":{"description":"Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.","type":"object"}},"202":{"description":"The request is on the queue to be processed","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.PaymentDetail"}}},"400":{"description":"Invalid organisation/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"}}}},"/organisations/{organisationId}/Employees/PayParts":{"get":{"tags":["PayParts"],"summary":"Get shift details for a pay period","description":"Returns information about the shifts that occurred during the pay period, such as start time and end, hours worked, job code and description. There will be a record for each shift.","operationId":"PayParts_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"delta","in":"query","description":"Allows you to get all records. <br />  — `true`: Results are filtered by the specified time range.<br />  — `false`: All records are returned. The other time-related parameters are ignored.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Gets an array of an Employees pay part data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.PayPart"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee pay part data"}}}},"/organisations/{organisationId}/Exports/PayPartsExport/{paybasisID}/{taxyear}/{payperiod}":{"get":{"tags":["PayPartsExport"],"summary":"Get pay parts export","description":"Gets a standard SuperJournal export. <b>This operation is currently in development. Use of this operation is currently restricted to selected customers and partners during this time.</b>","operationId":"PayPartsExport_GetPayPartsAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"","required":true,"type":"string"},{"name":"paybasisID","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"taxyear","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"payperiod","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Okay","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.PayPartExport"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No pay parts data"}}}},"/organisations/{organisationId}/Exports/PayPartsExport/{paybasisID}/{taxyear}/{payperiod}/{employeenumber}":{"get":{"tags":["PayPartsExport"],"summary":"Get pay parts export by employee","description":"Gets a standard SuperJournal export. <b>This operation is currently in development. Use of this operation is currently restricted to selected customers and partners during this time.</b>","operationId":"PayPartsExport_GetPayPartsAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"","required":true,"type":"string"},{"name":"paybasisID","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"taxyear","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"payperiod","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"employeenumber","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"Okay","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.PayPartExport"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No pay parts data"}}}},"/organisations/{organisationId}/Exports/PostPayrunExport/{paybasisID}/{taxyear}/{payperiod}":{"get":{"tags":["PayPartsExport"],"summary":"Get post pay-run export","description":"Gets a standard SuperJournal export. <b>This operation is currently in development. Use of this operation is currently restricted to selected customers and partners during this time.</b>","operationId":"PayPartsExport_GetPostPayrunAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"","required":true,"type":"string"},{"name":"paybasisID","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"taxyear","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"payperiod","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Okay","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.PostPreviewExport"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No pay parts data"}}}},"/organisations/{organisationId}/PayrollPeriod":{"get":{"tags":["PayrollPeriod"],"summary":"Get payroll periods","description":"Returns the details of any payroll periods during the specified period.","operationId":"PayrollPeriod_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"}],"responses":{"200":{"description":"Gets an array of payroll period data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.PayrollPeriod"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee payroll period data"}}}},"/organisations/{organisationId}/Employees/Payslips":{"get":{"tags":["Payslips"],"summary":"Get payslip details","description":"Returns the details of any payslips issued during the time period. There will be one record returned for each transaction (or “element”) on the payslip.","operationId":"Payslips_GetDataAsync","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"organisationId","in":"path","description":"The unique Fourth ID for the business.","required":true,"type":"string"},{"name":"start","in":"query","description":"Use with `duration` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"duration","in":"query","description":"Use with `start` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateFrom","in":"query","description":"Use with `dateTo` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Use with `dateFrom` to specify a time range. See [Query Parameter Behaviour](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference#tag/Query-parameter-behaviour).","required":true,"type":"string"}],"responses":{"200":{"description":"Gets an array of an Employees payslip data for a date range","schema":{"type":"array","items":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Payslip"}}},"400":{"description":"Invalid organisation/time filters/parameters result in a bad request"},"401":{"description":"Unauthorized call made for the organisation"},"404":{"description":"No employee data"}}}}},"definitions":{"Fourth.PeopleSystem.Integration.Repositories.Models.Absence":{"description":"PS employee absences","type":"object","properties":{"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"Reference":{"description":"A unique Fourth ID for each absence record.","type":"string"},"Type":{"description":"Whether the employee's work schedule is shift work, hourly work, or by day. One of `D`, `days`, `S`, `shifts`, `H`, or `hours`.","type":"string"},"Days":{"format":"int32","description":"The number of days, shifts or hours for this leave; dependent on the how the employee is scheduled. This can be decimal; for example `4.5` for 4.5 hours.","type":"integer"},"StartDate":{"format":"date-time","description":"The day the leave begins.","type":"string"},"EndDate":{"format":"date-time","description":"The day the leave ends.","type":"string"},"Status":{"description":"The status of the request in Fourth. One of:\r\n<br /> `Added` — the absence was successfully added into Fourth.\r\n<br /> `ValidationError` — there was an issue with creating the absence in Fourth. \r\n<br /> `Deleted` — the absence was deleted from Fourth.","type":"string"},"Paid":{"description":"Whether the leave is paid. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Reason":{"description":"A description of the leave.","type":"string"},"ExpectedReturn":{"description":"Description of when the employee is expected to return to work.","type":"string"},"ExpectedReturnDate":{"format":"date-time","description":"Date when the employee is expected to returned to work.","type":"string"},"MaternityDueDate":{"format":"date-time","description":"Date when the employee is or was due to give birth.","type":"string"},"MaternityDeliveryDate":{"format":"date-time","description":"Date when the employee gave birth.","type":"string"},"Documentation":{"description":"A description of any documentation that is related to this absence.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.AbsenceImport":{"required":["EmployeeNumber","Days","StartDate","EndDate","AbsenceID"],"type":"object","properties":{"QualifyingDays":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.QualifyingDaysClass"},"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"Days":{"format":"int32","description":"The number of days, shifts or hours. This can be decimal; for example `4.5`.","type":"integer"},"StartDate":{"format":"date-time","description":"The day the leave is set to begin.\r\n<br />Accepted formats are: `2021-15-05 10:10:10`, `2021-may-15 10:10:10`, `15 MAY 2021 10:10:10`, `15-May-2021 10:10:10`, `2021-May-15 10:10:10`, `15 may 2021 10:10:10`, `2021/may/15 10:10:10`, and `05-15-2021 10:10:10`. The time part of the datetime is ignore.","type":"string"},"EndDate":{"format":"date-time","description":"The day the leave is set to end.","type":"string"},"Description":{"description":"A description (or absence name) for the absence.","type":"string"},"DocumentsSeen":{"description":"Whether or not any documents related to this absence have been provided by the employee.","type":"string"},"DoctorsNote":{"description":"Whether a doctors note was provided.","type":"string"},"DoctorsNoteStartDate":{"description":"The start date of any leave that a doctor has prescribed for an employee.","type":"string"},"DoctorsNoteEndDate":{"description":"The end date of any leave that a doctor has prescribed for an employee.","type":"string"},"SubmissionID":{"format":"uuid","description":"A unique identifier for this request.","type":"string","example":"00000000-0000-0000-0000-000000000000"},"AbsenceID":{"format":"int32","description":"The third-party identifier for the absence.","type":"integer"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.QualifyingDaysClass":{"type":"object","properties":{"Monday":{"description":"The days that the employee normally works (their contracted working days). In this case, whether they work mondays. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Tuesday":{"description":"Whether the employee normally works Tuesdays. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Wednesday":{"description":"Whether the employee normally works Wednesdays. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Thursday":{"description":"Whether the employee normally works Thursdays. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Friday":{"description":"Whether the employee normally works Fridays. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Saturday":{"description":"Whether the employee normally works Saturdays. One of `Y`, `Yes`, `N` or `No`.","type":"string"},"Sunday":{"description":"Whether the employee normally works Sundays. One of `Y`, `Yes`, `N` or `No`.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.AbsenceUpdate":{"required":["AbsenceID","EmployeeNumber","Days","StartDate","EndDate"],"type":"object","properties":{"QualifyingDays":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.QualifyingDaysClass"},"AbsenceID":{"format":"int32","description":"The third-party ID for the absence record.","type":"integer"},"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"Days":{"format":"int32","description":"The number of days, shifts or hours. This can be decimal; for example `4.5`.","type":"integer"},"StartDate":{"format":"date-time","description":"The day the leave is set to begin.\r\n<br />Accepted formats are: `2021-15-05 10:10:10`, `2021-may-15 10:10:10`, `15 MAY 2021 10:10:10`, `15-May-2021 10:10:10`, `2021-May-15 10:10:10`, `15 may 2021 10:10:10`, `2021/may/15 10:10:10`, and `05-15-2021 10:10:10`. The time part of the datetime is ignore.","type":"string"},"EndDate":{"format":"date-time","description":"The day the leave is set to end.","type":"string"},"Description":{"description":"A description (or absence name) for the absence.","type":"string"},"DocumentsSeen":{"description":"Whether or not any documents related to this absence have been provided by the employee.","type":"string"},"DoctorsNote":{"description":"Whether a doctors note was provided.","type":"string"},"DoctorsNoteStartDate":{"description":"The start date of any leave that a doctor has prescribed for an employee.","type":"string"},"DoctorsNoteEndDate":{"description":"The end date of any leave that a doctor has prescribed for an employee.","type":"string"},"SubmissionID":{"format":"uuid","description":"A unique identifier for this request.","type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.AbsenceDelete":{"required":["EmployeeNumber","AbsenceID"],"type":"object","properties":{"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"AbsenceID":{"format":"int32","description":"The third-party identifier for the absence.","type":"integer"},"SubmissionID":{"format":"uuid","description":"A unique identifier for this request.","type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Accrual":{"description":"PS employee accrual: Returns the details of any accrual created during the time period. There will be one row for each accrual value.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"ElementName":{"description":"One possible value: `Holiday Balance`.","type":"string"},"ElementType":{"description":"One possible value: `ACCRUAL`.","type":"string"},"StartDateTime":{"format":"date-time","description":"The date when you requested this data. The format is `yyyy-mm-ddT00:00:00`.","type":"string"},"Units":{"format":"double","description":"The number of **hours** or **days** that the employee has accrued as holidays. This value is negative if the employee has been given leave they have not yet accrued.","type":"number"},"UnitType":{"description":"Whether the value of **Units** is in `Days` or `Hours`.","type":"string"},"IsFlexible":{"description":"Whether the employee is: <br />\r\n`Yes` — A flexible employee. <br />\r\n`No` — A full-time, part-time or casual employee.","type":"string"},"AvgSummary":{"format":"double","description":"Average hours per day that the employee works.","type":"number"},"AvgTime":{"format":"double","description":"Average hours per week that the employee works.","type":"number"},"AvgDays":{"format":"double","description":"Average days per week that the employee works.","type":"number"},"DayRate":{"format":"double","description":"The average hours per day (**AvgSummary**) multiplied by the employee’s hourly pay rate.","type":"number"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Address":{"description":"PS employee address: This resource returns the addresses associated with an employee.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"Reference":{"description":"The individual record ID for an address. An employee may have multiple address records returned in the same request.","type":"string"},"EffectiveDate":{"format":"date-time","type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"AddressLine3":{"type":"string"},"AddressLine4":{"type":"string"},"AddressTown":{"type":"string"},"AddressMunicipality":{"type":"string"},"AddressDistrict":{"type":"string"},"AddressCode":{"type":"string"},"AddressProvince":{"type":"string"},"AddressCountry":{"type":"string"},"EmailWork":{"type":"string"},"EmailHome":{"type":"string"},"TelephoneWork":{"type":"string"},"TelephoneHome":{"type":"string"},"TelephoneMobile":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.CountrySpecific":{"description":"PS employee country specific: This resource returns any country-specific fields that are not included in the main schema, e.g. US social security number or UK NI number.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"Country":{"type":"string"},"Property":{"type":"string"},"Value":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Dependent":{"description":"PS employee dependent: This resource returns the dependents listed for each employee during the specified time period.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"DependentReference":{"description":"The individual record ID for each dependent. An employee may have multiple dependent records returned in the same request.","type":"string"},"Name":{"type":"string"},"DependentType":{"type":"string"},"DateOfBirth":{"format":"date-time","type":"string"},"DependentID":{"type":"string"},"Nationality":{"type":"string"},"PassportNumber":{"type":"string"},"DependentPercent":{"format":"double","type":"number"},"Gender":{"type":"string"},"Occupation":{"type":"string"},"Income":{"format":"double","type":"number"},"Address":{"type":"string"},"Telephone":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Division":{"type":"object","properties":{"DivisionId":{"format":"int32","description":"Fourth ID for the division. This is unique within the customer's data, but may not be unique across multiple customer instances.","type":"integer"},"DivisionName":{"description":"The name of the division in a location; for example, `bar`. Division names are not unique across the business.","maxLength":50,"minLength":0,"type":"string"},"AccountingSystemCode":{"description":"A unique ID for the division that comes from external software such as a third-party accounting system.","maxLength":20,"minLength":0,"type":"string"},"DivisionGUID":{"description":"Fourth's globally unique ID for this division.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Document":{"description":"PS employee documents: This resource returns any documents listed for each employee during the specified time period.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"Reference":{"description":"The individual record ID for each document. An employee may have multiple document records returned in the same request.","type":"string"},"Type":{"type":"string"},"Number":{"type":"string"},"Country":{"type":"string"},"IssueDate":{"format":"date-time","type":"string"},"ArrivalDate":{"format":"date-time","type":"string"},"ExpiryDate":{"format":"date-time","type":"string"},"HolidayStart":{"format":"date-time","type":"string"},"HolidayEnd":{"format":"date-time","type":"string"},"IsRequired":{"type":"boolean"},"Processed":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.Employee":{"description":"PS employee (used for imports)\r\nNotice that there are 2 employee classes: One meant for import and the other for export.\r\nThey are part of different namespaces so we can use \"Employee\" entity when serializing them to XML, regardless of its an import or an export","required":["EmployeeNumber","FirstName","Surname","DateOfBirth","Gender","Address1","Town","Location","Division","JobTitle","StartDate","PaidByRota","IncludedInRota","EmploymentType"],"type":"object","properties":{"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`. When not supplied, Fourth will generate an employee number.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`,`0-9`, and `-`. Spaces are not allowed.","maxLength":10,"minLength":1,"type":"string"},"Title":{"description":"A title if provided. For example, `Miss`, `Dr`, `Professor`. \r\n<br /><br /><em> Accepted characters:</em> `a-Z`, `. - ' /` and spaces.","maxLength":35,"minLength":1,"type":"string"},"FirstName":{"description":"The employee's first (or given) name.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- ' — —` and space.","maxLength":49,"minLength":1,"type":"string"},"MiddleName":{"description":"The employee's  middle names.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- ' — —` and space.","maxLength":49,"minLength":1,"type":"string"},"Surname":{"description":"The employee's last (or family) name.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- ' — —` and space.","maxLength":49,"minLength":1,"type":"string"},"PreferredName":{"description":"The name the employee prefers to be called by; for example, <b>Liz</b> rather than <b>Elizabeth</b>. This is used onscreen and on some reports.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- ' — —` and space.","maxLength":49,"minLength":1,"type":"string"},"DateOfBirth":{"format":"date-time","description":"Employee's date of birth in the format `yyyy-mmm-dd`. For example, `2003-Sep-01`.\r\n<br />Fourth will do a basic validation check that the employee's age is above 10 and below 100.","type":"string"},"Gender":{"description":"The employee's gender, for tax and legal purposes.\r\n<br />One of: `Female`, `female`, `F`, `f` or `Male`, `male`, `M`, `m`.","type":"string"},"MaritalStatus":{"description":"The marital status of the employee. One of: `Single`, `Married`, `Divorced`, `Widowed`, `Separated`, `Co-habiting`, `Civil Partnership`.\r\n<br />This field may be mandatory depending on the customer's settings. If mandatory, then any requests missing a value will receive an error response.","type":"string"},"Address1":{"description":"First line of the employee's address; for example, `Flat 1 Claridge House`.\r\n <br /><br /><em>Accepted characters:</em> `a-Z`, `0-9`, space, and all special characters other than `|` and <code>`</code>.","maxLength":32,"minLength":4,"type":"string"},"Address2":{"description":"Second line of the employee's address; for example, `91 Baker Street`.\r\n <br /><br /><em>Accepted characters:</em> `a-Z`, `0-9`, space, and all special characters other than `|` and <code>`</code>.","maxLength":32,"minLength":4,"type":"string"},"Address3":{"description":"Third line of the employee's address; for example, `City of Westminster`.\r\n <br /><br /><em>Accepted characters:</em> `a-Z`, `0-9`, space, and all special characters other than `|` and <code>`</code>.","maxLength":32,"minLength":4,"type":"string"},"Town":{"description":"The town the employee's address is in.","maxLength":32,"minLength":3,"type":"string"},"County":{"description":"The country the employee's address is in.","maxLength":32,"minLength":3,"type":"string"},"Postcode":{"description":"The postcode for the address. One separator is allowed but not required. This can be either a space or hyphen. \r\n<br />Example valid formats: `NW16XE`, `NW1 6XE`, and `NW1-6XE`.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `0-9`, `-` and space.","maxLength":9,"minLength":5,"type":"string"},"HomeTel":{"description":"The landline number of the employee.\r\n<br /> Either a landline number or a mobile number is required. \r\n<br /><br /><em>Accepted characters:</em> `0-9`","maxLength":20,"minLength":4,"type":"string"},"MobileTel":{"description":"The mobile phone number of the employee.\r\n<br /> Either a landline number or a mobile number is required. \r\n<br /><br /><em>Accepted characters:</em> `0-9`","maxLength":20,"minLength":4,"type":"string"},"Email":{"description":"The employee's work email address. \r\n<br />Only addresses that have a valid format are accepted; that is: name@domain.xx.xx or similar.","maxLength":120,"minLength":0,"type":"string"},"HomeEmail":{"description":"The employee's home email address. \r\n<br />Only addresses that have a valid format are accepted; that is: name@domain.xx.xx or similar.","maxLength":120,"minLength":0,"type":"string"},"NIN":{"description":"The National Insurance (NI) number for the employee. If included this must be unique. The format of NI numbers is two letters, 6 numbers, then 1 letter (A-D); for example, `SK123456A`. \r\nFourth will validate that the NI number matches the [format as set by HMRC](https://en.wikipedia.org/wiki/National_Insurance_number).\r\n<br /> This field may be mandatory depending on the customer's settings. If mandatory, then any requests missing a value will receive an error response.\r\n<br /> Note that you cannot send in an Irish PPS number in this field.\r\n<br /><br /><em>Accepted characters:</em> `A-Z`, `0-9`. Letters must be uppercase. Any spaces are removed before processing.","maxLength":9,"minLength":9,"type":"string"},"Location":{"description":"This must match a Location that already exists in Fourth for the customer.  \r\n<br />The value is case insensitive, however, spaces used must match.","type":"string"},"Division":{"description":"This must match a Division that already exists in Fourth for the customer.  \r\n<br />The value is case insensitive, however, spaces used must match.","type":"string"},"JobTitle":{"description":"This must match a Job Title that already exists in Fourth for the customer.  \r\n<br />The value is case insensitive, however, spaces used must match.","type":"string"},"StartDate":{"format":"date-time","description":"The day the employee began employment. Format: `yyyy-mmm-dd`. For example, `2021-Oct-31`.\r\n<br />Fourth will check that this is a valid date (and later than the date of birth).","type":"string"},"TerminationDate":{"format":"date-time","description":"The day the employee stopped being employed. Format: `yyyy-mmm-dd`. For example, `2021-Dec-31`.\r\n<br /> Fourth will check that this is a valid date (and later than the `StartDate`).","type":"string"},"PaidByRota":{"description":"Whether or not the employee is paid a salary, or paid by the hour. Note that the Job Title in Fourth in part determines whether a job is salaried or not. One of:\r\n<br /> `Yes`, `Y` — an hourly or shiftwork employee \r\n<br /> `No`, `N` — salaried employee  \r\n<br /> When `Y` or `Yes`, then you must also provide values for:\r\n<br /> — `RateOfPay`\r\n<br /> — `PayType`, either `H` or `S`\r\n<br /><br /> When `N`or `No`, then instead provide a value for `AnnualSalary`. Leave `RateOfPay` and `PayType` blank.","type":"string"},"IncludedInRota":{"description":"Whether to include the employee in the wage cost analysis for each location. Options are `Yes`, `Y`, or `No`, `N`.\r\n<br /> When `Yes` or `Y`, the employee's wages are included in the wage cost analysis. Use `Yes` or `Y` for all employees except where otherwise advised by the customer or Fourth that the employee does not belong to a specific location.","type":"string"},"PayType":{"description":"Where `PaidByRota` is `Yes` or `Y`, then the value can be:\r\n<br /> `H` — hourly\r\n<br /> `S` — shift\r\n<br /> Whether this value can be hourly or shift depends on the \"Allowed Pay types\" setting for the Job Title.\r\n<br /> The `PayType` field is normally left blank if `PaidByRota` is `No` or `N`.","type":"string"},"RateOfPay":{"format":"double","description":"The rate of pay. For hourly workers, this is the hourly rate; e.g. `12.50`. For shift workers, this is the amount per shift; e.g. `120.00`. The value is ignored for salaried workers. If pay bands are set up for the customer, then Fourth will validate the value based on the bandings.\r\n<br /> Where `PaidByRota` is `Yes` or `Y`, then this value is optional. The value must be an integer or decimal number, and must be either `0` or a positive number. If the value contains more than two digits after the decimal point, then it is rounded. For example, 12.5690 would become 12.57 after processing. \r\n<br /> You must leave this field blank if `PaidByRota` is `No` or `N`.","type":"number"},"AnnualSalary":{"format":"double","description":"For salaried employees this is their annual salary before taxes and any other deductions.\r\n<br /> The value must be an integer or decimal number, and must be either `0` or a positive number. If the value contains more than two digits after the decimal point, then it is rounded. For example, 12.5690 would become 12.57 after processing.\r\n<br /> If upload value for `PaidByRota` is `Y` or `Yes`, then the value must be blank or `0`.","type":"number"},"EmploymentType":{"description":"The type of employment. Normally parttime and fulltime is salaried; however, this is configurable for each customer. One of:\r\n<br /> `Fulltime` or `Full time` — salaried or rota employees working fulltime.\r\n<br /> `Parttime` — salaried or rota employees working parttime for a set amount of hours a week.\r\n<br /> `Casual` — freelance, seasonal or zero-hour workers.\r\n<br /> `Flex` — flexible hours employee with a minimum set amount of hours per week.","type":"string"},"Contract":{"description":"The name of an existing active contract for the employee in Fourth. This must match the name exactly. For example, `Anil Bloggs 2019 11 22` (do not add any file extension).\r\n<br /> The request will add the contract to the specified Job Title if it is not already assigned to that Job Title.\r\n<br /> Note that, depending on the customer's settings, this field may be mandatory.","type":"string"},"ContractHours":{"format":"double","description":"The number of hours the employee is set to work in a week. For example:\r\n<br /> — For fulltime, salary or rota, this will be a value around `37.5` or `40`.  \r\n<br /> — For parttime, salary or rota, this will be a value under `35`. \r\n<br /> — For flex, normally rota, this is the minimum contracted hours weekly for the employee. Normally, the employee can still do overtime.\r\n<br /> — For casual, this may be set to zero. \r\n<br /><br /> The value must be an integer or decimal number, and must be either `0` or a positive number. If the value contains more than two digits after the decimal point, then it is rounded. For example, 37.503 would become 37.50 after processing.","type":"number"},"PaymentMethod":{"description":"How the employee will be paid. The payment methods you can specify depends on the global settings for the customer. \r\n<br /> Possible options are: `BACS`, `Cheque`, `Cash`, and `None`. Use `None` if the payment method is not known.\r\n<br /><b>Barclayscard Prepaid</b> is not supported via the API. If this is the payment method required, then enter `None`. The customer's HR team will need to complete the Barclaycard details via the Fourth UI. \r\n<br /> Note that there is currently no validation on this field.","type":"string"},"BankName":{"description":"This is the name of the bank the employee's pay is deposited in. \r\nThis is required if the payment method is `BACS`, otherwise the value is ignored. \r\n<br /> Accepted characters: `a-Z`, and `-`. Spaces are not allowed.","maxLength":100,"minLength":1,"type":"string"},"BankAccountName":{"description":"This is the official name of the bank account holder (normally the employee).\r\nThis is required if the payment method is `BACS`, otherwise the value is ignored.","maxLength":50,"minLength":1,"type":"string"},"BankSortCode":{"description":"The 6-digit number that identifies the UK bank that the employee's pay is deposted in. \r\nThis is required if the payment method is `BACS`, otherwise the value is ignored.","maxLength":6,"minLength":4,"type":"string"},"BankAccountNumber":{"description":"The bank account number for the account the employee's pay is deposited in.\r\nThis is required if the payment method is `BACS`, otherwise the value is ignored. \r\n<br /><br /><em>Accepted characters:</em> `0-9`.","maxLength":8,"minLength":6,"type":"string"},"BuildingSocietyRollNumber":{"description":"A number used to identify an account with a building society.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `0-9`, special characters, spaces, and other characters.","maxLength":50,"minLength":1,"type":"string"},"NOK1Title":{"description":"The title for the primary next of kin. For example, `Miss`, `Dr`, `Professor`. \r\n<br /><br /><em> Accepted characters:</em> `a-Z`, `. - ' /` and spaces.","maxLength":35,"minLength":1,"type":"string"},"NOK1Firstname":{"description":"The first (or given) name of the primary next of kin. \r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- '` and space.","maxLength":50,"minLength":1,"type":"string"},"NOK1Surname":{"description":"The last (or family) name of the primary next of kin.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- '` and space.","maxLength":50,"minLength":1,"type":"string"},"NOK1Relationship":{"description":"How the primary next of kin is related to the employee. For example, `mother`, `friend`.","maxLength":50,"minLength":1,"type":"string"},"NOK1Phone1":{"description":"Contact phone number for the primary next of kin.","maxLength":20,"minLength":4,"type":"string"},"NOK1Phone2":{"description":"Additional contact phone number for the primary next of kin.","maxLength":20,"minLength":4,"type":"string"},"NOK1Email":{"description":"The primary next of kin's email address. \r\n<br />Only addresses that have a valid format are accepted; that is: name@domain.xxx or similar.","type":"string"},"NOK2Title":{"description":"A title if provided for the secondary next of kin. For example, `Miss`, `Dr`, `Professor`. \r\n<br /><br /><em> Accepted characters:</em> `a-Z`, `. - ' /` and spaces.","maxLength":35,"minLength":1,"type":"string"},"NOK2Firstname":{"description":"The first (or given) name of the secondary next of kin. \r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- '` and space.","maxLength":50,"minLength":1,"type":"string"},"NOK2Surname":{"description":"The last (or family) name of the secondary next of kin.\r\n<br /><br /><em>Accepted characters:</em> `a-Z`, `- '` and space.","maxLength":50,"minLength":1,"type":"string"},"NOK2Relationship":{"description":"How the secondary next of kin is related to the employee. For example, `brother`, `flatmate`.","maxLength":50,"minLength":1,"type":"string"},"NOK2Phone1":{"description":"Contact phone number for the secondary next of kin.","maxLength":20,"minLength":4,"type":"string"},"NOK2Phone2":{"description":"Additional contact phone number for the secondary next of kin.","maxLength":20,"minLength":4,"type":"string"},"NOK2Email":{"description":"The secondary next-of-kin's email address. \r\n<br />Only addresses that have a valid format are accepted; that is: name@domain.xxx or similar.","type":"string"},"FTE":{"format":"double","description":" Full time equivalent (FTE) value for a parttime employee. This field is mandatory for parttime salary or rota employees, and the values here are used in holiday calculations. The possible value depends on each customer’s settings:\r\n <br /> For hourly rota employees, the value is the number of hours worked in a week, e.g. `12`.\r\n<br /> For shift rota employees, the value is the number of shifts worked in a week, e.g. `2`.\r\n<br /> For salaried employees, this is percentage of the work week for the Job Title (at fulltime), as a decimal amount. For example, if the job is 5 days a week, and the employee works 3 days, (3/5), then the value is `0.6`.","type":"number"},"OverrideFTE":{"description":"","type":"string"},"FTEDays":{"format":"double","description":"","type":"number"},"FTEShifts":{"format":"double","description":"","type":"number"},"FTEHours":{"format":"double","description":"","type":"number"},"HolidayDaysTaken":{"format":"double","description":"","type":"number"},"HolidayAverageHoursPerWeek":{"format":"double","description":"","type":"number"},"HolidayAverageDaysPerWeek":{"format":"double","description":"","type":"number"},"HolidayEffectiveDate":{"format":"date-time","description":"","type":"string"},"EmployeeSourceDesc":{"description":"","type":"string"},"EffectiveDate":{"format":"date-time","description":"","type":"string"},"Nationality":{"description":"","type":"string"},"CountryOfResidence":{"description":"","type":"string"},"ProofOfEligibility":{"description":"","type":"string"},"PassportNumber":{"description":"","type":"string"},"PassportExpiryDate":{"format":"date-time","description":"","type":"string"},"DrivingLicence":{"description":"","type":"string"},"IndefiniteLeave":{"description":"","type":"string"},"DocumentsSeenAndCopied":{"description":"","type":"string"},"WorkPermit":{"description":"","type":"string"},"WorkPermitType":{"description":"","type":"string"},"WorkPermitNumber":{"description":"","type":"string"},"WorkPermitExpiryDate":{"format":"date-time","description":"","type":"string"},"StudentVisa":{"description":"","type":"string"},"StudentVisaType":{"description":"","type":"string"},"StudentVisaStartDate":{"format":"date-time","description":"","type":"string"},"StudentVisaEndDate":{"format":"date-time","description":"","type":"string"},"StudentVisaNumber":{"description":"","type":"string"},"StudentVisaExemptionStartDate":{"format":"date-time","description":"","type":"string"},"StudentVisaExemptionEndDate":{"format":"date-time","description":"","type":"string"},"StudentVisaDocumentsSeenAndCopied":{"description":"","type":"string"},"DrivingLicenceExpiryDate":{"format":"date-time","description":"","type":"string"},"SettledStatus":{"description":"The [residency status](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#eucitizens) of a European (EU) employee. One of: <br />\r\n— `yes`: the employee has settled status <br />\r\n— `no`: the employee does not have this status <br />","type":"string"},"SettledStatusShareCode":{"description":"If `SettledStatus` is `yes`, use this field to include the government-granted share code. <br /><br /><br /><em>Accepted characters</em>: `0-9`","maxLength":20,"minLength":1,"type":"string"},"PreSettledStatus":{"description":"The [residency status](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#eucitizens) of a European (EU) employee. One of: <br />\r\n— `yes`: the employee has pre-settled status <br />\r\n— `no`: the employee does not have this status <br />","type":"string"},"PreSettledStatusExpiryDate":{"format":"date-time","description":"If `PreSettledStatus` is `yes`, then you can include the expiry date for the status. Use the format: `yyyy-MMM-dd`, for example: `2021-Apr-16`.","type":"string"},"TemporaryLeaveToRemain":{"description":"The [residency status](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#eucitizens) of a European (EU) employee. One of: <br />\r\n— `yes`: the employee has pre-settled status <br />\r\n— `no`: the employee does not have this status <br />","type":"string"},"TemporaryLeaveToRemainExpiryDate":{"format":"date-time","description":"If `TemporaryLeaveToRemain` is `yes`, then you can include the expiry date for the status. Use the format: `yyyy-MMM-dd`, for example: `2021-Apr-16`.","type":"string"},"SensitiveInfo":{"$ref":"#/definitions/Fourth.PeopleSystem.Integration.Repositories.Models.Import.SensitiveInfo"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.Document":{"type":"object","properties":{"DocumentType":{"type":"string"},"DocumentPath":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.P45":{"type":"object","properties":{"EmployerPayBasisID":{"format":"int32","type":"integer"},"WTD":{"type":"string"},"P45_Provided":{"type":"string"},"Previous_Employer_Office_No":{"type":"string"},"Previous_Employer_Ref_No":{"type":"string"},"Previous_Employer_Leave_Date":{"format":"date-time","type":"string"},"P45_Tax_Code":{"type":"string"},"P45_Tax_Code_W1M1":{"type":"string"},"P45_Last_Week":{"type":"string"},"P45_Last_Month":{"type":"string"},"P46_Statement":{"type":"string"},"SLD":{"type":"string"},"SLD_Direct_Payment":{"type":"string"},"SLD_Plan":{"type":"string"},"PGL":{"description":"Whether the employee has a Post Graduate Loan (PGL). One of: <br />\r\n— `Y`: they do have a PGL<br />\r\n— `N`: they do not have a PGL<br />\r\nThis field can be blank.","type":"string"},"PGL_Direct_Payment":{"description":"For employees with a Post Graduate Loan (PGL) only. One of: <br />\r\n— `Y`: The employee has a private agreement to pay back the loan with the student loan company.<br />\r\n— `N`: The employee does not have a private agreement with the company and may require deductions from payroll. <br />\r\nThis field can be blank.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.SensitiveInfo":{"type":"object","properties":{"EthnicOrigin":{"description":"The employee's self-declared ethnic background. For a list of possible options, see [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"},"IsDisabled":{"description":"","type":"string"},"DisabledNotes":{"description":"A free-text field for notes about any disability the employee may have.","type":"string"},"Religion":{"description":"","type":"string"},"HasDependants":{"description":"","type":"string"},"DependentChildren":{"format":"int32","description":"","type":"integer"},"DependentDisabled":{"format":"int32","description":"","type":"integer"},"DependentElderly":{"format":"int32","type":"integer"},"Languages":{"type":"string"},"SexualOrientation":{"description":"The employee's self-declared sexual orientation. For a list of possible options, see [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"},"Disability":{"description":"A description of the employee's disabilities, if provided. This uses a set of pre-defined descriptions, which you can find in [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"},"GenderIdentity":{"description":"The employee's self-declared gender identity. For a list of possible options, see [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Export.Employee":{"description":"PS employee (used for exports).\r\nNotice that there are 2 employee classes: One meant for import and the other for export.\r\nThey are part of different namespaces so we can use \"Employee\" entity when serializing them to XML, regardless of its an import or an export\r\n\r\nThis resource collects the personal and contact details for an employee.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"PayrollNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `EmployeeNumber`.","type":"string"},"FAID":{"description":"The [Fourth Account ID](https://developer.fourth.com/en-gb/docs/identity-and-access-management#accounts) for the employee. This unique ID is used across the Fourth Platform, and is an 18-digit alphanumeric string. Note that rehired employees receive a new `FAID`.","type":"string"},"PayrollID":{"format":"int32","description":"The pay basis the employee is attached to.","type":"integer"},"CompanyID":{"format":"int32","type":"integer"},"CompanyName":{"type":"string"},"Paybasis":{"type":"string"},"FirstName":{"description":"The employee's first (or given) name.","maxLength":49,"minLength":0,"type":"string"},"MiddleName":{"type":"string"},"LastName":{"description":"The employee's surname.","maxLength":49,"minLength":0,"type":"string"},"PreferredName":{"type":"string"},"Title":{"type":"string"},"Initials":{"type":"string"},"Gender":{"description":"The employee's gender, for tax and legal purposes.\r\n<br />One of: `Female`, `female`, `F`, `f` or `Male`, `male`, `M`, `m`.","type":"string"},"DateOfBirth":{"format":"date-time","type":"string"},"DateOfDeath":{"format":"date-time","type":"string"},"EthnicOrigin":{"description":"The employee's self-declared ethnic background. For a list of possible options, see [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"},"Nationality":{"type":"string"},"MaritalStatus":{"type":"string"},"MaritalStatusDate":{"format":"date-time","type":"string"},"EducationLevel":{"type":"string"},"IsDisabled":{"type":"boolean"},"Disability":{"description":"A description of the employee's disabilities, if provided. This uses a set of pre-defined descriptions, which you can find in [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"},"Language":{"type":"string"},"Religion":{"type":"string"},"ReligionOther":{"type":"string"},"HasDependents":{"type":"boolean"},"DependentChildren":{"format":"int32","type":"integer"},"DependentDisabled":{"format":"int32","type":"integer"},"DependentElderly":{"format":"int32","type":"integer"},"SexualOrientation":{"description":"The employee's self-declared sexual orientation. For a list of possible options, see [the API Guide](https://developer.fourth.com/en-gb/docs/uk-employee-api/guide#sensitive-information-fields).","type":"string"},"SexualOrientationOther":{"type":"string"},"IR35":{"description":"The IR35 status for an employee. Either: <br />\r\n— `true`: the person falls within IR35 regulation, and their payments must go through payroll. <br />\r\n— `false`: the person is a regular employee.","type":"boolean"},"IsEmployeeFurlough":{"description":"Either:<br />\r\n— `true`: the employee is furloughed. <br />\r\n— `false`: the employee is not furloughed. <br />\r\nIf an employee is made redundant, the value returns to `false`.","type":"boolean"},"FurLoughContractHours":{"format":"double","description":"Used for furlough calculations. This is the number of hours that the employee is normally employed in a week. This is based on the following:<br />\r\n— Flexible employees: the flexible holiday calculation, matching any current legislation. <br />\r\n— All other employees: the weekly contracted hours, or the full-time equivalent (FTE) hours, whichever is relevant for the employee.","type":"number"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.EmployeeSource":{"description":"Returns list of employee source","type":"object","properties":{"SourceDescription":{"description":"The recruitment source for the employee. The possible values are customer-defined.","maxLength":40,"minLength":0,"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Employment":{"description":"PS employee employment: This resource returns the employment details listed for each employee during the specified time period","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"EmploymentReference":{"description":"The individual record ID for each employment. An employee may have multiple employment records returned in the same request.","type":"string"},"EmploymentStartDate":{"format":"date-time","type":"string"},"EmploymentEndDate":{"format":"date-time","type":"string"},"AssignmentStartDate":{"format":"date-time","type":"string"},"AssignmentEndDate":{"format":"date-time","type":"string"},"TerminationReason":{"type":"string"},"Rehire":{"type":"boolean"},"EmploymentType":{"type":"string"},"EmploymentStatus":{"format":"int32","type":"integer"},"IsPermanent":{"type":"boolean"},"IsFulltime":{"type":"boolean"},"IsForeignStudent":{"type":"boolean"},"IsLiveIn":{"type":"boolean"},"Department":{"type":"string"},"DepartmentDescription":{"type":"string"},"JobCode":{"type":"string"},"JobDescription":{"type":"string"},"SiteCode":{"type":"string"},"SiteDescription":{"type":"string"},"ShiftType":{"type":"string"},"PayGroup":{"type":"string"},"WorkingPattern":{"type":"string"},"RateOfPay":{"format":"double","type":"number"},"ContractedHours":{"format":"double","type":"number"},"RateOfPayType":{"type":"string"},"JobGrade":{"type":"string"},"JobGradeDescription":{"type":"string"},"SectionID":{"format":"int32","type":"integer"},"SectionDescription":{"type":"string"},"UD_Group01":{"description":"A user (customer) defined group that the location belongs to. In the Fourth UI, our customers can group locations together to help manage them.","type":"string"},"UD_Group02":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group03":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group04":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group05":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group06":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group07":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group08":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group09":{"description":"A user defined group that the location belongs to.","type":"string"},"UD_Group10":{"description":"A user defined group that the location belongs to.","type":"string"},"IR35":{"description":"The IR35 status for an employee. Either: <br />\r\n— `true`: the person falls within IR35 regulation, and their payments must go through payroll. <br />\r\n— `false`: the person is a regular employee.","type":"boolean"},"ReportsTo":{"description":"The first and last name of the employee's manager.","maxLength":99,"minLength":0,"type":"string"},"ReportsToEmployeeNumber":{"description":"The Employee Number of the employee's manager. Note that this ID is editable by customers.","type":"string"},"ReportsToFAID":{"description":"Fourth Account ID for the employee's manager. This unique ID is used across the Fourth Platform, and is an 18-digit alphanumeric string.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.HolidayRequest":{"description":"Holiday Requests","required":["EmployeeNumber","RequestDate","Value","Type","Unpaid"],"type":"object","properties":{"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"RequestDate":{"format":"date-time","description":"The day the holiday applies to.\r\n<br />Accepted formats are: `2021-15-05 10:10:10`, `2021-may-15 10:10:10`, `15 MAY 2021 10:10:10`, `15-May-2021 10:10:10`, `2021-May-15 10:10:10`, `15 may 2021 10:10:10`, `2021/may/15 10:10:10`, and `05-15-2021 10:10:10`. The time part of the timestamp is ignored.","type":"string"},"Value":{"format":"double","description":"The number of days, shifts or hours. This can be decimal; for example `4.5`. You cannot specify more than one day (or 24 hours) per request:\r\n<br /> — Days must be either `.5` or `1`. \r\n<br /> — Shifts must be between `.5` and `2`. \r\n<br /> — Hours must be between `.5` and `24`.","type":"number"},"Type":{"description":"Whether the employee's work schedule is shift work, hourly work, or by day. One of `D`, `days`, `S`, `shifts`, `H`, or `hours`.","type":"string"},"Unpaid":{"description":"Whether the holiday is being taken as unpaid leave. One of `Y`, `Yes`, `N`, or `No`.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.HolidayDelete":{"description":"Holiday Delete","required":["EmployeeNumber","RequestDate"],"type":"object","properties":{"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"RequestDate":{"format":"date-time","description":"The day the holiday applies to. \r\n<br />Accepted formats are: `2021-15-05 10:10:10`, `2021-may-15 10:10:10`, `15 MAY 2021 10:10:10`, `15-May-2021 10:10:10`, `2021-May-15 10:10:10`, `15 may 2021 10:10:10`, `2021/may/15 10:10:10`, and `05-15-2021 10:10:10`. The time part of the timestamp is ignored.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.ImportLog":{"description":"PS import log","type":"object","properties":{"Id":{"format":"int64","type":"integer"},"XmlType":{"type":"string"},"ReferenceNumber":{"type":"string"},"Xml":{"type":"string"},"Status":{"type":"string"},"DateCreatedUtc":{"format":"date-time","type":"string"},"Error":{"type":"string"},"SubmissionID":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"Result":{"type":"string"},"ClientID":{"format":"int32","type":"integer"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Location":{"description":"Returns the list of Locations","type":"object","properties":{"LocationID":{"format":"int32","description":"Fourth ID for the customer location. This is unique to the customer, but may not be unique across multiple customer instances.","type":"integer"},"Description":{"description":"The name of the location; for example \"Covent Garden Example Restaurant\".","maxLength":50,"minLength":0,"type":"string"},"Country":{"description":"The country; one of `UK`, `Ireland` and `Jersey`. More countries may be added at a future date.","type":"string"},"Area":{"description":"The area (optional); one of `Inner Dublin` or `Outer Dublin`. More areas may be added at a future date.","type":"string"},"AccountingSystemCode":{"description":"A unique ID for the location that comes from external software such as a third-party accounting system.","maxLength":10,"minLength":0,"type":"string"},"LocationGUID":{"description":"Fourth's globally unique ID for the customer location.","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.MultipleEmployment":{"description":"PS employee Multiple Employment","type":"object","properties":{"EmployeeNumber":{"description":"A unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"ME_ID":{"format":"int32","type":"integer"},"Location":{"type":"string"},"Division":{"type":"string"},"Jobtitle":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"PayType":{"type":"string"},"PayAmount":{"format":"double","type":"number"},"PaidByRota":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.NextOfKin":{"description":"PS employee next of kin: This resource returns the next of kin listed for each employee during the specified time period","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"NextOfKinReference":{"type":"string"},"Name":{"type":"string"},"Relationship":{"type":"string"},"AddressReference":{"type":"string"},"AddressEffectiveDate":{"format":"date-time","type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"AddressLine3":{"type":"string"},"AddressTown":{"type":"string"},"AddressMunicipality":{"type":"string"},"AddressDistrict":{"type":"string"},"AddressCode":{"type":"string"},"AddressProvince":{"type":"string"},"AddressCountry":{"type":"string"},"TelephoneHome":{"type":"string"},"TelephoneWork":{"type":"string"},"TelephoneMobile":{"type":"string"},"EmailWork":{"type":"string"},"EmailHome":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Passport":{"description":"PS employee passport: This resource returns any passports associated with an employee.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"PassportText":{"type":"string"},"PassportReference":{"type":"string"},"PassportNumber":{"type":"string"},"IssuingCountry":{"type":"string"},"IssueDate":{"format":"date-time","type":"string"},"ExpiryDate":{"format":"date-time","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Export.PaymentDetail":{"description":"PS employee payment detail: This resource returns the payment details listed for each employee during the specified time period.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"PayMethod":{"type":"string"},"AccountDetails":{"type":"string"},"AccountName":{"type":"string"},"AccountNumber":{"type":"string"},"IBAN":{"type":"string"},"BranchCode":{"type":"string"},"BICSwift":{"type":"string"},"BranchName":{"type":"string"},"Bank":{"type":"string"},"AccountType":{"type":"string"},"AccountCurrency":{"type":"string"},"PaymentReference":{"type":"string"},"SplitPayment":{"type":"string"},"SplitType":{"type":"string"},"SplitValue":{"type":"string"},"SplitOrder":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Import.PaymentDetail":{"description":"PS employee payment details (used for imports)\r\nNotice that there are 2 payment details classes: One meant for import and the other for export.\r\nThey are part of different namespaces so we can use \"Employee\" entity when serializing them to XML, regardless of its an import or an export\r\nSo for reusing the same SP sprc_ImportXML_UpdateEmployee, for Bank Details Import we are renaming the tag 'PaymentDetail' to 'Employee'","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"EmployeeNumber":{"description":"unique ID editable by customers or third-parties, also known as the `PayrollNumber`.","type":"string"},"PayMethod":{"type":"string"},"AccountDetails":{"type":"string"},"AccountName":{"type":"string"},"AccountNumber":{"type":"string"},"IBAN":{"type":"string"},"BranchCode":{"type":"string"},"Bank":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.PayPart":{"description":"PS employee pau part: This resource returns the details of any pay parts created during the time period. There will be one row for each pay part value.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"ElementName":{"type":"string"},"ElementLocalRef":{"type":"string"},"StartDateTime":{"format":"date-time","type":"string"},"EndDateTime":{"format":"date-time","type":"string"},"Units":{"format":"double","type":"number"},"UnitType":{"type":"string"},"Rate":{"format":"double","type":"number"},"Value":{"format":"double","type":"number"},"Reference":{"type":"string"},"Department":{"type":"string"},"DepartmentDescription":{"type":"string"},"JobCode":{"type":"string"},"JobDescription":{"type":"string"},"JobGrade":{"type":"string"},"JobGradeDescription":{"type":"string"},"SiteCode":{"type":"string"},"SiteDescription":{"type":"string"},"ShiftType":{"type":"string"},"IsCallIn":{"type":"boolean"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.PayPartExport":{"type":"object","properties":{"NominalCode":{"type":"string"},"Amount":{"format":"double","type":"number"},"Description":{"type":"string"},"LocationCode":{"type":"string"},"DivisionCode":{"type":"string"},"JobCode":{"type":"string"},"EmployeeNo":{"type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.PostPreviewExport":{"type":"object","properties":{"Employee_ID":{"type":"string"},"Element_Name":{"type":"string"},"Element_Type":{"type":"string"},"Element_Local_Ref":{"type":"string"},"Element_Ledger_Code":{"type":"string"},"Pay_Ded":{"format":"int32","type":"integer"},"Unit":{"type":"string"},"Rate":{"type":"string"},"Value":{"type":"string"},"Currency":{"type":"string"},"Division_Code":{"format":"int32","type":"integer"},"Division_Description":{"type":"string"},"Division_Ledger_Code":{"type":"string"},"Department_Code":{"format":"int32","type":"integer"},"Department_Description":{"type":"string"},"Job_Code":{"format":"int32","type":"integer"},"Job_Description":{"type":"string"},"Job_Ledger_Code":{"type":"string"},"Job_Grade":{"format":"int32","type":"integer"},"Job_Grade_Description":{"type":"string"},"Job_Grade_Ledger_Code":{"type":"string"},"Site_Code":{"format":"int32","type":"integer"},"Site_Description":{"type":"string"},"Site_Ledger_Code":{"type":"string"},"Rota_Date":{"type":"string"},"PayslipCategoryID":{"format":"int32","type":"integer"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.PayrollPeriod":{"description":"PS payroll period: This resource returns the details of any payroll periods during the specified period","type":"object","properties":{"CompanyName":{"type":"string"},"PayrollID":{"format":"int32","description":"The pay basis this data relates to.","type":"integer"},"PeriodName":{"type":"string"},"PeriodNumber":{"format":"int32","type":"integer"},"PeriodTaxYear":{"format":"int32","type":"integer"},"PayDate":{"format":"date-time","type":"string"},"PeriodStartDate":{"format":"date-time","type":"string"},"PeriodEndDate":{"format":"date-time","type":"string"}}},"Fourth.PeopleSystem.Integration.Repositories.Models.Payslip":{"description":"PS employee payslip: This resource returns the details of any payslips issued during the time period.","type":"object","properties":{"EmployeeID":{"format":"int32","description":"Fourth ID for the employee. This ID is globally unique in Fourth.","type":"integer"},"PayslipReference":{"type":"string"},"PayslipDate":{"format":"date-time","type":"string"},"PaymentDate":{"format":"date-time","type":"string"},"TaxCategory":{"type":"string"},"TaxRate":{"type":"string"},"SocialSecurityCategory":{"type":"string"},"SocialSecurityRate":{"type":"string"},"PayGroup":{"type":"string"},"ElementName":{"type":"string"},"ElementCode":{"type":"string"},"ElementCategory":{"type":"string"},"Units":{"format":"double","type":"number"},"UnitType":{"type":"string"},"Rate":{"format":"double","type":"number"},"Value":{"format":"double","type":"number"},"Reference":{"type":"string"},"JobCode":{"type":"string"},"JobDescription":{"type":"string"},"JobGrade":{"type":"string"},"JobGradeDescription":{"type":"string"},"SiteCode":{"type":"string"},"Department":{"type":"string"},"DepartmentDescription":{"type":"string"},"CostCentre":{"type":"string"}}}},"tags":[{"name":"Query parameter behaviour","description":"<b>Required parameters</b> <br /><br />The GET requests have query parameters for filtering results. You must include all query parameters with the request; however, you only need to include a value for `delta` for the request to be accepted. For example:<br /><br />`{ROOT}/organisations/{organisationId}/Employees?start=&duration=&dateFrom=&dateTo=&delta=true`<br /><br /><br /><b>Specifying time ranges</b><br /><br />By default, all GET requests will retrieve data for the last calendar month. You can specify an alternative time range using either `start` and `duration` **OR** `dateFrom` and `dateTo` query parameters. For example:<br /><br /> `{ROOT}/organisations/{organisationId}/Employees/Absences?start=7d&duration=7d&dateFrom=&dateTo=&delta=true`<br /><br />If you use `dateFrom` and `dateTo`, then any values set for `start` and `duration` are ignored. <br /><br /><br /><b>Setting `start` and `duration` values</b><br /><br />These parameters specify a time range relative to the current day.<br />&nbsp; &nbsp; &bull; &nbsp; `start`: the number of days or months in the past to start the time range<br />&nbsp; &nbsp; &bull; &nbsp; `duration`: the number of days or months to include in the results<br /><br /> The days are inclusive. The format is <b>(n)d</b> for days, and <b>(n)m</b> for calendar months. For example: <br />&nbsp; &nbsp; &bull; &nbsp; `7d`: seven days <br />&nbsp; &nbsp; &bull; &nbsp; `0d`: today (for `start`) or zero days (for `duration`) <br />&nbsp; &nbsp; &bull; &nbsp; `2m`: two full calendar months. For example, if it is mid-April, then the export will start from the beginning of February.<br /><br />To use these parameters, you must set a value for both.<br /><br /><br/><b>Setting `dateFrom` and `dateTo` values</b><br /><br />These parameters let you get results by date, using the format `YYYY-MM-DD`. The dates are inclusive.<br /><br />To use these parameters, you must set a value for both.<br /><br /><br /><b>Example requests</b><br/><br />To get employee absences for the last week:<br /><br />`GET <ROOT>/organisations/{organisationId}/Employees/Absences?start=7d&duration=7d&dateFrom=&dateTo=&delta=true` <br /><br />To get the absences of all employees employed in 2017, specify<br /><br />`GET <ROOT>/organisations/{organisationId}/Employees/Absences?start=&duration=&dateFrom=2017-01-01&dateTo=2017-12-31&delta=true` <br /><br />If you wish to include all current and historic records, set the `delta` parameter to `false` in your request. For example, this request retrieves all employees ever employed: <br /><br />`GET <ROOT>/organisations/{organisationId}/Employees?start=&duration=&dateFrom=&dateTo=&delta=false` <br /><br />"}]}