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
4 structure changes including:
4 Modifications
Modified 4
GET /api/v1/cases
  • Query
  • filter[custom_field:REFERENCE] query parameter Added
GET /api/v1/client/{client_uuid}/cases
  • Query
  • filter[custom_field:REFERENCE] query parameter Added
POST /api/v1/account
  • Body
  • application/json content type Modified
    • alternative Modified
      • Create Employee Account alternative Modified
        • role_uuids property Added
PUT /api/v1/account/{uuid}
  • Body
  • application/json content type Modified
    • alternative Modified
      • Update Employee Account alternative Modified
        • role_uuids property Added
61 structure changes including:
61 Modifications
Modified 61 Breaking
DELETE /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/plans/{uuid}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/v1/document-pack/document-pack/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, name, percentage, cover properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, percentage, cover properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/claim
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/cover
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/sub-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
POST /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, percentage, cover properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/claim
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/cover
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/provider-feed-sync
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Response
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references, group_scheme properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/document-pack/document-pack/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • message property Added
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, percentage, cover properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Response
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Response
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Response
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 409 response Added
PUT /api/v1/plans/{uuid}
  • Response
  • 409 response Added