Change Updates

Do not miss any Penfold Partner API changes, ever again

Subscribe to the Penfold Partner API changelog to be up to date on recent changes.

RSS
Penfold Partner API

Changelog

Last update:
Compare
1 structure change including:
1 Addition
Added 1
PATCH /employers/{employerId}
2 structure changes including:
2 Modifications
Modified 2
GET /employers/{employerId}/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • optInDate, optOutWindowStartDate, optOutWindowEndDate properties Added
GET /employers/{employerId}/uploads/{uploadId}/enrolments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • optInDate, optOutWindowStartDate, optOutWindowEndDate properties Added
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
GET /employers/{employerId}/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • id property Modified
          • Property is now required
            Breaking
        • addressLine1, postcode properties Modified
          • Properties are no longer required
        • exitDate, optOutDate properties Modified
          • Properties are no longer required
          • Type went from string(date) to string(date) | null
        • uploadId, employerId, optInDate, optOutWindowStartDate, optOutWindowEndDate properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status property Added
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
        • addressLine1, postcode properties Modified
          • Properties are no longer required
        • exitDate, optOutDate properties Modified
          • Properties are no longer required
          • Type went from string(date) to string(date) | null
        • uploadId, employerId, optInDate, optOutWindowStartDate, optOutWindowEndDate properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status property Added
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
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
2 structure changes including:
2 Additions
Added 2
GET /employers/{employerId}/employees/{employeeId}/documents
GET /employers/{employerId}/employees/{employeeId}/documents/{documentId}/download
19 structure changes including:
1 Breaking change
18 Additions
1 Removal
Removed 1 Breaking
GET /employers/{employerRef}/members/{employeeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 18
POST /employers/{employerId}/uploads
POST /employers/{employerId}/employees/{employeeId}/transfers
POST /employers/{employerId}/employees
POST /employers/{employerId}/contributions
POST /employers
PATCH /employers/{employerId}/employees/{employeeId}
GET /employers/{employerId}/uploads/{uploadId}/errors
GET /employers/{employerId}/uploads/{uploadId}/enrolments
GET /employers/{employerId}/uploads/{uploadId}/contributions
GET /employers/{employerId}/uploads/{uploadId}
GET /employers/{employerId}/uploads
GET /employers/{employerId}/payments
GET /employers/{employerId}/employees/{employeeId}/transfers
GET /employers/{employerId}/employees/{employeeId}/pension-summary
GET /employers/{employerId}/employees/{employeeId}/contributions
GET /employers/{employerId}/employees
GET /employers/{employerId}/contributions
GET /employers
1 structure change including:
1 Modification
Modified 1 Breaking
GET /employers/{employerRef}/members/{employeeId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • balance property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • potSummary property Added