UK API Release Notes

Announcements
1

API Updated - 17/09/2019

Changes

  • definitions/UkUnstructuredEmployeeModel - Optional property appointmentEndDate added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property bankAccount1_RollNumber added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property bankAccount2_RollNumber added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property bankAccount3_RollNumber added: Optional property added

API Updated - 16/09/2019

Changes

  • definitions/EssEmployeeDetailsModel - Optional property hasConnectedDevices added: Optional property added

API Updated - 12/09/2019

Changes

  • definitions/AttachmentModel - Optional property dateScanned added: Optional property added
  • definitions/AttachmentModel - Optional property isInfected added: Optional property added

API Updated - 09/09/2019

Breaking changes

API Updated - 09/09/2019

Breaking changes

Changes

API Updated - 02/09/2019

Changes

  • /api/v2/business/{businessId}/report/fps: Endpoint added
  • /api/v2/business/{businessId}/report/fps/xml/{transactionid}: Endpoint added
  • definitions/UkPayCategoryModel - Optional property payCategoryType added: Optional property added

API Updated - 02/09/2019

Breaking changes

Changes

  • /api/v2/business/{businessId}/bacs: Endpoint added
  • /api/v2/business/{businessId}/bacs/{id}: Endpoint added
  • /api/v2/business/{businessId}/employee/{employeeId}/pension: Endpoint added
  • /api/v2/business/{businessId}/employee/{employeeId}/pension/force: Endpoint added
  • /api/v2/business/{businessId}/pensionscheme: Endpoint added
  • /api/v2/business/{businessId}/pensionscheme/{id}: Endpoint added
  • /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan: Endpoint added
  • /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId}: Endpoint added
  • /api/v2/business/{businessId}/pensionscheme/dates: Endpoint added

API Updated - 01/09/2019

Changes

  • definitions/BankAccountEditModel - Optional property swift added: Optional property added
  • definitions/LeaveCategoryModel - Optional property useGrossPaymentRate added: Optional property added

API Updated - 26/08/2019

Changes

  • definitions/ActiveEmployeesModel - Optional property abn added: Optional property added

API Updated - 18/08/2019

Breaking changes

Changes

  • /api/v2/business/{businessId}/manager/rostershift/manage: Endpoint added
  • /api/v2/business/{businessId}/rostershift/create: Endpoint added
  • definitions/ExpenseRequestResponseModel - Optional property dateCreated added: Optional property added
  • definitions/EssExpenseRequestResponseModel - Optional property dateCreated added: Optional property added
  • definitions/ManagerExpenseRequestModel - Optional property dateCreated added: Optional property added

API Updated - 05/08/2019

Breaking changes

Changes

API Updated - 23/07/2019

Breaking changes

  • GET /api/v2/business/{businessId}/employee/{employeeId}: Endpoint deleted

API Updated - 18/07/2019

Changes

  • definitions/EmployeePensionContributionPlanSettingsViewModel - Optional property pensionSchemeOptions added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsViewModel - Optional property postponementOptions added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsViewModel - Optional property postponementOptionsPostponed added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsViewModel - Optional property postponementOptionsManual added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsViewModel - Optional property pensionSchemes added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsViewModel - Optional property hasContributionPlans added: Optional property added
  • definitions/PensionSchemeContributionPlanModel - Optional property isAutoEnrolmentScheme added: Optional property added
  • definitions/PensionSchemeContributionPlanModel - Optional property lowerEarningsDisregard added: Optional property added
  • definitions/PensionSchemeContributionPlanModel - Optional property lowerDefaultEarningsDisregardType added: Optional property added
  • definitions/PensionSchemeContributionPlanModel - Optional property upperEarningsCap added: Optional property added
  • definitions/PensionSchemeContributionPlanModel - Optional property upperDefaultEarningsCapType added: Optional property added
  • definitions/PensionSchemeContributionPlanModel - Optional property pensionSchemeContributionPlanPostponementRules added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsModel - Optional property postponementOption added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsModel - Optional property deferralDate added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsModel - Optional property defaultMaxEarningsThreshold added: Optional property added
  • definitions/EmployeePensionContributionPlanSettingsModel - Optional property defaultMinEarningsThreshold added: Optional property added
  • definitions/AutoEnrolmentNoticeViewModel - Optional property deferralDate added: Optional property added
  • definitions/AutoEnrolmentNoticeModel - Optional property enrolmentDeferralDate added: Optional property added

