API structure has changed
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
-
data property Modified
-
application/json content type Modified
GET /api/v2/mortgage-searches
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- products property Modified
-
data property Modified
-
application/json content type 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
-
products property Modified
-
application/json content type Modified
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
-
data property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type Modified
GET /api/v2/plans/linked-policy-numbers
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- plan property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v2/transactions
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- plan property Modified
-
data property Modified
-
application/json content type 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
-
products property Modified
-
application/json content type Modified
POST /api/v1/cases
- Response
-
200 response Modified
-
application/json content type Modified
-
plans property Modified
- mortgage_product property Modified
-
plans property Modified
-
application/json content type Modified
POST /api/v1/charge-split
- Response
-
201 response Modified
-
application/json content type Modified
-
splitable property Modified
- mortgage_product property Modified
-
splitable property Modified
-
application/json content type Modified
POST /api/v1/expectation/reconcile
- Response
-
200 response Modified
-
application/json content type Modified
-
chargeable property Modified
- mortgage_product property Modified
-
chargeable property Modified
-
application/json content type Modified
POST /api/v1/illustration
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type Modified
POST /api/v1/illustration/{illustration_uuid}/generate
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
linked_plans property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
linked_plans property Modified
-
application/json content type Modified
POST /api/v1/plans/{plan_uuid}/transaction
- Response
-
201 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type Modified
PUT /api/v1/cases/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
plans property Modified
- mortgage_product property Modified
-
plans property Modified
-
application/json content type Modified
PUT /api/v1/charge-split/{chargeSplit_uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
splitable property Modified
- mortgage_product property Modified
-
splitable property Modified
-
application/json content type Modified
PUT /api/v1/expectation/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
chargeable property Modified
- mortgage_product property Modified
-
chargeable property Modified
-
application/json content type Modified
PUT /api/v1/illustration/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
linked_plans property Modified
-
application/json content type Modified
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
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
linked_plans property Modified
-
application/json content type Modified
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
-
products property Modified
-
application/json content type Modified
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
-
plan property Modified
-
application/json content type Modified
GET /api/v1/cases/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
plans property Modified
- mortgage_product property Modified
-
plans property Modified
-
application/json content type Modified
GET /api/v1/charge
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- chargeable property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v1/charge-split/{chargeSplit_uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
splitable property Modified
- mortgage_product property Modified
-
splitable property Modified
-
application/json content type Modified
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- splitable property Modified
-
data property Modified
-
application/json content type 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
-
splitable property Modified
-
application/json content type Modified
GET /api/v1/circles/{circle_uuid}/expectations
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- chargeable property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v1/client/{client_uuid}/cases
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- plans property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v1/client/{client_uuid}/expectations
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- chargeable property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v1/client/{client_uuid}/illustrations
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type Modified
GET /api/v1/expectation
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- chargeable property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v1/expectation/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
chargeable property Modified
- mortgage_product property Modified
-
chargeable property Modified
-
application/json content type Modified
GET /api/v1/illustration/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type Modified
GET /api/v2/holdings
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- plan property Modified
-
data property Modified
-
application/json content type 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
-
linked_plans property Modified
-
application/json content type Modified
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- plan property Modified
-
data property Modified
-
application/json content type Modified
GET /api/v1/plans/{plan_uuid}/transaction
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- plan property Modified
-
data property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type Modified
GET /api/v1/plans/{plan_uuid}/illustrations
- Response
-
200 response Modified
-
application/json content type Modified
-
plan property Modified
- mortgage_product property Modified
-
plan property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type Modified
GET /api/v1/plans/{plan_uuid}/expectations
- Response
-
200 response Modified
-
application/json content type Modified
-
data property Modified
- chargeable property Modified
-
data property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type 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
-
plan property Modified
-
application/json content type 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
-
data property Modified
-
application/json content type Modified
Added
1
POST /api/v1/addons/mortgagebrain/mortgage-search/{mortgageSearch_uuid}/sync