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
24 structure changes including:
3 Breaking changes
6 Additions
15 Modifications
3 Removals
Modified 15
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • show_fact_find_illustrations property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
POST /api/v1/fact-find/schema
  • Response
  • 201 response Modified
    • application/json content type Modified
      • public_url property Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account, invitation_url, fact_find_passes properties Added
  • Body
  • application/json content type Added
POST /api/v1/fact-find/request
  • Body
  • application/json content type Modified
    • circle_uuid, send_invitation_email properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account, invitation_url, fact_find_passes properties Added
GET /api/v1/note/{notableType}/{notableUuid}
  • Query
  • filter[path_exact] query parameter Added
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
GET /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
GET /api/v1/fact-find/request/{factFindRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account, invitation_url, fact_find_passes properties Added
GET /api/v1/client/{client_uuid}/all-notes
  • Query
  • filter[path_exact] query parameter Added
GET /api/v1/circles/{circle_uuid}/notes
  • Query
  • filter[path_exact] query parameter Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
Removed 3 Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/complete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/completion
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/incomplete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
PUT /api/v1/circles/{circle_uuid}/fact-find-access
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
GET /api/v1/fact-find-passes/{factFindRequest_uuid}
GET /api/v1/circles/{circle_uuid}/fact-find-access
3 structure changes including:
3 Modifications
Modified 3
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_uuid property Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • joint_account_uuid property Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_uuid property Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/v2/portal/actions
  • Query
  • filter[completed] query parameter Modified
    • Type went from boolean to string
      Breaking
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shares_owned property Modified
        • Type went from integer to number
          Breaking
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shares_owned property Modified
        • Type went from number to integer
          Breaking
Added 1
GET /api/v1/circles/{circle_uuid}/fact-find-requests
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /api/v2/addresses/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_accounts property Added
POST /api/v2/addresses
  • Response
  • 201 response Modified
    • application/json content type Modified
      • primary_accounts property Added
PUT /api/v2/addresses/{uuid}
  • Body
  • application/json content type Modified
    • primary_account_uuids property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_accounts property Added
PUT /api/v2/contact-details/{id}
  • Body
  • application/json content type Modified
    • primary_account_uuids property Added
Added 1
POST /api/v1/illustration/{illustration_uuid}/proceed
15 structure changes including:
15 Modifications
Modified 15
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Added
26 structure changes including:
26 Modifications
Modified 26
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/charge
  • Query
  • filter[group_uuids] query parameter Added
GET /api/v1/circles/{circle_uuid}/charges
  • Query
  • filter[group_uuids] query parameter Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/client/{client_uuid}/charges
  • Query
  • filter[group_uuids] query parameter Added
GET /api/v1/client/{client_uuid}/plans
  • Query
  • filter[account_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
GET /api/v1/plans
  • Query
  • filter[account_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/plans/{plan_uuid}/charges
  • Query
  • filter[group_uuids] query parameter Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • accounts property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (1) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (2) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (3) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (4) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (5) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (6) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (7) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (8) response Modified
    • application/json content type Modified
      • accounts property Added
  • 200 (9) response Modified
    • application/json content type Modified
      • accounts property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ownership_percentage property Added
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • accounts property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
4 structure changes including:
1 Breaking change
3 Additions
1 Removal
Removed 1 Breaking
POST /api/v1/addons/be-iq/create-risk-profile/{client_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /api/v1/addons/be-iq/client/{client_uuid}
GET /api/v1/addons/be-iq/token
POST /api/v1/addons/be-iq/profiler/invite