For AI agents: a documentation index is available at https://apidocs.plannrcrm.com/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.

Do not miss any PlannrCRM API changes, ever again

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

RSS

Changelog

Last update:
Compare
14 structure changes including:
14 Modifications
Modified 14 Breaking
POST /api/v1/bank-statement/upload
  • Body
  • application/json content type Modified
    • bank_transactions property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/bank-transaction
  • Body
  • application/json content type Modified
    • statement_transactions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • bank_transactions property Added
POST /api/v1/bank-transaction/reconcile
  • Body
  • application/json content type Modified
    • statement_transactions, bank_transactions properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/charge
  • Body
  • application/json content type Modified
    • tax property Modified
      • Property is no longer required
    • exclude_from_rmar property Modified
      • Type went from string to boolean
        Breaking
    • advice_area property Modified
      • Type went from array to object
        Breaking
      • deposit, non_regulated, non_rmar, non_investment_insurance, regulated_mortgage, retail_investment, other_fca_regulated, unknown properties Added
POST /api/v1/expectation/balance
  • Body
  • application/json content type Modified
    • expectation_uuids, statement_transaction_uuids properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expectation/calculate
  • Body
  • application/json content type Modified
    • tax property Modified
      • Property is no longer required
POST /api/v1/expectation/reconcile
  • Body
  • application/json content type Modified
    • statement_transactions property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/provider-statement/upload
  • Body
  • application/json content type Modified
    • statement_transactions property Modified
      • Type went from array to array[object]
      • object property Added
    • category_mapper property Modified
      • Type went from array to object
        Breaking
POST /api/v1/statement-transaction
  • Body
  • application/json content type Modified
    • statement_transactions property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/statement-transaction/auto-reconcile
  • Body
  • application/json content type Modified
    • statement_transaction_uuids, provider_statement_uuids properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/statement-transaction/create-expectations
  • Body
  • application/json content type Modified
    • statement_transactions property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Body
  • application/json content type Modified
    • amount property Modified
      • Type went from string(date) to integer
        Breaking
PUT /api/v1/charge/{uuid}
  • Body
  • application/json content type Modified
    • recurring, exclude_from_rmar properties Modified
      • Type went from string to boolean
        Breaking
    • tax property Modified
      • Property is no longer required
    • advice_area property Modified
      • Type went from array to object
        Breaking
      • deposit, non_regulated, non_rmar, non_investment_insurance, regulated_mortgage, retail_investment, other_fca_regulated, unknown properties Added
PUT /api/v1/expectation/{uuid}
  • Body
  • application/json content type Modified
    • exclude_from_rmar property Modified
      • Type went from string to boolean
        Breaking
    • advice_area property Modified
      • Type went from array to object
        Breaking
      • deposit, non_regulated, non_rmar, non_investment_insurance, regulated_mortgage, retail_investment, other_fca_regulated, unknown properties Added
