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

Changelog

Last update:
Compare
v1.70.0
16 structure changes including:
16 Modifications
Modified 16 Breaking
GET /api/v1/client/{client_uuid}/employment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • last_salary_increase property Modified
        • Type went from object to string
          Breaking
        • amount, formatted, currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/client/{client_uuid}/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • employment property Modified
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
GET /api/v2/employments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
GET /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • last_salary_increase property Modified
        • Type went from object to string
          Breaking
        • amount, formatted, currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v2/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • employment property Modified
GET /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 201 response Modified
    • application/json content type Modified
      • last_salary_increase property Modified
        • Type went from object to string
          Breaking
        • amount, formatted, currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/client/{client_uuid}/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • employment property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
POST /api/v2/employments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • last_salary_increase property Modified
        • Type went from object to string
          Breaking
        • amount, formatted, currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v2/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • employment property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • last_salary_increase property Modified
        • Type went from object to string
          Breaking
        • amount, formatted, currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
PUT /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • last_salary_increase property Modified
        • Type went from object to string
          Breaking
        • amount, formatted, currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employment property Modified
        • last_salary_increase property Modified
          • Type went from object to string
            Breaking
v1.68.4
228 structure changes including:
228 Modifications
Modified 228
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
DELETE /api/v1/plans/{uuid}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
      • accounts property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • linked_owners property Modified
        • last_interaction_at property Added
      • contract_enquiry_account property Modified
        • last_interaction_at property Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • last_interaction_at property Added
