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

25 days ago

main
v1.21.2
Compare
v1.21.2

API structure has changed

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