184 structure changes including:
184 Modifications
Modified 184 Breaking
DELETE /api/v1/cases/{case_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Property is now required
        Breaking
DELETE /api/v1/conversation/{conversation_uuid}/admin
  • Body
  • application/json content type Modified
    • participant property Modified
      • Property is now required
        Breaking
DELETE /api/v1/conversation/{conversation_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Property is now required
        Breaking
DELETE /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Property is now required
        Breaking
DELETE /api/v1/mobile/notification-token
  • Body
  • application/json content type Modified
    • token property Modified
      • Property is now required
        Breaking
DELETE /api/v1/personal-access-tokens/{id}
  • Body
  • application/json content type Modified
    • password property Modified
      • Property is now required
        Breaking
GET /api/v1/search
  • Body
  • application/json content type Modified
    • q property Modified
      • Property is now required
        Breaking
GET /api/v2/flux
  • Body
  • application/json content type Modified
    • model_type, model_uuid, start_date, end_date properties Modified
      • Properties are now required
        Breaking
POST /api/v1/account
  • Body
  • application/json content type Modified
    • alternative Modified
      • Create Client Account alternative Modified
        • external_reference, business_details properties Modified
POST /api/v1/account/{account_uuid}/address
  • Body
  • application/json content type Modified
    • name, address_1 properties Modified
      • Properties are now required
        Breaking
POST /api/v1/account/{account_uuid}/check
  • Body
  • application/json content type Modified
    • type, via_integration, originally_ran_at properties Modified
      • Properties are now required
        Breaking
POST /api/v1/account/{account_uuid}/contact-detail
  • Body
  • application/json content type Modified
    • type, name, value properties Modified
      • Properties are now required
        Breaking
POST /api/v1/account/{account_uuid}/login
  • Body
  • application/json content type Modified
    • first_name, last_name, email, has_write_permission, has_delete_permission, receives_unread_notifications_email, wealth_enabled, goals_enabled, factfind_enabled, tasks_enabled properties Modified
      • Properties are now required
        Breaking
POST /api/v1/addons/be-iq/profiler/invite
  • Body
  • application/json content type Modified
    • client_account_uuid, employee_account_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/addons/seccl/{addon}/associate-node
  • Body
  • application/json content type Modified
    • associations property Modified
      • Property is now required
        Breaking
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Body
  • application/json content type Modified
    • attributes property Modified
      • Property is now required
        Breaking
      • bank, addresses, documents properties Modified
        • Properties are no longer required
POST /api/v1/addons/transact/account-opening
  • Body
  • application/json content type Modified
    • adviser_id, bank_account properties Modified
      • Properties are now required
        Breaking
    • investors property Modified
      • Property is now required
        Breaking
      • mobile_number property Modified
        • country, number properties Modified
          • Properties are no longer required
      • residential_address property Modified
        • line1, line2, post_code, country properties Modified
          • Properties are no longer required
      • postal_address property Modified
        • line1, line2, post_code, country properties Modified
          • Properties are no longer required
POST /api/v1/adviser-split
  • Body
  • application/json content type Modified
    • name, type properties Modified
      • Properties are now required
        Breaking
    • firm_percentage, adviser_percentage properties Modified
      • Properties are now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/automation-blueprints
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Body
  • application/json content type Modified
    • name, type, configuration properties Modified
      • Properties are now required
        Breaking
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/trigger
  • Body
  • application/json content type Modified
    • client_uuid property Modified
      • Property is now required
        Breaking
POST /api/v1/bank-statement
  • Body
  • application/json content type Modified
    • statement_uuid, date properties Modified
      • Properties are now required
        Breaking
POST /api/v1/bank-statement/upload
  • Body
  • application/json content type Modified
    • statement_uuid, date, bank_transactions properties Modified
      • Properties are now required
        Breaking
POST /api/v1/bank-transaction
  • Body
  • application/json content type Modified
    • bank_statement_uuid, statement_transactions properties Modified
      • Properties are now required
        Breaking
POST /api/v1/bank-transaction/reconcile
  • Body
  • application/json content type Modified
    • bank_transactions property Modified
      • Property is now required
        Breaking
POST /api/v1/bulk-actions/execute
  • Body
  • application/json content type Modified
    • items property Modified
      • Property is now required
        Breaking
POST /api/v1/cases
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/cases-status
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/cases-type
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/cases/{case_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Property is now required
        Breaking
POST /api/v1/charge
  • Body
  • application/json content type Modified
    • chargeable_type, chargeable_uuid, seller_uuid, payment_origin, type, category, recurring, start_date, tax_exempt, exclude_from_rmar, advice_type, service_type properties Modified
      • Properties are now required
        Breaking
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
    • tax property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/charge-split
  • Body
  • application/json content type Modified
    • splitable_type, splitable_uuid, account_uuid, charge_split_schema_uuid, transfer_fci, initial, ongoing properties Modified
      • Properties are now required
        Breaking
    • percentage property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/charge-split-schema
  • Body
  • application/json content type Modified
    • name, can_change_transfer_fci, default_transfer_fci, can_change_initial, default_initial, can_change_ongoing, default_ongoing, valid_for_advisers, valid_for_clients, valid_for_introducers, visible_to_advisers properties Modified
      • Properties are now required
        Breaking
    • min_percentage, max_percentage, default_percentage, percentage_paid_by_firm, percentage_paid_by_adviser properties Modified
      • Properties are now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/circles
  • Body
  • application/json content type Modified
    • name, account_uuids, group_uuids properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client
  • Body
  • application/json content type Modified
    • first_name, last_name, client_regulatory_classification, external_reference properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client-status
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/client-status/{clientStatus}/transfer-clients
  • Body
  • application/json content type Modified
    • new_status_uuid property Modified
      • Property is now required
        Breaking
POST /api/v1/client/{client_uuid}/dependant
  • Body
  • application/json content type Modified
    • first_name, last_name, relationship properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client/{client_uuid}/employment
  • Body
  • application/json content type Modified
    • status property Modified
      • Property is now required
        Breaking
    • shareholding_in_business property Modified
      • Type went from float to number(float)
        Breaking
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Body
  • application/json content type Modified
    • amount property Modified
      • Property is now required
        Breaking
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}
  • Body
  • application/json content type Modified
    • amount property Modified
      • Property is now required
        Breaking
POST /api/v1/client/{client_uuid}/goal
  • Body
  • application/json content type Modified
    • name, description properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client/{client_uuid}/income
  • Body
  • application/json content type Modified
    • name, type, amount, amount_type, frequency properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client/{client_uuid}/linked-clients
  • Body
  • application/json content type Modified
    • account_uuid, relationship, inverse_relationship properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client/{client_uuid}/owners
  • Body
  • application/json content type Modified
    • mode, owners properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client/{client_uuid}/risk
  • Body
  • application/json content type Modified
    • completed_at, completed_by properties Modified
      • Properties are now required
        Breaking
POST /api/v1/client/{client_uuid}/staff-members
  • Body
  • application/json content type Modified
    • account_uuid, hired_at properties Modified
      • Properties are now required
        Breaking
POST /api/v1/conversation
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/conversation/{conversation_uuid}/admin
  • Body
  • application/json content type Modified
    • participant property Modified
      • Property is now required
        Breaking
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Body
  • application/json content type Modified
    • files property Modified
      • Property is now required
        Breaking
POST /api/v1/conversation/{conversation_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Property is now required
        Breaking
POST /api/v1/conversation/{conversation_uuid}/pin
  • Body
  • application/json content type Modified
    • pin property Modified
      • Property is now required
        Breaking
POST /api/v1/custom-default-folder
  • Body
  • application/json content type Modified
    • model, structure, is_active properties Modified
      • Properties are now required
        Breaking
POST /api/v1/custom-field
  • Body
  • application/json content type Modified
    • type, name, is_required, model_type properties Modified
      • Properties are now required
        Breaking
POST /api/v1/document
  • Body
  • application/json content type Modified
    • name, client_uuids properties Modified
      • Properties are now required
        Breaking
POST /api/v1/document-pack/document-pack
  • Body
  • application/json content type Modified
    • name, description properties Modified
      • Properties are now required
        Breaking
POST /api/v1/document-signing
  • Body
  • application/json content type Modified
    • participant_uuids, document_template_uuids properties Modified
      • Properties are now required
        Breaking
POST /api/v1/document-template
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/document-template/{documentTemplate_uuid}/content/docx
  • Body
  • application/json content type Modified
    • file property Modified
      • Property is now required
        Breaking
POST /api/v1/document/{document_uuid}/content/docx
  • Body
  • application/json content type Modified
    • file property Modified
      • Property is now required
        Breaking
POST /api/v1/employee
  • Body
  • application/json content type Modified
    • first_name, last_name, role, with_login, departments properties Modified
      • Properties are now required
        Breaking
POST /api/v1/expectation/calculate
  • Body
  • application/json content type Modified
    • chargeable_type, chargeable_uuid, amount properties Modified
      • Properties are now required
        Breaking
    • tax property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/expectation/reconcile
  • Body
  • application/json content type Modified
    • expectation_uuid property Modified
      • Property is now required
        Breaking
POST /api/v1/expectation/unbalance
  • Body
  • application/json content type Modified
    • expectation_uuid property Modified
      • Property is now required
        Breaking
POST /api/v1/expenditure-structure/field
  • Body
  • application/json content type Modified
    • name, life_stage_section_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/expenditure-structure/field/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Property is now required
        Breaking
POST /api/v1/expenditure-structure/section
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/expenditure-structure/section/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Property is now required
        Breaking
POST /api/v1/expenditure-structure/section/set-custom-expenditure
  • Body
  • application/json content type Modified
    • section_uuids property Modified
      • Property is now required
        Breaking
POST /api/v1/fact-find/request
  • Body
  • application/json content type Modified
    • fact_find_schema_uuid, client_uuid, circle_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Body
  • application/json content type Modified
    • fact_find_pass_uuid property Modified
      • Property is now required
        Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress
  • Body
  • application/json content type Modified
    • fact_find_pass_uuid, is_complete properties Modified
      • Properties are now required
        Breaking
POST /api/v1/fact-find/schema
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/generate-pdf
  • Body
  • application/json content type Modified
    • client_uuid property Modified
      • Property is now required
        Breaking
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Body
  • application/json content type Modified
    • name, front_end_section properties Modified
      • Properties are now required
        Breaking
POST /api/v1/file
  • Body
  • application/json content type Modified
    • files property Modified
      • Property is now required
        Breaking
POST /api/v1/file/direct-upload
  • Body
  • application/json content type Modified
    • name, file, folder_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • tax property Modified
      • Type went from float to number(float)
        Breaking
    • fact_find_completed_notification_to_assigned_adviser, fact_find_completed_notification_to_assigned_administrator, fact_find_completed_notification_to_assigned_paraplanner properties Modified
      • Properties are now required
        Breaking
POST /api/v1/firm/{firm}/fca
  • Body
  • application/json content type Modified
    • fca_number property Modified
      • Property is now required
        Breaking
POST /api/v1/folder
  • Body
  • application/json content type Modified
    • name, parent properties Modified
      • Properties are now required
        Breaking
POST /api/v1/folder/{folder_uuid}/permissions
  • Body
  • application/json content type Modified
    • clients_read, clients_write properties Modified
      • Properties are now required
        Breaking
POST /api/v1/form
  • Body
  • application/json content type Modified
    • title property Modified
      • Property is now required
        Breaking
POST /api/v1/form/{form_uuid}/question
  • Body
  • application/json content type Modified
    • type, required, title, position, selection_options, section_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/form/{form_uuid}/section
  • Body
  • application/json content type Modified
    • title property Modified
      • Property is now required
        Breaking
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Body
  • application/json content type Modified
    • answers property Modified
      • Property is now required
        Breaking
POST /api/v1/group
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Property is now required
        Breaking
POST /api/v1/illustration
  • Body
  • application/json content type Modified
    • name, accounts, requested_by_uuid, is_draft, platform properties Modified
      • Properties are now required
        Breaking
POST /api/v1/import
  • Body
  • application/json content type Modified
    • type, mode, file properties Modified
      • Properties are now required
        Breaking
POST /api/v1/import/map/{import_uuid}
  • Body
  • application/json content type Modified
    • headers property Modified
      • Property is now required
        Breaking
POST /api/v1/introducer
  • Body
  • application/json content type Modified
    • first_name, last_name, entity_name, email properties Modified
      • Properties are now required
        Breaking
POST /api/v1/life-stage
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/life-stage/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Property is now required
        Breaking
POST /api/v1/me/switch-account
  • Body
  • application/json content type Modified
    • account_uuid, mobile_account_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/mobile/notification-token
  • Body
  • application/json content type Modified
    • token property Modified
      • Property is now required
        Breaking
POST /api/v1/my/welcome-widget-tasks/{id}
  • Body
  • application/json content type Modified
    • is_complete property Modified
      • Property is now required
        Breaking
POST /api/v1/new-business-event
  • Body
  • application/json content type Modified
    • contribution_type, adviser_uuid, advice_type, conducted_by, source_of_funds, status properties Modified
      • Properties are now required
        Breaking
POST /api/v1/note
  • Body
  • application/json content type Modified
    • notable_type, notable_uuid, contents properties Modified
      • Properties are now required
        Breaking
POST /api/v1/personal-access-tokens
  • Body
  • application/json content type Modified
    • name, password properties Modified
      • Properties are now required
        Breaking
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • client_uuid, type, sub_type, provider_uuid, status, on_panel, external_reference properties Modified
      • Properties are now required
        Breaking
POST /api/v1/plans/{plan_uuid}/beneficiary
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
    • percentage property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/plans/{plan_uuid}/claim
  • Body
  • application/json content type Modified
    • claim_amount, claim_start_date properties Modified
      • Properties are now required
        Breaking
POST /api/v1/plans/{plan_uuid}/cover
  • Body
  • application/json content type Modified
    • cover_type, benefit_amount, benefit_frequency, benefit_status, excess properties Modified
      • Properties are now required
        Breaking
    • indexation property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Body
  • application/json content type Modified
    • account_uuid, status properties Modified
      • Properties are now required
        Breaking
POST /api/v1/plans/{plan_uuid}/premiums
  • Body
  • application/json content type Modified
    • transfer_type, date_advice_given, amount, frequency, payment_method, start_date, transferred_from_plan_type, transferred_from_plan_sub_type, external_reference properties Modified
      • Properties are now required
        Breaking
    • percentage property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Body
  • application/json content type Modified
    • type property Modified
      • Property is now required
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Body
  • application/json content type Modified
    • fund_name property Modified
      • Property is now required
        Breaking
    • units property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
    • unit_price_raw property Modified
      • Type went from float to number(float)
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings
  • Body
  • application/json content type Modified
    • holdings property Modified
      • Property is now required
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Body
  • application/json content type Modified
    • valued_at, value properties Modified
      • Properties are now required
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Body
  • application/json content type Modified
    • type, value properties Modified
      • Properties are now required
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Body
  • application/json content type Modified
    • name, status properties Modified
      • Properties are now required
        Breaking
    • employer_percentage, employee_percentage properties Modified
      • Type went from float to number(float)
        Breaking
POST /api/v1/plans/{plan_uuid}/transaction
  • Body
  • application/json content type Modified
    • type, amount, date properties Modified
      • Properties are now required
        Breaking
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Body
  • application/json content type Modified
    • type, amount, start_date properties Modified
      • Properties are now required
        Breaking
    • frequency property Modified
      • Property is now required
        Breaking
      • Type went from string(date) to string
POST /api/v1/provider-statement
  • Body
  • application/json content type Modified
    • statement_uuid, provider_uuid, date properties Modified
      • Properties are now required
        Breaking
POST /api/v1/provider-statement/upload
  • Body
  • application/json content type Modified
    • statement_uuid, provider_uuid, date, statement_transactions properties Modified
      • Properties are now required
        Breaking
POST /api/v1/reaction
  • Body
  • application/json content type Modified
    • reactable_type, reactable_uuid, reaction properties Modified
      • Properties are now required
        Breaking
POST /api/v1/report
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
    • report_query property Modified
      • Type went from array to object
        Breaking
POST /api/v1/report-template
  • Body
  • application/json content type Modified
    • name, report_type_id properties Modified
      • Properties are now required
        Breaking
POST /api/v1/statement-transaction
  • Body
  • application/json content type Modified
    • provider_statement_uuid, statement_transactions properties Modified
      • Properties are now required
        Breaking
POST /api/v1/statement-transaction/auto-reconcile
  • Body
  • application/json content type Modified
    • statement_transaction_uuids, provider_statement_uuids properties Modified
      • Properties are now required
        Breaking
POST /api/v1/statement-transaction/create-expectations
  • Body
  • application/json content type Modified
    • statement_transactions property Modified
      • Property is now required
        Breaking
POST /api/v1/subscribe
  • Body
  • application/json content type Modified
    • addon_id, enabled properties Modified
      • Properties are now required
        Breaking
POST /api/v1/tag
  • Body
  • application/json content type Modified
    • mode, taggable_type, taggable_uuid properties Modified
      • Properties are now required
        Breaking
    • tags property Modified
      • Property is now required
        Breaking
      • Type went from array to array[string | string(uuid) | object]
      • property Added
        • string-1, string-2, object-3 properties Added
POST /api/v1/task
  • Body
  • application/json content type Modified
    • name, taskable_type, taskable_uuid, task_status_uuid properties Modified
      • Properties are now required
        Breaking
    • assigned_to_uuids, group_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • custom_fields property Modified
      • Type went from array to object
        Breaking
POST /api/v1/task-status
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/time-entry
  • Body
  • application/json content type Modified
    • trackable_type, trackable_uuid, name properties Modified
      • Properties are now required
        Breaking
POST /api/v1/unipass/certificate
  • Body
  • application/json content type Modified
    • certificate_email, certificate properties Modified
      • Properties are now required
        Breaking
POST /api/v1/workflow
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v1/workflow/{workflow_uuid}/run
  • Body
  • application/json content type Modified
    • model_type, model_uuid properties Modified
      • Properties are now required
        Breaking
POST /api/v1/workflow/{workflow_uuid}/task
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
POST /api/v2/addresses
  • Body
  • application/json content type Modified
    • account_uuids, name, address_1 properties Modified
      • Properties are now required
        Breaking
POST /api/v2/bank-accounts
  • Body
  • application/json content type Modified
    • account_uuids, account_name, account_holders, account_number, sort_code properties Modified
      • Properties are now required
        Breaking
POST /api/v2/contact-details
  • Body
  • application/json content type Modified
    • type, name, value, account_uuids properties Modified
      • Properties are now required
        Breaking
POST /api/v2/dependants
  • Body
  • application/json content type Modified
    • account_uuids, first_name, last_name, relationship properties Modified
      • Properties are now required
        Breaking
POST /api/v2/employments
  • Body
  • application/json content type Modified
    • account_uuid, status properties Modified
      • Properties are now required
        Breaking
    • shareholding_in_business property Modified
      • Type went from float to number(float)
        Breaking
POST /api/v2/goals
  • Body
  • application/json content type Modified
    • account_uuids, name, description, target_amount properties Modified
      • Properties are now required
        Breaking
POST /api/v2/income
  • Body
  • application/json content type Modified
    • account_uuid, name, type, amount, amount_type, frequency properties Modified
      • Properties are now required
        Breaking
POST /api/v2/risks
  • Body
  • application/json content type Modified
    • completed_at, completed_by properties Modified
      • Properties are now required
        Breaking
POST /api/v2/shareholder
  • Body
  • application/json content type Modified
    • business_uuid, full_name, shares_owned, voting_rights, role, appointed_at properties Modified
      • Properties are now required
        Breaking
    • ownership_percentage property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
POST /api/v2/valuations/bulk
  • Body
  • application/json content type Modified
    • plan_uuid, valuations properties Modified
      • Properties are now required
        Breaking
POST /api/v2/webhook-subscriptions
  • Body
  • application/json content type Modified
    • url, events properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Body
  • application/json content type Modified
    • has_write_permission, has_delete_permission, wealth_enabled, goals_enabled, factfind_enabled, tasks_enabled properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/adviser-split/{adviserSplit_uuid}
  • Body
  • application/json content type Modified
    • firm_percentage, adviser_percentage properties Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Body
  • application/json content type Modified
    • configuration property Modified
      • Property is now required
        Breaking
PUT /api/v1/cases-type/{uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
PUT /api/v1/charge-split-schema/{chargeSplitSchema_uuid}
  • Body
  • application/json content type Modified
    • min_percentage, max_percentage, default_percentage, percentage_paid_by_firm, percentage_paid_by_adviser properties Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Body
  • application/json content type Modified
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v1/charge/{uuid}
  • Body
  • application/json content type Modified
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
    • tax property Modified
      • Property is now required
        Breaking
      • Type went from float to number(float)
        Breaking
PUT /api/v1/circles/{circle_uuid}/fact-find-access
  • Body
  • application/json content type Modified
    • account_uuid, target_account_uuid, has_fact_find_access properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/client/{client_uuid}/linked-clients/{uuid}
  • Body
  • application/json content type Modified
    • relationship, inverse_relationship properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Body
  • application/json content type Modified
    • contents property Modified
      • Property is now required
        Breaking
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
  • Body
  • application/json content type Modified
    • structure property Modified
      • Property is now required
        Breaking
PUT /api/v1/document-pack/document-pack/{uuid}
  • Body
  • application/json content type Modified
    • name, description properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/employee/{uuid}
  • Body
  • application/json content type Modified
    • with_login property Modified
      • Property is now required
        Breaking
PUT /api/v1/expectation/{uuid}
  • Body
  • application/json content type Modified
    • seller_uuid, exclude_from_rmar, advice_type, service_type properties Modified
      • Properties are now required
        Breaking
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v1/expenditure-structure/field/{lifeStageField_uuid}
  • Body
  • application/json content type Modified
    • life_stage_section_uuid property Modified
      • Property is now required
        Breaking
PUT /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
PUT /api/v1/file/{file_uuid}/copy
  • Body
  • application/json content type Modified
    • folder property Modified
      • Property is now required
        Breaking
PUT /api/v1/file/{uuid}
  • Body
  • application/json content type Modified
    • name, folder_uuid properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/form/{form_uuid}/question/{uuid}
  • Body
  • application/json content type Modified
    • section_uuid property Modified
      • Property is now required
        Breaking
PUT /api/v1/form/{form_uuid}/section/{uuid}
  • Body
  • application/json content type Modified
    • title property Modified
      • Property is now required
        Breaking
PUT /api/v1/group/{uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
PUT /api/v1/illustration/{uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
PUT /api/v1/life-stage/{lifeStage_uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Body
  • application/json content type Modified
    • contribution_type, adviser_uuid, advice_type, conducted_by, source_of_funds, status properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/note/{uuid}
  • Body
  • application/json content type Modified
    • contents property Modified
      • Property is now required
        Breaking
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Body
  • application/json content type Modified
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Body
  • application/json content type Modified
    • indexation property Modified
      • Type went from float to number(float)
        Breaking
    • beneficiaries property Modified
      • percentage property Modified
        • Type went from float to number(float)
          Breaking
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Body
  • application/json content type Modified
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
    • transferred_from_plan_type, transferred_from_plan_sub_type properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Body
  • application/json content type Modified
    • type property Modified
      • Property is now required
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Body
  • application/json content type Modified
    • units, unit_price_raw properties Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Body
  • application/json content type Modified
    • value property Modified
      • Property is now required
        Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Body
  • application/json content type Modified
    • value property Modified
      • Property is now required
PUT /api/v1/tag/{uuid}
  • Body
  • application/json content type Modified
    • name, colour properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/task/{uuid}
  • Body
  • application/json content type Modified
    • assigned_to_uuids, group_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • custom_fields property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/time-entry/{uuid}
  • Body
  • application/json content type Modified
    • trackable_type, trackable_uuid properties Modified
      • Properties are now required
        Breaking
PUT /api/v1/workflow/{uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
PUT /api/v2/bank-accounts/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, account_name, account_holders, account_number, sort_code properties Modified
      • Properties are now required
        Breaking
PUT /api/v2/employments/{uuid}
  • Body
  • application/json content type Modified
    • shareholding_in_business property Modified
      • Type went from float to number(float)
        Breaking
    • status property Modified
      • Property is now required
        Breaking
PUT /api/v2/income/{uuid}
  • Body
  • application/json content type Modified
    • name, type, amount, amount_type, frequency properties Modified
      • Properties are now required
        Breaking
PUT /api/v2/shareholder/{uuid}
  • Body
  • application/json content type Modified
    • business_uuid property Modified
      • Property is now required
        Breaking
    • percentage property Modified
      • Type went from float to number(float)
        Breaking
PUT /api/v2/webhook-subscriptions/{uuid}
  • Body
  • application/json content type Modified
    • events property Modified
      • Property is now required
        Breaking
14 structure changes including:
14 Modifications
Modified 14 Breaking
DELETE /api/v1/cases/{case_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
DELETE /api/v1/conversation/{conversation_uuid}/admin
  • Body
  • application/json content type Modified
    • participants property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • participant property Added
DELETE /api/v1/conversation/{conversation_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/cases
  • Body
  • application/json content type Modified
    • participants, assigned_to_uuids, group_uuids, plans properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/cases/{case_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/circles
  • Body
  • application/json content type Modified
    • account_uuids, group_uuids properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/client
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/client/{client_uuid}/owners
  • Body
  • application/json content type Modified
    • owners property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/conversation
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/conversation/{conversation_uuid}/admin
  • Body
  • application/json content type Modified
    • participants property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • participant property Added
POST /api/v1/conversation/{conversation_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/cases/{uuid}
  • Body
  • application/json content type Modified
    • assigned_to_uuids, group_uuids, plans properties Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/circles/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, group_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • accounts property Added
PUT /api/v1/client/{uuid}
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
14 structure changes including:
14 Modifications
Modified 14 Breaking
DELETE /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/addons/seccl/{addon}/associate-node
  • Body
  • application/json content type Modified
    • associations property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Body
  • application/json content type Modified
    • attributes property Modified
      • Type went from array to object
        Breaking
      • bank, addresses, documents properties Added
    • attributes.bank, attributes.bank.account_type, attributes.bank.sortcode, attributes.bank.account_number, attributes.bank.roll_number, attributes.addresses, attributes.addresses.*.flat, attributes.addresses.*.building, attributes.addresses.*.street_1, attributes.addresses.*.street_2, attributes.addresses.*.town, attributes.addresses.*.region, attributes.addresses.*.postcode, attributes.addresses.*.duration, attributes.documents, attributes.documents.national_insurance, attributes.passport, attributes.documents.passport.country, attributes.documents.passport.expiry, attributes.documents.passport.mrz_line_2, attributes.documents.driving_licence, attributes.documents.driving_licence.number properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/v1/addons/transact/account-opening
  • Body
  • application/json content type Modified
    • investors property Modified
      • Type went from array to array[object]
      • object property Added
    • bank_account property Modified
      • Type went from array to object
        Breaking
      • sort_code, account_number, account_name_or_roll_number, is_building_society properties Added
POST /api/v1/group
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/subscribe
  • Body
  • application/json content type Modified
    • config property Modified
      • Type went from array to object
        Breaking
POST /api/v1/workflow/{workflow_uuid}/task
  • Body
  • application/json content type Modified
    • participants, groups properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Body
  • application/json content type Modified
    • config property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Body
  • application/json content type Modified
    • conditions property Modified
      • Type went from array to array[object]
      • object property Added
    • configuration property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Body
  • application/json content type Modified
    • configuration property Modified
      • Type went from array to object
        Breaking
      • params property Added
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Body
  • application/json content type Modified
    • participants, groups properties Modified
      • Type went from array to array[string(uuid)]
247 structure changes including:
247 Modifications
Modified 247 Breaking
DELETE /api/v1/cases/{case_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array[string] to array
        Breaking
DELETE /api/v1/conversation/{conversation_uuid}/admin
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
DELETE /api/v1/conversation/{conversation_uuid}/participants
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
DELETE /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
DELETE /api/v1/mobile/notification-token
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • token property Modified
      • Property is no longer required
DELETE /api/v1/personal-access-tokens/{id}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • password property Modified
      • Property is no longer required
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array[string] to array
        Breaking
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Added
GET /api/v1/automation-executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Added
  • Query
  • filter[account_uuids], include query parameters Added
GET /api/v1/automation-executions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • user property Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • remember_token_expires_at property Added
GET /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remember_token_expires_at property Added
GET /api/v1/metrics/aum
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/cases
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/cases/completed
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/clients
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/conversations
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/documents/generated
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/fact-finds/sent
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/files/uploaded
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/introducers
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/messages/sent
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/plans
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/signatures
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/tasks
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/tasks/completed
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/metrics/time-logged
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
GET /api/v1/search
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • q property Modified
      • Property is no longer required
GET /api/v2/direct-debit-mandates
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /api/v2/direct-debit-mandates/{uuid}
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /api/v2/flux
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • model_type property Modified
      • Property is no longer required
    • model_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • start_date, end_date properties Modified
      • Properties are no longer required
      • Type went from date to string(date)
        Breaking
    • filter property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • filter.include_inactive property Added
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Body
  • application/json content type Modified
    • date_of_birth property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/account
  • Body
  • application/json content type Added
POST /api/v1/account/{account_uuid}/address
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, address_1 properties Modified
      • Properties are no longer required
POST /api/v1/account/{account_uuid}/check
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, via_integration, originally_ran_at properties Modified
      • Properties are no longer required
POST /api/v1/account/{account_uuid}/contact-detail
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, name, value properties Modified
      • Properties are no longer required
POST /api/v1/account/{account_uuid}/login
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • first_name, last_name, email, has_write_permission, has_delete_permission, receives_unread_notifications_email, wealth_enabled, goals_enabled, factfind_enabled, tasks_enabled properties Modified
      • Properties are no longer required
POST /api/v1/addons/be-iq/profiler/invite
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • client_account_uuid, employee_account_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
POST /api/v1/addons/seccl/{addon}/associate-node
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • associations property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • attributes property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • attributes.bank, attributes.bank.account_type, attributes.bank.sortcode, attributes.bank.account_number, attributes.bank.roll_number, attributes.addresses, attributes.addresses.*.flat, attributes.addresses.*.building, attributes.addresses.*.street_1, attributes.addresses.*.street_2, attributes.addresses.*.town, attributes.addresses.*.region, attributes.addresses.*.postcode, attributes.addresses.*.duration, attributes.documents, attributes.documents.national_insurance, attributes.passport, attributes.documents.passport.country, attributes.documents.passport.expiry, attributes.documents.passport.mrz_line_2, attributes.documents.driving_licence, attributes.documents.driving_licence.number properties Added
POST /api/v1/addons/transact/account-opening
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • adviser_id property Modified
      • Property is no longer required
    • investors, bank_account properties Modified
      • Properties are no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/adviser-split
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, type properties Modified
      • Properties are no longer required
    • firm_percentage, adviser_percentage properties Modified
      • Properties are no longer required
      • Type went from number to float
        Breaking
POST /api/v1/automation-blueprints
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • conditions, configuration properties Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, type properties Modified
      • Properties are no longer required
    • configuration property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/trigger
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • client_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/bank-statement
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
POST /api/v1/bank-statement/upload
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • bank_transactions property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/bank-transaction
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • bank_statement_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • statement_transactions property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/bank-transaction/reconcile
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_transactions property Modified
      • Type went from array[string] to array
        Breaking
    • bank_transactions property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/bulk-actions/execute
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • items property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • filters, data properties Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/cases
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • participants, assigned_to_uuids, group_uuids, plans properties Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/cases-status
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/cases-type
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/cases/{case_uuid}/participants
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/charge
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • chargeable_type, chargeable_uuid, type, category, recurring, tax_exempt, exclude_from_rmar, advice_type, service_type properties Modified
      • Properties are no longer required
    • seller_uuid, payment_origin properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • start_date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • end_date property Modified
      • Type went from date to string(date)
        Breaking
    • percentage property Modified
      • Type went from number to float
        Breaking
    • tax property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
    • advice_area property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/charge-split
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • splitable_type, transfer_fci, initial, ongoing properties Modified
      • Properties are no longer required
    • splitable_uuid, account_uuid, charge_split_schema_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • percentage property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
POST /api/v1/charge-split-schema
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, can_change_transfer_fci, default_transfer_fci, can_change_initial, default_initial, can_change_ongoing, default_ongoing, valid_for_advisers, valid_for_clients, valid_for_introducers, visible_to_advisers properties Modified
      • Properties are no longer required
    • min_percentage, max_percentage, default_percentage, percentage_paid_by_firm, percentage_paid_by_adviser properties Modified
      • Properties are no longer required
      • Type went from number to float
        Breaking
POST /api/v1/circles
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • account_uuids, group_uuids properties Modified
      • Properties are no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/client
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • first_name, last_name, client_regulatory_classification properties Modified
      • Properties are no longer required
    • date_of_birth, prospect_converted_at, smoker_since, will_last_reviewed, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, poa_attorney_appointed_at, date_of_forecast, date_of_marriage, deceased_at, checked_sanctions_at properties Modified
      • Type went from date to string(date)
        Breaking
    • nationalities, groups properties Modified
      • Type went from array[string] to array
        Breaking
    • external_reference property Modified
      • Type went from array[string] to object
        Breaking
      • third_party, reference properties Added
POST /api/v1/client-status
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/client-status/{clientStatus}/transfer-clients
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • new_status_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/client/{client_uuid}/dependant
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • first_name, last_name, relationship properties Modified
      • Properties are no longer required
    • date_of_birth property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/client/{client_uuid}/employment
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • status property Modified
      • Property is no longer required
    • started_at, ended_at, last_salary_increase properties Modified
      • Type went from date to string(date)
        Breaking
    • address property Modified
      • Type went from array[string] to object
        Breaking
      • name, address_1, address_2, address_3, address_4, town_city, county, postcode, country, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Added
    • shareholding_in_business property Modified
      • Type went from number to float
        Breaking
    • turnover_history property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • amount property Modified
      • Property is no longer required
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • amount property Modified
      • Property is no longer required
POST /api/v1/client/{client_uuid}/goal
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, description properties Modified
      • Properties are no longer required
POST /api/v1/client/{client_uuid}/income
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, type, amount, amount_type, frequency properties Modified
      • Properties are no longer required
POST /api/v1/client/{client_uuid}/linked-clients
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid, relationship, inverse_relationship properties Modified
      • Properties are no longer required
POST /api/v1/client/{client_uuid}/owners
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • mode property Modified
      • Property is no longer required
    • owners property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/client/{client_uuid}/risk
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • completed_at property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • completed_by property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/client/{client_uuid}/staff-members
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • hired_at property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • left_at property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/conversation
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • participants property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/conversation/{conversation_uuid}/admin
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/conversation/{conversation_uuid}/messages
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array[string] to array
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • remember_token_expires_at property Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • files property Modified
      • Property is no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • remember_token_expires_at property Added
POST /api/v1/conversation/{conversation_uuid}/participants
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/conversation/{conversation_uuid}/pin
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • pin property Modified
      • Property is no longer required
POST /api/v1/custom-default-folder
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • model, is_active properties Modified
      • Properties are no longer required
    • structure property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/custom-field
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, name, is_required, model_type properties Modified
      • Properties are no longer required
    • selection_options property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/document
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • client_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • known_dependants property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/document-pack/document-pack
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, description properties Modified
      • Properties are no longer required
POST /api/v1/document-signing
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participant_uuids, document_template_uuids properties Modified
      • Properties are no longer required
      • Type went from array[string] to array
        Breaking
    • document_template_dependants property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/document-template
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/document-template/{documentTemplate_uuid}/content/docx
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • file property Modified
      • Property is no longer required
POST /api/v1/document/{document_uuid}/content/docx
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • file property Modified
      • Property is no longer required
POST /api/v1/employee
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • first_name, last_name, role, with_login properties Modified
      • Properties are no longer required
    • departments property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • groups property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/expectation/balance
  • Body
  • application/json content type Modified
    • expectation_uuids, statement_transaction_uuids properties Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/expectation/calculate
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • chargeable_type, amount properties Modified
      • Properties are no longer required
    • chargeable_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • tax property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
POST /api/v1/expectation/reconcile
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • expectation_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • statement_transactions property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/expectation/unbalance
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • expectation_uuid property Modified
      • Property is no longer required
POST /api/v1/expenditure-structure/field
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, life_stage_section_uuid properties Modified
      • Properties are no longer required
POST /api/v1/expenditure-structure/field/reorder
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • order property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/expenditure-structure/section
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/expenditure-structure/section/reorder
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • order property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/expenditure-structure/section/set-custom-expenditure
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • section_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/fact-find/request
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • fact_find_schema_uuid, client_uuid, circle_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • fact_find_pass_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • fact_find_pass_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • is_complete property Modified
      • Property is no longer required
POST /api/v1/fact-find/schema
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/generate-pdf
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • client_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, front_end_section properties Modified
      • Properties are no longer required
POST /api/v1/file
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • files property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/file/direct-upload
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, file, folder_uuid properties Modified
      • Properties are no longer required
    • original_created_at property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • brand_colours property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • tax property Modified
      • Type went from number to float
        Breaking
    • rmar_start_date property Modified
      • Type went from date to string(date)
        Breaking
    • fact_find_completed_notification_to_assigned_adviser, fact_find_completed_notification_to_assigned_administrator, fact_find_completed_notification_to_assigned_paraplanner properties Modified
      • Properties are no longer required
POST /api/v1/firm/{firm}/fca
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • fca_number property Modified
      • Property is no longer required
POST /api/v1/folder
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, parent properties Modified
      • Properties are no longer required
POST /api/v1/folder/{folder_uuid}/permissions
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • clients_read, clients_write properties Modified
      • Properties are no longer required
    • participants property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/form
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • title property Modified
      • Property is no longer required
    • allowed_hosts property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/form/{form_uuid}/question
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, required, title, position properties Modified
      • Properties are no longer required
    • selection_options property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • section_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/form/{form_uuid}/section
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • title property Modified
      • Property is no longer required
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • answers property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/group
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • participants property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • participants property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/illustration
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, is_draft, platform properties Modified
      • Properties are no longer required
    • accounts property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • requested_by_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • request_data property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/import
  • Body
  • multipart/form-data content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • application/json content type Added
POST /api/v1/import/map/{import_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • headers property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/introducer
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • first_name, last_name, entity_name, email properties Modified
      • Properties are no longer required
    • groups property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/life-stage
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/life-stage/reorder
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • order property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/me/switch-account
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid, mobile_account_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remember_token_expires_at property Added
POST /api/v1/mobile/notification-token
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • token property Modified
      • Property is no longer required
POST /api/v1/my/welcome-widget-tasks/{id}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • is_complete property Modified
      • Property is no longer required
POST /api/v1/new-business-event
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • contribution_type, advice_type, conducted_by, source_of_funds, status properties Modified
      • Properties are no longer required
    • adviser_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • start_date, proposal_date, opted_out_at properties Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/note
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • notable_type, contents properties Modified
      • Properties are no longer required
    • notable_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/personal-access-tokens
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, password properties Modified
      • Properties are no longer required
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • client_uuid, provider_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • accounts, cases, linked_owners, visible_to_circles_uuids, beneficiaries properties Modified
      • Type went from array[string] to array
        Breaking
    • type, sub_type, status, on_panel properties Modified
      • Properties are no longer required
    • inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from date to string(date)
        Breaking
    • external_reference property Modified
      • Type went from array[string] to object
        Breaking
      • third_party, reference properties Added
POST /api/v1/plans/{plan_uuid}/beneficiary
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • percentage property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
POST /api/v1/plans/{plan_uuid}/claim
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • claim_amount property Modified
      • Property is no longer required
    • claim_start_date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • claim_end_date, claim_notes properties Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/plans/{plan_uuid}/cover
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • cover_type, benefit_amount, benefit_frequency, benefit_status, excess properties Modified
      • Properties are no longer required
    • indexation property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
    • beneficiaries property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • status property Modified
      • Property is no longer required
    • on_risk_at, inactive_at properties Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/plans/{plan_uuid}/premiums
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • transfer_type, amount, frequency, payment_method, transferred_from_plan_type, transferred_from_plan_sub_type properties Modified
      • Properties are no longer required
    • date_advice_given, start_date properties Modified
      • Properties are no longer required
      • Type went from date to string(date)
        Breaking
    • percentage property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
    • end_date property Modified
      • Type went from date to string(date)
        Breaking
    • external_reference property Modified
      • Type went from array[string] to object
        Breaking
      • third_party, reference properties Added
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type property Modified
      • Property is no longer required
    • started_at, ended_at, paid_at properties Modified
      • Type went from date to string(date)
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • fund_name property Modified
      • Property is no longer required
    • units property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
    • unit_price_raw property Modified
      • Type went from number to float
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • proposed_at property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • holdings property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • valued_at property Modified
      • Property is no longer required
      • Type went from string to string(date-time)
    • value property Modified
      • Property is no longer required
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, value properties Modified
      • Properties are no longer required
    • started_at, ended_at, withdrawn_at properties Modified
      • Type went from date to string(date)
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, status properties Modified
      • Properties are no longer required
    • on_risk_at, inactive_at properties Modified
      • Type went from date to string(date)
        Breaking
    • employer_percentage, employee_percentage properties Modified
      • Type went from number to float
        Breaking
POST /api/v1/plans/{plan_uuid}/transaction
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, amount properties Modified
      • Properties are no longer required
    • date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, amount properties Modified
      • Properties are no longer required
    • frequency, start_date properties Modified
      • Properties are no longer required
      • Type went from date to string(date)
        Breaking
    • end_date property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/provider-statement
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_uuid, provider_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
POST /api/v1/provider-statement/upload
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_uuid, provider_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • date property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • statement_transactions property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • category_mapper property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/reaction
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • reactable_type, reaction properties Modified
      • Properties are no longer required
    • reactable_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v1/report
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • report_query property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/report-template
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, report_type_id properties Modified
      • Properties are no longer required
    • report_query property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/statement-transaction
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • provider_statement_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • statement_transactions property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/statement-transaction/auto-reconcile
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_transaction_uuids, provider_statement_uuids properties Modified
      • Properties are no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/statement-transaction/create-expectations
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • statement_transactions property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/subscribe
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • addon_id, enabled properties Modified
      • Properties are no longer required
    • config property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/tag
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • mode, taggable_type properties Modified
      • Properties are no longer required
    • taggable_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • tags property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
POST /api/v1/task
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, taskable_type properties Modified
      • Properties are no longer required
    • taskable_uuid, task_status_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • assigned_to_uuids, custom_fields, group_uuids properties Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/task-status
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/time-entry
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • trackable_type, name properties Modified
      • Properties are no longer required
    • trackable_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • start_date, end_date properties Modified
      • Type went from date to string(date)
        Breaking
POST /api/v1/unipass/certificate
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • certificate_email, certificate properties Modified
      • Properties are no longer required
POST /api/v1/workflow
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
POST /api/v1/workflow/{workflow_uuid}/run
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • model_type, model_uuid properties Modified
      • Properties are no longer required
POST /api/v1/workflow/{workflow_uuid}/task
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • participants, groups properties Modified
      • Type went from array[string] to array
        Breaking
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v2/addresses
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • primary_account_uuids property Modified
      • Type went from array[string] to array
        Breaking
    • name, address_1 properties Modified
      • Properties are no longer required
POST /api/v2/bank-accounts
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • account_name, account_holders, account_number, sort_code properties Modified
      • Properties are no longer required
POST /api/v2/contact-details
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type, name, value properties Modified
      • Properties are no longer required
    • account_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • primary_account_uuids property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v2/dependants
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • first_name, last_name, relationship properties Modified
      • Properties are no longer required
    • date_of_birth property Modified
      • Type went from date to string(date)
        Breaking
POST /api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/complete
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Path
  • direct_debit_mandate path parameter Added
POST /api/v2/employments
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • address property Modified
      • Type went from array[string] to object
        Breaking
      • name, address_1, address_2, address_3, address_4, town_city, county, postcode, country, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Added
    • ended_at, last_salary_increase, started_at properties Modified
      • Type went from date to string(date)
        Breaking
    • shareholding_in_business property Modified
      • Type went from number to float
        Breaking
    • status property Modified
      • Property is no longer required
POST /api/v2/goals
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • name, description, target_amount properties Modified
      • Properties are no longer required
    • visible_to_circles_uuids property Modified
      • Type went from array[string] to array
        Breaking
POST /api/v2/income
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • name, type, amount, amount_type, frequency properties Modified
      • Properties are no longer required
POST /api/v2/risks
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • completed_at property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • completed_by property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
POST /api/v2/shareholder
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • business_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • full_name, shares_owned, voting_rights, role properties Modified
      • Properties are no longer required
    • ownership_percentage property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
    • appointed_at property Modified
      • Property is no longer required
      • Type went from date to string(date)
        Breaking
    • address property Modified
      • Type went from array[string] to object
        Breaking
      • name, address_1, address_2, address_3, address_4, town_city, county, postcode, country, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Added
POST /api/v2/valuations/bulk
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • plan_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • valuations property Modified
      • Property is no longer required
      • Type went from array[string] to array[object]
        Breaking
      • object property Added
POST /api/v2/webhook-subscriptions
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • url property Modified
      • Property is no longer required
    • events property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • has_write_permission, has_delete_permission, wealth_enabled, goals_enabled, factfind_enabled, tasks_enabled properties Modified
      • Properties are no longer required
PUT /api/v1/account/{uuid}
  • Body
  • application/json content type Modified
    • alternative Modified
      • alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Update Client Account, Update Employee Account, Update Introducer Account alternatives Added
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Body
  • application/json content type Modified
    • config property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/adviser-split/{adviserSplit_uuid}
  • Body
  • application/json content type Modified
    • firm_percentage, adviser_percentage properties Modified
      • Type went from number to float
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Body
  • application/json content type Modified
    • conditions, configuration properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Body
  • application/json content type Modified
    • configuration property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/bank-statement/{bankStatement_uuid}
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Body
  • application/json content type Modified
    • date, amount, reference properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/cases-type/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
PUT /api/v1/cases/{uuid}
  • Body
  • application/json content type Modified
    • assigned_to_uuids, group_uuids, plans properties Modified
      • Type went from array[string] to array
        Breaking
    • review_at, completed_at properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/charge-split-schema/{chargeSplitSchema_uuid}
  • Body
  • application/json content type Modified
    • min_percentage, max_percentage, default_percentage, percentage_paid_by_firm, percentage_paid_by_adviser properties Modified
      • Type went from number to float
        Breaking
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Body
  • application/json content type Modified
    • percentage property Modified
      • Type went from number to float
        Breaking
PUT /api/v1/charge/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • start_date, end_date properties Modified
      • Type went from date to string(date)
        Breaking
    • percentage property Modified
      • Type went from number to float
        Breaking
    • tax property Modified
      • Property is no longer required
      • Type went from number to float
        Breaking
    • advice_area property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/circles/{circle_uuid}/fact-find-access
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuid, target_account_uuid properties Modified
      • Properties are no longer required
      • Type went from string to string(uuid)
    • has_fact_find_access property Modified
      • Property is no longer required
PUT /api/v1/circles/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, group_uuids properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Body
  • application/json content type Modified
    • date_of_birth property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Body
  • application/json content type Modified
    • started_at, ended_at, last_salary_increase properties Modified
      • Type went from date to string(date)
        Breaking
    • address, turnover_history properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/client/{client_uuid}/linked-clients/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • relationship, inverse_relationship properties Modified
      • Properties are no longer required
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Body
  • application/json content type Modified
    • email property Modified
      • Type went from email to string
        Breaking
    • date_of_birth, smoker_since, will_last_reviewed, first_contact_date, next_review_date properties Modified
      • Type went from date to string(date)
        Breaking
    • nationalities property Modified
      • Type went from array[string] to array
        Breaking
    • will_notes property Modified
      • Type went from integer to string
        Breaking
PUT /api/v1/client/{client_uuid}/risk/{uuid}
  • Body
  • application/json content type Modified
    • completed_at property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/client/{client_uuid}/staff-members/{uuid}
  • Body
  • application/json content type Modified
    • hired_at, left_at properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/client/{uuid}
  • Body
  • application/json content type Modified
    • date_of_birth, prospect_converted_at, smoker_since, will_last_reviewed, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, poa_attorney_appointed_at, date_of_forecast, date_of_marriage, deceased_at, checked_sanctions_at properties Modified
      • Type went from date to string(date)
        Breaking
    • nationalities, groups properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • contents property Modified
      • Property is no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • remember_token_expires_at property Added
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • structure property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
PUT /api/v1/custom-field/{customField_uuid}
  • Body
  • application/json content type Modified
    • selection_options property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/document-pack/document-pack/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, description properties Modified
      • Properties are no longer required
PUT /api/v1/document/{uuid}
  • Body
  • application/json content type Modified
    • client_uuids, known_dependants properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/employee/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • with_login property Modified
      • Property is no longer required
    • departments, groups properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/expectation/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • seller_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • expected_payment_date property Modified
      • Type went from date to string(date)
        Breaking
    • percentage property Modified
      • Type went from number to float
        Breaking
    • exclude_from_rmar, advice_type, service_type properties Modified
      • Properties are no longer required
    • advice_area property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/expenditure-structure/field/{lifeStageField_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • life_stage_section_uuid property Modified
      • Property is no longer required
PUT /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
PUT /api/v1/file/{file_uuid}/copy
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • folder property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
PUT /api/v1/file/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • folder_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • original_created_at property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • ip_whitelist, cc_email_addresses, bcc_email_addresses properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/form/{form_uuid}/question/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • selection_options property Modified
      • Type went from array[string] to array
        Breaking
    • section_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
PUT /api/v1/form/{form_uuid}/section/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • title property Modified
      • Property is no longer required
PUT /api/v1/form/{uuid}
  • Body
  • application/json content type Modified
    • allowed_hosts property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/group/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
PUT /api/v1/illustration/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
    • request_data property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/introducer/{uuid}
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/life-stage/{lifeStage_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
PUT /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remember_token_expires_at property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • contribution_type, advice_type, conducted_by, source_of_funds, status properties Modified
      • Properties are no longer required
    • adviser_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • start_date, proposal_date, opted_out_at properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/note/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • contents property Modified
      • Property is no longer required
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Body
  • application/json content type Modified
    • percentage property Modified
      • Type went from number to float
        Breaking
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Body
  • application/json content type Modified
    • claim_start_date, claim_end_date, claim_notes properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Body
  • application/json content type Modified
    • indexation property Modified
      • Type went from number to float
        Breaking
    • beneficiaries property Modified
      • Type went from array[string] to array[object]
        Breaking
      • object property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • date_advice_given, start_date, end_date properties Modified
      • Type went from date to string(date)
        Breaking
    • percentage property Modified
      • Type went from number to float
        Breaking
    • transferred_from_plan_type, transferred_from_plan_sub_type properties Modified
      • Properties are no longer required
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • type property Modified
      • Property is no longer required
    • started_at, ended_at, paid_at properties Modified
      • Type went from date to string(date)
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Body
  • application/json content type Modified
    • units, unit_price_raw properties Modified
      • Type went from number to float
        Breaking
  • Response
  • 200 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Body
  • application/json content type Modified
    • proposed_at property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • value property Modified
      • Property is no longer required
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • started_at, ended_at, withdrawn_at properties Modified
      • Type went from date to string(date)
    • value property Modified
      • Property is no longer required
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Body
  • application/json content type Modified
    • frequency, start_date, end_date, paused_until properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • accounts, cases, linked_owners, linked_plans, visible_to_circles_uuids, group_scheme_member_detail, beneficiaries properties Modified
      • Type went from array[string] to array
        Breaking
    • inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Body
  • application/json content type Modified
    • report_query property Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Body
  • application/json content type Modified
    • date property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/tag/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, colour properties Modified
      • Properties are no longer required
PUT /api/v1/task/{uuid}
  • Body
  • application/json content type Modified
    • assigned_to_uuids, custom_fields, group_uuids properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v1/time-entry/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • trackable_type property Modified
      • Property is no longer required
    • trackable_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • start_date, end_date properties Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v1/workflow/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name property Modified
      • Property is no longer required
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Body
  • application/json content type Modified
    • participants, groups properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v2/addresses/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, primary_account_uuids properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v2/bank-accounts/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • account_uuids property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
    • account_name, account_holders, account_number, sort_code properties Modified
      • Properties are no longer required
PUT /api/v2/contact-details/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, primary_account_uuids properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v2/dependants/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids property Modified
      • Type went from array[string] to array
        Breaking
    • date_of_birth property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v2/employments/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • address property Modified
      • Type went from array[string] to object
        Breaking
      • name, address_1, address_2, address_3, address_4, town_city, county, postcode, country, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Added
    • ended_at, last_salary_increase, started_at properties Modified
      • Type went from date to string(date)
        Breaking
    • shareholding_in_business property Modified
      • Type went from number to float
        Breaking
    • status property Modified
      • Property is no longer required
PUT /api/v2/goals/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, visible_to_circles_uuids properties Modified
      • Type went from array[string] to array
        Breaking
PUT /api/v2/income/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • name, type, amount, amount_type, frequency properties Modified
      • Properties are no longer required
PUT /api/v2/risks/{uuid}
  • Body
  • application/json content type Modified
    • completed_at property Modified
      • Type went from date to string(date)
        Breaking
PUT /api/v2/shareholder/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • business_uuid property Modified
      • Property is no longer required
      • Type went from string to string(uuid)
    • appointed_at property Modified
      • Type went from date to string(date)
        Breaking
    • address property Modified
      • Type went from array[string] to object
        Breaking
      • name, address_1, address_2, address_3, address_4, town_city, county, postcode, country, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Added
    • percentage property Modified
      • Type went from number to float
        Breaking
PUT /api/v2/webhook-subscriptions/{uuid}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • events property Modified
      • Property is no longer required
      • Type went from array[string] to array
        Breaking
1 structure change including:
1 Modification
Modified 1
GET /api/v1/addon
  • Query
  • filter[category] query parameter Added
1 structure change including:
1 Modification
Modified 1
GET /api/v1/account
  • Query
  • filter[circle_uuids] query parameter Added
1 structure change including:
1 Modification
Modified 1
GET /api/v1/account
  • Query
  • filter[circle_uuids] query parameter Added