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.8.2
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 1
GET /api/v2/transactions
v1.8.0
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • client, accounts properties Added
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • client, accounts properties Added
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • client, accounts properties Added
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • client, accounts properties Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • client, accounts properties Added
v1.5.1
1 structure change including:
1 Modification
Modified 1
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • visible_to_circles_uuids property Added
v1.5.0
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • account property Added
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • account property Added
GET /api/v2/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • type_other property Added
GET /api/v2/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type_other property Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • account property Added
POST /api/v2/income
  • Body
  • application/json content type Modified
    • type_other property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • type_other property Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • account property Added
PUT /api/v2/income/{uuid}
  • Body
  • application/json content type Modified
    • type_other property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type_other property Added
v1.4.0
8 structure changes including:
8 Additions
Added 8
DELETE /api/v2/webhook-subscriptions/{uuid}
GET /api/v1/static/webhook-subscription-events
GET /api/v2/webhook-subscriptions
GET /api/v2/webhook-subscriptions/{uuid}
GET /api/v2/webhook-subscriptions/{webhookSubscription_uuid}/calls
POST /api/v2/webhook-subscriptions
POST /api/v2/webhook-subscriptions/calls/{outgoingWebhookCall_uuid}/retry
PUT /api/v2/webhook-subscriptions/{uuid}
v1.3.3
40 structure changes including:
40 Modifications
Modified 40 Breaking
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • external_references property Added
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • external_references property Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/client/{client_uuid}/employment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • income property Modified
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • income property Modified
        • type_other property Added
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • application property Modified
        • client property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • clients property Added
GET /api/v1/client/{client_uuid}/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • type_other property Added
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type_other property Added
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle property Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle property Modified
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • application property Modified
        • client property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • clients property Added
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle property Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • application property Modified
        • client property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • clients property Added
GET /api/v2/employments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • income property Modified
GET /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • income property Modified
        • type_other property Added
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • external_references property Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 201 response Modified
    • application/json content type Modified
      • income property Modified
        • type_other property Added
POST /api/v1/client/{client_uuid}/income
  • Body
  • application/json content type Modified
    • type_other property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • type_other property Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
POST /api/v1/illustration
  • Body
  • application/json content type Modified
    • client_uuid property Modified
      • Property is no longer required
    • accounts property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • application property Modified
        • client property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • clients property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
POST /api/v2/employments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • income property Modified
        • type_other property Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • external_references property Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • income property Modified
        • type_other property Added
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Body
  • application/json content type Modified
    • type_other property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type_other property Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • application property Modified
        • client property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • clients property Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • external_references property Added
PUT /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • income property Modified
        • type_other property Added
v1.2.0
1 structure change including:
1 Modification
Modified 1
GET /api/v1/addons/seccl/{addon}/schema-products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • platform property Added
v1.1.0
1 structure change including:
1 Addition
Added 1
POST /api/v1/addons/transact/account-opening
v1.0.4
2 structure changes including:
2 Modifications
Modified 2
POST /api/v1/workflow/{workflow_uuid}/task
  • Body
  • application/json content type Modified
    • auto_assign_assigned_paraplanner property Added
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Body
  • application/json content type Modified
    • auto_assign_assigned_paraplanner property Added
v1.0.2
20 structure changes including:
20 Breaking changes
20 Removals
Removed 20 Breaking
DELETE /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v1/subscription
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/invoice
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/invoice/{invoiceId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/invoice/{invoiceId}/download
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/me/otp/recovery-codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/me/otp/show
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/subscription
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/subscription/plans
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/firm/{firm_id}/billing
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/impersonated-login/{account_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/confirm
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/new-recovery-codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/reset
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/settings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/sms/setup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/subscription
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking