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
23 structure changes including:
11 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
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 11
PUT /employers/{employer_id}/employees/{employee_id}/beneficiaries
POST /employers/{employer_id}/leavers
POST /employers/{employer_id}/employees/{employee_id}/contribution_change_requests
GET /fund_allocations/{fund_allocation_id}
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}
17 structure changes including:
17 Modifications
Modified 17 Breaking
GET /employers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • contributionBasis, allowsSalarySacrifice, defaultPlan, externalReference, paymentMethod, phone, primaryContactEmail, primaryContactRole, defaultEmployeeContributionsPercent, defaultEmployerContributionsPercent, stagingDate, statusUpdatedAt, tprCode properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • contribution_basis, allows_salary_sacrifice, external_reference, company_number, payment_method, primary_contact_email, primary_contact_role, default_employee_contributions_percent, default_employer_contributions_percent properties Added
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
GET /employers/{employer_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contributionBasis, allowsSalarySacrifice, defaultPlan, externalReference, paymentMethod, phone, primaryContactEmail, primaryContactRole, defaultEmployeeContributionsPercent, defaultEmployerContributionsPercent, stagingDate, statusUpdatedAt, tprCode properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • contribution_basis, allows_salary_sacrifice, external_reference, company_number, payment_method, primary_contact_email, primary_contact_role, default_employee_contributions_percent, default_employer_contributions_percent properties Added
GET /employers/{employer_id}/agreement-signing-sessions/{signing_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • returnUrl, expiresAt, failureCode, completedAt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • return_url, expires_at, failure_code, completed_at properties Added
GET /employers/{employer_id}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageSize, pageNumber, sortBy, sortOrder query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_size, page_number, sort_by, sort_order query parameters Added
GET /employers/{employer_id}/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageSize, pageNumber query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_size, page_number query parameters Added
GET /employers/{employer_id}/employees/{employee_id}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageSize, pageNumber, sortBy, sortOrder query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_size, page_number, sort_by, sort_order query parameters Added
GET /uploads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • employerId, putDestinationUrl, createdAt, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • employer_id, put_destination_url, created_at, updated_at, processing_started, processing_ended, processing_time, total_errors, contributions_created, contributions_unprocessed, contributions_already_existed, employer_contributions, employee_contributions, total_contributions properties Added
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageNumber, employerId query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_number, employer_id query parameters Added
GET /uploads/{upload_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employerId, putDestinationUrl, createdAt, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • employer_id, put_destination_url, created_at, updated_at, processing_started, processing_ended, processing_time, total_errors, contributions_created, contributions_unprocessed, contributions_already_existed, employer_contributions, employee_contributions, total_contributions properties Added
GET /uploads/{upload_id}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageSize, pageNumber query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_size, page_number query parameters Added
GET /uploads/{upload_id}/enrolments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageSize, pageNumber query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_size, page_number query parameters Added
GET /uploads/{upload_id}/errors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageNumber, pageSize, totalItems properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • page_number, page_size, total_items properties Added
  • Query
  • pageSize, pageNumber query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page_size, page_number query parameters Added
PATCH /employers/{employer_id}
  • Body
  • application/json content type Modified
    • primaryContactEmail, primaryContactRole, payrollFrequencies, defaultEmployerContributionsPercent, defaultEmployeeContributionsPercent, contributionBasis, allowsSalarySacrifice, paymentMethod properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • primary_contact_email, primary_contact_role, payroll_frequencies, default_employer_contributions_percent, default_employee_contributions_percent, contribution_basis, allows_salary_sacrifice, payment_method properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contributionBasis, allowsSalarySacrifice, defaultPlan, externalReference, paymentMethod, phone, primaryContactEmail, primaryContactRole, defaultEmployeeContributionsPercent, defaultEmployerContributionsPercent, stagingDate, statusUpdatedAt, tprCode properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • contribution_basis, allows_salary_sacrifice, external_reference, company_number, payment_method, primary_contact_email, primary_contact_role, default_employee_contributions_percent, default_employer_contributions_percent properties Added
POST /employers
  • Body
  • application/json content type Modified
    • companyNumber, companyName, primaryContactEmail, primaryContactRole, payrollFrequencies, expectedFirstPayPeriodStartDate, expectedPayPeriodCadence, defaultEmployeeContributionsPercent, defaultEmployerContributionsPercent, contributionBasis, allowsSalarySacrifice, paymentMethod, numberOfEmployees properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • company_number, company_name, primary_contact_email, primary_contact_role, payroll_frequencies, expected_first_pay_period_start_date, expected_pay_period_cadence, default_employee_contributions_percent, default_employer_contributions_percent, contribution_basis, allows_salary_sacrifice, payment_method, number_of_employees properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id property Modified
        • Permission is now readOnly
        • Property is no longer required
      • name property Modified
        • Property is no longer required
      • status property Modified
        • Permission is now readOnly
        • Property is no longer required
        • Type is no longer string
          Breaking
      • externalReference, companyNumber, defaultEmployeeContributionsPercent, defaultEmployerContributionsPercent, contributionBasis, allowsSalarySacrifice, paymentMethod, createdAt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • created_at, updated_at, contribution_basis, allows_salary_sacrifice, external_reference, company_number, payment_method, primary_contact_email, primary_contact_role, default_employee_contributions_percent, default_employer_contributions_percent properties Added
  • 409 response Modified
    • application/json content type Modified
      • externalReference property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • external_reference property Added
POST /employers/{employer_id}/agreement-signing-sessions
  • Response
  • 201 response Modified
    • application/json content type Modified
      • signingSessionId, redirectUrl, expiresAt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • signing_session_id, redirect_url, expires_at properties Added
POST /employers/{employer_id}/contributions
  • Response
  • 201 response Modified
    • application/json content type Modified
      • employerId, putDestinationUrl, createdAt, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • employer_id, put_destination_url, created_at, updated_at, processing_started, processing_ended, processing_time, total_errors, contributions_created, contributions_unprocessed, contributions_already_existed, employer_contributions, employee_contributions, total_contributions properties Added
POST /employers/{employer_id}/employees
  • Response
  • 201 response Modified
    • application/json content type Modified
      • employerId, putDestinationUrl, createdAt, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • employer_id, put_destination_url, created_at, updated_at, processing_started, processing_ended, processing_time, total_errors, contributions_created, contributions_unprocessed, contributions_already_existed, employer_contributions, employee_contributions, total_contributions properties Added
POST /uploads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employerId, putDestinationUrl, createdAt, updatedAt, processingStarted, processingEnded, processingTime, totalErrors, contributionsCreated, contributionsUnprocessed, contributionsAlreadyExisted, employerContributions, employeeContributions, totalContributions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • employer_id, put_destination_url, created_at, updated_at, processing_started, processing_ended, processing_time, total_errors, contributions_created, contributions_unprocessed, contributions_already_existed, employer_contributions, employee_contributions, total_contributions properties Added
45 structure changes including:
25 Breaking changes
19 Additions
1 Modification
25 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 25 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}/agreement-signing-sessions
  • 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
POST EmployerAgreementSigningCompletedwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers
  • 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