For AI agents: a documentation index is available at https://apidocs.plannrcrm.com/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.

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
24 structure changes including:
24 Modifications
Modified 24
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transaction property Modified
        • auto_reconciliation_message property Added
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement_transactions property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement_transactions property Modified
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement_transactions property Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement_transactions 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
        • auto_reconciliation_message property Added
GET /api/v1/statement
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • statement_transactions property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transaction property Modified
        • auto_reconciliation_message property Added
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
POST /api/v1/provider-statement
  • Response
  • 201 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statement_transactions property Modified
        • auto_reconciliation_message property Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_reconciliation_message property Added
4 structure changes including:
4 Modifications
Modified 4
GET /api/v2/risks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • risk_description, chosen_risk_level, chosen_risk_level_string, chosen_risk_reason properties Added
GET /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • risk_description, chosen_risk_level, chosen_risk_level_string, chosen_risk_reason properties Added
POST /api/v2/risks
  • Body
  • application/json content type Modified
    • risk_description, chosen_risk_level, chosen_risk_level_string, chosen_risk_reason properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • risk_description, chosen_risk_level, chosen_risk_level_string, chosen_risk_reason properties Added
PUT /api/v2/risks/{uuid}
  • Body
  • application/json content type Modified
    • risk_description, chosen_risk_level, chosen_risk_level_string, chosen_risk_reason properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • risk_description, chosen_risk_level, chosen_risk_level_string, chosen_risk_reason properties Added
1 structure change including:
1 Modification
Modified 1
POST /api/v1/conversation
  • Body
  • application/json content type Modified
    • files property Added
38 structure changes including:
2 Breaking changes
36 Modifications
2 Removals
Modified 36 Breaking
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
Removed 2 Breaking
GET /api/v1/portal-engagement/summary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/static/portal-access-statuses
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
47 structure changes including:
11 Additions
36 Modifications
Modified 36
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Added
Added 11
DELETE /api/v1/checklist-item/{checklistItem_uuid}
DELETE /api/v1/checklist/{uuid}
GET /api/v1/portal-engagement/summary
GET /api/v1/static/portal-access-statuses
GET /api/v1/task/{task_uuid}/checklists
GET /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
PATCH /api/v1/checklist-item/{checklistItem_uuid}
PATCH /api/v1/checklist/{uuid}
POST /api/v1/checklist/{checklist_uuid}/items
POST /api/v1/task/{task_uuid}/checklists
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
3 structure changes including:
3 Additions
Added 3
GET /api/v1/addons/seccl/{addon}/client/{account_uuid}/bank-details/status
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/bank-details
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/direct-debit-mandate/portal-completion