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
15 structure changes including:
15 Modifications
Modified 15
GET /api/v1/account/{account_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/cases/{case_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/circles/{circle_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • user property Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • two_factor_setup_required property Added
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • user property Modified
GET /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • two_factor_setup_required property Added
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • user property Modified
POST /api/v1/conversation/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • user property Modified
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • two_factor_setup_required property Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • two_factor_setup_required property Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • enforce_client_two_factor property Added
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • two_factor_setup_required property Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • user property Modified
282 structure changes including:
282 Modifications
Modified 282
DELETE /api/v1/account/{account_uuid}/out-of-office
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/account/{account_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants, latest_message properties Modified
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/audits
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/audits/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-executions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/bank-statement
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement, bank_transactions properties Modified
GET /api/v1/bank-statement/{bankStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • bank_transactions property Modified
        • account property Modified
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement, account, reconciliations properties Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • reconciliations property Modified
        • account property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transaction property Modified
        • account property Modified
      • bank_transaction property Modified
        • account property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/bulk-actions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • executed_by property Modified
GET /api/v1/bulk-actions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • executed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/business-units
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • members property Modified
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/business-units/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • members property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants, plans properties Modified
GET /api/v1/cases/{case_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants, latest_message properties Modified
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable, account, author, seller, premium properties Modified
GET /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • splitable, account properties Modified
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/circles/{circle_uuid}/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • logins property Modified
GET /api/v1/circles/{circle_uuid}/charge-splits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/circles/{circle_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants, latest_message properties Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement properties Modified
GET /api/v1/circles/{circle_uuid}/form-submissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/circles/{circle_uuid}/notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/client/{client_uuid}/all-notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/client/{client_uuid}/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants, plans properties Modified
GET /api/v1/client/{client_uuid}/dependant
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • mailbox property Modified
GET /api/v1/client/{client_uuid}/employment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address, phone_number, email_address, shared_owner, income properties Modified
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • phone_number property Modified
        • accounts property Modified
      • email_address property Modified
        • accounts property Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • income property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement properties Modified
GET /api/v1/client/{client_uuid}/goal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • requested_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{client_uuid}/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner, employment properties Modified
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • employment property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, adviser, case, existing_plan properties Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • covers, claims, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, contract_enquiry_account properties Modified
GET /api/v1/client/{client_uuid}/risk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by property Modified
GET /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{client_uuid}/signatures
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • launched_by property Modified
GET /api/v1/client/{client_uuid}/staff-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/client/{client_uuid}/staff-members/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants, latest_message properties Modified
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, user properties Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • user property Modified
        • current_account property Modified
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • participants property Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • latest_message property Modified
        • author property Modified
GET /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • launched_by property Modified
GET /api/v1/document-signing/{signatureTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/employee/{employee_uuid}/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/employee/{employee}/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement properties Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • charge_schedule property Modified
        • account, author, seller properties Modified
      • chargeable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • statement_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
GET /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/form/{form_uuid}/submission-request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • submission property Modified
GET /api/v1/form/{form_uuid}/submission/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • requested_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/logs/{modelType}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/mailboxes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/mailboxes/message/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mailbox property Modified
        • created_by property Modified
GET /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • current_login property Modified
        • account property Modified
GET /api/v1/me/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, adviser, case, existing_plan properties Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • clients property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • modelable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • case property Modified
        • participants property Modified
      • existing_plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/note/{notableType}/{notableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/notifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • triggered_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/notifications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • triggered_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • covers, claims, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, contract_enquiry_account properties Modified
GET /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • cover property Modified
GET /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cover property Modified
        • client property Modified
GET /api/v1/plans/{plan_uuid}/claim
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Modified
GET /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/plans/{plan_uuid}/cover
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Modified
GET /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement properties Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • covers, claims, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, contract_enquiry_account, group_scheme properties Modified
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • requested_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, adviser, case, existing_plan properties Modified
GET /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by, plan, transferred_from_plan properties Modified
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • transferred_from_plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • covers, claims, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, contract_enquiry_account, group_scheme properties Modified
GET /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, account, transaction_schedule properties Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, account properties Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • transaction_schedule property Modified
        • account property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • covers property Modified
        • client property Modified
      • claims property Modified
        • client property Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • visible_to_circles property Modified
        • accounts property Modified
      • cases property Modified
        • participants property Modified
      • wrap property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • wrap_children property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • contract_enquiry_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/provider-statement
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement, statement_transactions properties Modified
GET /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • statement_transactions property Modified
        • account property Modified
GET /api/v1/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/report-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/statement
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • locked_by, statement_transactions properties Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • bank_transaction_reconciliations property Modified
        • account property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • bank_transaction_reconciliations property Modified
        • account property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transaction property Modified
        • account property Modified
      • bank_transaction property Modified
        • account property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • statement_transactions property Modified
        • account property Modified
GET /api/v1/submission-request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • submission property Modified
GET /api/v1/submission-request/received/{account}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • submission property Modified
GET /api/v1/submission-request/sent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • submission property Modified
GET /api/v1/submission-request/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • submission property Modified
        • account property Modified
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • taskable, workflow_task properties Modified
GET /api/v1/task/{task_uuid}/checklists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • items property Modified
GET /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • participants property Modified
      • workflow_task property Modified
        • author, participants properties Modified
GET /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • items property Modified
GET /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v2/employments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address, phone_number, email_address, shared_owner, income properties Modified
GET /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • phone_number property Modified
        • accounts property Modified
      • email_address property Modified
        • accounts property Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • income property Modified
        • shared_owner property Modified
GET /api/v2/goals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v2/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • employment property Modified
GET /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • shared_owner property Modified
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • cases property Modified
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cases property Modified
        • participants property Modified
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • covers, claims, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, contract_enquiry_account properties Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • covers, claims, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, contract_enquiry_account 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/risks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by property Modified
GET /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v2/roles/{role_uuid}/assignees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • primary_phone_number, primary_email, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
        • is_pending_fact_find_account property Added
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address, account properties Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
GET /api/v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, transaction_schedule properties Modified
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PATCH /api/v1/checklist-item/{checklistItem_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checked_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PATCH /api/v1/checklist/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • checked_by property Modified
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • participants property Modified
      • workflow_task property Modified
        • author, participants properties Modified
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • participants property Modified
      • workflow_task property Modified
        • author, participants properties Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
POST /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cases property Modified
        • participants property Modified
POST /api/v1/addons/seccl/{addon}/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/bank-statement
  • Response
  • 201 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • bank_transactions property Modified
        • account property Modified
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • reconciliations property Modified
        • account property Modified
POST /api/v1/business-units
  • Response
  • 201 response Modified
    • application/json content type Modified
      • members property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/checklist/{checklist_uuid}/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checked_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
POST /api/v1/client/{client_uuid}/dependant
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • phone_number property Modified
        • accounts property Modified
      • email_address property Modified
        • accounts property Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • income property Modified
        • shared_owner property Modified
POST /api/v1/client/{client_uuid}/goal
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/client/{client_uuid}/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • employment property Modified
        • shared_owner property Modified
POST /api/v1/client/{client_uuid}/risk
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • participants property Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • latest_message property Modified
        • author property Modified
POST /api/v1/conversation/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • participants property Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • latest_message property Modified
        • author property Modified
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • user property Modified
        • current_account property Modified
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • user property Modified
        • current_account property Modified
POST /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • charge_schedule property Modified
        • account, author, seller properties Modified
      • chargeable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • statement_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
POST /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/form/{form_uuid}/submission-request/{account_uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • submission property Modified
        • account property Modified
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • requested_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • requested_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/import/map/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/import/start/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • clients property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • modelable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • case property Modified
        • participants property Modified
      • existing_plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
POST /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 201 response Modified
    • application/json content type Modified
      • cover property Modified
        • client property Modified
POST /api/v1/plans/{plan_uuid}/claim
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/plans/{plan_uuid}/cover
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • covers property Modified
        • client property Modified
      • claims property Modified
        • client property Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • visible_to_circles property Modified
        • accounts property Modified
      • cases property Modified
        • participants property Modified
      • wrap property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • wrap_children property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • contract_enquiry_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • group_scheme property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • transferred_from_plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • covers property Modified
        • client property Modified
      • claims property Modified
        • client property Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • visible_to_circles property Modified
        • accounts property Modified
      • cases property Modified
        • participants property Modified
      • wrap property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • wrap_children property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • contract_enquiry_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • group_scheme property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • transaction_schedule property Modified
        • account property Modified
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/provider-statement
  • Response
  • 201 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • statement_transactions property Modified
        • account property Modified
POST /api/v1/provider-statement/import
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/provider-statement/upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/report
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • bank_transaction_reconciliations property Modified
        • account property Modified
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • statement_transactions property Modified
        • account property Modified
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • statement_transactions property Modified
        • account property Modified
POST /api/v1/task
  • Response
  • 201 response Modified
    • application/json content type Modified
      • taskable property Modified
        • participants property Modified
      • workflow_task property Modified
        • author, participants properties Modified
POST /api/v1/task/{task_uuid}/checklists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • checked_by property Modified
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • checked_by property Modified
POST /api/v2/contact-details
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v2/dependants
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v2/employments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • phone_number property Modified
        • accounts property Modified
      • email_address property Modified
        • accounts property Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • income property Modified
        • shared_owner property Modified
POST /api/v2/goals
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v2/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • employment property Modified
        • shared_owner property Modified
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
POST /api/v2/risks
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/account/{account_uuid}/out-of-office
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/bank-statement/{bankStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • bank_transactions property Modified
        • account property Modified
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • reconciliations property Modified
        • account property Modified
PUT /api/v1/business-units/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • members property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • phone_number property Modified
        • accounts property Modified
      • email_address property Modified
        • accounts property Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • income property Modified
        • shared_owner property Modified
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • employment property Modified
        • shared_owner property Modified
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
PUT /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • user property Modified
        • current_account property Modified
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • participants property Modified
      • participants property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • latest_message property Modified
        • author property Modified
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • author property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • charge_schedule property Modified
        • account, author, seller properties Modified
      • chargeable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • statement_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
PUT /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • submission property Modified
        • account property Modified
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • requested_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • primary_phone_number property Modified
        • accounts property Modified
      • primary_email property Modified
        • accounts property Modified
      • assigned_adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_administrator property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • assigned_paraplanner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • introduced_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • business_unit property Modified
        • members property Modified
      • owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • joint_account_circle property Modified
        • accounts property Modified
      • circles property Modified
        • accounts property Modified
      • is_pending_fact_find_account property Added
PUT /api/v1/mailboxes/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • clients property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • modelable property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • adviser property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • case property Modified
        • participants property Modified
      • existing_plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cover property Modified
        • client property Modified
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • covers property Modified
        • client property Modified
      • claims property Modified
        • client property Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • visible_to_circles property Modified
        • accounts property Modified
      • cases property Modified
        • participants property Modified
      • wrap property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • wrap_children property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • contract_enquiry_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • transferred_from_plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • transaction_schedule property Modified
        • account property Modified
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • covers property Modified
        • client property Modified
      • claims property Modified
        • client property Modified
      • client property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • seller property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_owners property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • linked_plans property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • visible_to_circles property Modified
        • accounts property Modified
      • cases property Modified
        • participants property Modified
      • wrap property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • wrap_children property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
      • contract_enquiry_account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by property Modified
      • statement_transactions property Modified
        • account property Modified
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expectation property Modified
        • account, seller, author properties Modified
      • bank_transactions property Modified
        • account property Modified
      • statement property Modified
        • locked_by property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • bank_transaction_reconciliations property Modified
        • account property Modified
PUT /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • participants property Modified
      • workflow_task property Modified
        • author, participants properties Modified
PUT /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • phone_number property Modified
        • accounts property Modified
      • email_address property Modified
        • accounts property Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
      • income property Modified
        • shared_owner property Modified
PUT /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • shared_owner property Modified
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cases property Modified
        • participants property Modified
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
PUT /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
      • account property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • is_pending_fact_find_account property Added
62 structure changes including:
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/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product property Added
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product 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
        • mortgage_product property Added
      • modelable property Modified
        • mortgage_product property Added
      • existing_plan property Modified
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product property Added
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product 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
        • mortgage_product property Added
      • transferred_from_plan property Modified
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • mortgage_product property Added
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • products property Modified
        • plans property Added
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • plan, mortgage_search properties Added
      • plans 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
        • mortgage_product 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
        • mortgage_product property Added
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
  • Body
  • application/json content type Modified
    • case_uuid, circle_uuid properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • plan, mortgage_search properties Added
      • plans property Added
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Added
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • mortgage_product property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • mortgage_product property Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • modelable property Modified
        • mortgage_product property Added
      • existing_plan property Modified
        • mortgage_product property Added
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • mortgage_product_uuid property Added
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 Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • group_scheme property Modified
        • mortgage_product property Added
      • mortgage_product property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • transferred_from_plan property Modified
        • mortgage_product property Added
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 Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • group_scheme property Modified
        • mortgage_product property Added
      • mortgage_product property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • mortgage_product property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • mortgage_product property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • modelable property Modified
        • mortgage_product property Added
      • existing_plan property Modified
        • mortgage_product property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • mortgage_product property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • transferred_from_plan property Modified
        • mortgage_product property Added
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 Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • mortgage_product property Added
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • plan, mortgage_search properties Added
      • plans property 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 Added
62 structure changes including:
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/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product property Added
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product 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
        • mortgage_product property Added
      • modelable property Modified
        • mortgage_product property Added
      • existing_plan property Modified
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product property Added
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product 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
        • mortgage_product property Added
      • transferred_from_plan property Modified
        • mortgage_product 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
        • mortgage_product 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
        • mortgage_product property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • mortgage_product property Added
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • products property Modified
        • plans property Added
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • plan, mortgage_search properties Added
      • plans 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
        • mortgage_product 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
        • mortgage_product property Added
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
  • Body
  • application/json content type Modified
    • case_uuid, circle_uuid properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • plan, mortgage_search properties Added
      • plans property Added
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Added
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • mortgage_product property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • mortgage_product property Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • modelable property Modified
        • mortgage_product property Added
      • existing_plan property Modified
        • mortgage_product property Added
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • mortgage_product_uuid property Added
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 Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • group_scheme property Modified
        • mortgage_product property Added
      • mortgage_product property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • transferred_from_plan property Modified
        • mortgage_product property Added
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 Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • group_scheme property Modified
        • mortgage_product property Added
      • mortgage_product property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plans property Modified
        • mortgage_product property Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • mortgage_product property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chargeable property Modified
        • mortgage_product property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • modelable property Modified
        • mortgage_product property Added
      • existing_plan property Modified
        • mortgage_product property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • mortgage_product property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
      • transferred_from_plan property Modified
        • mortgage_product property Added
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 Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • mortgage_product property Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • linked_plans property Modified
        • mortgage_product property Added
      • wrap property Modified
        • mortgage_product property Added
      • wrap_children property Modified
        • mortgage_product property Added
      • mortgage_product property Added
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • plan, mortgage_search properties Added
      • plans property 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 Added
9 structure changes including:
8 Additions
1 Modification
Modified 1 Breaking
POST /api/v1/provider-statement/upload
  • Body
  • application/json content type Modified
    • statement_transactions property Modified
      • gross_amount, net_amount properties Modified
        • Type went from integer to string
          Breaking
Added 8
DELETE /api/v2/roles/{uuid}
GET /api/v1/static/rbac-permissions
GET /api/v2/roles
GET /api/v2/roles/{role_uuid}/assignees
GET /api/v2/roles/{uuid}
POST /api/v2/roles
POST /api/v2/roles/{role_uuid}/{action}
PUT /api/v2/roles/{uuid}