PlannrCRM API documentation

about 8 hours ago

Change #0c5486fc

v1.143.2

Compare

about 12 hours ago

Change #989ecf2b

v1.143.1

Compare

about 18 hours ago

Change #56fe4831

v1.143.0

Compare

about 19 hours ago

Change #7a612c30

v1.142.4

Compare

1 day ago

Change #a8632370

v1.142.1

Compare

2 days ago

Change #395ce9a7

v1.142.0

Breaking

Compare

9 structure changes including:

8 Additions

1 Modification

Modified 1 Breaking

POST /api/v1/provider-statement/upload

Body
application/json content type Modified
- statement_transactions property Modified
  - gross_amount, net_amount properties Modified
    - Type went from integer to string
      Breaking

Added 8

DELETE /api/v2/roles/{uuid}

GET /api/v1/static/rbac-permissions

GET /api/v2/roles

GET /api/v2/roles/{role_uuid}/assignees

GET /api/v2/roles/{uuid}

POST /api/v2/roles

POST /api/v2/roles/{role_uuid}/{action}

PUT /api/v2/roles/{uuid}

3 days ago

Change #2b2fb006

v1.141.0

Compare

291 structure changes including:

291 Modifications

Modified 291

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

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

DELETE /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

GET /api/v1/account

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

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
    - firm property Modified

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

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

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

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

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

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}/documents

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

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

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

GET /api/v1/account/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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

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

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
    - firm property Modified

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
    - firm property Modified

GET /api/v1/bank-statement

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

GET /api/v1/bank-statement/{bankStatement_uuid}

Response
200 response Modified
- application/json content type Modified
  - bank_transactions property Modified
    - firm property Modified

GET /api/v1/bank-transaction

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

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - statement_transaction property Modified
    - firm property Modified
  - bank_transaction property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified

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
    - firm property Modified

GET /api/v1/business-units

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

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

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

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

Response
200 response Modified
- application/json content type Modified
  - members property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties 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/{case_uuid}/documents

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

GET /api/v1/cases/{uuid}

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

GET /api/v1/charge

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

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

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

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}/accounts

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

GET /api/v1/circles/{circle_uuid}/charge-splits

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

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}/documents

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

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

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account, seller, author, charge_schedule, statement_transactions, firm properties 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/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
    - firm property Modified

GET /api/v1/client

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm 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/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
    - firm property Modified

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

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - firm, participants, attachments properties 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
    - firm property Modified

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

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account, seller, author, charge_schedule, statement_transactions, firm 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
    - progress_amount, progress_type properties Added

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

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - firm property Modified
  - progress_amount, progress_type properties Added

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

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

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
    - firm property Modified

GET /api/v1/client/{client_uuid}/new-business-events

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - clients, firm, adviser properties Modified

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

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

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
    - firm property Modified

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
    - firm property Modified

GET /api/v1/client/{client}/shared-accounts

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

GET /api/v1/client/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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}/documents

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

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

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

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

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

GET /api/v1/conversation/{uuid}

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

GET /api/v1/custom-field

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

