Set the firm's configuration controls
- AML Checks
-
Account
- Check for potential duplicate clients before creation.
- Get all accounts
- Create an account
- Get an account
- Update an account
- Delete an account
- Set an employee's Out of Office
- Clear an employee's Out of Office
- Get a client's marketing consent history
- Record a client's marketing consent
- Get a client's marketing consent status
- List the active potential duplicates for a client.
- Mark one or more matched records as not-a-duplicate of the given client.
- Actions
- Addon Subscriptions
-
Addons
- Get all available addons
- Get an addon's sub-firm availability for your firm
- Update an addon's sub-firm availability for your firm
- Initiate a sync to pull all clients from Nucleus
- Initiate a sync to pull all plans from Nucleus
- Seccl - Sync all the clients
- Seccl - Sync all the plans
- Seccl - Get a list of Seccl Nodes for the firm
- Seccl - Store an adviser node association
- Seccl - Search assets on Seccl
- Seccl - Create a new Seccl client and sync them into Plannr
- Seccl - Get the seccl client associated with the account
- Seccl - Update the seccl client
- Seccl - List scheme products on Seccl
- Get api v1 addons seccl addon direct debit mandate
- Post api v1 addons seccl addon direct debit mandate
- Client portal: submit bank details once after AML has cleared but BAV is still pending.
- Client portal: read the latest BAV verification status from SECCL.
- Client portal: complete the Direct Debit mandate inline after BAV passes.
- Seccl - Accept product terms for a client product
- Post api v1 addons seccl addon sync client account uuid
- Post api v1 addons seccl addon sync plan plan uuid
- Seccl - Get a list of client products for the given account
- SmartSearch - Run a UKAML Check
- Transact - Account Opening
- Get list of advisers
- Addresses (v1)
- Addresses (v2)
-
Audit Log
- Get the firm's Audit tab entries
- Get a single Audit tab entry, for the entry's detail/view page
- Get the firm's marketplace (addon install/removal/permission-change) audit trail. See ENT-274.
- Export the firm's marketplace audit trail as a CSV, honouring every filter the index endpoint accepts.
- Get a single marketplace audit log entry, for the entry's detail/view page
- Audits
- Automation Blocks
-
Automation Blueprints
- Trigger automations through webhook
- Get all Automation Blueprints
- Create an Automation Blueprint
- Get a Automation Blueprint
- Update a Automation Blueprint
- Delete an Automation Blueprint
- Trigger and start running an automation
- Attach a webhook target to an automation blueprint
- Get all executions for a single automation blueprint
- Automation Execution Steps
- Automation Executions
- Bank Accounts
- Beneficiary
- Blueprint Steps
- Bulk Actions
- Business Metrics
- Business Units
-
Cases
- Get all client cases
- Get all cases
- Create a case
- Get a case
- Update a case
- Delete a case
- Add clients to a case
- Remove clients from a case
- Get all case statuses
- Create a case status
- Update a case status
- Delete a case status
- Get all case types
- Create a case type
- Get a case type
- Update a case type
- Delete a case type
- Checklists
- Circle Expenditures
-
Circles
- Get all circles
- Create a circle
- Get a circle
- Update a circle
- Delete a circle
- Get all emails for a circle
- Get all notes for a circle
- Get circle charge splits
- Get all Accounts for the Circle
- Get all form submissions for accounts in a circle
- Get all linked clients for clients of a circle
- Get Wealth summary of all accounts of a circle
- Get the fact-find access policies
- Update a fact-find policy
- Claim
- Client Statuses
-
Clients
- Get all clients [DEPRECATED: Use account route]
- Create a client [DEPRECATED: Use create an account route]
- Get a client [DEPRECATED: Use get an account route]
- Update a client [DEPRECATED: Use update an account route]
- Delete a client [DEPRECATED: use delete an account route]
- Get all client plans
- Get all linked clients for a client
- Create a client link
- Update a client link
- Delete a client link
- Retrieve the owners of the client with their personal details.
- Manage owners for the shared client.
- Update the personal details of one of the owners.
- Get all shared accounts the client belongs to.
- Get all fact-find requests the client owns.
- Create a wealth summary for the client.
- Get all of a client's new business events
- Get all the emails the client is a participant of.
- Get all the illustrations for a client
- Cloning
- Contact Details (v1)
- Contact Details (v2)
- Contributions
-
Conversations
- Get all account conversations
- Get all circle conversations
- Get all conversations of a case
- Create a conversation with inline files
- Get all conversations.
- Create a conversation.
- Get a conversation.
- Update a conversation.
- Delete a conversation
- Update notification settings for a conversation
- Leave a conversation
- Archive the conversation
- Unarchive the conversation
- Pin the conversation
- Add participants to conversation
- Remove participants from a conversation
- Promote participants to conversation admins
- Revoke admin privileges from conversation participants
- Create a message with inline files
- Get all messages
- Create a message
- Get a message
- Update a message
- Delete a message
- Get a messages edit history
- Cover
- Custom Default Folders
- Custom Fields
- Dependants (v1)
- Dependants (v2)
-
Document Builder
- Get available variables
- Get document templates
- Create a document template
- Get a document template
- Update a document template
- Delete a template
- Download Template as DOCX
- Update the DOCX content of a template
- Download Template as SFDT
- Download Template as PDF
- Generate Document Preview
- Get all documents
- Create a document
- Get a document
- Update a document
- Delete a document
- Download Document as DOCX
- Update the DOCX content of a document
- Download Document as SFDT
- Download Document as PDF
- Generate Document Preview
- Publish a document
- Document Packs
- Document Signing
- Employee
- Employment (V2)
- Employments
-
Endpoints
- Post api v1 migrate joint documents to circle
- Returns referral connections for the current firm with direction indicated.
- Creates a new referral connection request to another adviser using their referral code.
- Get api v1 referral connections referral connection uuid
- Deletes a pending referral connection. Only the sender can delete a connection request.
- Returns referrals for the current firm with direction indicated.
- Creates a new referral to share client data with a connected firm.
- Get api v1 referrals uuid
- Deletes a pending referral. Only the sender can delete a referral.
- Accepts a pending referral. Only the recipient firm can accept.
- Rejects a pending referral. Only the recipient firm can reject.
- Update Client in Conquest and redirect to Conquest to view client
- Create Plan in Conquest and return URL to view Conquest Client.
- Create Be-IQ Risk Profile Invitation
- Show the Be-IQ client
- Get the Microsoft Entra token from the PensionLabs SDK
- Get api v2 flux
-
Expenditures
- Get all Life Stages for a Firm
- Create a Life Stage for a Firm
- Retrieve a Life Stage for a Firm
- Update a Life Stage for a Firm
- Delete a Life Stages for a firm
- Reorder Life Stages for a firm
- Get Sections for Life Stages for a Firm
- Create a Section for a Life Stage for a Firm
- Get a Section for a Life Stage for a Firm
- Update a Section for a Life Stage for a Firm
- Delete a Section for a Life Stage for a Firm
- Reorder Life Stage Sections for a firm
- Update the custom expenditures setting across all uuids
- Get all the Fields for a Life Stage Section for a Firm
- Create a Field for a Life Stage Section for a Firm
- Get a Field for a Life Stage Section for a Firm
- Update a Field for a Life Stage Section for a Firm
- Delete a Field for a Life Stage Section for a Firm
- Reorder Life Stage Section Fields for a firm
- Get all expenditures including totals for a client
- Show an individual Expenditure
- Delete an Expenditure
- Sync joint expenditure to a circle
- Create or Update an Expenditure
- Create an Expenditure
- Update an Expenditure
- Delete api v1 client client uuid expenditure life stage uuid custom expenditure uuid
- FCA Numbers
- Fact-Find Blocks
- Fact-Find Question Conditions
- Fact-Find Questions
- Fact-Find Sections
- Fact-Find Sessions
- Fact-Find Template Question
-
Fact-Find Templates
- Get all fact-find templates
- Create a fact-find template
- Get a fact-find template
- Update a fact-find template
- Delete a fact-find template
- Clone a fact-find template
- Generate a fact-find snapshot PDF
- Print a blank copy of a fact-find template
- List the clients blocking edits to this template.
- List automations using fact find template.
- Publish a fact-find template.
- Unpublish a fact-find template — retires it from the picker so no new sessions can be created against it. Existing sessions are unaffected.
- Archive a fact-find template.
-
Fact-Finds
- Get all fact find requests for accounts in a circle [DEPRECATED: Use the v2 fact-find session routes]
- Get all fact-find schemas [DEPRECATED: Use the v2 fact-find template routes]
- Create a fact-find schema [DEPRECATED: Use the v2 fact-find template routes]
- Get a fact-find schema [DEPRECATED: Use the v2 fact-find template routes]
- Update a fact-find schema [DEPRECATED: Use the v2 fact-find template routes]
- Delete a fact-find schema [DEPRECATED: Use the v2 fact-find template routes]
- Archive a fact-find schema [DEPRECATED: Use the v2 fact-find template routes]
- Unarchive a fact-find schema [DEPRECATED: Use the v2 fact-find template routes]
- Get all sections for a fact-find schema [DEPRECATED: Use the v2 fact-find section routes]
- Create a schema section [DEPRECATED: Use the v2 fact-find section routes]
- Get a section for a schema [DEPRECATED: Use the v2 fact-find section routes]
- Update a schema section [DEPRECATED: Use the v2 fact-find section routes]
- Delete a schema section [DEPRECATED: Use the v2 fact-find section routes]
- Generate the PDF for a fact-find schema and save it to the client's documents. [DEPRECATED: Use the v2 fact-find template routes]
- Retrieve all the sections for the request [DEPRECATED: Use the v2 fact-find session routes]
- Update a given section progress [DEPRECATED: Use the v2 fact-find session routes]
- Get all fact-find requests for the user. [DEPRECATED: Use the v2 fact-find session routes]
- Create a fact-find request [DEPRECATED: Use the v2 fact-find session routes]
- Get a fact-find request [DEPRECATED: Use the v2 fact-find session routes]
- Delete a fact-find request [DEPRECATED: Use the v2 fact-find session routes]
- Complete a fact-find request for a given fact-find pass [DEPRECATED: Use the v2 fact-find session routes]
- Finish the fact-find request [DEPRECATED: Use the v2 fact-find session routes]
- Create an additional account on a client's fact-find [DEPRECATED: Use the v2 fact-find session routes]
- Features
- File Uploading
-
Filesystem
- Get root folder for a firm
- Get root folder for a client
- Get root folder for a circle
- Get root folder for an illustration
- Get root folder for a case
- Get conversation files
- Create a folder
- Get a folder
- Update and/or move folders
- Delete a folder
- Get all files in a folder
- Update folder permissions
- Get a folder structure
- View deleted files
- Assign file
- Get a file
- Update and/or move a file
- Delete a file
- Get all files on a documentable model
- Restore a file
- Copy a file
- Download a file.
- Download a file via a temporary URL
- Force delete a file
- Get root folder for a plan
- Firm
-
Firm Network Settings
- Get the firm's network settings
- Set the firm's override
- Revert the firm's override
- Get the firm's inherited governance rules
- Get the firm's configuration controls
Set the firm's configuration controls - Firms
-
Form Builder
- Get all forms
- Create a form
- Get a form
- Update a form
- Delete a form
- Get all Linked Questions
- Get all linked custom field questions
- Get all received form submission requests
- Get all sent form submission requests
- Get all submission requests on a form
- Get a submission request
- Delete a submission request
- Make a duplicate of an existing form
- Make a form live
- Make a live form no longer live (only works on forms with no submissions)
- Create a section for a form
- Get a form's section
- Update a form's section
- Delete a form's section
- Create a question for a section
- Get a question
- Update a section's question
- Delete a section's question
- Get all submissions for a form
- Create a submission to a form
- Get a submission
- Delete a submission
- Get all submission for a form authored by a specific account
- Get all answers for a submission
- Submit answers to a submission
- Change the form status to submitted
- Get all submission requests on a form
- Update a form submission request
- Delete a submission request
- Store a submission request
- Goals (v1)
- Goals (v2)
- Groups
- Holdings
- Illustrations
- Imports
- Income (v1)
- Income (v2)
-
Income Reconciliation
- Get all charges for a circle
- Get all expectations of circle
- Get all charges for a client
- Get all expectations of client
- Get all charges for a plan
- Get all expectations of plan
- Upload a provider statement CSV.
- Import a provider statement CSV.
- Get all provider statements
- Create a provider statement
- Get a provider statement
- Update a provider statement
- Delete a provider statement
- Upload a bank statement CSV.
- Get all bank statements
- Create a bank statement
- Get a bank statement
- Update a bank statement
- Delete a bank statement
- Get all charges
- Create a charge
- Get a charge
- Update a charge
- Delete a charge
- Calculate the income splits of an expectation
- Get all firm expectations
- Get an expectation
- Update an expectation
- Delete an expectation
- Get all statement transactions
- Create an statement transaction
- Get an statement transaction
- Update an statement transaction
- Delete an statement transaction
- Unreconcile the expectation
- Get all bank transactions
- Create a bank transaction
- Get a bank transaction
- Update a bank transaction
- Delete a bank transaction
- Reconcile an expectation to statement transactions
- Balance partially reconciled expectations
- Unbalance the expectation
- Reconcile bank payments to statement transactions
- Delete a reconciliation
- Create expectations
- Auto reconcile statement transactions
- Get all reconciliations on a bank transaction
- Get all reconciliations on an statement transaction
- Get all charge splits
- Create a charge split
- Get a charge split
- Update a charge split
- Delete a charge split
- Get all adviser splits
- Create an adviser split
- Get an adviser split
- Update an adviser split
- Delete an adviser split
- Get all charge split schemas
- Create a charge split schema
- Get a charge split schema
- Update a charge split schema
- Delete a charge split schema
- Introducer
- Lead Interests
- Lead Sources
- Letter of Authority
- Logins
- Logs
- Lookups
-
Mailboxes
- Display a list of mailboxes for the current firm.
- Store a new mailbox for the current firm and return the form link to authenticate the mailbox.
- Update the specified mailbox.
- Remove the specified mailbox.
- Display the mailbox folders.
- Re-authenticate a mailbox.
- Display the specified email.
- Delete the specified mailbox message.
- Delete the specified mailbox message thread.
- Model
- Model Types
- Mortgage Searches (v2)
- Mortgage Sourcing
- Networth
- New Business Events
- Notes
- Notifications
- OAuth2 Connections (External Only)
- Plan Returns
-
Plans
- Get all plans
- Create a plan
- Get a plan
- Update a plan
- Delete a plan.
- Update a plan's ownership without updating the rest of the plan
- Get the valuations formatted for a graph
- Get all plan's new business events
- Get all group scheme members
- Create a group scheme member
- Get all sub schemes for a group scheme
- Create a sub-scheme for a group scheme plan
- Request Plan Data From Provider (Beta)
- Get all the provider feed logs for a given plan
- Get all the illustrations for a plan
- Get all linked policy numbers
- Create an linked policy number
- Update an linked policy number
- Delete an linked policy number
- Plans (v2)
- Platform
- Portal Engagement
- Premiums
- Providers
- Report Templates
- Report Types
- Reports
- Risks (v1)
- Risks (v2)
- Roles (v2)
- Service Levels
- Shareholders
- Staff Members
- Statements
-
Static Data
- Get a list of boolean choices
- Get a list of occupations
- Get a list of supported nationalities
- Get a list of addon categories
- Retrieve a list of all the plan type
- Retrieve the plan sub-types for a given plan type
- Plan statuses
- Get a list of plan inactivity reasons
- Get a list of transaction types and sub-types
- Get the subtypes for a transaction type
- Get a list of charge categories
- Get a list of RMAR types
- Get a list of service types
- Get a list of modelable types for logs
- Get a list of contribution types
- Get a list of advice types
- Get a list of options for new business event conducted by
- Get a list of options for new business event status
- Get a list of options for new business event source of funds
- Get a list of Frequency types
- Get a list of employee departments
- Get a list of crystallisation reasons
- Get a list of interest types
- Get a list of property types
- Get a list of repayment types
- Get a list of repayment methods
- Get a list of term types
- Get a list of transfer types
- Get a list of source of premiums
- Get a list of premium payment methods
- Get a list of cover types for the specific plan type.
- Get a list of file extensions
- Get a list of all reports
- Get a list of options for client regulatory classifications
- Get a list of all LookupTypes
- Get a list of all CheckStatuses
- Get a list of all CheckOutcomes
- Get a list of all states of health
- Get a list of all vulnerability types
- Get a list of all vulnerability sub-types
- Get a list of all vulnerability durations
- Get a list of all webhook subscription events.
- Get a list of relationship types with their inverse pairings
- Get a list of all titles
- Get a list of dependant relationship types
- Get a list of portal access statuses
- Get a list of all RBAC permissions grouped by resource type
- Sub Account Portfolios
- Sub Accounts
- Tagging
- Task Statuses
- Tasks
- Time Entries
- Transaction
- Transactions (v2)
- User Management
- Valuations
- Valuations (V2)
- Webhook Subscriptions
- Withdrawals
-
Workflows
- Get all workflows
- Create a workflow
- Get a workflow
- Update a workflow
- Delete a workflow
- Render a tree of the structure of the workflow.
- Render breadcrumbs of the structure of the workflow.
- Get all workflow tasks
- Create a workflow task
- Get a workflow task
- Update a workflow task
- Delete a workflow task
- Add a participant to the workflow task
- Remove a participant from a workflow task
- Run a workflow
PUT
https://api.plannrcrm.com/api/v1/firm/{firm_uuid}/network-settings/{key}/configuration-controls
https://api.plannrcrm.com
{var_value}
{description}
{description}
Set the firm's configuration controls
Enables or disables sub-firm and/or adviser configuration for a setting. Disabling sub-firm configuration removes the value it allowed the firms below it to hold, with an audit entry and an in-app notice to each affected firm's admins.
Authentication:
PUT
/api/v1/firm/{firm_uuid}/network-settings/{key}/configuration-controls
Loading...
Response
API Access Denied: you may need to authenticate first. If the issue persists, please contact the API maintainer.
Waiting for a request to be sent.