Do not miss any PlannrCRM API changes, ever again

Subscribe to the PlannrCRM API changelog to be up to date on recent changes.

RSS

about 22 hours ago

main
v1.127.2
Compare
v1.127.2

API structure has changed

386 structure changes including:
386 Modifications
Modified 386 Breaking
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
DELETE /api/v1/time-entry/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, firm, folder properties Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, firm properties Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • bank_statement, statement, account, firm, reconciliations properties Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bank_statement property Modified
        • statement, bank_transactions properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transaction property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transaction property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/business-units
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • members, firm properties Modified
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
GET /api/v1/business-units/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • members property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
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/{case_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable, account, author, seller, premium, firm properties Modified
GET /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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}/all-time-entries
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • trackable, account properties Modified
GET /api/v1/circles/{circle_uuid}/charge-splits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
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, firm properties Modified
GET /api/v1/circles/{circle_uuid}/fact-find-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file, account, fact_find_passes properties Modified
GET /api/v1/circles/{circle_uuid}/form-submissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, request, form properties 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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/client/{client_id}/fact-find/requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file, account, fact_find_passes properties Modified
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}/all-time-entries
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • trackable, account 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
        • accounts, shared_owner properties Modified
GET /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • mailbox, firm, ancestors, descendants, participants, attachments properties 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
          • Type went from string to object
            Breaking
      • phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • email_address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • income property Modified
        • shared_owner, employment, account properties Modified
          • Type went from string to object
            Breaking
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, firm 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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • application property Modified
        • firm, illustration, requested_by, plan properties Modified
          • Type went from string to object
            Breaking
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • requested_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/client/{client_uuid}/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner, employment, account properties Modified
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • employment property Modified
        • address, phone_number, email_address, shared_owner, turnover_history, income properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, firm, 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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_account, sub_accounts, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, linked_policy_numbers, 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, account properties Modified