GET /api/v1/custom-field/{customField_uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties 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
    - firm property Modified

GET /api/v1/employee

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

GET /api/v1/expectation

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account, seller, author, charge_schedule, statement_transactions, firm properties Modified

GET /api/v1/expectation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - seller property Modified
    - firm property Modified
  - author property Modified
    - firm property Modified
  - charge_schedule property Modified
    - firm property Modified
  - statement_transactions property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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
    - firm property Modified

GET /api/v1/file/bin

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

GET /api/v1/file/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

GET /api/v1/firm/{uuid}

Response
200 response Modified
- application/json content type Modified
  - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

GET /api/v1/folder/{uuid}

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

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
    - firm property Modified

GET /api/v1/group/{group_uuid}/participants

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

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

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

GET /api/v1/illustration/{uuid}

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

GET /api/v1/import

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

GET /api/v1/import/{uuid}

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

GET /api/v1/introducer

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

GET /api/v1/introducer/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

GET /api/v1/logins

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account, firm properties 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
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - participants property Modified
    - firm property Modified
  - attachments property Modified
    - firm property Modified

GET /api/v1/me

Response
200 response Modified
- application/json content type Modified
  - current_account property Modified
    - firm property Modified
  - current_login property Modified
    - firm property Modified

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, firm, adviser properties Modified

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

Response
200 response Modified
- application/json content type Modified
  - clients property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - adviser property Modified
    - firm property Modified

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
    - firm property Modified
  - triggered_by property Modified
    - firm property Modified

GET /api/v1/notifications/{id}

Response
200 response Modified
- application/json content type Modified
  - notifiable property Modified
    - firm property Modified
  - triggered_by property Modified
    - firm property Modified

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
    - firm property Modified

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
    - firm property Modified

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

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

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

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - account, seller, author, charge_schedule, statement_transactions, firm 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
  - application property Modified
    - firm property Modified
  - requested_by property Modified
    - firm property Modified

GET /api/v1/plans/{plan_uuid}/new-business-events

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - clients, firm, 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
    - firm property Modified

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
    - firm property Modified

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

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

GET /api/v1/plans/{uuid}

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

GET /api/v1/provider-statement

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

GET /api/v1/provider-statement/{providerStatement_uuid}

Response
200 response Modified
- application/json content type Modified
  - statement_transactions property Modified
    - firm property Modified

GET /api/v1/report

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - created_by, files properties 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
    - firm property Modified

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
    - firm property Modified
  - files property Modified
    - firm property Modified

GET /api/v1/statement

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - locked_by, statement_transactions properties Modified

GET /api/v1/statement-transaction

Response
200 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - statement_transaction property Modified
    - firm property Modified
  - bank_transaction property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified

GET /api/v1/statement/{uuid}

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - firm property Modified
  - statement_transactions property Modified
    - firm property Modified

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

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

GET /api/v2/dependants/{uuid}

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

GET /api/v2/direct-debit-mandates

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

GET /api/v2/direct-debit-mandates/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties 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
    - firm 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
    - firm property Modified

GET /api/v2/goals

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - shared_owner property Modified
    - progress_amount, progress_type properties Added

GET /api/v2/goals/{uuid}

Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - firm property Modified
  - progress_amount, progress_type properties Added

GET /api/v2/mortgage-searches

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

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

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

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
    - firm property Modified

GET /api/v2/shareholder

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

GET /api/v2/shareholder/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - account property Modified
    - firm property Modified

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

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

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

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

POST /api/v1/account

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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

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

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

Response
201 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

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

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

POST /api/v1/automation-blueprints

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

POST /api/v1/bank-statement

Response
201 response Modified
- application/json content type Modified
  - bank_transactions property Modified
    - firm property Modified

POST /api/v1/bank-statement/upload

Response
200 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/bank-transaction

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/business-units

Response
201 response Modified
- application/json content type Modified
  - members property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/cases

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

POST /api/v1/charge-split

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

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

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

POST /api/v1/circles

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

POST /api/v1/client

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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

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

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

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

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

Body
application/json content type Modified
- progress_amount, progress_type properties Added
Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - firm property Modified
  - progress_amount, progress_type properties Added

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

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

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

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

POST /api/v1/conversation

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

POST /api/v1/conversation/inline

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

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

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

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

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

POST /api/v1/custom-field

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/document-signing

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

POST /api/v1/employee

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

POST /api/v1/expectation/reconcile

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - seller property Modified
    - firm property Modified
  - author property Modified
    - firm property Modified
  - charge_schedule property Modified
    - firm property Modified
  - statement_transactions property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/fact-find/request

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

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

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

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

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

POST /api/v1/file

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/file/direct-upload

Response
201 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/firm/{firm_uuid}/branding

Response
200 response Modified
- application/json content type Modified
  - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/firm/{firm_uuid}/settings

Response
200 response Modified
- application/json content type Modified
  - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/folder

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

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

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

POST /api/v1/illustration

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

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

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

POST /api/v1/import

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

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

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

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

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

POST /api/v1/introducer

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

POST /api/v1/new-business-event

Response
201 response Modified
- application/json content type Modified
  - clients property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - adviser property Modified
    - firm property Modified

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

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

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

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

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

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

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

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

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

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

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

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

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

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

POST /api/v1/provider-statement

Response
201 response Modified
- application/json content type Modified
  - statement_transactions property Modified
    - firm property Modified

POST /api/v1/provider-statement/import

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

POST /api/v1/provider-statement/upload

Response
201 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v1/report

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

POST /api/v1/report-template

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

POST /api/v1/statement-transaction

Response
200 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - firm property Modified
  - statement_transactions property Modified
    - firm property Modified

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

Response
200 response Modified
- application/json content type Modified
  - locked_by property Modified
    - firm property Modified
  - statement_transactions property Modified
    - firm property Modified

POST /api/v2/contact-details

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

POST /api/v2/dependants

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

POST /api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/complete

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

POST /api/v2/employments

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

POST /api/v2/fact-find/session

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

POST /api/v2/goals

Body
application/json content type Modified
- progress_amount, progress_type properties Added
Response
201 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - firm property Modified
  - progress_amount, progress_type properties Added

POST /api/v2/risks

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

POST /api/v2/shareholder

Response
201 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - account property Modified
    - firm property Modified

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

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

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

PUT /api/v1/account/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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

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

PUT /api/v1/bank-statement/{bankStatement_uuid}

Response
200 response Modified
- application/json content type Modified
  - bank_transactions property Modified
    - firm property Modified

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

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - members property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

PUT /api/v1/cases/{uuid}

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

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

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

PUT /api/v1/circles/{uuid}

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

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

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

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

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

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

Body
application/json content type Modified
- progress_amount, progress_type properties Added
Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - firm property Modified
  - progress_amount, progress_type properties Added

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

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

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

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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

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

PUT /api/v1/client/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

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

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

PUT /api/v1/conversation/{uuid}

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

PUT /api/v1/custom-field/{customField_uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

PUT /api/v1/employee/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

PUT /api/v1/expectation/{uuid}

Response
200 response Modified
- application/json content type Modified
  - account property Modified
    - firm property Modified
  - seller property Modified
    - firm property Modified
  - author property Modified
    - firm property Modified
  - charge_schedule property Modified
    - firm property Modified
  - statement_transactions property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

PUT /api/v1/file/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

PUT /api/v1/firm/{uuid}

Response
200 response Modified
- application/json content type Modified
  - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

PUT /api/v1/folder/{uuid}

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

PUT /api/v1/illustration/{uuid}

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

PUT /api/v1/introducer/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - assigned_adviser property Modified
    - firm property Modified
  - assigned_administrator property Modified
    - firm property Modified
  - assigned_paraplanner property Modified
    - firm property Modified
  - introduced_by property Modified
    - firm property Modified
  - business_unit property Modified
    - firm property Modified
  - owners property Modified
    - firm property Modified

PUT /api/v1/mailboxes/{uuid}

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

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

Response
200 response Modified
- application/json content type Modified
  - clients property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - adviser property Modified
    - firm property Modified

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

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

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

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

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

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

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

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

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

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

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

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

PUT /api/v1/plans/{uuid}

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

PUT /api/v1/provider-statement/{providerStatement_uuid}

Response
200 response Modified
- application/json content type Modified
  - statement_transactions property Modified
    - firm property Modified

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

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

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

Response
200 response Modified
- application/json content type Modified
  - expectation property Modified
    - firm property Modified
  - bank_transactions property Modified
    - firm property Modified
  - account property Modified
    - firm property Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added

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

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

PUT /api/v2/dependants/{uuid}

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

PUT /api/v2/employments/{uuid}

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

PUT /api/v2/goals/{uuid}

Body
application/json content type Modified
- progress_amount, progress_type properties Added
Response
200 response Modified
- application/json content type Modified
  - shared_owner property Modified
    - firm property Modified
  - progress_amount, progress_type properties Added

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

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

PUT /api/v2/risks/{uuid}

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

PUT /api/v2/shareholder/{uuid}

Response
200 response Modified
- application/json content type Modified
  - firm property Modified
    - factfind_pdf_header_background, factfind_pdf_header_text, factfind_pdf_logo properties Added
  - account property Modified
    - firm property Modified

5 days ago

Change #960e0b88

v1.140.2

Compare

6 days ago

Change #5f4e8655

v1.140.1

Compare

7 days ago

Change #329b150b

v1.140.0

Compare

7 days ago

Change #4b3e3d46

v1.139.7

Compare

19 structure changes including:

19 Modifications

Modified 19

GET /api/v2/fact-find/blocks/{factFindBlock_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_section property Modified
    - fact_find_template property Modified

GET /api/v2/fact-find/sections/{factFindSection_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_template property Modified
    - display_name property Added

GET /api/v2/fact-find/session

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

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

Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - display_name property Added

GET /api/v2/fact-find/templates

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - sections property Modified
    - display_name property Added

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections

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

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks

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

POST /api/v2/fact-find/session

Response
201 response Modified
- application/json content type Modified
  - template property Modified
    - display_name property Added

POST /api/v2/fact-find/templates

Body
application/json content type Modified
- display_name property Added
Response
201 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/archive

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/clone

Response
201 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/publish

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections

Response
201 response Modified
- application/json content type Modified
  - fact_find_template property Modified
    - display_name property Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks

Response
201 response Modified
- application/json content type Modified
  - fact_find_section property Modified
    - fact_find_template property Modified

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/unpublish

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

PUT /api/v2/fact-find/blocks/{factFindBlock_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_section property Modified
    - fact_find_template property Modified

PUT /api/v2/fact-find/sections/{factFindSection_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_template property Modified
    - display_name property Added

PUT /api/v2/fact-find/templates/{factFindTemplate_uuid}

Body
application/json content type Modified
- display_name property Added
Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - display_name property Added

7 days ago

Change #ae277736

v1.139.6

Compare

20 structure changes including:

2 Additions

18 Modifications

Modified 18

PUT /api/v2/fact-find/templates/{factFindTemplate_uuid}

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - archived_at, is_archived properties Added

PUT /api/v2/fact-find/sections/{factFindSection_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_template property Modified
    - archived_at, is_archived properties Added

PUT /api/v2/fact-find/blocks/{factFindBlock_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_section property Modified
    - fact_find_template property Modified

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/unpublish

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - archived_at, is_archived properties Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks

Response
201 response Modified
- application/json content type Modified
  - fact_find_section property Modified
    - fact_find_template property Modified

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections

Response
201 response Modified
- application/json content type Modified
  - fact_find_template property Modified
    - archived_at, is_archived properties Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/publish

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - archived_at, is_archived properties Added
422 response Added

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/clone

Response
201 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - archived_at, is_archived properties Added

POST /api/v2/fact-find/templates

Response
201 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - archived_at, is_archived properties Added

POST /api/v2/fact-find/session

Response
201 response Modified
- application/json content type Modified
  - template property Modified
    - archived_at, is_archived properties Added

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks

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

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections

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

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}

Response
200 response Modified
- application/json content type Modified
  - sections property Modified
    - fact_find_template property Modified
  - archived_at, is_archived properties Added

GET /api/v2/fact-find/templates

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - sections property Modified
    - archived_at, is_archived properties Added
Query
filter[archived] query parameter Added

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

Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - archived_at, is_archived properties Added

GET /api/v2/fact-find/session

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

GET /api/v2/fact-find/sections/{factFindSection_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_template property Modified
    - archived_at, is_archived properties Added

GET /api/v2/fact-find/blocks/{factFindBlock_uuid}

Response
200 response Modified
- application/json content type Modified
  - fact_find_section property Modified
    - fact_find_template property Modified

Added 2

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/archive

GET /api/v2/fact-find/templates/{factFindTemplate_uuid}/automations

8 days ago

Change #bcc03b35

v1.139.5

Compare

8 days ago

Change #ee07fcf0

v1.139.3

Compare

13 days ago

Change #8507b192

v1.139.2

Compare

13 days ago

Change #39dd75b0

v1.139.1

Compare

14 days ago

Change #9469471b

v1.139.0

Compare

14 days ago

Change #e0d65883

v1.138.6

Compare

15 days ago

Change #b52e6bd3

v1.138.5

Compare

16 days 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

Do not miss any PlannrCRM API changes, ever again

Changelog

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

Documentation content has changed

API structure 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

API structure has changed