Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

Changelog

Last update:
Compare
v1.87.1
13 structure changes including:
7 Additions
6 Modifications
Modified 6
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • is_recurring, recurring_frequency, recurring_last_run, recurring_next_run properties Added
GET /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_recurring, recurring_frequency, recurring_last_run, recurring_next_run properties Added
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_recurring, recurring_frequency, recurring_last_run, recurring_next_run properties Added
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_recurring, recurring_frequency, recurring_last_run, recurring_next_run properties Added
POST /api/v1/task
  • Body
  • application/json content type Modified
    • is_recurring, recurring_frequency properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • is_recurring, recurring_frequency, recurring_last_run, recurring_next_run properties Added
PUT /api/v1/task/{uuid}
  • Body
  • application/json content type Modified
    • is_recurring, recurring_frequency properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_recurring, recurring_frequency, recurring_last_run, recurring_next_run properties Added
Added 7
DELETE /api/v1/enterprise/network/{uuid}
GET /api/v1/enterprise/network
GET /api/v1/enterprise/network/{uuid}
GET /api/v1/enterprise/settings
PATCH /api/v1/enterprise/network/{uuid}
POST /api/v1/enterprise/network
PUT /api/v1/enterprise/settings
v1.86.0
1 structure change including:
1 Modification
Modified 1
GET /api/v1/task
  • Query
  • filter[is_recurring] query parameter Added
v1.85.1
1 structure change including:
1 Addition
Added 1
GET /api/v1/addons/seccl/{addon}/client-products/{account_uuid}
v1.82.2
22 structure changes including:
1 Breaking change
21 Modifications
1 Removal
Modified 21 Breaking
DELETE /api/v1/addon-subscriptions/{addonSubscription_uuid}/unsubscribe
  • Response
  • 204 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
GET /api/v1/addon
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • params property Modified
GET /api/v1/addon-subscriptions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • addon property Modified
GET /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employers property Modified
        • addressDetail property Modified
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • workflow_task property Added
GET /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
GET /api/v2/plans/linked-policy-numbers
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /api/v2/plans/{plan_uuid}/returns
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • time_weighted_return, money_weighted_return properties Modified
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Body
  • application/json content type Modified
    • title, nationality, national_insurance_no, tax_domicile, bank_details, marital_status, retirement_age, vulnerability, requires_debit_mandate, employment_status, employers, nationalities, platform_terms_agreed properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employers property Modified
        • addressDetail property Modified
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/confirm-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/disable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/enable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Body
  • application/json content type Modified
    • applicants property Modified
      • date_of_birth, birth_gender, salutation, retirement_age, employment_status, annual_salary_amount properties Added
    • case_uuids property Modified
      • Type went from array[string(uuid)] to array[string(uuid)] | null
    • oauth_connection_uuid property Modified
      • Type went from string(uuid) to string(uuid) | null
POST /api/v1/subscribe
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/task
  • Response
  • 201 response Modified
    • application/json content type Modified
      • workflow_task property Added
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added
PUT /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 201 response Added
Removed 1 Breaking
GET /api/v1/networks/{network_uuid}/charges
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
v1.81.4
1 structure change including:
1 Modification
Modified 1
GET /api/v2/flux
  • Body
  • application/json content type Modified
    • filter.transaction_types, filter.include_premiums properties Added
v1.81.2
83 structure changes including:
83 Modifications
Modified 83
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_open_accounts_for property Added
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data 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
        • firm property Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data 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 property Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
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
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/mailboxes/message/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data 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
        • firm property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
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
        • mobile_app_support_number, mobile_app_support_email properties Added
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_open_accounts_for property Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • mobile_app_support_number, mobile_app_support_email properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • mobile_app_support_number, mobile_app_support_email properties Added
v1.81.1
4 structure changes including:
1 Addition
3 Modifications
Modified 3
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • name property Added
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • name property Added
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • name property Added
Added 1
PUT /api/v2/mortgage-searches/{uuid}
v1.80.3
1 structure change including:
1 Modification
Modified 1
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • email_logo property Added