Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

2 days ago

main
v1.66.8
Compare
v1.66.8

API structure has changed

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