Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

Jul 30, 2023

main
1.0.0
Compare

API structure has changed

109 structure changes including:
109 Modifications
Modified 109 Breaking
GET /api/v1/account/{account_uuid}/address
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/account/{account_uuid}/contact-detail
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/account/{account_uuid}/conversations
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/account/{account_uuid}/documents
  • Query
  • sort, filter[name], filter[date_from], filter[date_to], filter[extension], filter[uploaded_by], filter[size], filter[last_modified_from], filter[last_modified_to], filter[original_created_from], filter[original_created_to] query parameters Removed
GET /api/v1/account/{account_uuid}/groups
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/account/{account_uuid}/login
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Query
  • filter[uuid], sort, per_page query parameters Added
GET /api/v1/addon
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/addon-subscriptions
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/adviser-split
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/audits
  • Query
  • page query parameter Removed
  • filter[uuid] query parameter Added
GET /api/v1/audits/{model}/{modelUuid}
  • Query
  • page query parameter Removed
  • filter[uuid] query parameter Added
GET /api/v1/automation-blueprints
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/automation-executions
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/bank-transaction
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • type property Removed
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/board/{board_uuid}/list/trashed
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/board/{board_uuid}/list/{boardList_uuid}/task
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/board/{board_uuid}/tasks
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/cases
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/cases-status
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/cases-type
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/cases/{case_uuid}/conversations
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/cases/{case_uuid}/documents
  • Query
  • sort, filter[name], filter[date_from], filter[date_to], filter[extension], filter[uploaded_by], filter[size], filter[last_modified_from], filter[last_modified_to], filter[original_created_from], filter[original_created_to] query parameters Removed
GET /api/v1/charge-split-schema
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
  • Query
  • filter, include query parameters Removed
  • filter[uuid] query parameter Added
GET /api/v1/client
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client-status
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_id}/fact-find/requests
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/all-notes
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/cases
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/charges
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/dependant
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/employment
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/expectations
  • Query
  • include, filter[uuid], filter[groups] query parameters Added
GET /api/v1/client/{client_uuid}/expenditure
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/goal
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/income
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/new-business-events
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/plans
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/risk
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/signatures
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/client/{client_uuid}/staff-members
  • Query
  • include query parameter Removed
  • filter[uuid] query parameter Added
GET /api/v1/client/{client}/shared-accounts
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/conversation
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/custom-default-folder
  • Query
  • filter, include query parameters Removed
  • filter[uuid], filter[model], filter[is_active] query parameters Added
GET /api/v1/custom-field
  • Query
  • filter query parameter Removed
  • filter[uuid], filter[model_type] query parameters Added
GET /api/v1/document
  • Query
  • filter[uuid], filter[name], filter[date_from], filter[date_to] query parameters Added
GET /api/v1/document-pack
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/document-signing
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/document-template
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/documents/{model}/{modelUuid}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/employee
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/employee/{employee_uuid}/audits
  • Query
  • filter[uuid], per_page query parameters Added
GET /api/v1/employee/{employee}/logs
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/expectation
  • Query
  • filter[uuid], filter[groups] query parameters Added
GET /api/v1/fact-find/request
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/fact-find/schema
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/file/bin
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/firm/{firm_uuid}/documents
  • Query
  • sort, filter[name], filter[date_from], filter[date_to], filter[extension], filter[uploaded_by], filter[size], filter[last_modified_from], filter[last_modified_to], filter[original_created_from], filter[original_created_to] query parameters Removed
GET /api/v1/form
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/form/{form_uuid}/submission
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}
  • Query
  • include, filter[uuid], filter[form.title] query parameters Added
GET /api/v1/form/{form_uuid}/submission-request
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/group
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/group/{group_uuid}/participants
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/import
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/introducer
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/linked-form-questions
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/logs/{modelType}/{modelUuid}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/me/logs
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/me/tasks
  • Query
  • filter, due_at_from, due_at_to query parameters Removed
  • filter[uuid], filter[completed], filter[due_at_from], filter[due_at_to] query parameters Added
GET /api/v1/my/audits
  • Query
  • filter[uuid], per_page query parameters Added
GET /api/v1/note/{notableType}/{notableUuid}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/notifications
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/charges
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/claim
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/contributions/{subAccount}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/cover
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/documents
  • Query
  • sort, filter[name], filter[date_from], filter[date_to], filter[extension], filter[uploaded_by], filter[size], filter[last_modified_from], filter[last_modified_to], filter[original_created_from], filter[original_created_to] query parameters Removed
GET /api/v1/plans/{plan_uuid}/expectations
  • Query
  • include, filter[uuid], filter[groups] query parameters Added
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/holdings/{subAccount}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/sub-accounts
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/transaction
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/valuations/{subAccount}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/plans/{plan_uuid}/withdrawals/{subAccount}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/providers
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Query
  • filter[uuid], filter[name], sort query parameters Added
GET /api/v1/report
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/report-template
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/snippet
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/statement
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/statement-transaction
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • type property Removed
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/submission-request
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/submission-request/received/{account}
  • Query
  • account query parameter Removed
  • filter[uuid], per_page query parameters Added
GET /api/v1/submission-request/sent
  • Query
  • filter[uuid], per_page query parameters Added
GET /api/v1/tag
  • Query
  • filter query parameter Removed
  • filter[uuid], filter[name] query parameters Added
GET /api/v1/tasks
  • Query
  • include query parameter Removed
  • filter[uuid] query parameter Added
GET /api/v1/time-entry/{trackable_type}/{trackable_uuid}
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/workflow
  • Query
  • filter[uuid] query parameter Added
GET /api/v1/workflow/{workflow_uuid}/task
  • Query
  • filter[uuid] query parameter Added