GET /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
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}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • files, author, user properties Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • user property Modified
        • current_account, current_login, current_time_entry properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • latest_message property Modified
        • files, author, user, reactions properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/document-pack/document-pack/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
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, accounts properties Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
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, firm properties Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • charge_schedule property Modified
        • chargeable, account, author, seller, premium, firm properties Modified
          • Type went from string to object
            Breaking
      • chargeable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/fact-find-passes/{factFindRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v1/fact-find/request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file, account, fact_find_passes properties Modified
GET /api/v1/fact-find/request/{factFindRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • fact_find_passes property Modified
        • account property Modified
          • Type went from string to object
            Breaking
GET /api/v1/file/bin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • folder, firm, account properties Modified
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v1/firm/{firm_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon_subscriptions property Modified
        • addon property Modified
          • Type went from string to object
            Breaking
      • task_board_template property Modified
        • modelable property Modified
          • Type went from string to object
            Breaking
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v1/folder/{folder_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/form
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • sections property Modified
GET /api/v1/form/{form_uuid}/question/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • section property Modified
        • form, questions properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/form/{form_uuid}/section/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
      • questions property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, request, form properties 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, request, form properties Modified
GET /api/v1/form/{form_uuid}/submission-request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • form, submission properties Modified
GET /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • question property Modified
GET /api/v1/form/{form_uuid}/submission/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • request property Modified
        • form, submission properties Modified
          • Type went from string to object
            Breaking
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
GET /api/v1/form/{uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • sections property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
GET /api/v1/illustration/{illustration_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • application property Modified
        • firm, illustration, requested_by, plan properties Modified
          • Type went from string to object
            Breaking
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • requested_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • error_report, account properties Modified
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, owners, joint_account_circle, circles properties Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/life-stage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • sections property Modified
GET /api/v1/life-stage/{lifeStage_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections property Modified
        • fields property Modified
          • Type went from string to object
            Breaking
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, firm properties Modified
GET /api/v1/logs/{modelType}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account, accounts 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
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • data property Modified
          • Type went from string to object
            Breaking
      • descendants property Modified
        • data property Modified
          • Type went from string to object
            Breaking
      • participants property Modified
        • mailbox_message, firm, mailbox properties Modified
          • Type went from string to object
            Breaking
      • attachments property Modified
        • firm property Modified
          • Type went from string to object
            Breaking
GET /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • current_login property Modified
        • account, firm properties Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/me/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account, accounts properties Modified
GET /api/v1/my/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, firm, 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
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • clients property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • modelable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • existing_plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • triggered_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/notifications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • triggered_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_account, sub_accounts, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account properties Modified
GET /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, name, percentage, cover properties Added
GET /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, percentage, cover properties Added
GET /api/v1/plans/{plan_uuid}/claim
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Added
GET /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Added
GET /api/v1/plans/{plan_uuid}/cover
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Added
GET /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Added
GET /api/v1/plans/{plan_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
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, firm properties Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_account, sub_accounts, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, group_scheme properties Modified
GET /api/v1/plans/{plan_uuid}/holdings/{subAccount}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • sub_account property Modified
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • application property Modified
        • firm, illustration, requested_by, plan properties Modified
          • Type went from string to object
            Breaking
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • requested_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, firm, 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
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Added
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Added
GET /api/v1/plans/{plan_uuid}/provider-feed-logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/plans/{plan_uuid}/sub-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_account, sub_accounts, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, linked_policy_numbers, 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
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Added
GET /api/v1/plans/{plan_uuid}/valuations/{subAccount}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • sub_account property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/referral-connections/{referralConnection_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sender_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • recipient_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
GET /api/v1/referrals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sender_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • recipient_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
GET /api/v1/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by, files, folder properties 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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
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
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • bank_transaction_reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • bank_transaction_reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transaction property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transaction property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/submission-request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • form, submission properties Modified
GET /api/v1/submission-request/received/{account}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • form, submission properties Modified
GET /api/v1/submission-request/sent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • form, submission properties Modified
GET /api/v1/submission-request/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
      • submission property Modified
        • account, request, form properties Modified
          • Type went from string to object
            Breaking
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • taskable, author, completed_by, workflow_task properties Modified
        • assigned_to property Modified
          • Type went from object to array[object]
            Breaking
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
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • assigned_to property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
      • completed_by property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • workflow_task property Modified
        • uuid, created_at, updated_at, name, description, priority, location_uuid properties Modified
          • Type went from object to string
            Breaking
        • position, offset_due_at_by properties Modified
          • Type went from object to integer
            Breaking
        • task_status, author, participants, tags, parent, trigger, trigger_tasks, sub_tasks, groups, workflow properties Modified
        • visible_to_clients, auto_assign_assigned_adviser, auto_assign_assigned_administrator, auto_assign_clients, is_trigger_task properties Modified
          • Type went from object to boolean
            Breaking
GET /api/v1/time-entry/{trackable_type}/{trackable_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • trackable, account properties Modified
GET /api/v1/time-entry/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
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/v1/workflow/{workflow_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_tasks property Modified
        • sub_tasks property Modified
          • Type went from string to object
            Breaking
GET /api/v2/addresses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts, primary_accounts properties Modified
GET /api/v2/addresses/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • primary_accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v2/bank-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v2/bank-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v2/contact-details
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts, primary_accounts properties Modified
GET /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v2/dependants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v2/direct-debit-mandates
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm, account properties Modified
GET /api/v2/direct-debit-mandates/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v2/employments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address, phone_number, email_address, shared_owner, income, account properties Modified
GET /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • email_address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • income property Modified
        • shared_owner, employment, account properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v2/fact-find-employments/{factFindSession_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address, phone_number, email_address, shared_owner, income, account properties 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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v2/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • employment, account properties Modified
GET /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • address, phone_number, email_address, shared_owner, turnover_history, income, account properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • applicants, cases, products, files properties Modified
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • applicants property Modified
        • account property Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • products property Modified
        • files property Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_account, sub_accounts, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account properties Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_account, sub_accounts, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, wrap, wrap_children, linked_policy_numbers, 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/portal/actions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • resource property Modified
GET /api/v2/risks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by, account properties Modified
GET /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address, firm, account properties Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
GET /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fact_find_answers property Modified
        • fact_find_question property Modified
GET /api/v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, sub_account, holding, 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
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PATCH /api/v1/checklist-item/{checklistItem_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checked_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PATCH /api/v1/checklist/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • checked_by property Modified
          • Type went from string to object
            Breaking
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • assigned_to property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
      • completed_by property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • workflow_task property Modified
        • uuid, created_at, updated_at, name, description, priority, location_uuid properties Modified
          • Type went from object to string
            Breaking
        • position, offset_due_at_by properties Modified
          • Type went from object to integer
            Breaking
        • task_status, author, participants, tags, parent, trigger, trigger_tasks, sub_tasks, groups, workflow properties Modified
        • visible_to_clients, auto_assign_assigned_adviser, auto_assign_assigned_administrator, auto_assign_clients, is_trigger_task properties Modified
          • Type went from object to boolean
            Breaking
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • assigned_to property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
      • completed_by property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • workflow_task property Modified
        • uuid, created_at, updated_at, name, description, priority, location_uuid properties Modified
          • Type went from object to string
            Breaking
        • position, offset_due_at_by properties Modified
          • Type went from object to integer
            Breaking
        • task_status, author, participants, tags, parent, trigger, trigger_tasks, sub_tasks, groups, workflow properties Modified
        • visible_to_clients, auto_assign_assigned_adviser, auto_assign_assigned_administrator, auto_assign_clients, is_trigger_task properties Modified
          • Type went from object to boolean
            Breaking
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • applicants property Modified
        • account property Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • products property Modified
        • files property Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/addons/seccl/{addon}/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/bank-statement
  • Response
  • 201 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bank_statement property Modified
        • statement, bank_transactions properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/business-units
  • Response
  • 201 response Modified
    • application/json content type Modified
      • members property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/checklist/{checklist_uuid}/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checked_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/client/{client_uuid}/dependant
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • email_address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • income property Modified
        • shared_owner, employment, account properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/client/{client_uuid}/goal
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/client/{client_uuid}/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • employment property Modified
        • address, phone_number, email_address, shared_owner, turnover_history, income properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v1/client/{client_uuid}/risk
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • latest_message property Modified
        • files, author, user, reactions properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/conversation/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • latest_message property Modified
        • files, author, user, reactions properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • user property Modified
        • current_account, current_login, current_time_entry properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • user property Modified
        • current_account, current_login, current_time_entry properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/custom-default-folder
  • Body
  • application/json content type Modified
    • structure property Modified
      • children property Modified
        • property Modified
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • charge_schedule property Modified
        • chargeable, account, author, seller, premium, firm properties Modified
          • Type went from string to object
            Breaking
      • chargeable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/fact-find/request
  • Response
  • 201 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • fact_find_passes property Modified
        • account property Modified
          • Type went from string to object
            Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • fact_find_passes property Modified
        • account property Modified
          • Type went from string to object
            Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • fact_find_passes property Modified
        • account property Modified
          • Type went from string to object
            Breaking
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon_subscriptions property Modified
        • addon property Modified
          • Type went from string to object
            Breaking
      • task_board_template property Modified
        • modelable property Modified
          • Type went from string to object
            Breaking
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon_subscriptions property Modified
        • addon property Modified
          • Type went from string to object
            Breaking
      • task_board_template property Modified
        • modelable property Modified
          • Type went from string to object
            Breaking
POST /api/v1/folder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/form
  • Response
  • 201 response Modified
    • application/json content type Modified
      • sections property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/form/{form_uuid}/duplicate
  • Response
  • 201 response Modified
    • application/json content type Modified
      • sections property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/form/{form_uuid}/question
  • Response
  • 200 response Modified
    • application/json content type Modified
      • section property Modified
        • form, questions properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/form/{form_uuid}/section
  • Response
  • 200 response Modified
    • application/json content type Modified
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
      • questions property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • request property Modified
        • form, submission properties Modified
          • Type went from string to object
            Breaking
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
POST /api/v1/form/{form_uuid}/submission-request/{account_uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
      • submission property Modified
        • account, request, form properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • application property Modified
        • firm, illustration, requested_by, plan properties Modified
          • Type went from string to object
            Breaking
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • requested_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • application property Modified
        • firm, illustration, requested_by, plan properties Modified
          • Type went from string to object
            Breaking
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • requested_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/import/map/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/import/start/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/life-stage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections property Modified
        • fields property Modified
          • Type went from string to object
            Breaking
POST /api/v1/me/switch-account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • current_login property Modified
        • account, firm properties Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • clients property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • modelable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • existing_plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, percentage, cover properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, percentage, cover properties Added
POST /api/v1/plans/{plan_uuid}/claim
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Added
POST /api/v1/plans/{plan_uuid}/cover
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references, group_scheme properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • group_scheme property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references, group_scheme properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references, group_scheme properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • group_scheme property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references, group_scheme properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Added
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references, group_scheme properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references, group_scheme properties Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Added
POST /api/v1/provider-statement
  • Response
  • 201 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/provider-statement/import
  • Response
  • 201 response Modified
    • application/json content type Modified
      • error_report property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/referral-connections
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sender_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • recipient_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
POST /api/v1/referrals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sender_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • recipient_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
POST /api/v1/referrals/{referral_uuid}/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sender_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • recipient_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
POST /api/v1/referrals/{referral_uuid}/reject
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sender_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • recipient_account property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
POST /api/v1/report
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • bank_transaction_reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
POST /api/v1/task
  • Response
  • 201 response Modified
    • application/json content type Modified
      • taskable property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • assigned_to property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
      • completed_by property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • workflow_task property Modified
        • uuid, created_at, updated_at, name, description, priority, location_uuid properties Modified
          • Type went from object to string
            Breaking
        • position, offset_due_at_by properties Modified
          • Type went from object to integer
            Breaking
        • task_status, author, participants, tags, parent, trigger, trigger_tasks, sub_tasks, groups, workflow properties Modified
        • visible_to_clients, auto_assign_assigned_adviser, auto_assign_assigned_administrator, auto_assign_clients, is_trigger_task properties Modified
          • Type went from object to boolean
            Breaking
POST /api/v1/task/{task_uuid}/checklists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • checked_by property Modified
          • Type went from string to object
            Breaking
POST /api/v1/time-entry
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v1/time-entry/{timeEntry_uuid}/stop
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
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
          • Type went from string to object
            Breaking
POST /api/v2/addresses
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • primary_accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v2/bank-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v2/contact-details
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v2/dependants
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v2/employments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • email_address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • income property Modified
        • shared_owner, employment, account properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v2/goals
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v2/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • employment property Modified
        • address, phone_number, email_address, shared_owner, turnover_history, income, account properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
POST /api/v2/risks
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/bank-statement/{bankStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bank_statement property Modified
        • statement, bank_transactions properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/business-units/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • members property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • email_address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • income property Modified
        • shared_owner, employment, account properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • employment property Modified
        • address, phone_number, email_address, shared_owner, turnover_history, income properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • user property Modified
        • current_account, current_login, current_time_entry properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • participants property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • latest_message property Modified
        • files, author, user, reactions properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
  • Body
  • application/json content type Modified
    • structure property Modified
      • property Modified
        • property Added
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/document-pack/document-pack/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • message property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • charge_schedule property Modified
        • chargeable, account, author, seller, premium, firm properties Modified
          • Type went from string to object
            Breaking
      • chargeable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon_subscriptions property Modified
        • addon property Modified
          • Type went from string to object
            Breaking
      • task_board_template property Modified
        • modelable property Modified
          • Type went from string to object
            Breaking
PUT /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
      • parents property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • ancestors property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
      • children property Modified
        • participants, folders, files, parents, ancestors, children properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/form/{form_uuid}/question/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • section property Modified
        • form, questions properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/form/{form_uuid}/section/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
      • questions property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • form property Modified
        • sections property Modified
          • Type went from string to object
            Breaking
      • submission property Modified
        • account, request, form properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/form/{uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • sections property Modified
        • section, linked_question properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • application property Modified
        • firm, illustration, requested_by, plan properties Modified
          • Type went from string to object
            Breaking
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • requested_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • primary_phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • primary_email property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
      • assigned_adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_administrator property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • assigned_paraplanner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • introduced_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • business_unit property Modified
        • members, groups, firm properties Modified
          • Type went from string to object
            Breaking
      • owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • joint_account_circle property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/life-stage/{lifeStage_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections property Modified
        • fields property Modified
          • Type went from string to object
            Breaking
PUT /api/v1/mailboxes/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, terms_of_business_at, client_agreement_at, can_be_deleted, inactive_at, last_interaction_at, referral_code properties Modified
          • Type went from object to string
            Breaking
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, permissions, custom_fields, external_references properties Modified
        • with_login, has_joint_account properties Modified
          • Type went from object to boolean
            Breaking
        • ownership_percentage property Modified
          • Type went from object to integer
            Breaking
PUT /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • current_login property Modified
        • account, firm properties Modified
          • Type went from string to object
            Breaking
      • current_time_entry property Modified
        • trackable, account properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • clients property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • modelable property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • adviser property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • case property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • existing_plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, percentage, cover properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, percentage, cover properties Added
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • sub_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Added
  • 409 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • main_account property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • sub_accounts property Modified
        • latest_valuation, active_portfolio properties Modified
          • Type went from string to object
            Breaking
      • covers property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • claims property Modified
        • client property Modified
          • Type went from string to object
            Breaking
      • latest_valuations property Modified
        • sub_account property Modified
          • Type went from string to object
            Breaking
      • client property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • seller property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_owners property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_plans property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • visible_to_circles property Modified
        • accounts, groups, external_references properties Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • wrap property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • wrap_children property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • linked_policy_numbers property Modified
        • plan property Modified
          • Type went from string to object
            Breaking
      • contract_enquiry_account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • statement_transactions property Modified
        • provider_statement, expectation, bank_transactions, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider_statement property Modified
        • provider, statement, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • expectation property Modified
        • account, seller, author, charge_schedule, chargeable, statement_transactions, statement, income_splits, firm properties Modified
          • Type went from string to object
            Breaking
      • bank_transactions property Modified
        • bank_statement, statement, account, firm properties Modified
          • Type went from string to object
            Breaking
      • statement property Modified
        • locked_by, statement_transactions properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • bank_transaction_reconciliations property Modified
        • statement_transaction, bank_transaction, account properties Modified
          • Type went from string to object
            Breaking
PUT /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • author property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • assigned_to property Modified
        • Type went from object to array[object]
          Breaking
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url, external_references properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
      • completed_by property Modified
        • uuid, created_at, updated_at, type, role, first_name, last_name, name, email, photo_url properties Modified
          • Type went from object to string
            Breaking
        • external_references property Modified
      • workflow_task property Modified
        • uuid, created_at, updated_at, name, description, priority, location_uuid properties Modified
          • Type went from object to string
            Breaking
        • position, offset_due_at_by properties Modified
          • Type went from object to integer
            Breaking
        • task_status, author, participants, tags, parent, trigger, trigger_tasks, sub_tasks, groups, workflow properties Modified
        • visible_to_clients, auto_assign_assigned_adviser, auto_assign_assigned_administrator, auto_assign_clients, is_trigger_task properties Modified
          • Type went from object to boolean
            Breaking
PUT /api/v1/time-entry/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v2/addresses/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • primary_accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v2/bank-accounts/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • phone_number property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • email_address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • income property Modified
        • shared_owner, employment, account properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • address, phone_number, email_address, shared_owner, turnover_history, income, account properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • applicants property Modified
        • account property Modified
          • Type went from string to object
            Breaking
      • cases property Modified
        • status, type, participants, plans, custom_fields properties Modified
          • Type went from string to object
            Breaking
      • products property Modified
        • files property Modified
          • Type went from string to object
            Breaking
      • files property Modified
        • folder, firm, account, tags properties Modified
          • Type went from string to object
            Breaking
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • main_account, sub_accounts, provider, covers, claims, latest_valuations, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, cases, tags, wrap, wrap_children, linked_policy_numbers, contract_enquiry_account, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • external_references property Modified
          • Type went from string to object
            Breaking
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address property Modified
        • accounts property Modified
          • Type went from string to object
            Breaking
      • firm property Modified
        • addon_subscriptions, task_board_template properties Modified
          • Type went from string to object
            Breaking
      • account property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, business_unit, groups, tags, owners, joint_account_circle, circles, custom_fields, external_references properties Modified
          • Type went from string to object
            Breaking
PUT /api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • fact_find_answers property Modified
        • fact_find_question property Modified