PlannrCRM API documentation

DELETE /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

DELETE /api/v1/plans/{uuid}

Response
204 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - linked_owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - contract_enquiry_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/account/{account_uuid}/contact-detail

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/account/{account_uuid}/contact-detail/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

GET /api/v1/audits

Response
201 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/audits/{model}/{modelUuid}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/automation-blueprints

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/automation-blueprints/{automationBlueprint_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/automation-executions

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/automation-executions/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/bulk-actions

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - executed_by property Modified

GET /api/v1/bulk-actions/{uuid}

Response
200 response Modified
- application/json content type Modified
  - executed_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/client

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/client/{client_uuid}/illustrations

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - referral_code property 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
    - 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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/client/{client_uuid}/signatures

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - launched_by property Modified

GET /api/v1/client/{client_uuid}/staff-members

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/client/{client_uuid}/staff-members/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/client/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/conversation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/employee

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

GET /api/v1/employee/{employee_uuid}/audits

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account property Modified

GET /api/v1/employee/{employee}/logs

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - author, modelable, through, account properties Modified

GET /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - author property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/illustration/{uuid}

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/introducer/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/note/{notableType}/{notableUuid}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account, notable properties Modified

GET /api/v1/notifications

Response
200 response Modified
- application/json content type Modified
  - notifiable property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - triggered_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/notifications/{id}

Response
200 response Modified
- application/json content type Modified
  - notifiable property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - triggered_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/plans/{plan_uuid}/transaction/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/plans/{uuid}

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - linked_owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - contract_enquiry_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/report-type

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - created_by property Modified

GET /api/v1/report/{uuid}

Response
200 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/statement-transaction/{statementTransaction_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v1/statement/{uuid}

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v2/contact-details/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /api/v2/dependants/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/account

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /api/v1/account/{account_uuid}/address

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/account/{account_uuid}/check

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/account/{account_uuid}/contact-detail

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/account/{account_uuid}/login

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/automation-blueprints

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/bank-statement/upload

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/bank-transaction

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/cases

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/charge-split

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/circles

Response
201 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/client

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /api/v1/client/{client_uuid}/dependant

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/client/{client_uuid}/employment

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/client/{client_uuid}/goal

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property 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
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/client/{client_uuid}/risk

Response
201 response Modified
- application/json content type Modified
  - completed_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/conversation

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/conversation/{conversation_uuid}/messages

Response
200 response Modified
- application/json content type Modified
  - author property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/conversation/{conversation_uuid}/messages/inline

Response
200 response Modified
- application/json content type Modified
  - author property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/document-signing

Response
200 response Modified
- application/json content type Modified
  - launched_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/employee

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /api/v1/expectation/reconcile

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - author property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/form/{form_uuid}/submission

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/illustration

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/illustration/{illustration_uuid}/generate

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/import

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/import/map/{import_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/import/start/{import_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/introducer

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /api/v1/me/switch-account

Response
200 response Modified
- application/json content type Modified
  - current_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/new-business-event

Response
201 response Modified
- application/json content type Modified
  - clients property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/claim

Response
201 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/cover

Response
201 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/group-scheme-members

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - linked_owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - contract_enquiry_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/premiums

Response
201 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/sub-group-schemes

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - linked_owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - contract_enquiry_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/transaction

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/plans/{plan_uuid}/transaction-schedule

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/provider-statement/upload

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/report

Response
201 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/report-template

Response
200 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/statement-transaction

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/statement/{statement_uuid}/lock

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v1/statement/{statement_uuid}/unlock

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v2/contact-details

Response
201 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v2/dependants

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v2/employments

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v2/goals

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v2/risks

Response
201 response Modified
- application/json content type Modified
  - completed_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /api/v2/shareholder

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/account/{account_uuid}/address/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/account/{account_uuid}/check/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/account/{account_uuid}/contact-detail/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/account/{account_uuid}/login/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/account/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/bank-transaction/{bankTransaction_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/cases/{uuid}

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/charge-split/{chargeSplit_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/circles/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/client/{client_uuid}/dependant/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/client/{client_uuid}/employment/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/client/{client_uuid}/goal/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property 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
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /api/v1/client/{client_uuid}/risk/{uuid}

Response
200 response Modified
- application/json content type Modified
  - completed_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/client/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}

Response
200 response Modified
- application/json content type Modified
  - author property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/conversation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /api/v1/expectation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - author property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/illustration/{uuid}

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/introducer/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_administrator property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - assigned_paraplanner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - introduced_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - referral_code property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /api/v1/mailboxes/{uuid}

Response
200 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/me

Response
200 response Modified
- application/json content type Modified
  - current_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/new-business-event/{newBusinessEvent_uuid}

Response
200 response Modified
- application/json content type Modified
  - clients property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - adviser property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{plan_uuid}/claim/{uuid}

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{plan_uuid}/cover/{uuid}

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{plan_uuid}/ownership

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - linked_owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - contract_enquiry_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}

Response
200 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/plans/{uuid}

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - seller property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - linked_owners property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - contract_enquiry_account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/report-template/{reportTemplate_uuid}

Response
200 response Modified
- application/json content type Modified
  - created_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v1/statement-transaction/{statementTransaction_uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v2/contact-details/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v2/dependants/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v2/employments/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v2/goals/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v2/risks/{uuid}

Response
200 response Modified
- application/json content type Modified
  - completed_by property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PUT /api/v2/shareholder/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - referral_code property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

Do not miss any PlannrCRM API changes, ever again

Jan 23, 2026

API structure has changed