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
78 structure changes including:
78 Modifications
Modified 78
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/bank-transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address 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
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • cc_email_addresses, bcc_email_addresses, reply_to_email_address properties Added
1 structure change including:
1 Modification
Modified 1
GET /api/v2/flux
  • Body
  • application/json content type Modified
    • filter property Added
1 structure change including:
1 Modification
Modified 1
GET /api/v2/plans/{plan_uuid}/returns
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • first_valuation_within_date_range property Added
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
GET /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/v1/addons/seccl/{addon}/client/{id}
4 structure changes including:
4 Modifications
Modified 4
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, groups, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account, can_be_deleted, joint_account_circle, circles, ownership_percentage, inactive_at, custom_fields properties Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, groups, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account, can_be_deleted, joint_account_circle, circles, ownership_percentage, inactive_at, custom_fields properties Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, groups, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account, can_be_deleted, joint_account_circle, circles, ownership_percentage, inactive_at, custom_fields properties Added
2 structure changes including:
2 Additions
Added 2
POST /api/v1/addons/seccl/{addon}/sync-client/{account_uuid}
POST /api/v1/addons/seccl/{addon}/sync-plan/{plan_uuid}