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
32 structure changes including:
31 Breaking changes
1 Modification
31 Removals
Modified 1 Breaking
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Path went from /api/v2/fact-find-session/{factFindSession_uuid}/launch to /api/v2/fact-find/session/{factFindSession_uuid}/launch (same operationId)
  • Path
  • factFindSession path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 31 Breaking
DELETE /api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v2/fact-find-employments/{factFindSession_uuid}/{employment_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v2/fact-find-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom/{factFindExpenditure_group_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v2/fact-find-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/{lifeStageField_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/notes/{factFindNote}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/fact-find-circle-expenditures/{factFindSession_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/fact-find-employments/{factFindSession_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/fact-find-expenditures/{factFindSession_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/fact-find-launch/{factFindSession_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/fact-find-session/{factFindSession_uuid}/account/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/life-stage/{factFindSession_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/diff
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/notes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/addons/be-iq/profiler/invite-fact-find/{factFindSession_uuid}/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/{lifeStageField_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/fact-find-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/fact-find-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom/{factFindExpenditure_group_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/fact-find-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/{lifeStageField_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/postcode/{factFindSession_uuid}/search
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/submissions/add-user/{factFindSession_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/approve
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/complete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/notes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/reject
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/v2/fact-find-employments/{factFindSession_uuid}/{employment_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/notes/{factFindNote_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Path went from /api/v2/fact-find-session/{factFindSession_uuid}/launch to /api/v2/fact-find/session/{factFindSession_uuid}/launch (same operationId)
  • Path
  • factFindSession_uuid path parameter Modified
    • Type went from string to integer
      Breaking
POST /api/v1/account
  • Body
  • application/json content type Modified
    • alternative Modified
      • Create Employee Account alternative Modified
        • departments property Modified
          • Type went from string to array[string]
            Breaking
PUT /api/v1/account/{uuid}
  • Body
  • application/json content type Modified
    • alternative Modified
      • Update Client Account alternative Modified
        • groups property Modified
          • Type went from array[string(uuid)] to array[string(uuid)] | null
      • Update Employee Account alternative Modified
        • departments property Modified
          • Property is now required
            Breaking
          • Type went from string to array[string]
            Breaking
        • groups property Modified
          • Type went from array[string(uuid)] to array[string(uuid)] | null
      • Update Introducer Account alternative Modified
        • groups property Modified
          • Type went from array[string(uuid)] to array[string(uuid)] | null
4 structure changes including:
3 Additions
1 Modification
Modified 1 Breaking
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Path went from /api/v2/fact-find-session/{factFindSession_uuid}/launch to /api/v2/fact-find/session/{factFindSession_uuid}/launch (same operationId)
  • Path
  • factFindSession_uuid path parameter Modified
    • Type went from string to integer
      Breaking
Added 3
DELETE /api/v2/fact-find-employments/{factFindSession_uuid}/{employment_uuid}
POST /api/v1/client/{client_uuid}/expenditure/sync-to-circle
PUT /api/v2/fact-find-employments/{factFindSession_uuid}/{employment_uuid}
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/v1/bank-statement
  • Query
  • include query parameter Added
GET /api/v1/provider-statement
  • Query
  • include query parameter Added
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Path went from /api/v2/fact-find-session/{factFindSession_uuid}/launch to /api/v2/fact-find/session/{factFindSession_uuid}/launch (same operationId)
  • Path
  • factFindSession_uuid path parameter Modified
    • Type went from string to integer
      Breaking
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Path went from /api/v2/fact-find-session/{factFindSession_uuid}/launch to /api/v2/fact-find/session/{factFindSession_uuid}/launch (same operationId)
  • Path
  • factFindSession_uuid path parameter Modified
    • Type went from string to integer
      Breaking
GET /api/v2/plans/{plan_uuid}/returns
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • time_weighted_return property Modified
        • time_weighted_return.growth_value property Added
60 structure changes including:
36 Additions
24 Modifications
Modified 24 Breaking
DELETE /api/v1/fact-find/request/{factFindRequest_uuid}
  • Operation is now deprecated
DELETE /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Operation is now deprecated
DELETE /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Operation is now deprecated
GET /api/v1/circles/{circle_uuid}/fact-find-requests
  • Operation is now deprecated
GET /api/v1/fact-find/request
  • Operation is now deprecated
GET /api/v1/fact-find/request/{factFindRequest_uuid}
  • Operation is now deprecated
GET /api/v1/fact-find/request/{factFindRequest_uuid}/section
  • Operation is now deprecated
GET /api/v1/fact-find/schema
  • Operation is now deprecated
GET /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Operation is now deprecated
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Operation is now deprecated
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Operation is now deprecated
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Path went from /api/v2/fact-find-session/{factFindSession_uuid}/launch to /api/v2/fact-find/session/{factFindSession_uuid}/launch (same operationId)
  • Path
  • factFindSession_uuid path parameter Modified
    • Type went from string to integer
      Breaking
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Operation is now deprecated
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Operation is now deprecated
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/unarchive
  • Operation is now deprecated
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Operation is now deprecated
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/generate-pdf
  • Operation is now deprecated
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/archive
  • Operation is now deprecated
POST /api/v1/fact-find/schema
  • Operation is now deprecated
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress
  • Operation is now deprecated
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
  • Operation is now deprecated
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
  • Operation is now deprecated
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Operation is now deprecated
POST /api/v1/fact-find/request
  • Operation is now deprecated
Added 36
PUT /api/v2/fact-find/templates/{factFindTemplate_uuid}
PUT /api/v2/fact-find/sections/{factFindSection_uuid}
PUT /api/v2/fact-find/questions/{factFindQuestion_uuid}
PUT /api/v2/fact-find/factFindQuestionCondition/{uuid}
PUT /api/v2/fact-find/blocks/{factFindBlock_uuid}
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/unpublish
DELETE /api/v2/fact-find/blocks/{factFindBlock_uuid}
DELETE /api/v2/fact-find/factFindQuestionCondition/{uuid}
DELETE /api/v2/fact-find/questions/{factFindQuestion_uuid}
DELETE /api/v2/fact-find/sections/{factFindSection_uuid}
DELETE /api/v2/fact-find/session/{factFindSession_uuid}
DELETE /api/v2/fact-find/templates/{factFindTemplate_uuid}
GET /api/v2/fact-find/blocks/default
GET /api/v2/fact-find/blocks/{factFindBlock_uuid}
GET /api/v2/fact-find/sections/{factFindSection_uuid}
GET /api/v2/fact-find/session
GET /api/v2/fact-find/session/{factFindSession_uuid}
GET /api/v2/fact-find/templates
GET /api/v2/fact-find/templates/{factFindTemplate_uuid}
GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/active-sessions
GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/questions
GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/questions/{factFindQuestion_uuid}
GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections
GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks
POST /api/v2/fact-find/blocks/reorder
POST /api/v2/fact-find/fact-find-questions/{fact_find_question_uuid}/factFindQuestionCondition
POST /api/v2/fact-find/questions/custom-field
POST /api/v2/fact-find/questions/reorder
POST /api/v2/fact-find/sections/reorder
POST /api/v2/fact-find/session
POST /api/v2/fact-find/templates
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/clone
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/generate-pdf
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/publish
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks
2 structure changes including:
2 Additions
Added 2
GET /api/v1/static/dependant-relationship-types
GET /api/v1/static/relationship-types