API 3.1.0 Changes

There are some significant changes in this version of the product and a few changes in the API version as outlined below and on the DEVPortal;

Type of change	API Area	Method	Description
Breaking Changes
	Job Template	GET	A change has been made to the JobTemplates API so that the Job Template Status is exposed as part of the result set. Your integration may be impacted by this change depending on how you are retrieving data and schema validations or serializing to objects with older schema.
Enhancements
	User/Parent/Client/Contact/Costcentre	ALL	Added addressline3 field to the outlined records. This field has been added with backward compatibility in mind so you don't need to provide where it is not defined as a mandatory field against the country configuration. If this is set a validation error may be provided that the field is required. We see this field as only being required in the United Kingdom.
	Candidate	GET	Add a filter to retrieve Candidates who are currently on a JobOrder or not on JobOrder .
	Candidate	POST/PUT/PATCH	Gender is now a mandatory field when the country is set to United Kingdom.
	Reference data	GET	Added a new Reference Data API created for retrieving Invoice Bill Code Grouping settings.
Bug Fixes
	ClientContact	PUT	Fixed the creation of duplicate ClientId in the Clientcontact record when updating the ClientContact records via API.
	Candidate	POST	Added validation to address object so it sends an error response when the address is provided as a string in the request object instead of a sub object.
	Candidate	PUT	Candidate update API now fixed to support where current office is inactive and a payee record exists
	Candidate	POST/PUT/PATCH	Fixed validation of gender based on the country that is set in maintenance.
	Candidate	GET	Fixed the Candidate API filter for Id range and dates
	Candidate	POST	Improved the Candidate Skills creation performance.
	CostCentre	POST	Added validation when creating a CostCentre to check all fields are provided in the request body. (Possible breaking change)
	ReferralStage	PUT	Fixed a performance issue.
	JobOrder	PUT	Fixed the issue so we are now able to change the JobOrder status from Closed to Filled.
	JobOrder	PATCH	Fixed so you can patch a joborder with "jobRateFrequencyID" field.
	JobOrder	GET	Fixed the incorrect date format on lastTimesheetenddate field
	JobOrder	POST	Fixed so isPayrollTaxExempt field will be inherited from client record when it is not supplied
	JobOrder	GET	Fixed an issue where previously we were unable to get the correct bill rate in a job order agreement rates
	Payee	POST	Fixed to prevent submission of JobOrder that is filled by a Candidate with a Payee record that has a paygroup of 0.
	Payee	GET, POST, PUT and PATCH	· Added STSL field in the PAYG Tax Details section of the Payee API.
	Payee	Post/Put/Patch	Fixed the AU Payee API so "protectedTypeId" value now contains the correct value.
	Payee	PATCH	Fixed the State which was getting blankedout when updating banking details
	Payee	POST/PUT/PATCH	Fixed only for Payee AU API, so PaygroupId value is no longer appearing in employmentTypeId field value in response.
	Payee	POST	Fixed the issue so rolling deductions created for payees via the API are now included in pay batches
	Job Template	PUT	Fixed where creating/editing a joborder by integration/API, it appears that a fortnightly template cannot be applied/attached unless the job order start date matches the template start date.
	Job Templat	GET	Fixed an issue where previously we were unable to get the correct bill rate in a job template agreement rates
	Debtor	POST	Fixed so we can add invoice fee details in debtor via post call of debtor API
	Debtor	POST (PUT, PATCH)	Debtor is now fixed so a Debtor that has a client contact as a Billng Contact and the Delivery contact allows uppercase characters email address (both emailone and emailtwo)
	TokenVerification	POST	Fixed occasional failures when API consumers make a request to verify user tokens via the API.
	Timesheet	PATCH	Fixed the "last updated datetime" in correct format when a Timesheet is released (Submit to Approve) via the API.
	Timesheet	PATCH	Fixed patch Timesheet API (from Submit to Approve) now logs to TimesheetHeaderAudit correctly.
	Timeshee	GET	Fixed timesheet API to retrieve timesheets when approver is a Contact and not an agency user.
	Timesheet	POST	Fixed so the Username is now populated in the timesheet audit history in the product when a timesheet with available status has been keyed via API.
	Timesheet	POST	Fixed so you are now able to key timesheet in the available status when the id of the temp time sheet matches an ID of a keyed-in time sheet (any keyed in time sheet)
	Timesheet	GET	Fixed an issue where GET timesheet (that belongs to a contractor job) returns an incorrect job type
	Timesheet	POST	Fixed timesheet creation with reimbursement via the API so qty is set to 1 and no longer set to 0.
	Timesheet	POST	Fixed Timesheet creation API so Attendance items now have validation when start and end times are the same.
	Invoice/Payslip	GET	Fixed ability to Generate Invoice/payslip via API
	Invoice/Payslip	GET	Fixed ability to Generate Invoice/payslip via API Fixed Payslip search API so you can now search without providing a value for the isDelivered.