API Updated - 17/07/2019

Changes

  • /api/v2/business/{businessId}/report/eps: Endpoint added
  • /api/v2/business/{businessId}/report/eps/{id}: Endpoint added
  • /api/v2/business/{businessId}/report/eps/{id}/xml: Endpoint added

API Updated - 27/06/2019

Changes

  • definitions/UkUnstructuredEmployeeModel - Property isOverseasResidentialAddress deleted: Property deleted
  • definitions/UkUnstructuredEmployeeModel - Property isOverseasPostalAddress deleted: Property deleted
  • definitions/UkUnstructuredEmployeeModel - Optional property residentialAddressIsOverseas added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property postalAddressIsOverseas added: Optional property added

API Updated - 27/06/2019

Changes

  • definitions/UkUnstructuredEmployeeModel - Property residentialAddressIsOverseas deleted: Property deleted
  • definitions/UkUnstructuredEmployeeModel - Property postalAddressIsOverseas deleted: Property deleted
  • definitions/UkUnstructuredEmployeeModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property isOverseasPostalAddress added: Optional property added

API Updated - 26/06/2019

Changes

  • definitions/UkUnstructuredEmployeeModel - Property isOverseasResidentialAddress deleted: Property deleted
  • definitions/UkUnstructuredEmployeeModel - Property isOverseasPostalAddress deleted: Property deleted
  • definitions/UkUnstructuredEmployeeModel - Optional property residentialAddressIsOverseas added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property postalAddressIsOverseas added: Optional property added

API Updated - 24/06/2019

Changes

  • definitions/UkBusinessExportModel - Optional property autoEnrolmentStagingDate added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property hasStudentLoan added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property appointmentStartDate added: Optional property added
  • definitions/EmployeeUpdateResponseModel - Optional property detailedStatus added: Optional property added
  • definitions/AvailableBusinessModel - Optional property autoEnrolmentStagingDate added: Optional property added

API Updated - 19/06/2019

Breaking changes

  • GET /api/v2/business/{businessId}/employee: Required parameter added: externalId

Changes

  • GET /api/v2/business/{businessId}/employee: Parameter deleted: filter.payScheduleId
  • GET /api/v2/business/{businessId}/employee: Parameter deleted: filter.locationId
  • POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff: Endpoint added
  • /api/v2/business/{businessId}/manager/kiosk/timesheetcomments/{timesheetLineId}: Endpoint added
  • definitions/ReportAccessModel - Optional property noReportingRestriction added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property residentialCountry added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property postalCountry added: Optional property added
  • definitions/UkUnstructuredEmployeeModel - Optional property isOverseasPostalAddress added: Optional property added
  • definitions/ShiftCostingsRequestShiftModel - Optional property submittedByUser added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property residentialCountryId added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property postalCountryId added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property isOverseasPostalAddress added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property residentialCountryId added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property postalCountryId added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property isOverseasPostalAddress added: Optional property added
  • definitions/TimeAndAttendanceKioskModel - Optional property availableToAllRestrictedUsersWithKioskAccess added: Optional property added
  • definitions/TimesheetLineModel - Optional property submittedByUser added: Optional property added
  • definitions/AvailableBusinessModel - Optional property locationPermissions added: Optional property added
  • definitions/AvailableBusinessModel - Optional property employeeGroupPermissions added: Optional property added
  • definitions/PaygPaymentSummaryModel - Optional property payeeCountry added: Optional property added
  • definitions/UkApiPaySlipModel - Optional property employeePostalAddressCountry added: Optional property added
  • definitions/PayRunFinaliseResult - Optional property activeEmployees added: Optional property added
  • definitions/LeaveLiabilityExportModel - Property accruedAmountInDays deleted: Property deleted
  • definitions/ActiveEmployeesModel - Optional property isStpEnabled added: Optional property added

API Updated - 11/06/2019

Placeholder text for now