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
1 structure change including:
1 Addition
Added 1
GET /api/v1/circles/{circle_uuid}/linked-clients
16 structure changes including:
2 Additions
14 Modifications
Modified 14
GET /api/v1/account/{account_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aml_passed property Added
GET /api/v1/cases/{case_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/circles/{circle_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/conversation/{conversation_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/firm/{firm_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/folder/{folder_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/illustration/{illustration_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v1/plans/{plan_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
GET /api/v2/portal/actions
  • Query
  • per_page query parameter Added
GET /api/v2/risks
  • Query
  • filter[level], filter[level_string], filter[completed_after], filter[completed_before], filter[risk_assessment_provider], filter[time_horizon_set_after], filter[time_horizon_set_before], filter[account_uuids], filter[circle_uuids] query parameters Added
POST /api/v1/folder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
PUT /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable_type, documentable_uuid properties Added
Added 2
GET /api/v1/circles/{circle_uuid}/accounts
GET /api/v1/circles/{circle_uuid}/form-submissions
8 structure changes including:
2 Additions
6 Modifications
Modified 6
GET /api/v1/charge
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/client/{client_uuid}/charges
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/client/{client_uuid}/expectations
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/expectation
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/plans/{plan_uuid}/charges
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Query
  • filter[circle_uuids] query parameter Added
Added 2
GET /api/v1/circles/{circle_uuid}/charges
GET /api/v1/circles/{circle_uuid}/expectations
13 structure changes including:
5 Additions
8 Modifications
Modified 8
POST /api/v1/client/{client_uuid}/employment
  • Body
  • application/json content type Modified
    • primary property Added
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • beneficiaries property Added
POST /api/v1/plans/{plan_uuid}/cover
  • Body
  • application/json content type Modified
    • beneficiaries property Added
POST /api/v2/employments
  • Body
  • application/json content type Modified
    • primary property Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Body
  • application/json content type Modified
    • primary property Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Body
  • application/json content type Modified
    • beneficiaries property Added
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • beneficiaries property Added
PUT /api/v2/employments/{uuid}
  • Body
  • application/json content type Modified
    • primary property Added
Added 5
DELETE /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
GET /api/v1/plans/{plan_uuid}/beneficiary
GET /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
POST /api/v1/plans/{plan_uuid}/beneficiary
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
4 structure changes including:
1 Addition
3 Modifications
Modified 3
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan, clients properties Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan, clients properties Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan, clients properties Added
Added 1
GET /api/v1/new-business-event
5 structure changes including:
2 Additions
3 Modifications
Modified 3 Breaking
GET /api/v1/circles/{circle_uuid}/notes
  • Header
  • X-PLANNR-ACCOUNT-UUID header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • filter[author_uuids], filter[is_pinned], filter[edited] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • include, filter[date_from], filter[date_to], filter[contents], filter[path], filter[notable_type] query parameters Added
GET /api/v1/conversation
  • Query
  • filter[circle_uuids] query parameter Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • core_details_changed_notification_for_assigned_paraplannr property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • core_details_changed_notification_for_assigned_paraplanner property Added
Added 2
GET /api/v1/circles/{circle_uuid}/conversations
GET /api/v2/portal/actions
7 structure changes including:
1 Addition
6 Modifications
Modified 6
GET /api/v1/audits
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/audits/{model}/{modelUuid}
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/employee/{employee_uuid}/audits
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/my/audits
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v2/dependants
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v2/employments
  • Query
  • filter[client_uuids] query parameter Added
Added 1
GET /api/v1/circles/{circle_uuid}/notes
7 structure changes including:
4 Additions
3 Modifications
Modified 3
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}
  • Body
  • application/json content type Modified
    • life_stage_section_uuid property Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • core_details_changed_notification_for_assigned_adviser, core_details_changed_notification_for_assigned_administrator, core_details_changed_notification_for_assigned_paraplannr properties Added
PUT /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Body
  • application/json content type Modified
    • has_custom_expenditures property Added
Added 4
DELETE /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
POST /api/v1/expenditure-structure/section/set-custom-expenditure
11 structure changes including:
5 Additions
6 Modifications
Modified 6 Breaking
GET /api/v1/task
  • Query
  • filter[client_uuid] query parameter Added
GET /api/v2/addresses
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v2/goals
  • Query
  • filter[circle_uuids] query parameter Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • fact_find_completed_notification_to_assigned_adviser, fact_find_completed_notification_to_assigned_administrator, fact_find_completed_notification_to_assigned_paraplanner properties Added
POST /api/v1/task
  • Body
  • application/json content type Modified
    • group_uuids property Added
PUT /api/v1/task/{uuid}
  • Body
  • application/json content type Modified
    • group_uuids property Added
Added 5
DELETE /api/v2/contact-details/{id}
GET /api/v2/contact-details
GET /api/v2/contact-details/{id}
POST /api/v2/contact-details
PUT /api/v2/contact-details/{id}
14 structure changes including:
2 Additions
12 Modifications
Modified 12 Breaking
GET /api/v1/account/{account_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/cases/{case_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/conversation/{conversation_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/file/bin
  • Query
  • filter[name], filter[date_from], filter[date_to], filter[extension], filter[uploaded_by_uuid], filter[size], filter[last_modified_from], filter[last_modified_to], filter[original_created_from], filter[original_created_to] query parameters Added
GET /api/v1/files/{model}/{modelUuid}
  • Query
  • filter[uploaded_by_uuid] query parameter Added
GET /api/v1/firm/{firm_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/folder/{folder_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/illustration/{illustration_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/plans/{plan_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
POST /api/v1/folder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
PUT /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
Added 2
GET /api/v1/circles/{circle_uuid}/documents
GET /api/v1/folder/{folder_uuid}/files
5 structure changes including:
5 Additions
Added 5
DELETE /api/v2/risks/{uuid}
GET /api/v2/risks
GET /api/v2/risks/{uuid}
POST /api/v2/risks
PUT /api/v2/risks/{uuid}