PlannrCRM API documentation

about 7 hours ago

Change #b52e6bd3

v1.138.5

Compare

1 day ago

Change #693d9564

v1.138.4

Breaking

Compare

61 structure changes including:

61 Modifications

Modified 61 Breaking

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

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

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

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified

GET /api/v1/account/{account_uuid}/conversations

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

GET /api/v1/account/{account_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/cases/{case_uuid}/conversations

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

GET /api/v1/cases/{case_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/circles/{circle_uuid}/conversations

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

GET /api/v1/circles/{circle_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/circles/{circle_uuid}/fact-find-requests

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

GET /api/v1/client/{client_id}/fact-find/requests

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

GET /api/v1/conversation

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

GET /api/v1/conversation/{conversation_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

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

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

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

Response
200 response Modified
- application/json content type Modified
  - files property Modified
    - preview_url property Added

GET /api/v1/conversation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - latest_message property Modified
    - files property Modified

GET /api/v1/fact-find/request

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

GET /api/v1/fact-find/request/{factFindRequest_uuid}

Response
200 response Modified
- application/json content type Modified
  - latest_file property Modified
    - preview_url property Added

GET /api/v1/file/bin

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - folder property Modified
    - preview_url property Added

GET /api/v1/file/{uuid}

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

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

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

GET /api/v1/firm/{firm_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/folder/{folder_uuid}/files

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

GET /api/v1/folder/{folder_uuid}/tree

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/folder/{uuid}

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/illustration/{illustration_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/import

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

GET /api/v1/import/{uuid}

Response
200 response Modified
- application/json content type Modified
  - error_report property Modified
    - preview_url property Added

GET /api/v1/plans/{plan_uuid}/documents

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

GET /api/v1/report

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - files, folder properties Modified

GET /api/v1/report/{uuid}

Response
200 response Modified
- application/json content type Modified
  - files property Modified
    - preview_url property Added
  - folder property Modified
    - files property Modified

GET /api/v2/fact-find/session

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

GET /api/v2/fact-find/session/{factFindSession_uuid}

Response
200 response Modified
- application/json content type Modified
  - latest_file property Modified
    - preview_url property Added

GET /api/v2/fact-find/session/{factFindSession_uuid}/launch

Response
401 response Modified
- application/json content type Modified
  - Type is now object
  - Plannr_Error property Added
- text/plain content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
403 response Modified
- application/json content type Modified
  - Type is now object
  - Plannr_Error property Added
- text/plain content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
404 response Modified
- application/json content type Modified
  - Type is now object
  - Plannr_Error property Added
- text/plain content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

GET /api/v2/mortgage-searches

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - products, files properties Modified

GET /api/v2/mortgage-searches/{uuid}

Response
200 response Modified
- application/json content type Modified
  - products property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added

GET /api/v2/portal/actions

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

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

Response
201 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified

POST /api/v1/addons/mortgagebrain/mortgage-search

Response
200 response Modified
- application/json content type Modified
  - products property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added

POST /api/v1/conversation

Response
200 response Modified
- application/json content type Modified
  - latest_message property Modified
    - files property Modified

POST /api/v1/conversation/inline

Response
200 response Modified
- application/json content type Modified
  - latest_message property Modified
    - files property Modified

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

Response
200 response Modified
- application/json content type Modified
  - files property Modified
    - preview_url property Added

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

Response
200 response Modified
- application/json content type Modified
  - files property Modified
    - preview_url property Added

POST /api/v1/fact-find/request

Response
201 response Modified
- application/json content type Modified
  - latest_file property Modified
    - preview_url property Added

POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete

Response
200 response Modified
- application/json content type Modified
  - latest_file property Modified
    - preview_url property Added

POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish

Response
200 response Modified
- application/json content type Modified
  - latest_file property Modified
    - preview_url property Added

POST /api/v1/file

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

POST /api/v1/file/direct-upload

Response
201 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

POST /api/v1/folder

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

POST /api/v1/import

Response
200 response Modified
- application/json content type Modified
  - error_report property Modified
    - preview_url property Added

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

Response
200 response Modified
- application/json content type Modified
  - error_report property Modified
    - preview_url property Added

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

Response
200 response Modified
- application/json content type Modified
  - error_report property Modified
    - preview_url property Added

POST /api/v1/provider-statement/import

Response
201 response Modified
- application/json content type Modified
  - error_report property Modified
    - preview_url property Added

POST /api/v1/report

Response
201 response Modified
- application/json content type Modified
  - files property Modified
    - preview_url property Added
  - folder property Modified
    - files property Modified

POST /api/v2/fact-find/session

Response
201 response Modified
- application/json content type Modified
  - latest_file property Modified
    - preview_url property Added

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

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified

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

Response
200 response Modified
- application/json content type Modified
  - files property Modified
    - preview_url property Added

PUT /api/v1/conversation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - latest_message property Modified
    - files property Modified

PUT /api/v1/file/{file_uuid}/copy

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

PUT /api/v1/file/{uuid}

Response
200 response Modified
- application/json content type Modified
  - folder property Modified
    - files property Modified
  - preview_url property Added

PUT /api/v1/folder/{uuid}

Response
200 response Modified
- application/json content type Modified
  - folders property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added
  - parents property Modified
    - files property Modified
  - ancestors property Modified
    - files property Modified
  - children property Modified
    - files property Modified

PUT /api/v2/mortgage-searches/{uuid}

Response
200 response Modified
- application/json content type Modified
  - products property Modified
    - files property Modified
  - files property Modified
    - preview_url property Added

7 days ago

Change #f66eb49c

v1.138.1

Compare

8 days ago

Change #477c46f0

v1.138.0

Breaking

Compare

4 structure changes including:

4 Modifications

Modified 4 Breaking

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

Query
filter[modelable_uuid] query parameter Added
Response
422 response Added

GET /api/v1/logs/{modelType}/{modelUuid}

Query
filter[modelable_uuid] query parameter Added

GET /api/v1/me/logs

Query
filter[modelable_uuid] query parameter Added
Response
422 response Added

POST /api/v1/provider-statement/upload

Response
200 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
201 response Added

8 days ago

Change #66ca40e5

v1.137.2

Compare

8 days ago

Change #b97345e7

v1.137.1

Compare

9 days ago

Change #6fc2bad3

v1.137.0

Compare

236 structure changes including:

236 Modifications

Modified 236

DELETE /api/v1/account/{account_uuid}/out-of-office

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

DELETE /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level 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
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

GET /api/v1/addons/seccl/{addon}/client/{id}

Response
200 response Modified
- application/json content type Modified
  - plannr_account property Modified
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - service_level 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
    - service_level property Added

GET /api/v1/business-units

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

GET /api/v1/business-units/{business_unit_uuid}/members

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners properties Modified
    - service_level property Added

GET /api/v1/business-units/{uuid}

Response
200 response Modified
- application/json content type Modified
  - members property Modified
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

GET /api/v1/client

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level 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
    - service_level property Added

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
    - service_level 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
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

GET /api/v1/client/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level 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
    - service_level property Added

GET /api/v1/conversation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - service_level 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
    - service_level property Added

GET /api/v1/employee

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level 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
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level 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
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - author property Modified
    - service_level 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
    - service_level 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
    - service_level property Added

GET /api/v1/illustration/{uuid}

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - service_level 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
    - service_level 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
    - service_level property Added

GET /api/v1/introducer/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level 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/me

Response
200 response Modified
- application/json content type Modified
  - current_account property Modified
    - service_level 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/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
    - service_level property Added
  - adviser property Modified
    - service_level 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
    - service_level property Added
  - triggered_by property Modified
    - service_level property Added

GET /api/v1/notifications/{id}

Response
200 response Modified
- application/json content type Modified
  - notifiable property Modified
    - service_level property Added
  - triggered_by property Modified
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

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

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

GET /api/v1/plans/{uuid}

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added
  - accounts property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - linked_owners property Modified
    - service_level property Added
  - contract_enquiry_account property Modified
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

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

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

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

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

GET /api/v1/statement/{uuid}

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

GET /api/v2/dependants/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level 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
    - service_level property Added

PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}

Response
200 response Modified
- application/json content type Modified
  - plannr_account property Modified
    - service_level property Added

PATCH /api/v1/checklist-item/{checklistItem_uuid}

Response
200 response Modified
- application/json content type Modified
  - checked_by property Modified
    - service_level property Added

POST /api/v1/account

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

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

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

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

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

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

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - service_level 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
    - service_level property Added

POST /api/v1/addons/seccl/{addon}/client

Response
200 response Modified
- application/json content type Modified
  - plannr_account property Modified
    - service_level property Added

POST /api/v1/automation-blueprints

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

POST /api/v1/bank-statement/upload

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

POST /api/v1/bank-transaction

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

POST /api/v1/business-units

Response
201 response Modified
- application/json content type Modified
  - members property Modified
    - service_level property Added

POST /api/v1/cases

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - service_level property Added

POST /api/v1/charge-split

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

POST /api/v1/checklist/{checklist_uuid}/items

Response
200 response Modified
- application/json content type Modified
  - checked_by property Modified
    - service_level property Added

POST /api/v1/circles

Response
201 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

POST /api/v1/client

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - completed_by property Modified
    - service_level property Added

POST /api/v1/conversation

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - service_level property Added

POST /api/v1/conversation/inline

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - author property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - author property Modified
    - service_level property Added

POST /api/v1/document-signing

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

POST /api/v1/employee

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

POST /api/v1/expectation/reconcile

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - author property Modified
    - service_level property Added

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

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

POST /api/v1/illustration

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - service_level property Added

POST /api/v1/import

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

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

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

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

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

POST /api/v1/introducer

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

POST /api/v1/new-business-event

Response
201 response Modified
- application/json content type Modified
  - clients property Modified
    - service_level property Added
  - adviser property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added
  - accounts property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - linked_owners property Modified
    - service_level property Added
  - contract_enquiry_account property Modified
    - service_level property Added

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

Response
201 response Modified
- application/json content type Modified
  - created_by property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added
  - accounts property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - linked_owners property Modified
    - service_level property Added
  - contract_enquiry_account property Modified
    - service_level property Added

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

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

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

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

POST /api/v1/provider-statement/import

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

POST /api/v1/provider-statement/upload

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

POST /api/v1/report

Response
201 response Modified
- application/json content type Modified
  - created_by property Modified
    - service_level property Added

POST /api/v1/report-template

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

POST /api/v1/statement-transaction

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

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

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

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

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - service_level property Added

POST /api/v2/contact-details

Response
201 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

POST /api/v2/dependants

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

POST /api/v2/employments

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

POST /api/v2/goals

Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

POST /api/v2/risks

Response
201 response Modified
- application/json content type Modified
  - completed_by property Modified
    - service_level property Added

POST /api/v2/shareholder

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

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

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

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

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

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

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

PUT /api/v1/account/{account_uuid}/out-of-office

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

PUT /api/v1/account/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

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

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

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

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

PUT /api/v1/business-units/{uuid}

Response
200 response Modified
- application/json content type Modified
  - members property Modified
    - service_level property Added

PUT /api/v1/cases/{uuid}

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - service_level property Added

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

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

PUT /api/v1/circles/{uuid}

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level 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
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - completed_by property Modified
    - service_level property Added

PUT /api/v1/client/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - author property Modified
    - service_level property Added

PUT /api/v1/conversation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - service_level property Added

PUT /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

PUT /api/v1/expectation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - author property Modified
    - service_level property Added

PUT /api/v1/illustration/{uuid}

Response
200 response Modified
- application/json content type Modified
  - requested_by property Modified
    - service_level property Added

PUT /api/v1/introducer/{uuid}

Response
200 response Modified
- application/json content type Modified
  - assigned_adviser property Modified
    - service_level property Added
  - assigned_administrator property Modified
    - service_level property Added
  - assigned_paraplanner property Modified
    - service_level property Added
  - introduced_by property Modified
    - service_level property Added
  - owners property Modified
    - service_level property Added
  - service_level property Added

PUT /api/v1/mailboxes/{uuid}

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

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

Response
200 response Modified
- application/json content type Modified
  - clients property Modified
    - service_level property Added
  - adviser property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added

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

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added
  - accounts property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - linked_owners property Modified
    - service_level property Added
  - contract_enquiry_account property Modified
    - service_level property Added

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

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

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

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

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

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

PUT /api/v1/plans/{uuid}

Response
200 response Modified
- application/json content type Modified
  - client property Modified
    - service_level property Added
  - accounts property Modified
    - service_level property Added
  - seller property Modified
    - service_level property Added
  - linked_owners property Modified
    - service_level property Added
  - contract_enquiry_account property Modified
    - service_level property Added

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

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

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

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

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

Response
200 response Modified
- application/json content type Modified
  - accounts property Modified
    - service_level property Added

PUT /api/v2/dependants/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

PUT /api/v2/employments/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

PUT /api/v2/goals/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - service_level property Added

PUT /api/v2/risks/{uuid}

Response
200 response Modified
- application/json content type Modified
  - completed_by property Modified
    - service_level property Added

PUT /api/v2/shareholder/{uuid}

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

12 days ago

Change #569b19e7

v1.136.3

Compare

13 days ago

Change #a447e068

v1.136.2

Compare

13 days ago

Change #58a84753

v1.136.1

Compare

14 days ago

Change #aa865e7a

v1.136.0

Compare

15 days ago

Change #4e012aa0

v1.135.4

Compare

15 days ago

Change #a31f49a4

v1.135.3

Compare

16 days ago

Change #b6952761

v1.135.1

Compare

16 days ago

Change #652ad894

v1.135.0

Compare

16 days ago

Change #507f7b17

v1.134.2

Compare

19 days ago

Change #298c6742

v1.134.1

Compare

3 structure changes including:

3 Modifications

Modified 3

DELETE /api/v1/account/{account_uuid}/out-of-office

Response
400 response Added

GET /api/v1/account

Query
filter[client_agreement_at], filter[engagement_rating], filter[is_potential_duplicate], filter[last_login_after], filter[last_login_before], filter[portal_access_status], filter[service_level], filter[terms_of_business_at] query parameters Added

PUT /api/v1/account/{account_uuid}/out-of-office

Response
400 response Added

19 days ago

Change #f107ad53

v1.134.0

Breaking

Compare

27 structure changes including:

27 Breaking changes

27 Removals

Removed 27 Breaking

DELETE /api/v1/mobile/notification-token

Removing a resource is always breaking unless it was deprecated before
Breaking

DELETE /api/v1/personal-access-tokens/{id}

Removing a resource is always breaking unless it was deprecated before
Breaking

DELETE /api/v1/reaction/{uuid}

Removing a resource is always breaking unless it was deprecated before
Breaking

DELETE /api/v1/unipass/certificate

Removing a resource is always breaking unless it was deprecated before
Breaking

DELETE /api/v1/upload-files

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/addons/be-iq/token

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/migrate-joint-logins

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/my/audits

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/my/welcome-widget-tasks

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/navigator/{modelType}/{modelUuid}

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/personal-access-tokens

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/search

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/state

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/unipass/certificate

Removing a resource is always breaking unless it was deprecated before
Breaking

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

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/me/switch-account

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/migrate-joint-logins/{jointAccountLogin_uuid}

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/mobile/notification-token

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/my/welcome-widget-tasks/{id}

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/note/{notableType}/{notableUuid}/mentions

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/personal-access-tokens

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/postcode/search

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/reaction

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/unipass/certificate

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/upload-files

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /api/v1/upload-files/create

Removing a resource is always breaking unless it was deprecated before
Breaking

PUT /api/v1/me

Removing a resource is always breaking unless it was deprecated before
Breaking

22 days ago

Change #d39c0b6c

v1.133.0

Compare

23 days ago

Change #4ef3a195

v1.132.5

Compare

Do not miss any PlannrCRM API changes, ever again

Changelog

Documentation content has changed

API structure has changed

Documentation content has changed

API structure has changed

Documentation content has changed

Documentation content has changed

API structure has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

Documentation content has changed

API structure has changed

API structure has changed

Documentation content has changed

Documentation content has changed