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
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
GET /employers/{employer_id}/employees/{employee_id}/pot_performance
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /employers/{employer_id}/employees/{employee_id}/pot_value_history
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /employers/{employer_id}/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • exit_date, opt_out_date, opt_in_date properties Modified
          • Type went from string(date) to string(date) | null
        • address_line1, postcode properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address property Added
GET /employers/{employer_id}/employees/{employee_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exit_date, opt_out_date, opt_in_date properties Modified
        • Type went from string(date) to string(date) | null
      • address_line1, postcode properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • address property Added
GET /uploads/{upload_id}/enrolments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • exit_date, opt_out_date, opt_in_date properties Modified
          • Type went from string(date) to string(date) | null
        • address_line1, postcode properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address property Added
PATCH /employers/{employer_id}/employees/{employee_id}
  • Body
  • application/json content type Modified
    • address_line1, postcode properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • address property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exit_date, opt_out_date, opt_in_date properties Modified
        • Type went from string(date) to string(date) | null
      • address_line1, postcode properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • address property Added
Added 1
PUT /employers/{employer_id}/employees/{employee_id}/fund_allocation
2 structure changes including:
2 Additions
Added 2
GET /fund_allocations/{fund_allocation_id}
PUT /employers/{employer_id}/employees/{employee_id}/beneficiaries
21 structure changes including:
9 Additions
12 Modifications
Modified 12 Breaking
POST /uploads
  • Path
  • employer_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /employers
  • Body
  • application/json content type Modified
    • payroll_frequencies property Modified
      • Type went from array to array[string]
PATCH /employers/{employer_id}/employees/{employee_id}
  • Body
  • application/json content type Modified
    • email, forename, surname, title, date_of_birth, address_line1, postcode, national_insurance_number, employment_start_date properties Added
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /uploads/{upload_id}/errors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • page_number, page_size, total_items, items properties Modified
        • Properties are now required
          Breaking
  • Path
  • employer_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /uploads/{upload_id}/enrolments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • member_scheme_status, employee_contributions_percent, employer_contributions_percent properties Added
  • Path
  • employer_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /uploads/{upload_id}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • page_number, page_size, total_items, items properties Modified
        • Properties are now required
          Breaking
  • Path
  • employer_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /uploads/{upload_id}
  • Path
  • employer_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /uploads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • page_number, page_size, total_items, items properties Modified
        • Properties are now required
          Breaking
  • Query
  • employer_id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /employers/{employer_id}/employees/{employee_id}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • page_number, page_size, total_items, items properties Modified
        • Properties are now required
          Breaking
GET /employers/{employer_id}/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • member_scheme_status, employee_contributions_percent, employer_contributions_percent properties Added
GET /employers/{employer_id}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • page_number, page_size, total_items, items properties Modified
        • Properties are now required
          Breaking
GET /employers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • page_number, page_size, total_items, items properties Modified
        • Properties are now required
          Breaking
  • Query
  • page_size, page_number query parameters Added
Added 9
POST /employers/{employer_id}/leavers
POST /employers/{employer_id}/employees/{employee_id}/contribution_change_requests
GET /fund_allocations
GET /employers/{employer_id}/employees/{employee_id}/transactions
GET /employers/{employer_id}/employees/{employee_id}/pot_performance
GET /employers/{employer_id}/employees/{employee_id}/portfolio_summary
GET /employers/{employer_id}/employees/{employee_id}/fund_allocation
GET /employers/{employer_id}/employees/{employee_id}/beneficiaries
GET /employers/{employer_id}/employees/{employee_id}
4.0
42 structure changes including:
22 Breaking changes
19 Additions
1 Modification
22 Removals
Modified 1 Breaking
GET /healthz
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204, 500 responses Added
Removed 22 Breaking
GET /employers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/documents
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/documents/{documentId}/download
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/pension-summary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/transfers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/payments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}/enrolments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}/errors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /employers/{employerId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /employers/{employerId}/employees/{employeeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/employees
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/employees/{employeeId}/transfers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/uploads
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Bearer authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 19
O auth2 client credentialsauthentication method
GET /employers
GET /employers/{employer_id}
GET /employers/{employer_id}/agreement-signing-sessions/{signing_session_id}
GET /employers/{employer_id}/contributions
GET /employers/{employer_id}/employees
GET /employers/{employer_id}/employees/{employee_id}/contributions
GET /uploads
GET /uploads/{upload_id}
GET /uploads/{upload_id}/contributions
GET /uploads/{upload_id}/enrolments
GET /uploads/{upload_id}/errors
PATCH /employers/{employer_id}
PATCH /employers/{employer_id}/employees/{employee_id}
POST /employers
POST /employers/{employer_id}/agreement-signing-sessions
POST /employers/{employer_id}/contributions
POST /employers/{employer_id}/employees
POST /uploads
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