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

21 days ago

main
v1.52.0
Compare
v1.52.0

API structure has changed

58 structure changes including:
58 Modifications
Modified 58
DELETE /api/v1/plans/{uuid}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • visible_to_circles property Added
      • wrap property Modified
        • visible_to_circles property Added
      • wrap_children property Modified
        • visible_to_circles property Added
      • visible_to_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/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • visible_to_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/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • visible_to_circles 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/circles/{circle_uuid}/charge-splits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • visible_to_circles 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/client/{client_uuid}/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plans property Modified
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}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_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}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • visible_to_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/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • visible_to_circles property Added
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_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/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
      • modelable property Modified
        • visible_to_circles property Added
      • existing_plan property Modified
        • visible_to_circles property Added
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • visible_to_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/{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
        • visible_to_circles property Added
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles 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}/premiums
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, transferred_from_plan properties Modified
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
      • transferred_from_plan property Modified
        • visible_to_circles property Added
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
        • visible_to_circles property Added
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}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • visible_to_circles property Added
      • wrap property Modified
        • visible_to_circles property Added
      • wrap_children property Modified
        • visible_to_circles property Added
      • visible_to_circles property Added
GET /api/v2/goals
  • Query
  • include_circle_goals query parameter Added
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • visible_to_circles property Added
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • visible_to_circles property Added
GET /api/v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • visible_to_circles property Added
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • visible_to_circles property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • visible_to_circles property Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
      • modelable property Modified
        • visible_to_circles property Added
      • existing_plan property Modified
        • visible_to_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
        • visible_to_circles property Added
      • wrap property Modified
        • visible_to_circles property Added
      • wrap_children property Modified
        • visible_to_circles property Added
      • group_scheme property Modified
        • visible_to_circles property Added
      • visible_to_circles property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
      • transferred_from_plan property Modified
        • visible_to_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
        • visible_to_circles property Added
      • wrap property Modified
        • visible_to_circles property Added
      • wrap_children property Modified
        • visible_to_circles property Added
      • group_scheme property Modified
        • visible_to_circles property Added
      • visible_to_circles property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
POST /api/v2/goals
  • Body
  • application/json content type Modified
    • show_on_circles, visible_to_circles_uuids properties Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • visible_to_circles property Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • visible_to_circles property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • visible_to_circles property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
      • modelable property Modified
        • visible_to_circles property Added
      • existing_plan property Modified
        • visible_to_circles property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • visible_to_circles property Added
      • wrap property Modified
        • visible_to_circles property Added
      • wrap_children property Modified
        • visible_to_circles property Added
      • visible_to_circles property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
      • transferred_from_plan property Modified
        • visible_to_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
        • visible_to_circles property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • visible_to_circles property Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • visible_to_circles property Added
      • wrap property Modified
        • visible_to_circles property Added
      • wrap_children property Modified
        • visible_to_circles property Added
      • visible_to_circles property Added
PUT /api/v2/goals/{uuid}
  • Body
  • application/json content type Modified
    • shown_on_circles, visible_to_circles_uuids properties Added