Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

Changelog

Last update:
Compare
v1.81.2
83 structure changes including:
83 Modifications
Modified 83
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_open_accounts_for property Added
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/file/bin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/mailboxes/message/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v2/direct-debit-mandates
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v2/direct-debit-mandates/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_open_accounts_for property Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • mobile_app_support_number, mobile_app_support_email properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
v1.81.1
4 structure changes including:
1 Addition
3 Modifications
Modified 3
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • name property Added
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • name property Added
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • name property Added
Added 1
PUT /api/v2/mortgage-searches/{uuid}
v1.80.3
1 structure change including:
1 Modification
Modified 1
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • email_logo property Added
v1.79.3
4 structure changes including:
4 Modifications
Modified 4 Breaking
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • name, policy_number, proposal_reference, inactive_reason properties Modified
      • Type went from string to string | null
    • provider_uuid, seller_uuid, active_adviser_uuid, wrap_uuid, contract_enquiry_account_uuid properties Modified
      • Type went from string(uuid) to string(uuid) | null
    • opened_at, inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from string(date) to string(date) | null
    • agency_in_your_name, originally_sold_by_firm, under_advice, show_on_joint, on_panel, is_group_scheme, is_wrap_product properties Modified
      • Type went from boolean to boolean | null
    • visible_on_client_portal, include_in_client_valuation properties Modified
      • Properties are now required
        Breaking
    • visible_to_circles_uuids property Modified
      • Type went from array[string(uuid)] to array[string(uuid)] | null
    • current_value property Modified
      • Type went from integer to integer | null
    • seller_name property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Body
  • application/json content type Modified
    • on_risk_at property Modified
      • Type went from string(date) to string(date) | null
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Body
  • application/json content type Modified
    • policy_number property Modified
      • Type went from string to string | null
    • inactive_at, on_risk_at properties Modified
      • Type went from string(date) to string(date) | null
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • name, policy_number, proposal_reference, inactive_reason properties Modified
      • Type went from string to string | null
    • accounts property Modified
      • Type went from array to array[object]
      • object property Added
    • provider_uuid, seller_uuid, active_adviser_uuid, wrap_uuid, contract_enquiry_account_uuid properties Modified
      • Type went from string(uuid) to string(uuid) | null
    • opened_at property Modified
      • Type went from string to string(date) | null
    • inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from string(date) to string(date) | null
    • agency_in_your_name, originally_sold_by_firm, under_advice, on_panel properties Modified
      • Type went from boolean to boolean | null
    • cases, visible_to_circles_uuids properties Modified
      • Type went from array to array[string(uuid)] | null
    • linked_owners, linked_plans properties Modified
      • Type went from array to array[string(uuid)]
    • current_value property Modified
      • Type went from integer to integer | null
    • group_scheme_member_detail property Modified
      • Type went from array to object
        Breaking
      • workplace_location, employment_division properties Added
    • beneficiaries property Modified
      • Type went from array to array[object]
      • object property Added
    • seller_name property Added
v1.79.2
1 structure change including:
1 Modification
Modified 1 Breaking
POST /api/v1/bank-transaction
  • Body
  • application/json content type Modified
    • bank_transactions property Modified
      • date property Modified
        • Type went from string(date) to string(date) | null
  • Response
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
v1.78.0
3 structure changes including:
3 Modifications
Modified 3
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • products, files properties Added
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products, files properties Added
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products, files properties Added