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.25.0
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
GET /api/v1/file/bin
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
PUT /api/v1/file/{file_uuid}/copy
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • folder property Modified
      • Property is now required
        Breaking
Added 1
GET /api/v1/file/{file_uuid}/download/temporary-url
v1.24.0
2 structure changes including:
2 Additions
Added 2
GET /api/v1/migrate-joint-logins
POST /api/v1/migrate-joint-logins/{jointAccountLogin_uuid}
v1.22.0
80 structure changes including:
80 Modifications
Modified 80 Breaking
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
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
        • brand_colours property Modified
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
        • brand_colours property Modified
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
        • brand_colours property Modified
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
        • brand_colours property Modified
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}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
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}/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
        • brand_colours property Modified
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
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
        • brand_colours property Modified
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_account_email property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • portal_sidebar_account_email, portal_sidebar_collapse_button, portal_sidebar_collapse_button_hover properties Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
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/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
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
        • brand_colours property Modified
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
        • brand_colours property Modified
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
        • brand_colours property Modified
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}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
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
        • brand_colours property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
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
        • brand_colours property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/bank-transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_account_email property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • portal_sidebar_account_email, portal_sidebar_collapse_button, portal_sidebar_collapse_button_hover properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_account_email property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • portal_sidebar_account_email, portal_sidebar_collapse_button, portal_sidebar_collapse_button_hover properties Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_account_email property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • portal_sidebar_account_email, portal_sidebar_collapse_button, portal_sidebar_collapse_button_hover properties Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
v1.21.2
80 structure changes including:
4 Additions
76 Modifications
Modified 76
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • shown_on_circles property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
      • modelable property Modified
        • shown_on_circles property Added
      • existing_plan property Modified
        • shown_on_circles property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • shown_on_circles property Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • login_access_level property Added
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • shown_on_circles property Added
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • shown_on_circles property Added
POST /api/v1/account
  • Body
  • application/json content type Modified
    • Create Client Account alternative Modified
      • circles property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • shown_on_circles property Added
      • wrap property Modified
        • shown_on_circles property Added
      • wrap_children property Modified
        • shown_on_circles property Added
      • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children, group_scheme properties Modified
        • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
      • transferred_from_plan property Modified
        • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, transferred_from_plan properties Modified
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • shown_on_circles property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • shown_on_circles property Added
      • wrap property Modified
        • shown_on_circles property Added
      • wrap_children property Modified
        • shown_on_circles property Added
      • shown_on_circles property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
      • transferred_from_plan property Modified
        • shown_on_circles property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • shown_on_circles property Added
      • wrap property Modified
        • shown_on_circles property Added
      • wrap_children property Modified
        • shown_on_circles property Added
      • shown_on_circles property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
      • modelable property Modified
        • shown_on_circles property Added
      • existing_plan property Modified
        • shown_on_circles property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • shown_on_circles property Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • login_access_level property Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • shown_on_circles property Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • shown_on_circles property Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • shown_on_circles property Added
      • wrap property Modified
        • shown_on_circles property Added
      • wrap_children property Modified
        • shown_on_circles property Added
      • group_scheme property Modified
        • shown_on_circles property Added
      • shown_on_circles property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
      • transferred_from_plan property Modified
        • shown_on_circles property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • shown_on_circles property Added
      • wrap property Modified
        • shown_on_circles property Added
      • wrap_children property Modified
        • shown_on_circles property Added
      • group_scheme property Modified
        • shown_on_circles property Added
      • shown_on_circles property Added
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, modelable, existing_plan properties Modified
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable property Modified
GET /api/v1/client/{client_uuid}/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plans property Modified
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • login_access_level property Added
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable property Modified
GET /api/v1/circles/{circle_uuid}/charge-splits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • shown_on_circles property Added
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • login_access_level property Added
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • splitable property Modified
GET /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • shown_on_circles property Added
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable property Modified
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • shown_on_circles property Added
GET /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plans property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
DELETE /api/v1/plans/{uuid}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • shown_on_circles property Added
      • wrap property Modified
        • shown_on_circles property Added
      • wrap_children property Modified
        • shown_on_circles property Added
      • shown_on_circles property Added
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, modelable, existing_plan properties Modified
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children, group_scheme properties Modified
        • shown_on_circles property Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable property Modified
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • shown_on_circles property Added
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
      • modelable property Modified
        • shown_on_circles property Added
      • existing_plan property Modified
        • shown_on_circles property Added
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, modelable, existing_plan properties Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • shown_on_circles property Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • shown_on_circles property Added
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable property Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • login_access_level property Added
      • circles property Modified
        • login_access_level property Added
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • shown_on_circles property Added
Added 4
GET /api/v2/plans/line-graph
GET /api/v2/plans
GET /api/v2/networth/line-graph
GET /api/v2/networth
v1.17.6
1 structure change including:
1 Addition
Added 1
POST /api/v1/mobile/notification-token
v1.17.0
1 structure change including:
1 Modification
Modified 1
POST /api/v1/conversation
  • Body
  • application/json content type Modified
    • message property Added
v1.15.0
1 structure change including:
1 Addition
Added 1
POST /api/v1/conversation/{conversation_uuid}/messages/inline
v1.14.7
1 structure change including:
1 Addition
Added 1
GET /api/v2/plans/{plan_uuid}/returns