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

about 1 hour ago

main
4.0
Compare

API structure has changed

Next change
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}