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

about 2 hours ago

main
v1.163.0
Compare
v1.163.0

API structure has changed

Next change
63 structure changes including:
1 Addition
62 Modifications
Modified 62
GET /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plans property Modified
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • products property Modified
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children, mortgage_product properties Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • linked_plans, wrap, wrap_children, mortgage_product properties Modified
GET /api/v2/plans/linked-policy-numbers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Modified
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • mortgage_product property Modified
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • mortgage_product property Modified
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
      • modelable property Modified
        • mortgage_product property Modified
      • existing_plan property Modified
        • mortgage_product property Modified
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Modified
      • wrap property Modified
        • mortgage_product property Modified
      • wrap_children property Modified
        • mortgage_product property Modified
      • mortgage_product property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
      • group_scheme property Modified
        • mortgage_product property Modified
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
      • transferred_from_plan property Modified
        • mortgage_product property Modified
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Modified
      • wrap property Modified
        • mortgage_product property Modified
      • wrap_children property Modified
        • mortgage_product property Modified
      • mortgage_product property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
      • group_scheme property Modified
        • mortgage_product property Modified
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Modified
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • mortgage_product property Modified
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • mortgage_product property Modified
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
      • modelable property Modified
        • mortgage_product property Modified
      • existing_plan property Modified
        • mortgage_product property Modified
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Modified
      • wrap property Modified
        • mortgage_product property Modified
      • wrap_children property Modified
        • mortgage_product property Modified
      • mortgage_product property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
      • transferred_from_plan property Modified
        • mortgage_product property Modified
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Modified
      • wrap property Modified
        • mortgage_product property Modified
      • wrap_children property Modified
        • mortgage_product property Modified
      • mortgage_product property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Modified
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
        • mortgage_product property Modified
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
        • mortgage_product property Modified
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
        • mortgage_product property Modified
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, mortgage_product properties Modified
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
        • mortgage_product property Modified
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
GET /api/v2/holdings
  • 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
        • mortgage_product property Modified
      • wrap property Modified
        • mortgage_product property Modified
      • wrap_children property Modified
        • mortgage_product property Modified
      • mortgage_product property Modified
        • term_months, advance_amount, initial_rate, initial_rate_type, rate_control_period_months, initial_monthly_payment_amount, reversionary_rate, reversionary_monthly_payment_amount, total_amount_payable, lender_fees, total_lender_fees_amount, early_repayment_charge_description, early_repayment_charges properties Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product 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
  • 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, mortgage_product, group_scheme properties Modified
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
      • transferred_from_plan property Modified
        • mortgage_product property 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}/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
        • mortgage_product 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, mortgage_product, group_scheme properties Modified
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, mortgage_product properties Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Modified
      • modelable property Modified
        • mortgage_product property Modified
      • existing_plan property Modified
        • mortgage_product property Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, modelable, existing_plan properties Modified
Added 1
POST /api/v1/addons/mortgagebrain/mortgage-search/{mortgageSearch_uuid}/sync