Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API Explorer API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
PlannrCRM logo

Topics

  • Introduction
  • Authentication

Endpoints

  • AML Checks
    • Get all checks GET
    • Create a check POST
    • Show a check GET
    • Update a check PUT
    • Destroy a check DELETE
  • Account
    • Get all accounts GET
    • Create an account POST
    • Get an account GET
    • Update an account PUT
    • Delete an account DELETE
  • Actions
    • Get all Actions belonging to an account GET
  • Addon Subscriptions
    • Get all addon subscriptions GET
    • Subscribe to an addon POST
    • Get an addon subscription GET
    • Update the configuration on an addon subscription PUT
    • Unsubscribe from an addon DELETE
    • Enable an addon POST
    • Disable an addon POST
    • Confirm an addon payment POST
  • Addons
    • Get all available addons GET
    • Initiate a sync to pull all clients from Nucleus POST
    • Initiate a sync to pull all plans from Nucleus POST
    • Seccl - Sync all the clients POST
    • Seccl - Sync all the plans POST
    • Seccl - Get a list of Seccl Nodes for the firm GET
    • Seccl - Store an adviser node association POST
    • Seccl - Search assets on Seccl GET
    • Seccl - Get the seccl client associated with the account GET
    • Seccl - Update the seccl client PATCH
    • Seccl - List scheme products on Seccl GET
    • Get api v1 addons seccl addon direct debit mandate GET
    • Post api v1 addons seccl addon direct debit mandate POST
    • Post api v1 addons seccl addon sync client account uuid POST
    • Post api v1 addons seccl addon sync plan plan uuid POST
    • Fundment - Sync all the clients POST
    • Fundment - Sync all the plans (goals) POST
    • SmartSearch - Run a UKAML Check POST
    • Transact - Account Opening POST
  • Addresses (v1)
    • Get all account addresses GET
    • Create an address POST
    • Get an address GET
    • Update an address PUT
    • Delete an address DELETE
  • Addresses (v2)
    • Get all addresses GET
    • Create an address POST
    • Get an address GET
    • Update an address PUT
    • Delete an address DELETE
  • Audits
    • Get all audits made by authenticated employee GET
    • Get all audits made by an employee GET
    • Get all audits for the firm GET
    • Get all audits attached to a model GET
  • Automation Blocks
    • Get all Automation block information that can be used for blueprint steps GET
    • Get all trigger types for automation blocks GET
  • Automation Blueprints
    • Trigger automations through webhook POST
    • Get all Automation Blueprints GET
    • Create an Automation Blueprint POST
    • Get a Automation Blueprint GET
    • Update a Automation Blueprint PUT
    • Delete an Automation Blueprint DELETE
    • Trigger and start running an automation POST
    • Attach a webhook target to an automation blueprint POST
    • Get all executions for a single automation blueprint GET
  • Automation Execution Steps
    • Stop an automation step POST
    • Start an automation step POST
  • Automation Executions
    • Get all automation executions for an automation blueprint GET
    • Get an automation execution GET
  • Bank Accounts
    • Get all bank accounts GET
    • Create a bank account POST
    • Get a bank account GET
    • Update a bank account PUT
    • Delete a bank account DELETE
  • Beneficiary
    • Get all beneficiaries of a plan GET
    • Create beneficiary for a plan POST
    • Get a beneficiary of a plan GET
    • Update a beneficiary of a plan PUT
    • Delete beneficiary of a plan DELETE
  • Blueprint Steps
    • Get all Blueprint Steps on an automation blueprint GET
    • Create a Blueprint Step POST
    • Get a Blueprint Step GET
    • Update a Blueprint Step (this also moves the step if a new parent is specified) PUT
    • Delete a Blueprint Step DELETE
  • Bulk Actions
    • Get all bulk actions on the firm GET
    • Show a bulk action. GET
    • Execute a bulk action POST
  • Business Metrics
    • Assets Under Management GET
    • Cases GET
    • Cases Completed GET
    • Clients GET
    • Conversations GET
    • Documents Generated GET
    • Fact Finds Sent GET
    • Files Uploaded GET
    • Introducers GET
    • Messages Sent GET
    • Plans GET
    • Signatures GET
    • Tasks GET
    • Tasks Completed GET
    • Time Logged GET
  • Cases
    • Get all client cases GET
    • Get all cases GET
    • Create a case POST
    • Get a case GET
    • Update a case PUT
    • Delete a case DELETE
    • Add clients to a case POST
    • Remove clients from a case DELETE
    • Get all case statuses GET
    • Create a case status POST
    • Update a case status PUT
    • Delete a case status DELETE
    • Get all case types GET
    • Create a case type POST
    • Get a case type GET
    • Update a case type PUT
    • Delete a case type DELETE
  • Circles
    • Get all circles GET
    • Create a circle POST
    • Get a circle GET
    • Update a circle PUT
    • Delete a circle DELETE
    • Get all emails for a circle GET
    • Get all notes for a circle GET
    • Get circle charge splits GET
    • Get all Accounts for the Circle GET
    • Get all form submissions for accounts in a circle GET
    • Get all linked clients for clients of a circle GET
    • Get Wealth summary of all accounts of a circle GET
    • Get the fact-find access policies GET
    • Update a fact-find policy PUT
  • Claim
    • Get all claims of a plan GET
    • Create claim for a plan POST
    • Get claim of a plan GET
    • Update claim of a plan PUT
    • Delete claim of a plan DELETE
  • Client Statuses
    • Get all client statuses GET
    • Create a client status POST
    • Get a client status GET
    • Update a client status PUT
    • Delete a client status DELETE
    • Transfer clients from one status to another status POST
  • Clients
    • Get all clients [DEPRECATED: Use account route] GET
    • Create a client [DEPRECATED: Use create an account route] POST
    • Get a client [DEPRECATED: Use get an account route] GET
    • Update a client [DEPRECATED: Use update an account route] PUT
    • Delete a client [DEPRECATED: use delete an account route] DELETE
    • Get all client plans GET
    • Get all linked clients for a client GET
    • Create a client link POST
    • Update a client link PUT
    • Delete a client link DELETE
    • Retrieve the owners of the client with their personal details. GET
    • Manage owners for the shared client. POST
    • Update the personal details of one of the owners. PUT
    • Get all shared accounts the client belongs to. GET
    • Get all fact-find requests the client owns. GET
    • Create a wealth summary for the client. GET
    • Get all of a client's new business events GET
    • Get all the emails the client is a participant of. GET
    • Get all the illustrations for a client GET
  • Cloning
    • Clone a model POST
  • Contact Details (v1)
    • Get all account contact details GET
    • Create a contact detail POST
    • Get a contact detail GET
    • Update a contact detail PUT
    • Delete a contact detail DELETE
  • Contact Details (v2)
    • Get all contact details GET
    • Create a contact detail POST
    • Get a contact detail GET
    • Update a contact detail PUT
    • Delete a contact detail DELETE
  • Contributions
    • Create a contribution [DEPRECATED: Use transaction routes] POST
    • Get a contribution [DEPRECATED: Use transaction routes] GET
    • Update a contribution [DEPRECATED: Use transaction routes] PUT
    • Delete a contribution [DEPRECATED: Use transaction routes] DELETE
    • Get all contributions [DEPRECATED: Use transaction routes] GET
  • Conversations
    • Retrieve the mentionable accounts for a conversation. POST
    • Get all account conversations GET
    • Get all circle conversations GET
    • Get all conversations of a case GET
    • Get all conversations. GET
    • Create a conversation. POST
    • Get a conversation. GET
    • Update a conversation. PUT
    • Delete a conversation DELETE
    • Update notification settings for a conversation POST
    • Leave a conversation DELETE
    • Archive the conversation POST
    • Unarchive the conversation POST
    • Pin the conversation POST
    • Add participants to conversation POST
    • Remove participants from a conversation DELETE
    • Promote participants to conversation admins POST
    • Revoke admin privileges from conversation participants DELETE
    • Create a message with inline files POST
    • Get all messages GET
    • Create a message POST
    • Get a message GET
    • Update a message PUT
    • Delete a message DELETE
    • Get a messages edit history GET
  • Cover
    • Get all covers of a plan GET
    • Create cover for a plan POST
    • Get cover of a plan GET
    • Update cover of a plan PUT
    • Delete cover of a plan DELETE
  • Custom Default Folders
    • Get all custom default folders GET
    • Create a custom default folder POST
    • Get a custom default folder GET
    • Update a custom default folder PUT
    • Delete a custom default folder DELETE
  • Custom Fields
    • Get all custom fields GET
    • Create a custom field POST
    • Get a custom field GET
    • Update a custom field PUT
    • Delete a custom field DELETE
  • Dependants (v1)
    • Get all dependants GET
    • Create a dependant POST
    • Get a dependant GET
    • Update a dependant PUT
    • Delete a dependant DELETE
  • Dependants (v2)
    • Get all dependants GET
    • Create a dependant POST
    • Get a dependant GET
    • Update a dependant PUT
    • Delete a dependant DELETE
  • Document Builder
    • Get available variables GET
    • Get document templates GET
    • Create a document template POST
    • Get a document template GET
    • Update a document template PUT
    • Delete a template DELETE
    • Download Template as DOCX GET
    • Update the DOCX content of a template POST
    • Download Template as SFDT GET
    • Download Template as PDF GET
    • Generate Document Preview GET
    • Get all documents GET
    • Create a document POST
    • Get a document GET
    • Update a document PUT
    • Delete a document DELETE
    • Download Document as DOCX GET
    • Update the DOCX content of a document POST
    • Download Document as SFDT GET
    • Download Document as PDF GET
    • Generate Document Preview GET
    • Publish a document POST
  • Document Packs
    • Get all document packs GET
    • Create a document pack POST
    • Get a document pack GET
    • Update a document pack PUT
    • Delete a document pack DELETE
  • Document Signing
    • Get all client signature transactions GET
    • Get all signature transactions GET
    • Launch document signing POST
    • Get a signature transaction GET
  • Employee
    • Get all employees GET
    • Create an employee [DEPRECATED: Use create an account route] POST
    • Get an employee [DEPRECATED: Use get an account route] GET
    • Update an employee [DEPRECATED: Use update an account route] PUT
    • Delete an employee [DEPRECATED: use delete an account route] DELETE
  • Employment (V2)
    • List Employments GET
    • Create an Employment POST
    • Get an employment GET
    • Update an Employment PUT
    • Delete an employment DELETE
  • Employments
    • Get all employments GET
    • Create an employment POST
    • Get an employment GET
    • Update an employment PUT
    • Delete an employment DELETE
  • Endpoints
    • Get all personal access tokens GET
    • Create a personal access token POST
    • Delete a personal access token DELETE
    • Get api v1 migrate joint logins GET
    • Post api v1 migrate joint logins joint account login uuid POST
    • Post api v1 migrate joint documents to circle POST
    • Update Client in Conquest and redirect to Conquest to view client PUT
    • Create Plan in Conquest and return URL to view Conquest Client. POST
    • Create Be-IQ Risk Profile Invitation POST
    • Show the Be-IQ client GET
    • Retrieve a front-end access token to retrieve the Be-IQ front-end data GET
    • Get the Microsoft Entra token from the PensionLabs SDK POST
    • Get api v2 flux GET
  • Expenditures
    • Get all Life Stages for a Firm GET
    • Create a Life Stage for a Firm POST
    • Retrieve a Life Stage for a Firm GET
    • Update a Life Stage for a Firm PUT
    • Delete a Life Stages for a firm DELETE
    • Reorder Life Stages for a firm POST
    • Get Sections for Life Stages for a Firm GET
    • Create a Section for a Life Stage for a Firm POST
    • Get a Section for a Life Stage for a Firm GET
    • Update a Section for a Life Stage for a Firm PUT
    • Delete a Section for a Life Stage for a Firm DELETE
    • Reorder Life Stage Sections for a firm POST
    • Update the custom expenditures setting across all uuids POST
    • Get all the Fields for a Life Stage Section for a Firm GET
    • Create a Field for a Life Stage Section for a Firm POST
    • Get a Field for a Life Stage Section for a Firm GET
    • Update a Field for a Life Stage Section for a Firm PUT
    • Delete a Field for a Life Stage Section for a Firm DELETE
    • Reorder Life Stage Section Fields for a firm POST
    • Get all expenditures including totals for a client GET
    • Show an individual Expenditure GET
    • Delete an Expenditure DELETE
    • Create or Update an Expenditure POST
    • Create an Expenditure POST
    • Update an Expenditure POST
    • Delete api v1 client client uuid expenditure life stage uuid custom expenditure uuid DELETE
  • FCA Numbers
    • Get all FCA Numbers for a Firm GET
    • Create an FCA Number for a Firm POST
    • Delete an unverified FCA Number for a Firm DELETE
  • Fact-Finds
    • Get all fact find requests for accounts in a circle GET
    • Get all fact-find schemas GET
    • Create a fact-find schema POST
    • Get a fact-find schema GET
    • Update a fact-find schema PUT
    • Delete a fact-find schema DELETE
    • Archive a fact-find schema POST
    • Archive a fact-find schema POST
    • Get all sections for a fact-find schema GET
    • Create a schema section POST
    • Get a section for a schema GET
    • Update a schema section PUT
    • Delete a schema section DELETE
    • Generate the PDF for a fact-find schema and save it to the client's documents. POST
    • Retrieve all the sections for the request GET
    • Update a given section progress POST
    • Get all fact-find requests for the user. GET
    • Create a fact-find request POST
    • Get a fact-find request GET
    • Delete a fact-find request DELETE
    • Complete a fact-find request for a given fact-find pass POST
    • Finish the fact-find request POST
    • Create an additional account on a client's fact-find POST
  • File Uploading
    • Create the file records for all files added to the Filepond queue. POST
    • Upload the file POST
    • Revert the file uploading DELETE
    • Directly upload a file. POST
  • Filesystem
    • Get root folder for a firm GET
    • Get root folder for a client GET
    • Get root folder for a circle GET
    • Get root folder for an illustration GET
    • Get root folder for a case GET
    • Get conversation files GET
    • Create a folder POST
    • Get a folder GET
    • Update and/or move folders PUT
    • Delete a folder DELETE
    • Get all files in a folder GET
    • Update folder permissions POST
    • Get a folder structure GET
    • View deleted files GET
    • Assign file POST
    • Get a file GET
    • Update and/or move a file PUT
    • Delete a file DELETE
    • Get all files on a documentable model GET
    • Restore a file PUT
    • Copy a file PUT
    • Download a file. GET
    • Download a file via a temporary URL GET
    • Force delete a file DELETE
    • Get root folder for a plan GET
  • Firms
    • Get all firms GET
    • Get a firm GET
    • Update a firm PUT
    • Delete a firm DELETE
    • Update firm branding POST
    • Update firm settings POST
  • Form Builder
    • Get all forms GET
    • Create a form POST
    • Get a form GET
    • Update a form PUT
    • Delete a form DELETE
    • Get all Linked Questions GET
    • Get all linked custom field questions GET
    • Get all received form submission requests GET
    • Get all sent form submission requests GET
    • Get all submission requests on a form GET
    • Get a submission request GET
    • Delete a submission request DELETE
    • Make a duplicate of an existing form POST
    • Make a form live POST
    • Make a live form no longer live (only works on forms with no submissions) POST
    • Create a section for a form POST
    • Get a form's section GET
    • Update a form's section PUT
    • Delete a form's section DELETE
    • Create a question for a section POST
    • Get a question GET
    • Update a section's question PUT
    • Delete a section's question DELETE
    • Get all submissions for a form GET
    • Create a submission to a form POST
    • Get a submission GET
    • Delete a submission DELETE
    • Get all submission for a form authored by a specific account GET
    • Get all answers for a submission GET
    • Submit answers to a submission POST
    • Change the form status to submitted POST
    • Get all submission requests on a form GET
    • Update a form submission request PUT
    • Delete a submission request DELETE
    • Store a submission request POST
  • Goals (v1)
    • Get all goals GET
    • Create a goal POST
    • Show a goal GET
    • Update a goal PUT
    • Destroy a goal DELETE
  • Goals (v2)
    • Get all goals GET
    • Create a goal POST
    • Show a goal GET
    • Update a goal PUT
    • Delete a goal DELETE
  • Groups
    • Get all account groups GET
    • Get all groups GET
    • Create a group POST
    • Get a group GET
    • Update a group PUT
    • Delete a group DELETE
    • Get a group's participants GET
    • Add participants to a group POST
    • Remove participants from a group DELETE
  • Holdings
    • Create a holding POST
    • Get a holding GET
    • Update a holding PUT
    • Delete a holding DELETE
    • Sync Holdings on a Sub Account POST
    • Get all holdings GET
  • Illustrations
    • Store an illustration POST
    • Show an illustration GET
    • Update an Illustration PUT
    • Delete an illustration DELETE
    • Proceed an illustration to account opening application POST
    • Generate an Illustration POST
  • Imports
    • Get all imports GET
    • Create the import POST
    • Get an import GET
    • Delete an import DELETE
    • Get importer keys GET
    • Get available modes for import type GET
    • Map headers on an import POST
    • Start an import POST
  • Income (v1)
    • Get all incomes GET
    • Create an income POST
    • Get an income GET
    • Update an income PUT
    • Delete an income DELETE
  • Income (v2)
    • Get all incomes GET
    • Create an income POST
    • Get an income GET
    • Update an income PUT
    • Delete an income DELETE
  • Income Reconciliation
    • Get all charges for a circle GET
    • Get all expectations of circle GET
    • Get all charges for a client GET
    • Get all expectations of client GET
    • Get all charges for a plan GET
    • Get all expectations of plan GET
    • Upload a provider statement CSV. POST
    • Get all provider statements GET
    • Create a provider statement POST
    • Get a provider statement GET
    • Update a provider statement PUT
    • Delete a provider statement DELETE
    • Upload a bank statement CSV. POST
    • Get all bank statements GET
    • Create a bank statement POST
    • Get a bank statement GET
    • Update a bank statement PUT
    • Delete a bank statement DELETE
    • Get all charges GET
    • Create a charge POST
    • Get a charge GET
    • Update a charge PUT
    • Delete a charge DELETE
    • Calculate the income splits of an expectation POST
    • Get all firm expectations GET
    • Get an expectation GET
    • Update an expectation PUT
    • Delete an expectation DELETE
    • Get all statement transactions GET
    • Create an statement transaction POST
    • Get an statement transaction GET
    • Update an statement transaction PUT
    • Delete an statement transaction DELETE
    • Unreconcile the expectation POST
    • Get all bank transactions GET
    • Create a bank transaction POST
    • Get a bank transaction GET
    • Update a bank transaction PUT
    • Delete a bank transaction DELETE
    • Reconcile an expectation to statement transactions POST
    • Balance partially reconciled expectations POST
    • Unbalance the expectation POST
    • Reconcile bank payments to statement transactions POST
    • Delete a reconciliation DELETE
    • Create expectations POST
    • Auto reconcile statement transactions POST
    • Get all reconciliations on a bank transaction GET
    • Get all reconciliations on an statement transaction GET
    • Get all charge splits GET
    • Create a charge split POST
    • Get a charge split GET
    • Update a charge split PUT
    • Delete a charge split DELETE
    • Get all adviser splits GET
    • Create an adviser split POST
    • Get an adviser split GET
    • Update an adviser split PUT
    • Delete an adviser split DELETE
    • Get all charge split schemas GET
    • Create a charge split schema POST
    • Get a charge split schema GET
    • Update a charge split schema PUT
    • Delete a charge split schema DELETE
  • Introducer
    • Get all introducers GET
    • Create an introducer [Deprecated: Use create an account route] POST
    • View an introducer [Deprecated: Use get an account route] GET
    • Update an introducer [Deprecated: Use update an account route] PUT
    • Delete an introducer [Deprecated: use delete an account route] DELETE
  • Logins
    • Get all logins of an account. GET
    • Create a login POST
    • Update a login PUT
    • Revoke a login DELETE
    • Expire a login POST
    • Make a login the primary for the account POST
  • Logs
    • Get logs authored by another account GET
    • Get all logs for a model GET
    • Get all logs created by Authenticated Account GET
  • Lookups
    • Get all lookups GET
    • Delete a lookup DELETE
    • Retrieve a lookup GET
  • Mailboxes
    • Display a list of mailboxes for the current firm. GET
    • Store a new mailbox for the current firm and return the form link to authenticate the mailbox. POST
    • Update the specified mailbox. PUT
    • Remove the specified mailbox. DELETE
    • Display the mailbox folders. GET
    • Re-authenticate a mailbox. GET
    • Display the specified email. GET
    • Delete the specified mailbox message. DELETE
    • Delete the specified mailbox message thread. DELETE
  • Miscellaneous
    • Get the application's state. GET
  • Model
    • Get all firm's direct debit mandates GET
    • Get a single direct debit mandate GET
    • Get a single direct debit mandate view GET
    • Post api v2 direct debit mandates direct debit mandate uuid complete POST
  • Model Types
    • Custom field models GET
    • Time trackable models GET
  • Navigation
    • Return the data needed to build up the URL for front end for a given model and UUID. GET
  • Network Management
    • Network charges GET
  • Networth
    • Get net worth GET
    • Get net worth line graph GET
  • New Business Events
    • Get all new business events GET
    • Create a new business event POST
    • Get a new business event GET
    • Update a new business event PUT
    • Delete a new business event DELETE
  • Notes
    • Get accounts available to be mentioned POST
    • Get all notes for a client GET
    • Create a note POST
    • Get a note GET
    • Update a note PUT
    • Delete a note DELETE
    • Get all notes GET
  • Notifications
    • Subscribe to an item's notifications POST
    • Unsubscribe from an item's notifications POST
    • Mark all notification as read POST
    • Mark a notification as read POST
    • Mark a notification as unread POST
    • Get all notifications GET
    • Get a notification GET
    • Permanently delete a notification DELETE
  • OAuth2 Connections (External Only)
    • List all the available OAuth2 providers GET
    • List all OAuth2 connections GET
    • Update an OAuth2 connection PUT
    • Delete an OAuth2 connection DELETE
  • Plan Returns
    • Calculate returns for a plan within a date range GET
  • Plans
    • Get all plans GET
    • Create a plan POST
    • Get a plan GET
    • Update a plan PUT
    • Delete a plan DELETE
    • Update a plan's ownership without updating the rest of the plan PUT
    • Get the valuations formatted for a graph GET
    • Get all plan's new business events GET
    • Get all group scheme members GET
    • Create a group scheme member POST
    • Get all sub schemes for a group scheme GET
    • Create a sub-scheme for a group scheme plan POST
    • Request Plan Data From Provider (Beta) POST
    • Get all the provider feed logs for a given plan GET
    • Get all the illustrations for a plan GET
  • Plans (v2)
    • Get all plans GET
    • Get line graph of plans valuations GET
  • Platform
    • Show Platform Detail GET
    • Get all models for a supported platform. GET
  • Premiums
    • Get all premiums GET
    • Create a premium POST
    • Get a premium GET
    • Update a premium PUT
    • Delete a premium DELETE
  • Providers
    • List all providers GET
    • Get an individual provider GET
  • Reactions
    • Create a reaction POST
    • Delete a reaction DELETE
  • Report Templates
    • Get all Report Templates GET
    • Create a Report Template POST
    • Get a Report Template GET
    • Update a Report Template PUT
    • Delete a Report Template DELETE
  • Report Types
    • Get all Report Types GET
  • Reports
    • Get All Reports GET
    • Generate a new Report POST
    • Get Report GET
    • Delete a Report DELETE
  • Risks (v1)
    • Get all risks for Client GET
    • Create a risk assessment POST
    • Show a risk assessment GET
    • Update a risk assessment PUT
    • Delete a risk assessment DELETE
  • Risks (v2)
    • Get all risks GET
    • Create a risk POST
    • Get a risk GET
    • Update a risk PUT
    • Delete a risk DELETE
  • Search
    • Typesense multi searching GET
    • Postcode Searching POST
  • Shareholders
    • Get all shareholders GET
    • Create a shareholder POST
    • Show a shareholder GET
    • Update a shareholder PUT
    • Destroy a shareholder DELETE
  • Staff Members
    • Get all staff members GET
    • Create a staff member POST
    • Get a staff member GET
    • Update a staff member PUT
    • Delete a staff member DELETE
  • Statements
    • Get all statements GET
    • Get a statement GET
    • Lock a statement POST
    • Unlock a statement POST
  • Static Data
    • Get a list of boolean choices GET
    • Get a list of occupations GET
    • Get a list of supported nationalities GET
    • Get a list of addon categories GET
    • Retrieve a list of all the plan type GET
    • Retrieve the plan sub-types for a given plan type GET
    • Plan statuses GET
    • Get a list of plan inactivity reasons GET
    • Get a list of transaction types and sub-types GET
    • Get the subtypes for a transaction type GET
    • Get a list of charge categories GET
    • Get a list of RMAR types GET
    • Get a list of service types GET
    • Get a list of modelable types for logs GET
    • Get a list of contribution types GET
    • Get a list of advice types GET
    • Get a list of options for new business event conducted by GET
    • Get a list of options for new business event status GET
    • Get a list of options for new business event source of funds GET
    • Get a list of Frequency types GET
    • Get a list of employee departments GET
    • Get a list of crystallisation reasons GET
    • Get a list of interest types GET
    • Get a list of property types GET
    • Get a list of repayment types GET
    • Get a list of repayment methods GET
    • Get a list of term types GET
    • Get a list of transfer types GET
    • Get a list of source of premiums GET
    • Get a list of premium payment methods GET
    • Get a list of cover types for the specific plan type. GET
    • Get a list of file extensions GET
    • Get a list of all reports GET
    • Get a list of options for client regulatory classifications GET
    • Get a list of all LookupTypes GET
    • Get a list of all CheckStatuses GET
    • Get a list of all CheckOutcomes GET
    • Get a list of all states of health GET
    • Get a list of all webhook subscription events. GET
    • Get a list of all titles GET
  • Sub Account Portfolios
    • Get all portfolios GET
    • Create a portfolio POST
    • Get a portfolio GET
    • Update a portfolio PUT
    • Delete a portfolio DELETE
  • Sub Accounts
    • Get all sub accounts GET
    • Create a sub account POST
    • Get a sub account GET
    • Update a sub account PUT
    • Delete a sub account DELETE
  • Tagging
    • Get all tags GET
    • Add tags to company You can provide an array of tags in various formats. POST
    • Update a tag PUT
    • Delete a tag DELETE
  • Task Statuses
    • Get all task statuses in a firm GET
    • Create a task status POST
    • Get a task status GET
    • Update a task status PUT
    • Delete a task status DELETE
  • Tasks
    • Get all tasks on a firm. GET
    • Create a task POST
    • Get a task GET
    • Update a task PUT
    • Delete a task DELETE
    • Complete a task PATCH
    • Archive PATCH
    • Uncomplete a task PATCH
    • Archive PATCH
  • Time Entries
    • Get all time entries for a circle GET
    • Get all time entries for a client GET
    • Create a time entry POST
    • Get a time entry GET
    • Update a time entry PUT
    • Delete a time entry DELETE
    • Get time entries GET
    • Stop a time entry POST
  • Transaction
    • Get all transactions GET
    • Create a transaction POST
    • Get a transaction GET
    • Update a transaction PUT
    • Delete a transaction DELETE
    • Get a summary of the transaction schedules GET
    • Get all transaction schedules GET
    • Create a transaction schedule POST
    • Get a transaction schedule GET
    • Update a transaction schedule PUT
    • Delete a transaction schedule DELETE
  • Transactions (v2)
    • Get all transactions GET
  • Unipass Certificates
    • Get the Unipass certificate GET
    • Store the Unipass certificate POST
    • Delete the Unipass certificate DELETE
  • User Management
    • Get the authenticated user GET
    • Update the authenticated user PUT
    • Get all logins for the authenticated user GET
    • List all fact-find passes for the user GET
    • Switch user accounts POST
    • Store Firebase notification tokens POST
    • Delete api v1 mobile notification token DELETE
    • Remotely revoke an integration POST
    • Get the welcome widget tasks for the authenticated user GET
    • Update a welcome widget task for the given user POST
  • Valuations
    • Create a valuation POST
    • Get a valuation GET
    • Update a valuation PUT
    • Delete a valuation DELETE
    • Get all valuations GET
  • Valuations (V2)
    • Bulk insert valuations POST
  • Webhook Subscriptions
    • Get all webhook subscriptions GET
    • Create a webhook subscription POST
    • Get a webhook subscription GET
    • Update a webhook subscription PUT
    • Delete a webhook subscription DELETE
    • Get all calls made to a given webhook subscription GET
    • Retry the existing Webhook Call POST
  • Withdrawals
    • Create a withdrawal [DEPRECATED: Use transaction routes] POST
    • Get a withdrawal [DEPRECATED: Use transaction routes] GET
    • Update a withdrawal [DEPRECATED: Use transaction routes] PUT
    • Delete a withdrawal [DEPRECATED: Use transaction routes] DELETE
    • Get all withdrawals [DEPRECATED: Use transaction routes] GET
  • Workflows
    • Get all workflows GET
    • Create a workflow POST
    • Get a workflow GET
    • Update a workflow PUT
    • Delete a workflow DELETE
    • Render a tree of the structure of the workflow. GET
    • Render breadcrumbs of the structure of the workflow. GET
    • Get all workflow tasks GET
    • Create a workflow task POST
    • Get a workflow task GET
    • Update a workflow task PUT
    • Delete a workflow task DELETE
    • Add a participant to the workflow task POST
    • Remove a participant from a workflow task DELETE
    • Run a workflow POST
Powered by Bump.sh
API Explorer API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
PlannrCRM logo

Income (v1)

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown

APIs for managing income