API structure has changed
5 structure changes including:
5 Modifications
Modified
5
Breaking
GET /employers
- Response
-
200 response Modified
-
application/json content type Modified
-
employers property Modified
- status, defaultEmployeeContributionsPercent, defaultEmployerContributionsPercent, contributionBasis, allowsSalarySacrifice, paymentMethod, createdAt properties Added
-
employers property Modified
-
application/json content type Modified
GET /employers/{employerId}/employees
- Response
-
200 response Modified
-
application/json content type Modified
-
items property Modified
-
id property Modified
-
Property is now required Breaking
-
Property is now required
-
addressLine1, postcode properties Modified
- Properties are no longer required
-
exitDate, optOutDate properties Modified
- Properties are no longer required
-
Type went from
string(date)tostring(date) | null
-
uploadId, employerId, optInDate, optOutWindowStartDate, optOutWindowEndDate properties Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- status property Added
-
id property Modified
-
items property Modified
-
application/json content type Modified
GET /employers/{employerId}/uploads/{uploadId}/enrolments
- Response
-
200 response Modified
-
application/json content type Modified
-
items property Modified
-
id property Modified
-
Property is now required Breaking
-
Property is now required
-
addressLine1, postcode properties Modified
- Properties are no longer required
-
exitDate, optOutDate properties Modified
- Properties are no longer required
-
Type went from
string(date)tostring(date) | null
-
uploadId, employerId, optInDate, optOutWindowStartDate, optOutWindowEndDate properties Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- status property Added
-
id property Modified
-
items property Modified
-
application/json content type Modified
POST /employers/{employerId}/contributions
- Response
-
201 response Modified
-
application/json content type Modified
-
employerId, putDestinationUrl, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions, filename properties Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
employerId, putDestinationUrl, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions, filename properties Removed
-
application/json content type Modified
POST /employers/{employerId}/employees
- Response
-
201 response Modified
-
application/json content type Modified
-
employerId, putDestinationUrl, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions, filename properties Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
employerId, putDestinationUrl, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions, filename properties Removed
-
application/json content type Modified