GET /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
GET /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
GET /api/v1/account/{account_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants property Modified
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
GET /api/v1/audits
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/audits/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-executions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/bulk-actions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • executed_by property Modified
GET /api/v1/bulk-actions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • executed_by property Modified
        • last_interaction_at property Added
GET /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants property Modified
GET /api/v1/cases/{case_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants property Modified
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • last_interaction_at property Added
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, author, seller properties Modified
GET /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/circles/{circle_uuid}/charge-splits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/circles/{circle_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants property Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author properties Modified
GET /api/v1/circles/{circle_uuid}/form-submissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/circles/{circle_uuid}/notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/all-notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/client/{client_uuid}/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants property Modified
GET /api/v1/client/{client_uuid}/dependant
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • mailbox property Modified
GET /api/v1/client/{client_uuid}/employment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author properties Modified
GET /api/v1/client/{client_uuid}/goal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requested_by property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • clients, adviser properties Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/client/{client_uuid}/risk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by property Modified
GET /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client_uuid}/signatures
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • launched_by property Modified
GET /api/v1/client/{client_uuid}/staff-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/client/{client_uuid}/staff-members/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • last_interaction_at property Added
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
GET /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants property Modified
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author property Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • last_interaction_at property Added
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • last_interaction_at property Added
GET /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • launched_by property Modified
GET /api/v1/document-signing/{signatureTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • last_interaction_at property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
GET /api/v1/employee/{employee_uuid}/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/employee/{employee}/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author properties Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • author property Modified
        • last_interaction_at property Added
GET /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/form/{form_uuid}/submission/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • last_interaction_at property Added
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requested_by property Modified
        • last_interaction_at property Added
GET /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
        • last_interaction_at property Added
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/logs/{modelType}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/mailboxes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/mailboxes/message/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mailbox property Modified
        • created_by property Modified
GET /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • last_interaction_at property Added
GET /api/v1/me/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/my/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • clients, adviser properties Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • clients property Modified
        • last_interaction_at property Added
      • adviser property Modified
        • last_interaction_at property Added
GET /api/v1/note/{notableType}/{notableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/notifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • last_interaction_at property Added
      • triggered_by property Modified
        • last_interaction_at property Added
GET /api/v1/notifications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • last_interaction_at property Added
      • triggered_by property Modified
        • last_interaction_at property Added
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/plans/{plan_uuid}/claim
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Modified
GET /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
GET /api/v1/plans/{plan_uuid}/cover
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Modified
GET /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author properties Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requested_by property Modified
        • last_interaction_at property Added
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • clients, adviser properties Modified
GET /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
      • accounts property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • linked_owners property Modified
        • last_interaction_at property Added
      • contract_enquiry_account property Modified
        • last_interaction_at property Added
GET /api/v1/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
GET /api/v1/report-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
GET /api/v1/statement
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • locked_by property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • last_interaction_at property Added
GET /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
GET /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v2/employments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v2/goals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, contract_enquiry_account properties Modified
GET /api/v2/risks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by property Modified
GET /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • last_interaction_at property Added
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
POST /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/bank-transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • last_interaction_at property Added
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
POST /api/v1/client/{client_uuid}/dependant
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v1/client/{client_uuid}/goal
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v1/client/{client_uuid}/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v1/client/{client_uuid}/risk
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • last_interaction_at property Added
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • last_interaction_at property Added
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • last_interaction_at property Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • last_interaction_at property Added
POST /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • last_interaction_at property Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • author property Modified
        • last_interaction_at property Added
POST /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requested_by property Modified
        • last_interaction_at property Added
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requested_by property Modified
        • last_interaction_at property Added
POST /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/import/map/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/import/start/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
POST /api/v1/me/switch-account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • last_interaction_at property Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • clients property Modified
        • last_interaction_at property Added
      • adviser property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/claim
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/cover
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
      • accounts property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • linked_owners property Modified
        • last_interaction_at property Added
      • contract_enquiry_account property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
      • accounts property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • linked_owners property Modified
        • last_interaction_at property Added
      • contract_enquiry_account property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/report
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
POST /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • last_interaction_at property Added
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • last_interaction_at property Added
POST /api/v2/contact-details
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
POST /api/v2/dependants
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v2/employments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v2/goals
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
POST /api/v2/risks
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • last_interaction_at property Added
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • last_interaction_at property Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
PUT /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • last_interaction_at property Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • last_interaction_at property Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • last_interaction_at property Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • author property Modified
        • last_interaction_at property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requested_by property Modified
        • last_interaction_at property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • last_interaction_at property Added
      • assigned_administrator property Modified
        • last_interaction_at property Added
      • assigned_paraplanner property Modified
        • last_interaction_at property Added
      • introduced_by property Modified
        • last_interaction_at property Added
      • owners property Modified
        • last_interaction_at property Added
      • last_interaction_at property Added
PUT /api/v1/mailboxes/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
PUT /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • last_interaction_at property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • clients property Modified
        • last_interaction_at property Added
      • adviser property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
      • accounts property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • linked_owners property Modified
        • last_interaction_at property Added
      • contract_enquiry_account property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • last_interaction_at property Added
      • accounts property Modified
        • last_interaction_at property Added
      • seller property Modified
        • last_interaction_at property Added
      • linked_owners property Modified
        • last_interaction_at property Added
      • contract_enquiry_account property Modified
        • last_interaction_at property Added
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • last_interaction_at property Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
PUT /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • last_interaction_at property Added
PUT /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • last_interaction_at property Added
PUT /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • last_interaction_at property Added
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • last_interaction_at property Added
v1.67.1
11 structure changes including:
1 Addition
10 Modifications
Modified 10 Breaking
GET /api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}
  • Body
  • application/json content type Added
POST /api/v1/client
  • Body
  • application/json content type Modified
    • external_reference property Modified
      • Property is no longer required
      • third_party, reference properties Modified
        • Properties are now required
          Breaking
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • accounts property Modified
      • Type went from array to array[object]
      • object property Added
    • cases, linked_owners, visible_to_circles_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • beneficiaries property Modified
      • Type went from array to array[object]
      • object property Added
    • external_reference property Modified
      • Property is no longer required
      • third_party, reference properties Modified
        • Properties are now required
          Breaking
POST /api/v1/plans/{plan_uuid}/cover
  • Body
  • application/json content type Modified
    • beneficiaries property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Body
  • application/json content type Modified
    • transferred_from_plan_type, transferred_from_plan_sub_type properties Modified
      • Properties are no longer required
    • external_reference property Modified
      • Property is no longer required
      • third_party, reference properties Modified
        • Properties are now required
          Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings
  • Body
  • application/json content type Modified
    • holdings property Modified
      • Type went from array to array[object]
      • SubAccountHolding property Added
POST /api/v1/postcode/search
  • Body
  • application/json content type Added
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Body
  • application/json content type Modified
    • claim_end_date property Modified
      • Type went from string(date) to string(date) | null
    • claim_notes property Modified
      • Type went from string(date) to string | null
PUT /api/v1/plans/{plan_uuid}/ownership
  • Body
  • application/json content type Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Body
  • application/json content type Modified
    • transfer_type, source, payment_method, details properties Modified
      • Type went from string to string | null
    • date_advice_given, end_date properties Modified
      • Type went from string(date) to string(date) | null
    • amount property Modified
      • Type went from integer to integer | null
    • percentage property Modified
      • Type went from number(float) to number(float) | null
    • transferred_from_plan_uuid property Modified
      • Type went from string(uuid) to string(uuid) | null
    • transferred_from_plan_type, transferred_from_plan_sub_type properties Modified
      • Properties are no longer required
      • Type went from string to string | null
Added 1
GET /api/v1/addons/transact/advisers
v1.67.0
43 structure changes including:
43 Modifications
Modified 43 Breaking
POST /api/v1/account/{account_uuid}/login
  • Body
  • application/json content type Modified
    • has_write_permission, has_delete_permission, receives_unread_notifications_email properties Modified
      • Type went from string to boolean
        Breaking
POST /api/v1/bulk-actions/execute
  • Body
  • application/json content type Modified
    • filters property Modified
      • Type went from array to object
        Breaking
      • taskable_uuid, taskable_type properties Added
    • data property Modified
      • Type went from array to object
        Breaking
    • name property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • type property Added
POST /api/v1/client/{client_uuid}/employment
  • Body
  • application/json content type Modified
    • address property Modified
      • name, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • turnover_history property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/client/{client_uuid}/goal
  • Body
  • application/json content type Modified
    • progress property Modified
      • Type went from integer to number(float)
        Breaking
POST /api/v1/conversation/{conversation_uuid}/messages
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array<file> to array[string(binary)]
        Breaking
POST /api/v1/custom-default-folder
  • Body
  • application/json content type Modified
    • structure property Modified
      • Property is no longer required
      • Type went from array to array[object]
      • DefaultFoldersStructure property Added
POST /api/v1/document
  • Body
  • application/json content type Modified
    • client_uuids property Modified
      • Type went from array to array[string(uuid)]
    • known_dependants property Modified
      • Type went from array to object
        Breaking
POST /api/v1/document-signing
  • Body
  • application/json content type Modified
    • participant_uuids, document_template_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • document_template_dependants property Modified
      • Type went from array to object
        Breaking
POST /api/v1/document-template/{documentTemplate_uuid}/content/docx
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from uploaded-file to string(binary)
        Breaking
POST /api/v1/document/{document_uuid}/content/docx
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from uploaded-file to string(binary)
        Breaking
POST /api/v1/employee
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expenditure-structure/field/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expenditure-structure/section/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expenditure-structure/section/set-custom-expenditure
  • Body
  • application/json content type Modified
    • section_uuids property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
  • Body
  • application/json content type Added
POST /api/v1/file
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/file/direct-upload
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from multipart-file to string(binary)
        Breaking
POST /api/v1/folder/{folder_uuid}/permissions
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/form
  • Body
  • application/json content type Modified
    • allowed_hosts property Modified
      • Type went from array to array[string(hostname)]
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Body
  • application/json content type Modified
    • answers property Modified
      • Type went from array to object
        Breaking
POST /api/v1/illustration
  • Body
  • application/json content type Modified
    • accounts property Modified
      • Type went from array to array[string(uuid)]
    • request_data property Modified
      • Type went from array to object
        Breaking
POST /api/v1/import
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from file to string(binary)
        Breaking
POST /api/v1/import/map/{import_uuid}
  • Body
  • application/json content type Modified
    • headers property Modified
      • Type went from array to object
        Breaking
POST /api/v1/introducer
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/life-stage/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/report-template
  • Body
  • application/json content type Modified
    • report_query property Modified
      • Type went from array to object
        Breaking
POST /api/v1/upload-files/create
  • Body
  • application/json content type Added
POST /api/v2/shareholder
  • Body
  • application/json content type Modified
    • ownership_percentage property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • percentage property Added
POST /api/v2/webhook-subscriptions
  • Body
  • application/json content type Modified
    • events property Modified
      • Type went from array to array[string]
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Body
  • application/json content type Modified
    • primary, has_delete_permission properties Modified
      • Type went from string to boolean
        Breaking
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Body
  • application/json content type Modified
    • address property Modified
      • Type went from array to object
        Breaking
      • address_1, address_2, address_3, address_4, town_city, county, postcode, country properties Added
    • turnover_history property Modified
      • Type went from array to array[object]
      • object property Added
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Body
  • application/json content type Modified
    • progress property Modified
      • Type went from integer to number(float)
        Breaking
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
  • Body
  • application/json content type Modified
    • structure property Modified
      • Property is no longer required
      • Type went from array to array[object]
PUT /api/v1/document/{uuid}
  • Body
  • application/json content type Modified
    • client_uuids property Modified
      • Type went from array to array[string(uuid)]
    • known_dependants property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/employee/{uuid}
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • ip_whitelist property Modified
      • Type went from array to array[string(ipv4)]
    • cc_email_addresses, bcc_email_addresses properties Modified
      • Type went from array to array[string(email)]
PUT /api/v1/form/{form_uuid}/question/{uuid}
  • Body
  • application/json content type Modified
    • selection_options property Modified
      • Type went from array to array[string]
PUT /api/v1/form/{uuid}
  • Body
  • application/json content type Modified
    • allowed_hosts property Modified
      • Type went from array to array[string(hostname)]
PUT /api/v1/illustration/{uuid}
  • Body
  • application/json content type Modified
    • request_data property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/introducer/{uuid}
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Body
  • application/json content type Modified
    • report_query property Modified
      • Type went from array to object
        Breaking
PUT /api/v2/webhook-subscriptions/{uuid}
  • Body
  • application/json content type Modified
    • events property Modified
      • Type went from array to array[string]
v1.66.9
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