For AI agents: a documentation index is available at https://apidocs.plannrcrm.com/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.

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 Modification
Modified 1
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • email_logo property Added
4 structure changes including:
4 Modifications
Modified 4 Breaking
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • name, policy_number, proposal_reference, inactive_reason properties Modified
      • Type went from string to string | null
    • provider_uuid, seller_uuid, active_adviser_uuid, wrap_uuid, contract_enquiry_account_uuid properties Modified
      • Type went from string(uuid) to string(uuid) | null
    • opened_at, inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from string(date) to string(date) | null
    • agency_in_your_name, originally_sold_by_firm, under_advice, show_on_joint, on_panel, is_group_scheme, is_wrap_product properties Modified
      • Type went from boolean to boolean | null
    • visible_on_client_portal, include_in_client_valuation properties Modified
      • Properties are now required
        Breaking
    • visible_to_circles_uuids property Modified
      • Type went from array[string(uuid)] to array[string(uuid)] | null
    • current_value property Modified
      • Type went from integer to integer | null
    • seller_name property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Body
  • application/json content type Modified
    • on_risk_at property Modified
      • Type went from string(date) to string(date) | null
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Body
  • application/json content type Modified
    • policy_number property Modified
      • Type went from string to string | null
    • inactive_at, on_risk_at properties Modified
      • Type went from string(date) to string(date) | null
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • name, policy_number, proposal_reference, inactive_reason properties Modified
      • Type went from string to string | null
    • accounts property Modified
      • Type went from array to array[object]
      • object property Added
    • provider_uuid, seller_uuid, active_adviser_uuid, wrap_uuid, contract_enquiry_account_uuid properties Modified
      • Type went from string(uuid) to string(uuid) | null
    • opened_at property Modified
      • Type went from string to string(date) | null
    • inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from string(date) to string(date) | null
    • agency_in_your_name, originally_sold_by_firm, under_advice, on_panel properties Modified
      • Type went from boolean to boolean | null
    • cases, visible_to_circles_uuids properties Modified
      • Type went from array to array[string(uuid)] | null
    • linked_owners, linked_plans properties Modified
      • Type went from array to array[string(uuid)]
    • current_value property Modified
      • Type went from integer to integer | null
    • group_scheme_member_detail property Modified
      • Type went from array to object
        Breaking
      • workplace_location, employment_division properties Added
    • beneficiaries property Modified
      • Type went from array to array[object]
      • object property Added
    • seller_name property Added
1 structure change including:
1 Modification
Modified 1 Breaking
POST /api/v1/bank-transaction
  • Body
  • application/json content type Modified
    • bank_transactions property Modified
      • date property Modified
        • Type went from string(date) to string(date) | null
  • Response
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
3 structure changes including:
3 Modifications
Modified 3
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • products, files properties Added
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products, files properties Added
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products, files properties Added
60 structure changes including:
4 Additions
56 Modifications
Modified 56
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
        • linked_policy_numbers property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • linked_policy_numbers property Added
      • wrap property Modified
        • linked_policy_numbers property Added
      • wrap_children property Modified
        • linked_policy_numbers property Added
      • linked_policy_numbers property Added
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children properties Modified
        • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers property Added
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • linked_policy_numbers property Added
POST /api/v1/expectation/reconcile
  • Body
  • application/json content type Modified
    • create_linked_policy_numbers property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • linked_policy_numbers property Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • auto_create_linked_policy_numbers property Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
      • modelable property Modified
        • linked_policy_numbers property Added
      • existing_plan property Modified
        • linked_policy_numbers property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • linked_policy_numbers property Added
      • wrap property Modified
        • linked_policy_numbers property Added
      • wrap_children property Modified
        • linked_policy_numbers property Added
      • group_scheme property Modified
        • linked_policy_numbers property Added
      • linked_policy_numbers property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
      • transferred_from_plan property Modified
        • linked_policy_numbers property Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • linked_policy_numbers property Added
      • wrap property Modified
        • linked_policy_numbers property Added
      • wrap_children property Modified
        • linked_policy_numbers property Added
      • group_scheme property Modified
        • linked_policy_numbers property Added
      • linked_policy_numbers property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • linked_policy_numbers property Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • linked_policy_numbers property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • linked_policy_numbers property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
      • modelable property Modified
        • linked_policy_numbers property Added
      • existing_plan property Modified
        • linked_policy_numbers property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • linked_policy_numbers property Added
      • wrap property Modified
        • linked_policy_numbers property Added
      • wrap_children property Modified
        • linked_policy_numbers property Added
      • linked_policy_numbers property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
      • transferred_from_plan property Modified
        • linked_policy_numbers property Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • linked_policy_numbers property Added
      • wrap property Modified
        • linked_policy_numbers property Added
      • wrap_children property Modified
        • linked_policy_numbers property Added
      • linked_policy_numbers property Added
DELETE /api/v1/plans/{uuid}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • linked_policy_numbers property Added
      • wrap property Modified
        • linked_policy_numbers property Added
      • wrap_children property Modified
        • linked_policy_numbers property Added
      • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers property Added
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
      • transferred_from_plan property Modified
        • linked_policy_numbers 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
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
        • linked_policy_numbers 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
        • linked_policy_numbers 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
        • linked_policy_numbers property Added
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
      • modelable property Modified
        • linked_policy_numbers property Added
      • existing_plan property Modified
        • linked_policy_numbers 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/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • linked_policy_numbers property Added
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • linked_policy_numbers property Added
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable property Modified
Added 4
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
GET /api/v2/plans/linked-policy-numbers
DELETE /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}