{"openapi":"3.0.3","info":{"title":"Plannr API Documentation","description":"Version v1.110.0","version":"v1.110.0"},"servers":[{"url":"https://api.plannrcrm.com"}],"tags":[{"name":"AML Checks","description":"\nAPIs for managing a client's AML (anti-money laundering) checks"},{"name":"Account","description":"\nAPIs for managing Accounts"},{"name":"Actions","description":"\nApi endpoint for all Actions belonging to an account"},{"name":"Addon Subscriptions","description":"\nAPIs for managing Addon Subscriptions"},{"name":"Addons","description":"\nAPIs for managing addons"},{"name":"Addresses (v1)","description":"\nAPIs for managing account addresses"},{"name":"Addresses (v2)","description":"\nAPIs for managing addresses"},{"name":"Audits","description":"\nView audits of records"},{"name":"Automation Blocks","description":"\nAPIs for managing Automation Blocks and Triggers"},{"name":"Automation Blueprints","description":"\nAPIs for managing Automation Blueprints"},{"name":"Automation Execution Steps","description":""},{"name":"Automation Executions","description":"\nAPIs for managing models"},{"name":"Bank Accounts","description":"\nAPIs for managing bank accounts"},{"name":"Beneficiary","description":"\nAPIs for beneficiaries of a plan"},{"name":"Blueprint Steps","description":"\nAPIs for managing Blueprint Steps"},{"name":"Bulk Actions","description":"\nAPIs for managing bulk actions"},{"name":"Business Metrics","description":""},{"name":"Business Units","description":""},{"name":"Cases","description":"\nAPIs for managing case statuses"},{"name":"Circle Expenditures","description":"\nAPIs for managing a circle's shared expenditures"},{"name":"Circles","description":"\nAPIs for managing circles"},{"name":"Claim","description":"\nAPIs for claims of a plan"},{"name":"Client Statuses","description":"\nAPIs for managing client statuses"},{"name":"Clients","description":"\nAPIs for managing clients"},{"name":"Cloning","description":"\nAPIs for cloning models"},{"name":"Contact Details (v1)","description":"\nAPIs for managing account contact details"},{"name":"Contact Details (v2)","description":"\nAPIs for managing contact details"},{"name":"Contributions","description":""},{"name":"Conversations","description":""},{"name":"Cover","description":"\nAPIs for covers of a plan"},{"name":"Custom Default Folders","description":"\nAPIs for managing custom default folders for clients/cases"},{"name":"Custom Fields","description":"\nAPIs for managing custom fields"},{"name":"Dependants (v1)","description":"\nAPIs for managing dependants"},{"name":"Dependants (v2)","description":"\nAPIs for managing dependants"},{"name":"Document Builder","description":"\nAPIs for managing documents"},{"name":"Document Packs","description":"\nManage Document Packs for Document Signing."},{"name":"Document Signing","description":"\nAPIs for managing document signing"},{"name":"Employee","description":"\nAPIs for managing employees"},{"name":"Employment (V2)","description":"\nAPIs for managing models"},{"name":"Employments","description":"\nAPIs for managing employments"},{"name":"Endpoints","description":""},{"name":"Expenditures","description":"\nAPIs for managing a firm's Expenditure Life Stages"},{"name":"FCA Numbers","description":"\nManage FCA Numbers"},{"name":"Fact-Find Employment","description":"\nAPIs for managing fact-find employments"},{"name":"Fact-Find Sessions","description":"\nAPI for adding a user to an existing fact-find session"},{"name":"Fact-Find Submission","description":"\nAPIs for managing fact-find submissions"},{"name":"Fact-Finds","description":"\nAPIs for managing fact-find requests"},{"name":"File Uploading","description":"\nAPIs for managing uploading files to Plannr"},{"name":"Filesystem","description":"\nFolder management"},{"name":"Firms","description":"\nManage Firms"},{"name":"Form Builder","description":"\nAPIs for managing forms"},{"name":"Goals (v1)","description":"\nAPIs for managing a client's goals"},{"name":"Goals (v2)","description":"\nAPIs for managing goals"},{"name":"Groups","description":""},{"name":"Holdings","description":"\nAPIs for managing holdings"},{"name":"Illustrations","description":"\nManage Illustrations"},{"name":"Imports","description":"\nAPIs for managing imports"},{"name":"Income (v1)","description":"\nAPIs for managing income"},{"name":"Income (v2)","description":"\nAPIs for managing incomes"},{"name":"Income Reconciliation","description":"\nAPIs for managing incoming charges"},{"name":"Introducer","description":"\nAPIs for managing introducers"},{"name":"Letter of Authority","description":"\nAPIs for generating Letters of Authority"},{"name":"Logins","description":"\nAPIs for managing logins"},{"name":"Logs","description":"\nAPIs for managing logs"},{"name":"Lookups","description":"\nAPIs for managing lookups"},{"name":"Mailboxes","description":"\nAPIs for managing mailboxes and email syncing"},{"name":"Miscellaneous","description":"\nVarious APIs"},{"name":"Model","description":"\nAPIs for managing models"},{"name":"Model Types","description":"\nModel types for various parts of the system."},{"name":"Mortgage Searches (v2)","description":"\nAPIs for managing mortgage searches"},{"name":"Mortgage Sourcing","description":"\nAPIs for managing mortgage sourcing"},{"name":"Navigation","description":"\nAPIs for navigation"},{"name":"Networth","description":""},{"name":"New Business Events","description":"\nManage New Business Events"},{"name":"Notes","description":"\nAPIs for managing notes"},{"name":"Notifications","description":"\nManage Notifications"},{"name":"OAuth2 Connections (External Only)","description":"\nAPIs for viewing OAuth2 connections for the authenticated account"},{"name":"Plan Returns","description":"\nAPIs for managing plan returns"},{"name":"Plans","description":"\nManage Plans"},{"name":"Plans (v2)","description":"\nAPIs for managing plans"},{"name":"Platform","description":"\nAPIs for managing Platforms"},{"name":"Premiums","description":"\nAPIs for managing premiums"},{"name":"Providers","description":"\nManage Providers"},{"name":"Reactions","description":"\nAPIs for managing reactions"},{"name":"Report Templates","description":"\nAPIs for managing Report Templates"},{"name":"Report Types","description":"\nAPIs for managing Report Types"},{"name":"Reports","description":"\nAPIs for managing Report Generation"},{"name":"Risks (v1)","description":"\nAPIs for managing a client's risks assessments"},{"name":"Risks (v2)","description":"\nAPIs for managing risks"},{"name":"Search","description":"\nAPIs for searching"},{"name":"Shareholders","description":"\nAPIs for managing a business's shareholders"},{"name":"Staff Members","description":"\nAPIs for managing staff members for business clients"},{"name":"Statements","description":"\nAPIs for managing monthly statements"},{"name":"Static Data","description":"\nAPIs for static data"},{"name":"Sub Account Portfolios","description":"\nAPIs for managing portfolios on sub accounts"},{"name":"Sub Accounts","description":"\nManage Sub Accounts for Plans"},{"name":"Tagging","description":"\nAPIs for managing tags on the firm"},{"name":"Task Statuses","description":"\nAPIs for managing Task Statuses"},{"name":"Tasks","description":"\nAPIs for managing tasks"},{"name":"Time Entries","description":"\nAPIs for managing time entries"},{"name":"Transaction","description":"\nAPIs for managing transactions"},{"name":"Transactions (v2)","description":"\nAPIs for managing transactions"},{"name":"Unipass Certificates","description":"\nAPIs for managing Unipass certificates on the authenticated user"},{"name":"User Management","description":"\nManage resources for the currently signed-in user"},{"name":"Valuations","description":"\nManage Valuations"},{"name":"Valuations (V2)","description":"\nAPIs for managing valuations"},{"name":"Webhook Subscriptions","description":"\nAPIs for managing webhook subscriptions"},{"name":"Withdrawals","description":"\nManage Withdrawals"},{"name":"Workflows","description":"\nAPIs for managing and running workflows."}],"components":{"securitySchemes":{"PersonalAccessToken":{"type":"http","scheme":"bearer","description":"Send your personal access token in the Authorization header as such: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}\n\nFull authentication guide can be found at \u003ca href=\"https://api-how-to.plannrcrm.com/getting-started/authorization\"\u003ehttps://api-how-to.plannrcrm.com/getting-started/authorization\u003c/a\u003e"},"OAuth2":{"description":"Full authentication guide can be found at \u003ca href=\"https://api-how-to.plannrcrm.com/getting-started/authorization\"\u003ehttps://api-how-to.plannrcrm.com/getting-started/authorization\u003c/a\u003e","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://api.plannrcrm.com/oauth/authorize","tokenUrl":"https://api.plannrcrm.com/oauth/token","scopes":{"*":"All access"}}}}},"schemas":{"App_Http_Requests_User_UpdateUserRequest":{"type":"object","properties":{"email":{"type":"string","example":"example@email.com","description":"The new email the user wants to change to.","format":"email"},"current_password":{"type":"string","example":"kI4esnkFKH","description":"Current password of the account","format":"password"},"password":{"type":"string","example":"_24AtOn^hjs45I_","description":"New password chosen","format":"password"},"password_confirmation":{"type":"string","example":"_24AtOn^hjs45I_","description":"Confirmation of the new password, it must be the same value as password","format":"password"},"should_auto_save_notes":{"type":"boolean","example":true,"description":"Denotes if the user wants to use the auto-save notes feature. Can reduce browser performance on low-powered machines."}}},"App_Http_Requests_User_SwitchAccountRequest":{"type":"object","required":["account_uuid","mobile_account_uuid"],"properties":{"account_uuid":{"type":"string","example":"37739939-1d2a-42f5-bf80-8865a6016440","description":"The account UUID to switch to (for web-app).","format":"uuid"},"mobile_account_uuid":{"type":"string","example":"70b3a863-6482-4b4a-abbd-a8c2a83a20ea","description":"The account UUID to switch to (for native apps like mobile).","format":"uuid"}}},"App_Http_Requests_User_StorePersonalAccessTokenRequest":{"type":"object","required":["name","password"],"properties":{"name":{"type":"string","example":"Zapier","description":"The name of the personal access token"},"password":{"type":"string","example":"pUCAMNOoZ4MJ","description":"The password of the user for verification","format":"password"},"account_uuid":{"type":"string","example":"1f76f501-50dc-47c0-9e53-2e1a1418967d","description":"The UUID of the account you would like the token to be used for.","format":"uuid"}}},"App_Http_Requests_User_DeletePersonalAccessTokenRequest":{"type":"object","required":["password"],"properties":{"password":{"type":"string","example":"bJyt97pjFUF8","description":"The password of the user for verification","format":"password"}}},"App_Http_Requests_User_StoreMobileNotificationTokenRequest":{"type":"object","required":["token"],"properties":{"token":{"type":"string","example":"oAG2pi6CfzzV","description":"The Firebase (FCM) token generated to be used for native iOS/Android notifications.","format":"password"}}},"App_Http_Requests_User_DestroyMobileNotificationTokenRequest":{"type":"object","required":["token"],"properties":{"token":{"type":"string","example":"gAWbdH7JC5l7","description":"The Firebase (FCM) token to delete.","format":"password"}}},"App_Http_Requests_Reaction_StoreReactionRequest":{"type":"object","required":["reactable_type","reactable_uuid","reaction"],"properties":{"reactable_type":{"type":"string","example":"message","description":"The item type that is being reacted to."},"reactable_uuid":{"type":"string","example":"82a3dcac-7a6b-43a7-a280-c592a72f7569","description":"The UUID of the item that is being reacted to.","format":"uuid"},"reaction":{"type":"string","example":"like","description":"The reaction. e.g. like|love|laughing|surprised.","enum":["like","love","laughing","surprised"]}}},"App_Http_Requests_SearchRequest":{"type":"object","required":["q"],"properties":{"q":{"type":"string","example":"Plannr","description":"Query string."},"per_page":{"type":"integer","example":50,"description":"Number of results to return.","maximum":500}}},"App_Http_Requests_File_FileUploadRequest":{"type":"object","required":["files"],"properties":{"files":{"type":"array","example":[],"description":"An array of files to be uploaded.","items":{"type":"object","example":{"name":"My new File","filename":"my new file.pdf","extension":"pdf","type":"application/pdf","size":1024,"last_modified":1778247714},"properties":{"name":{"type":"string","example":"My new File","description":"The name of the file."},"filename":{"type":"string","example":"my new file.pdf","description":"The filename of the file."},"extension":{"type":"string","example":"pdf","description":"The file extension."},"type":{"type":"string","example":"application/pdf","description":"The mime type of the file."},"size":{"type":"integer","example":1024,"description":"The size of the file in bytes."},"last_modified":{"type":"integer","example":1778247714,"description":"The last modified timestamp of the file. unix timestamp format."}}}}}},"App_Http_Requests_User_UpdateWelcomeWidgetTaskRequest":{"type":"object","required":["is_complete"],"properties":{"is_complete":{"type":"boolean","example":true,"description":"Denotes if a welcome widget item is complete."}}},"App_Http_Requests_PostcodeSearchRequest":{"type":"object","required":["postcode"],"properties":{"postcode":{"type":"string","example":"SW1A 1AA","description":"The postcode to search for."}}},"App_Http_Requests_Unipass_StoreUnipassCertificateRequest":{"type":"object","required":["certificate_email","certificate"],"properties":{"certificate_email":{"type":"string","example":"example@example.com","description":"The email that was used in the certificate","format":"email"},"certificate":{"type":"string","example":"file-contents","description":"The multipart file containing the X509 certificate","format":"binary"}}},"App_Http_Requests_Firm_UpdateFirmRequest":{"type":"object","properties":{"name":{"type":"string","example":"Codepotato","description":"The firm's name."},"regulatory_text":{"type":"string","example":"To view our Privacy Statement, please click here. To view our Cookies Statement, please click here.","description":"The firm's regulatory text."},"ip_whitelist":{"type":"array","example":[],"description":"IP Addresses that are allowed to access Plannr","items":{"type":"string","example":"127.0.0.1","format":"ipv4"}},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"description":"Array of cc email addresses","items":{"type":"string","example":"jack@example.com","format":"email"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"description":"Array of bcc email addresses","items":{"type":"string","example":"jill@example.com","format":"email"}},"reply_to_email_address":{"type":"string","example":"jill@example.com","description":"Reply-to email addresses","format":"email"},"mobile_app_support_number":{"type":"string","example":"01234 567890","description":"Firm mobile app support number.","maxLength":255,"nullable":true},"mobile_app_support_email":{"type":"string","example":"support@example.com","description":"Firm mobile app support email address.","format":"email","maxLength":255,"nullable":true}}},"App_Http_Requests_Firm_UpdateFirmBrandingRequest":{"type":"object","properties":{"brand_colours":{"type":"array","example":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"description":"Array of hex colours values for your branding."},"logo":{"type":"string","example":"file-contents","description":"Image file of your logo. Max 10 MB","format":"binary"},"logo_icon":{"type":"string","example":"file-contents","description":"Image file of your logo icon. Max 10 MB, Width and Height: Min 50px Max 150px. Aspect Ratio 1/1","format":"binary"},"email_logo":{"type":"string","example":"file-contents","description":"Image file of your email logo. Max 10 MB","format":"binary"},"banner":{"type":"string","example":"file-contents","description":"Image file of your banner. Max 25 MB","format":"binary"},"branded_auth_background":{"type":"string","example":"file-contents","description":"Image file for the branded authentication background. Used on your branded login page. Max 25 MB","format":"binary"},"use_branded_auth":{"type":"boolean","example":true,"description":"Controls if the firm's branded authentication pages will work. When enabled, users will also be automatically redirected to the branded login page."},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome to {{ firm }} {{ first_name }}\u003c/h1\u003e","description":"Custom welcome paragraph html for the branded auth welcome page.. Can add basic variables for firm,first_name,last_name."},"email_welcome_paragraph_html":{"type":"string","example":"\u003cp\u003eHello {{ first_name }}, you have been invited to our portal at {{ firm }}.\u003c/p\u003e","description":"Custom welcome paragraph for the welcome/new user email. Can add basic variables for firm,first_name,last_name."},"show_fact_find_illustrations":{"type":"boolean","example":true,"description":"Determines if the illustrations/graphics are displayed on the fact find."}}},"App_Http_Requests_Firm_UpdateFirmSettingsRequest":{"type":"object","required":["fact_find_completed_notification_to_assigned_adviser","fact_find_completed_notification_to_assigned_administrator","fact_find_completed_notification_to_assigned_paraplanner"],"properties":{"keep_deleted_files_for":{"type":"integer","example":60,"description":"Number of days to keep files in the recycle bin. Set as null for indefinitely"},"tax":{"type":"number","example":17.5,"description":"Tax rate","format":"float"},"rmar_start_date":{"type":"string","example":"2022-08-01","description":"Date you will not be able to add charges before","format":"date"},"advice_type":{"type":"string","example":"independent","description":"|\n\nDefault RMAR advice type for new employees\n\n| Value | Description |\n| ----- | ----------- |\n|independent|Independent|\n|restricted|Restricted|","enum":["independent","restricted"]},"month_end":{"type":"integer","example":25,"description":"Day of the month for the monthly income reconciliation statements to end. Leave at 31 for the end of the month"},"lock_statements_after":{"type":"integer","example":0,"description":"Automatically lock statements after number of days of statement end date. Leave null for never lock automatically. Zero for lock automatically immediately"},"adviser_split_uuid":{"type":"string","example":"6cdf177c-17cf-451f-8da5-bc0118df6dfc","description":"Default adviser split to be applied to new advisers","format":"uuid"},"show_pseudo_folders_in_client_portal":{"type":"boolean","example":true,"description":"Whether to allow clients to view the pseudo folders in the client portal"},"fact_find_completed_notification_to_assigned_adviser":{"type":"boolean","example":true,"description":"Notify the assigned adviser when a client completes a fact find"},"fact_find_completed_notification_to_assigned_administrator":{"type":"boolean","example":true,"description":"Notify the assigned administrator when a client completes a fact find"},"fact_find_completed_notification_to_assigned_paraplanner":{"type":"boolean","example":true,"description":"Notify the assigned paraplanner when a client completes a fact find"},"charge_identifier":{"type":"boolean","example":true,"description":"Charge identifier to apply to charges. Visit support documentation for requirements and list of variables."},"core_details_changed_notification_for_assigned_adviser":{"type":"boolean","example":true,"description":"Notify the assigned adviser when a clients core details are updated."},"core_details_changed_notification_for_assigned_administrator":{"type":"boolean","example":true,"description":"Notify the assigned adviser when a clients core details are updated."},"core_details_changed_notification_for_assigned_paraplanner":{"type":"boolean","example":true,"description":"Notify the assigned adviser when a clients core details are updated."},"allow_completion_of_cases_with_incomplete_tasks":{"type":"boolean","example":true,"description":"Allow completion of cases with incomplete tasks."},"auto_create_linked_policy_numbers":{"type":"string","example":"always","description":"|\n\nAutomatically create linked policy numbers when reconciling income.\n\n| Value | Description |\n| ----- | ----------- |\n|always|ALWAYS|\n|ask|ASK|\n|off|OFF|","enum":["always","ask","off"]}}},"App_Http_Requests_FcaNumber_StoreFcaNumberRequest":{"type":"object","required":["fca_number"],"properties":{"fca_number":{"type":"integer","example":123456,"description":"An FCA Number in a 6 or 7-digit format"}}},"App_Http_Requests_KeyMetricsRequest":{"type":"object","properties":{"date":{"type":"string","example":"2023-01-01","description":"The date which you would like to run the key metric from.","format":"date"}}},"App_Http_Requests_LifeStages_StoreLifeStageRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Current Lifestyle","description":"The name of the Life Stage."},"start_age":{"type":"integer","example":21,"description":"The expected age of the client as they enter the Expenditure Life Stage. This field is not required and may be null, but is required with `end_age`."},"end_age":{"type":"integer","example":28,"description":"The expected age of the client as they mature beyond this Expenditure Life Stage. This field is not required and may be null, but is required with `start_age`."}}},"App_Http_Requests_LifeStages_UpdateLifeStageRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Current Lifestyle","description":"The name of the Expenditure Life Stage."},"start_age":{"type":"integer","example":21,"description":"The expected age of the client as they enter the Expenditure Life Stage. This field is not required and may be null but is required with `end_age`."},"end_age":{"type":"integer","example":28,"description":"The expected age of the client as they mature beyond this Expenditure Life Stage. This field is not required and may be null but is required with `start_age`."}}},"App_Http_Requests_LifeStages_ReorderLifeStageRequest":{"type":"object","required":["order"],"properties":{"order":{"type":"array","example":["7caf32e9-1700-4ecf-b3b1-bdb8158a0118","2644b520-02a1-48e5-bf6b-ce3e96abffa4","9301b604-4f9e-4bd1-982b-138e6da668b7"],"description":"An ordered array of Expenditure Life Stage UUID’s.","items":{"type":"string","example":"c8db694e-5b23-47b9-9e16-10f8b5a7f4ec","format":"uuid"}}}},"App_Http_Requests_LifeStages_StoreLifeStageSectionRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Current Lifestyle","description":"The name of the Expenditure Life Stage Section."}}},"App_Http_Requests_LifeStages_UpdateLifeStageSectionRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Children \u0026 Grandchildren Expenses","description":"The name of the Expenditure Life Stage Section."},"has_custom_expenditures":{"type":"boolean","example":true,"description":"Whether the Expenditure Life Stage Section accepts custom expenditures."}}},"App_Http_Requests_LifeStages_ReorderLifeStageSectionRequest":{"type":"object","required":["order"],"properties":{"order":{"type":"array","example":["c808bd54-6831-45b5-8771-bf8a670b86e7","e37e47d9-60b5-4d9e-b4b1-6ccad14fdf43","e7e6be38-2345-4670-b8aa-f6e61815eccd"],"description":"An ordered array of Expenditure Life Stage Section UUID’s.","items":{"type":"string","example":"9b2c1b0b-b622-463c-8609-8f15436820ba","format":"uuid"}}}},"App_Http_Requests_LifeStages_MassSetCustomExpendituresRequest":{"type":"object","required":["section_uuids"],"properties":{"section_uuids":{"type":"array","example":["42254523-22e7-4c12-9ed5-65aed4c34426","f40bf4b3-2141-4666-b100-8750dd79fc14","86df64a3-8a9f-4fc7-9924-4592b810d194"],"description":"An ordered array of Expenditure Life Stage Section UUID’s.","items":{"type":"string","example":"6affbe84-3467-4f4c-83dc-757420b55779","format":"uuid"}},"has_custom_expenditures":{"type":"boolean","example":true,"description":"Whether the Expenditure Life Stage Section accepts custom expenditures."}}},"App_Http_Requests_LifeStages_StoreLifeStageFieldRequest":{"type":"object","required":["name","life_stage_section_uuid"],"properties":{"name":{"type":"string","example":"Electricity","description":"The name of the Life Stage Field."},"life_stage_section_uuid":{"type":"string","example":"668b0608-f1b5-49d3-a78b-38113c435bdc","description":"The uuid of the parent Life Stage Section.","format":"uuid"}}},"App_Http_Requests_LifeStages_UpdateLifeStageFieldRequest":{"type":"object","required":["life_stage_section_uuid"],"properties":{"name":{"type":"string","example":"Electricity","description":"The name of the Life Stage Field."},"life_stage_section_uuid":{"type":"string","example":"a9d436ee-fe08-4c44-beab-49ecb2251c3b","description":"The uuid of the parent Life Stage Section.","format":"uuid"}}},"App_Http_Requests_LifeStages_ReorderLifeStageFieldRequest":{"type":"object","required":["order"],"properties":{"order":{"type":"array","example":["35cbee57-3287-4a7d-ae62-e6ee6fbca565","11b99d45-8b05-4974-a128-cdc81b2064e1","faf8fa85-2daf-48a9-aea5-0deaf707d5ee"],"description":"An ordered array of Expenditure Life Stage Section Fields UUID’s.","items":{"type":"string","example":"66730892-1a50-450f-a8e1-cd0b260fa5d0","format":"uuid"}}}},"App_Http_Requests_Import_StoreImportRequest":{"type":"object","required":["type","mode","file"],"properties":{"type":{"type":"string","example":"business_staff_members","description":"|\n\nType of record to import.\n\n| Value | Description |\n| ----- | ----------- |\n|business_staff_members|Business Staff Members|\n|charges|Charges|\n|circles|Circles|\n|clients|Clients|\n|group_scheme_members|Group Scheme Members|\n|incomes|Incomes|\n|notes|Notes|\n|plans|Plans|\n|premiums|Premiums|\n|tasks|Tasks|\n|valuations|Valuations|\n|seccl_valuations|Seccl Valuations|\n|expenses|Expenses|\n|provider_statement|Provider Statement|","enum":["business_staff_members","charges","circles","clients","group_scheme_members","incomes","notes","plans","premiums","tasks","valuations","seccl_valuations","expenses","provider_statement"]},"mode":{"type":"string","example":"store","description":"|\n\nType of import mode to enforce.\n\n| Value | Description |\n| ----- | ----------- |\n|store|Store|\n|update|Update|\n|validate|Validate|","enum":["store","update","validate"]},"file":{"type":"string","example":"file-contents","description":"CSV file with import records","format":"binary"}}},"App_Http_Requests_Import_MapImportRequest":{"type":"object","required":["headers"],"properties":{"headers":{"type":"object","description":"Key value array containing the supported import headers as keys, and the csv headers as values","example":{"first_name":"fname","last_name":"lname","email":"email"},"additionalProperties":true}}},"App_Http_Requests_Login_StoreLoginRequest":{"type":"object","required":["first_name","last_name","email","has_write_permission","has_delete_permission","receives_unread_notifications_email","wealth_enabled","goals_enabled","factfind_enabled","tasks_enabled"],"properties":{"first_name":{"type":"string","example":"Gareth","description":"First name"},"last_name":{"type":"string","example":"Thompson","description":"Last name"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email address to log in with","format":"email"},"expires_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of how long this login is valid for temporary access. Can leave blank for no expiration","format":"date-time"},"has_write_permission":{"type":"boolean","example":true,"description":"Give this login write access for the account. False to leave as read only"},"has_delete_permission":{"type":"boolean","example":true,"description":"Give this access to delete items. False to prevent logins from deleting resources."},"receives_unread_notifications_email":{"type":"boolean","example":true,"description":"Set to true this login should receive the unread notification digest email"},"wealth_enabled":{"type":"boolean","example":true,"description":"Set to true this login be able to access wealth on the client portal"},"goals_enabled":{"type":"boolean","example":true,"description":"Set to true for this login to be able to access goals on the client portal"},"factfind_enabled":{"type":"boolean","example":true,"description":"Set to true for this login to be able to access fact finds on the client portal"},"tasks_enabled":{"type":"boolean","example":true,"description":"Set to true for this login to be able to access tasks on the client portal"}}},"App_Http_Requests_Login_UpdateLoginRequest":{"type":"object","required":["has_write_permission","has_delete_permission","wealth_enabled","goals_enabled","factfind_enabled","tasks_enabled"],"properties":{"expires_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of how long this login is valid for temporary access. Can leave blank for no expiration.","format":"date-time"},"primary":{"type":"boolean","example":true,"description":"Make this the primary login for this account. Only one primary login per account."},"has_write_permission":{"type":"boolean","example":true,"description":"Give this login write access for the account. False to leave as read only."},"has_delete_permission":{"type":"boolean","example":true,"description":"Give this access to delete items. False to prevent logins from deleting resources."},"wealth_enabled":{"type":"boolean","example":true,"description":"Set to true this login be able to access wealth on the client portal."},"goals_enabled":{"type":"boolean","example":true,"description":"Set to true for this login to be able to access goals on the client portal."},"factfind_enabled":{"type":"boolean","example":true,"description":"Set to true for this login to be able to access fact finds on the client portal."},"tasks_enabled":{"type":"boolean","example":true,"description":"Set to true for this login to be able to access tasks on the client portal."},"receives_unread_notifications_email":{"type":"boolean","example":true,"description":"Set to true this login should receive the unread notification digest email"}}},"App_Http_Requests_Address_StoreAddressRequest":{"type":"object","required":["name","address_1"],"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars","description":"First line of the address"},"address_2":{"type":"string","example":"Waterberry Drive","description":"Second line of the address"},"address_3":{"type":"string","example":"The Innovative Centre","description":"Third line of the address"},"address_4":{"type":"string","example":"Waterlooville","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"primary":{"type":"boolean","example":true,"description":"Denotes if primary address."},"moved_in_month":{"type":"integer","example":6,"description":"The month the client moved into this address."},"moved_in_year":{"type":"integer","example":2022,"description":"The year the client moved into this address."},"moved_out_month":{"type":"integer","example":1,"description":"The month the client moved out of this address."},"moved_out_year":{"type":"integer","example":2024,"description":"The year the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","description":"The client's residential status when living at the address."},"residential_status_other":{"type":"string","example":"Non-tenant occupier","description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."}}},"App_Http_Requests_Address_UpdateAddressRequest":{"type":"object","properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars","description":"First line of the address"},"address_2":{"type":"string","example":"Waterberry Drive","description":"Second line of the address"},"address_3":{"type":"string","example":"The Innovative Centre","description":"Third line of the address"},"address_4":{"type":"string","example":"Waterlooville","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"moved_in_month":{"type":"integer","example":6,"description":"The month the client moved into this address."},"moved_in_year":{"type":"integer","example":2022,"description":"The year the client moved into this address."},"moved_out_month":{"type":"integer","example":1,"description":"The month the client moved out of this address."},"moved_out_year":{"type":"integer","example":2024,"description":"The year the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","description":"The client's residential status when living at the address."},"residential_status_other":{"type":"string","example":"Non-tenant occupier","description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."},"primary":{"type":"boolean","example":true,"description":"Make this address the primary contact address. Will make all other client addresses non primary."}}},"App_Http_Requests_Check_StoreCheckRequest":{"type":"object","required":["type","via_integration","originally_ran_at"],"properties":{"provider":{"type":"string","example":"SmartSearch","description":"The name of the provider that ran the check."},"type":{"type":"string","example":"aml","description":"|\n\nThe type of check, possible values are aml, smartdoc and fraud\n\n| Value | Description |\n| ----- | ----------- |\n|aml|Aml|\n|smartdoc|Smartdoc|\n|fraud|Fraud|","enum":["aml","smartdoc","fraud"]},"provider_reference":{"type":"string","example":"10009815","description":"The provider's unique identifier for the check."},"status":{"type":"string","example":"abandoned","description":"|\n\nThe check's status at the current time, possible values are abandoned, active, archive, complete, expired, failed, lock, pending and processing\n\n| Value | Description |\n| ----- | ----------- |\n|abandoned|Abandoned|\n|active|Active|\n|archive|Archive|\n|complete|Complete|\n|expired|Expired|\n|failed|Failed|\n|lock|Lock|\n|pending|Pending|\n|processing|Processing|","enum":["abandoned","active","archive","complete","expired","failed","lock","pending","processing"]},"outcome":{"type":"string","example":"pass","description":"|\n\nThe check's outcome at the current time, possible values are pass, refer, fail, high_risk, medium_risk and low_risk\n\n| Value | Description |\n| ----- | ----------- |\n|pass|Pass|\n|refer|Refer|\n|fail|Fail|\n|high_risk|High Risk|\n|medium_risk|Medium Risk|\n|low_risk|Low Risk|","enum":["pass","refer","fail","high_risk","medium_risk","low_risk"]},"via_integration":{"type":"boolean","example":false,"description":"Did this check originate via an integration or was it manually added."},"originally_ran_at":{"type":"string","example":"2026-05-01","description":"The date that the check was originally ran","format":"date"}}},"App_Http_Requests_Check_UpdateCheckRequest":{"type":"object","properties":{"provider":{"type":"string","example":"SmartSearch","description":"The name of the provider that ran the check."},"type":{"type":"string","example":"aml","description":"|\n\nThe type of check, possible values are aml, smartdoc and fraud\n\n| Value | Description |\n| ----- | ----------- |\n|aml|Aml|\n|smartdoc|Smartdoc|\n|fraud|Fraud|","enum":["aml","smartdoc","fraud"]},"provider_reference":{"type":"string","example":"10009815","description":"The provider's unique identifier for the check."},"status":{"type":"string","example":"abandoned","description":"|\n\nThe check's status at the current time, possible values are abandoned, active, archive, complete, expired, failed, lock, pending and processing\n\n| Value | Description |\n| ----- | ----------- |\n|abandoned|Abandoned|\n|active|Active|\n|archive|Archive|\n|complete|Complete|\n|expired|Expired|\n|failed|Failed|\n|lock|Lock|\n|pending|Pending|\n|processing|Processing|","enum":["abandoned","active","archive","complete","expired","failed","lock","pending","processing"]},"outcome":{"type":"string","example":"pass","description":"|\n\nThe check's outcome at the current time, possible values are pass, refer, fail, high_risk, medium_risk and low_risk\n\n| Value | Description |\n| ----- | ----------- |\n|pass|Pass|\n|refer|Refer|\n|fail|Fail|\n|high_risk|High Risk|\n|medium_risk|Medium Risk|\n|low_risk|Low Risk|","enum":["pass","refer","fail","high_risk","medium_risk","low_risk"]},"via_integration":{"type":"boolean","example":false,"description":"Did this check originate via an integration or was it manually added."},"originally_ran_at":{"type":"string","example":"2026-05-01","description":"The date that the check was originally ran","format":"date"}}},"App_Http_Requests_ContactDetails_StoreContactDetailRequest":{"type":"object","required":["type","name","value"],"properties":{"type":{"type":"string","example":"email","description":"|\n\nValid types: email and phone_number\n\n| Value | Description |\n| ----- | ----------- |\n|email|Email|\n|phone_number|Phone Number|","enum":["email","phone_number"]},"name":{"type":"string","example":"Work phone number","description":"Description of contact detail"},"value":{"type":"string","example":"+443330903630","description":"Value of contact detail. If the type is phone number, the format defaults to GB. You can provide an array `[\"country\" =\u003e \"AU\", \"number\" =\u003e \"+61 2 3456 7890\"]` if you want to use a different format."},"primary":{"type":"boolean","example":true,"description":"Make this contact type the primary contact.  Will make all other contact details of the same type no longer primary."}}},"App_Http_Requests_ContactDetails_UpdateContactDetailRequest":{"type":"object","properties":{"name":{"type":"string","example":"Work phone number","description":"Description of contact detail"},"value":{"type":"string","example":"+443330903630","description":"Value of contact detail"},"primary":{"type":"boolean","example":true,"description":"Make this contact type the primary contact.  Will make all other contact details of the same type no longer primary."}}},"App_Http_Requests_Circle_StoreCircleRequest":{"type":"object","required":["name","account_uuids","group_uuids"],"properties":{"name":{"type":"string","example":"Jones Family","description":"Circle name"},"bg_colour":{"type":"string","example":"#DDDDDD","description":"Hex colour for avatar background"},"account_uuids":{"type":"array","example":["014db8e0-9370-4ba2-b041-23651c58b6d0","bc1e13ec-047e-444f-a8b6-f46759307909","aab8a895-e548-491b-872c-6af1a5f543d9"],"description":"Account UUIDs that are being added to the circle. Between 1 and 100 account UUIDs are required.","items":{"type":"string","example":"2bc73e1b-6f09-4067-a3f7-f32c7671a63f","format":"uuid"}},"group_uuids":{"type":"array","example":["40a1713e-9f02-484d-b77b-8985a2d6b48c","da52b83f-4600-4bd5-9995-9c7f2fe6dd8f","96174e11-cf5c-4b87-b2b0-017e97020393"],"description":"Groups UUIDs the circle will belong to. Can belong to a maximum of 50 groups.","items":{"type":"string","example":"38390e12-4c04-4776-87db-33f71373df14","format":"uuid"}}}},"App_Http_Requests_Circle_UpdateCircleRequest":{"type":"object","properties":{"name":{"type":"string","example":"Jones Family","description":"Circle name"},"bg_colour":{"type":"string","example":"#DDDDDD","description":"Hex colour for avatar background"},"account_uuids":{"type":"array","example":["c257cb82-4dfa-438f-8780-85e6ae7d9210","1ab81735-ba0b-4840-97fb-7c5e1cd993ab","833c481d-cb91-4589-9bf7-02938b2df332"],"description":"Account UUIDs belonging to the circle. Between 1 and 100 account UUIDs are required.","items":{"type":"string","example":"0f4b0419-e9ab-41e4-a1c5-8fcce648ef21","format":"uuid"}},"accounts":{"type":"array","example":[],"description":"List of accounts - required without account_uuids","items":{"type":"object","example":{"uuid":"3b4bee6f-5e9a-42c0-b652-f297203fdd81","login_access_level":"read"},"properties":{"uuid":{"type":"string","example":"3b4bee6f-5e9a-42c0-b652-f297203fdd81","description":"uuid of account","format":"uuid"},"login_access_level":{"type":"string","example":"read","description":"|\n\nAccess level of the login\n\n| Value | Description |\n| ----- | ----------- |\n|read|Read|\n|write|Write|","enum":["read","write"],"nullable":true}}}},"group_uuids":{"type":"array","example":["ea5c1d01-3692-4d79-bff0-eb8b544b1602","e0f92022-03bf-4930-a8b8-ebe8094d4d86","ed023e22-8f17-431b-be18-3b8a37d09bab"],"description":"Groups UUIDs the circle will belong to. Can belong to a maximum of 50 groups.","items":{"type":"string","example":"96e45443-5597-4768-98f9-f86faf61e02c","format":"uuid"}}}},"App_Http_Requests_Circles_UpdateCircleFactFindAccessRequest":{"type":"object","required":["account_uuid","target_account_uuid","has_fact_find_access"],"properties":{"account_uuid":{"type":"string","example":"fc8ae83a-8405-45b9-832b-91f63cf3c8a4","description":"The UUID of the circle member account to attach the access to.","format":"uuid"},"target_account_uuid":{"type":"string","example":"0b24570d-f24f-4f28-bfba-f2bc43370a3d","description":"The UUID of the circle member account that account_uuid will have access to.","format":"uuid"},"has_fact_find_access":{"type":"boolean","example":true,"description":"Boolean to allow/deny the access."}}},"App_Http_Requests_Employee_StoreEmployeeRequest":{"type":"object","required":["first_name","last_name","role","with_login","departments"],"properties":{"first_name":{"type":"string","example":"Gareth","description":"The first name of the employee."},"last_name":{"type":"string","example":"Thompson","description":"The last name of the employee."},"email":{"type":"string","example":"gareth.thompson@plannrcrm.com","description":"The email of the employee. Required when with_login is present."},"assigned_adviser_uuid":{"type":"string","example":"24c5f645-7442-4c49-a73d-99d6b80aa9e5","description":"Uuid of the assigned adviser","format":"uuid"},"role":{"type":"string","example":"owner","description":"The role of the employee."},"with_login":{"type":"boolean","example":true,"description":"Denotes if the employee needs a billable login."},"departments":{"type":"array","example":["paraplanner","adviser"],"description":"The departments the employee is part of"},"groups":{"type":"array","example":["1dada451-35ba-4df1-8266-c0e6d9a74e0a","bf55ab38-26d7-4d63-b8e9-9b21b61b896e","e82c275a-0680-4713-bfbc-57c142f27463"],"description":"Group uuids belonging to the firm.","items":{"type":"string","example":"b9b74316-4eb1-44bc-8fdb-c7b2ef1fc60a","format":"uuid"}},"adviser_split_uuid":{"type":"string","example":"3d297f6e-ae3d-47f8-83f4-a19db1c3e92b","description":"The uuid of the the adviser split that will be applied when this adviser adds charges","format":"uuid"},"advice_type":{"type":"string","example":"independent","description":"|\n\nEmployee's RMAR advice type\n\n| Value | Description |\n| ----- | ----------- |\n|independent|Independent|\n|restricted|Restricted|","enum":["independent","restricted"]}}},"App_Http_Requests_Employee_UpdateEmployeeRequest":{"type":"object","required":["with_login"],"properties":{"first_name":{"type":"string","example":"Gareth","description":"The first name of the employee."},"last_name":{"type":"string","example":"Thompson","description":"The last name of the employee."},"email":{"type":"string","example":"gareth.thompson@plannrcrm.com","description":"The email of the employee. Required when with_login is present."},"with_login":{"type":"boolean","example":true,"description":"Denotes if the employee needs a billable login."},"assigned_adviser_uuid":{"type":"string","example":"cdc350e1-07d6-400a-8149-9e3f29e3c69b","description":"The uuid of the senior employee that the employee directly reports to","format":"uuid"},"role":{"type":"string","example":"owner","description":"The role of the employee."},"departments":{"type":"array","example":["paraplanner","adviser"],"description":"The departments the employee is part of"},"adviser_split_uuid":{"type":"string","example":"430c9976-80e6-41a7-9ec6-400f87a1e071","description":"Adviser split","format":"uuid"},"groups":{"type":"array","example":["f0392973-134c-4854-9d8b-bfc076f91b36","0cb872ae-b415-4bc5-a47c-913c57ae02c3","96b64883-c82f-496e-a442-e7e708d7283a"],"description":"Group UUIDs to sync employee to. Null can be provided to clear an employees groups","items":{"type":"string","example":"e1c57a80-4d78-416e-81ee-a47ca24b75de","format":"uuid"}},"advice_type":{"type":"string","example":"independent","description":"|\n\nEmployee's RMAR advice type\n\n| Value | Description |\n| ----- | ----------- |\n|independent|Independent|\n|restricted|Restricted|","enum":["independent","restricted"]}}},"App_Http_Requests_Illustration_StoreIllustrationRequest":{"type":"object","required":["name","accounts","requested_by_uuid","is_draft","platform"],"properties":{"name":{"type":"string","example":"SuperSaver 2024","description":"The name of the illustration."},"client_uuid":{"type":"string","example":"c2c38720-2947-49e2-b54e-937c629cb3ef","description":"The client UUID to associate the illustration with. (deprecated: use accounts instead)","format":"uuid"},"accounts":{"type":"array","example":["a883d83b-b125-434a-bd86-ea31e25c240d","d1fa0649-7002-44d9-8622-2cf309f23fbc","0f3b9cf8-cd40-4544-80d4-16783bd12023"],"description":"An array of client account UUIDs to associate the illustration with.","items":{"type":"string","example":"c6a5d787-e82e-4359-bab3-30a096c6d139","format":"uuid"}},"requested_by_uuid":{"type":"string","example":"c15b2f86-adfc-4a23-9f2e-774f74c0b4c3","description":"The requested by account UUID to associate the illustration with. If not passed, this will default to the assigned adviser on the client account.","format":"uuid"},"plan_uuid":{"type":"string","example":"e980576f-1673-482d-9ad7-8da641c083eb","description":"The plan UUID to associate the illustration with. If not provided and is_draft is false, a new proposed plan will be created using the request_data.","format":"uuid"},"request_data":{"type":"object","description":"The request data used to generate the illustration.","additionalProperties":true},"is_draft":{"type":"boolean","example":false,"description":"Whether the illustration is a draft or not. If draft, it will not be sent to the platform."},"platform":{"type":"string","example":"seccl","description":"The platform used to generate the illustration."},"generate":{"type":"boolean","example":true,"description":"Whether to generate the illustration. Defaults to true."}}},"App_Http_Requests_Illustration_UpdateIllustrationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"SuperSaver 2024","description":"The name of the illustration. (required without request_data)"},"request_data":{"type":"object","description":"The request data used to generate the illustration. (required without name)","additionalProperties":true},"generate":{"type":"boolean","example":true,"description":"Whether to generate the illustration. Defaults to false."}}},"App_Http_Requests_Client_StoreClientRequest":{"type":"object","required":["first_name","last_name","client_regulatory_classification"],"properties":{"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Gareth","description":"First Name"},"middle_name":{"type":"string","example":"Alex","description":"Middle Name"},"last_name":{"type":"string","example":"Thompson","description":"Last Name"},"maiden_name":{"type":"string","example":"Thompson","description":"Maiden Name"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email address"},"phone":{"type":"string","example":"443330509960","description":"Clients primary phone number"},"assigned_adviser_uuid":{"type":"string","example":"3cce2873-88ce-4eef-85c2-cae41b1d3513","description":"The UUID of the employee that the client directly reports to","format":"uuid"},"assigned_administrator_uuid":{"type":"string","example":"5e309915-cfa4-46dd-9679-03f503a91a7a","description":"The UUID of the adviser employee that the client has been assigned","format":"uuid"},"assigned_paraplanner_uuid":{"type":"string","example":"0f413db0-d949-4a66-97fd-f3a433c288d2","description":"The UUID of the paraplanner employee that the client has been assigned","format":"uuid"},"introduced_by_uuid":{"type":"string","example":"6b0631e1-72db-44fd-9174-862f6658af4d","description":"The UUID of the introducer for this client","format":"uuid"},"send_welcome_email":{"type":"boolean","example":true,"description":"Set to true if you would like Plannr to send an email to the client on account creation"},"date_of_birth":{"type":"string","example":"1976-05-08","description":"Date of birth","format":"date"},"gender":{"type":"string","example":"male","description":"|\n\nGender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown\n\n| Value | Description |\n| ----- | ----------- |\n|male|male|\n|female|female|\n|non-binary|non-binary|\n|transgender|transgender|\n|intersex|intersex|\n|other|other|\n|unknown|unknown|","enum":["male","female","non-binary","transgender","intersex","other","unknown"]},"ni_number":{"type":"string","example":"AB 12 34 56 C","description":"National Insurance Number"},"nickname":{"type":"string","example":"G","description":"preferred nickname of the client"},"target_retirement_age":{"type":"integer","example":60,"description":"Target retirement age."},"pronouns":{"type":"string","example":"he/him","description":"Pronouns"},"smoker_status":{"type":"string","example":"smoker","description":"|\n\nSmoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown\n\n| Value | Description |\n| ----- | ----------- |\n|smoker|Smoker|\n|non-smoker|Non Smoker|\n|vaper|Vaper|\n|ex-smoker|Ex Smoker|\n|never-smoked|Never Smoked|\n|unknown|Unknown|","enum":["smoker","non-smoker","vaper","ex-smoker","never-smoked","unknown"]},"residential_status":{"type":"string","example":"homeowner","description":"|\n\nResidential status\n\n| Value | Description |\n| ----- | ----------- |\n|homeowner|Homeowner|\n|renting|Renting|\n|living_with_parents|Living With Parents|\n|other|Other|","enum":["homeowner","renting","living_with_parents","other"]},"country_of_residence":{"type":"string","example":"United Kingdom","description":"Country of residence"},"marital_status":{"type":"string","example":"single","description":"|\n\nMarital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown\n\n| Value | Description |\n| ----- | ----------- |\n|single|single|\n|cohabiting|cohabiting|\n|married|married|\n|divorced|divorced|\n|civil-partnership|civil partnership|\n|dissolved-civil-partnership|dissolved-civil-partnership|\n|widowed|widowed|\n|separated|separated|\n|engaged|engaged|\n|in-relationship|in a relationship|\n|other|other|\n|unknown|unknown|","enum":["single","cohabiting","married","divorced","civil-partnership","dissolved-civil-partnership","widowed","separated","engaged","in-relationship","other","unknown"]},"is_vulnerable":{"type":"string","example":"yes","description":"whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\"","enum":["yes","no","possibly"]},"is_prospect":{"type":"boolean","example":false,"description":"Denotes if the client is a prospect or not."},"prospect_converted_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The datetime when the prospect was converted into a client.","format":"date"},"value":{"type":"integer","example":500000,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"is_uk_resident":{"type":"boolean","example":true,"description":"Whether the client is a UK resident or not."},"is_uk_domicile":{"type":"boolean","example":true,"description":"Whether the client is a UK domicile or not."},"expected_retirement_age":{"type":"integer","example":60,"description":"The expected retirement age."},"state_retirement_age":{"type":"integer","example":60,"description":"The state retirement age."},"nationalities":{"type":"array","example":["British","Romanian"],"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","description":"Any details regarding the client's vulnerabilities."},"vulnerability_sub_type":{"type":"array","example":[],"description":"One or more vulnerability sub types.","items":{"type":"string","example":"health","enum":["health","life_events","resilience","capability"]}},"vulnerability_last_assessment_date":{"type":"string","example":"2026-02-08","description":"The date of the last vulnerability assessment.","format":"date","nullable":true},"vulnerability_duration":{"type":"string","example":"temporary","description":"|\n\nWhether the vulnerability is temporary or permanent.\n\n| Value | Description |\n| ----- | ----------- |\n|temporary|Temporary|\n|permanent|Permanent|","enum":["temporary","permanent"]},"third_party_offered":{"type":"boolean","example":true,"description":"Whether the client has been offered any third party."},"procedure_adaptation":{"type":"boolean","example":true,"description":"Whether any procedures need to be adapted to the client."},"adaption_details_notes":{"type":"boolean","example":true,"description":"Any notes regarding adaptations"},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","description":"Any client preferences."},"current_state_of_health":{"type":"string","example":"Fit and healthy","description":"The client's current state of health."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","description":"Explanation of the current state of health."},"cigarettes_daily":{"type":"integer","example":6,"description":"The amount of cigarettes the client smokes a day."},"smoker_since":{"type":"string","example":"2016-05-08","description":"The date of when the client started smoking.","format":"date"},"long_term_care_needed":{"type":"boolean","example":false,"description":"Whether the client required long term care."},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","description":"Notes on the client's long term care."},"has_will":{"type":"boolean","example":false,"description":"Whether the client has a will or not."},"will_notes":{"type":"string","example":"Notes on the client's will.","description":"Notes on the client's will."},"will_last_reviewed":{"type":"string","example":"2026-05-07","description":"The date of the last time the will's been reviewed.","format":"date"},"has_power_of_attorney":{"type":"boolean","example":true,"description":"Whether the client has power of attorney."},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","description":"Notes on the client's power of attorney."},"first_contact_date":{"type":"string","example":"2026-04-08","description":"The date of the first contact.","format":"date"},"units_of_alcohol_weekly":{"type":"integer","example":28,"description":"The units of alcohol digested weekly."},"height":{"type":"integer","example":186,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"description":"The weight of the client in pounds."},"health_notes":{"type":"string","example":"Notes on the client's health.","description":"Notes on the client's health."},"has_iht_planning":{"type":"boolean","example":true,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","description":"Notes on the client's Inheritance Tax (IHT) planning."},"has_gifted_family":{"type":"boolean","example":true,"description":"Whether the client has gifted the family."},"gift_notes":{"type":"string","example":"Notes on the gifts.","description":"Notes on the gifts."},"is_anticipating_inheritance":{"type":"boolean","example":true,"description":"Whether the client is anticipating/ expecting any inheritance."},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","description":"Notes on the client's inheritance anticipation/ expectations."},"next_review_date":{"type":"string","example":"2026-06-08","description":"Date of next review","format":"date"},"previous_review_date":{"type":"string","example":"2026-04-08","description":"Date of previous review","format":"date"},"anniversary_review_date":{"type":"string","example":"2026-05-08","description":"Anniversary review date","format":"date"},"is_will_accurate":{"type":"boolean","example":true,"description":"Does your current will reflect your wishes?"},"will_executors":{"type":"string","example":"","description":"Who are the executors?"},"will_location":{"type":"string","example":"","description":"Where is the will stored?"},"will_bequests_detail":{"type":"string","example":"","description":"Details of any Bequests"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","description":"|\n\nIs the Power of Attorney Registered as a EPA or LPA\n\n| Value | Description |\n| ----- | ----------- |\n|epa|Epa|\n|lpa|Lpa|","enum":["epa","lpa"]},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","description":"Are the Attorneys appointed for Health, Wealth or Both?","enum":["health","wealth","both"]},"poa_attorney_appointed_at":{"type":"string","example":"2026-05-08","description":"When were the Attorney’s appointed?","format":"date"},"will_poa_details":{"type":"string","example":"","description":"Who are the Attorney’s?"},"are_poa_documents_registered":{"type":"boolean","example":true,"description":"Are the documents registered?"},"will_gifts_details":{"type":"string","example":"","description":"Notes of gifts"},"groups":{"type":"array","example":["ed862302-2181-4e36-9140-2d26c3025d71","b5be4ccd-07b3-489b-bfd8-cb417a2b0a6d","01d3e346-04ec-44ab-b412-5e804edbd41d"],"description":"Group UUIDs to sync client to.","items":{"type":"string","example":"c456a2d2-7c52-4367-87f7-46855156d922","format":"uuid"}},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"description":"Are you in receipt of your State Pension"},"has_obtained_a_forecast":{"type":"boolean","example":true,"description":"Have you recently obtained a forecast"},"date_of_forecast":{"type":"string","example":"2026-05-08","description":"What is the date of the obtained forecast","format":"date"},"projected_state_pension":{"type":"integer","example":50000,"description":"What is the projected State Pension"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"description":"How many years have you made Nation Insurance Contributions"},"pension_notes":{"type":"string","example":"","description":"Notes on the pension"},"status_uuid":{"type":"string","example":"b197c7d7-5541-4be5-934a-0ce84a744a0d","description":"The status of the client.","format":"uuid"},"date_of_marriage":{"type":"string","example":"2026-05-08","description":"Date of marriage","format":"date"},"is_deceased":{"type":"boolean","example":false,"description":"Denotes if the client is deceased"},"deceased_at":{"type":"string","example":"2026-05-08","description":"Date of death","format":"date"},"is_married_to_partner":{"type":"boolean","example":true,"description":"Denotes if the client is married to their partner"},"checked_sanctions_at":{"type":"string","example":"2026-05-08","description":"Date the client was checked for sanctions","format":"date"},"lead_source":{"type":"string","example":"LeadGen Company","description":"Marks the lead source of the client"},"write_to_whom":{"type":"string","example":"Gareth","description":"Marks the name of the client to write to"},"passport_number":{"type":"string","example":"123456","description":"The passport number of the client"},"do_not_contact_via_fax":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_mail":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via mail"},"do_not_contact_via_sms":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via SMS"},"do_not_contact_via_email":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via email"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via telephone"},"do_not_visit":{"type":"boolean","example":false,"description":"Denotes if the client can be visited"},"do_not_market":{"type":"boolean","example":false,"description":"Denotes if the client can be marketed to"},"client_regulatory_classification":{"type":"string","example":"retail_client","description":"|\n\nThe regulatory classification of the client. Possible values are: retail_client, professional_client, eligible_counterparty, not_applicable and unknown\n\n| Value | Description |\n| ----- | ----------- |\n|retail_client|Retail Client|\n|professional_client|Professional Client|\n|eligible_counterparty|Eligible Counterparty|\n|not_applicable|Not Applicable|\n|unknown|Unknown|","enum":["retail_client","professional_client","eligible_counterparty","not_applicable","unknown"]},"external_reference":{"$ref":"#/components/schemas/ExternalReference"}}},"App_Http_Requests_Client_UpdateClientRequest":{"type":"object","properties":{"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Gareth","description":"First name"},"middle_name":{"type":"string","example":"Alex","description":"Middle name."},"last_name":{"type":"string","example":"Thompson","description":"Last name"},"maiden_name":{"type":"string","example":"Thompson","description":"Maiden name."},"entity_name":{"type":"string","example":"Plannr Ltd","description":"Entity name for shared account types"},"assigned_adviser_uuid":{"type":"string","example":"af0787e3-4cf3-4390-91dc-bf65ca714b64","description":"The UUID of the employee that the client directly reports to","format":"uuid"},"assigned_administrator_uuid":{"type":"string","example":"b9c65fc9-97ad-4245-91e5-0037aca27068","description":"The UUID of the adviser employee that the client has been assigned","format":"uuid"},"assigned_paraplanner_uuid":{"type":"string","example":"3d97b381-f02b-4759-9849-33d85d0354eb","description":"The UUID of the paraplanner employee that the client has been assigned","format":"uuid"},"introduced_by_uuid":{"type":"string","example":"e0cbe122-c10f-4433-98c5-83aab2d539c2","description":"The UUID of the introducer for this client","format":"uuid"},"date_of_birth":{"type":"string","example":"1976-05-08","description":"Date of birth","format":"date"},"gender":{"type":"string","example":"male","description":"|\n\nGender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown\n\n| Value | Description |\n| ----- | ----------- |\n|male|male|\n|female|female|\n|non-binary|non-binary|\n|transgender|transgender|\n|intersex|intersex|\n|other|other|\n|unknown|unknown|","enum":["male","female","non-binary","transgender","intersex","other","unknown"]},"ni_number":{"type":"string","example":"AB 12 34 56 C","description":"National Insurance Number"},"nickname":{"type":"string","example":"Garth","description":"preferred nickname of the client"},"target_retirement_age":{"type":"integer","example":60,"description":"Target retirement age."},"pronouns":{"type":"string","example":"he/him","description":"Pronouns"},"smoker_status":{"type":"string","example":"smoker","description":"|\n\nSmoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown\n\n| Value | Description |\n| ----- | ----------- |\n|smoker|Smoker|\n|non-smoker|Non Smoker|\n|vaper|Vaper|\n|ex-smoker|Ex Smoker|\n|never-smoked|Never Smoked|\n|unknown|Unknown|","enum":["smoker","non-smoker","vaper","ex-smoker","never-smoked","unknown"]},"residential_status":{"type":"string","example":"homeowner","description":"|\n\nResidential status\n\n| Value | Description |\n| ----- | ----------- |\n|homeowner|Homeowner|\n|renting|Renting|\n|living_with_parents|Living With Parents|\n|other|Other|","enum":["homeowner","renting","living_with_parents","other"]},"country_of_residence":{"type":"string","example":"United Kingdom","description":"Country of residence"},"marital_status":{"type":"string","example":"single","description":"|\n\nMarital status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown\n\n| Value | Description |\n| ----- | ----------- |\n|single|single|\n|cohabiting|cohabiting|\n|married|married|\n|divorced|divorced|\n|civil-partnership|civil partnership|\n|dissolved-civil-partnership|dissolved-civil-partnership|\n|widowed|widowed|\n|separated|separated|\n|engaged|engaged|\n|in-relationship|in a relationship|\n|other|other|\n|unknown|unknown|","enum":["single","cohabiting","married","divorced","civil-partnership","dissolved-civil-partnership","widowed","separated","engaged","in-relationship","other","unknown"]},"is_vulnerable":{"type":"string","example":"yes","description":"whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\"","enum":["yes","no","possibly"]},"is_prospect":{"type":"boolean","example":false,"description":"Denotes if the client is a prospect or not."},"prospect_converted_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The datetime when the prospect was converted into a client.","format":"date"},"value":{"type":"integer","example":500000,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"is_uk_resident":{"type":"boolean","example":true,"description":"Whether the client is a UK resident or not."},"is_uk_domicile":{"type":"boolean","example":true,"description":"Whether the client is a UK domicile or not."},"expected_retirement_age":{"type":"integer","example":60,"description":"The expected retirement age."},"state_retirement_age":{"type":"integer","example":60,"description":"The state retirement age."},"nationalities":{"type":"array","example":["British","Romanian"],"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","description":"Any details regarding the client's vulnerabilities."},"vulnerability_sub_type":{"type":"array","example":[],"description":"One or more vulnerability sub types.","items":{"type":"string","example":"health","enum":["health","life_events","resilience","capability"]}},"vulnerability_last_assessment_date":{"type":"string","example":"2026-02-08","description":"The date of the last vulnerability assessment.","format":"date","nullable":true},"vulnerability_duration":{"type":"string","example":"temporary","description":"|\n\nWhether the vulnerability is temporary or permanent.\n\n| Value | Description |\n| ----- | ----------- |\n|temporary|Temporary|\n|permanent|Permanent|","enum":["temporary","permanent"]},"third_party_offered":{"type":"boolean","example":true,"description":"Whether the client has been offered any third party."},"procedure_adaptation":{"type":"boolean","example":false,"description":"Whether any procedures need to be adapted to the client."},"adaption_details_notes":{"type":"boolean","example":true,"description":"Any notes regarding adaptations"},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","description":"Any client preferences."},"current_state_of_health":{"type":"string","example":"Fit and healthy","description":"The client's current state of health."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","description":"Explanation of the current state of health."},"cigarettes_daily":{"type":"integer","example":6,"description":"The amount of cigarettes the client smokes a day."},"smoker_since":{"type":"string","example":"2016-05-08","description":"The date of when the client started smoking.","format":"date"},"long_term_care_needed":{"type":"boolean","example":false,"description":"Whether the client required long term care."},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","description":"Notes on the client's long term care."},"has_will":{"type":"boolean","example":true,"description":"Whether the client has a will or not."},"will_notes":{"type":"string","example":"Notes on the client's will.","description":"Notes on the client's will."},"will_last_reviewed":{"type":"string","example":"2026-05-08","description":"The date of the last time the will's been reviewed.","format":"date"},"has_power_of_attorney":{"type":"boolean","example":true,"description":"Whether the client has power of attorney."},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","description":"Notes on the client's power of attorney."},"first_contact_date":{"type":"string","example":"2026-04-08","description":"The date of the first contact.","format":"date"},"units_of_alcohol_weekly":{"type":"integer","example":28,"description":"The units of alcohol digested weekly."},"height":{"type":"integer","example":186,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"description":"The weight of the client in pounds."},"health_notes":{"type":"string","example":"Notes on the client's health.","description":"Notes on the client's health."},"has_iht_planning":{"type":"boolean","example":true,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","description":"Notes on the client's Inheritance Tax (IHT) planning."},"has_gifted_family":{"type":"boolean","example":true,"description":"Whether the client has gifted the family."},"gift_notes":{"type":"string","example":"Notes on the gifts.","description":"Notes on the gifts."},"is_anticipating_inheritance":{"type":"boolean","example":true,"description":"Whether the client is anticipating/ expecting any inheritance."},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","description":"Notes on the client's inheritance anticipation/ expectations."},"next_review_date":{"type":"string","example":"2026-06-08","description":"Date of next review","format":"date"},"previous_review_date":{"type":"string","example":"2026-04-08","description":"Date of previous review","format":"date"},"anniversary_review_date":{"type":"string","example":"2026-05-08","description":"Anniversary review date","format":"date"},"is_will_accurate":{"type":"boolean","example":true,"description":"Does your current will reflect your wishes?"},"will_executors":{"type":"string","example":"","description":"Who are the executors?"},"will_location":{"type":"string","example":"","description":"Where is the will stored?"},"will_bequests_detail":{"type":"string","example":"","description":"Details of any Bequests"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","description":"|\n\nIs the Power of Attorney Registered as a EPA or LPA\n\n| Value | Description |\n| ----- | ----------- |\n|epa|Epa|\n|lpa|Lpa|","enum":["epa","lpa"]},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","description":"Are the Attorneys appointed for Health, Wealth or Both?","enum":["health","wealth","both"]},"poa_attorney_appointed_at":{"type":"string","example":"2026-05-08","description":"When were the Attorney’s appointed?","format":"date"},"will_poa_details":{"type":"string","example":"","description":"Who are the Attorney’s?"},"are_poa_documents_registered":{"type":"boolean","example":true,"description":"Are the documents registered?"},"will_gifts_details":{"type":"string","example":"","description":"Notes of gifts"},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"description":"Are you in receipt of your State Pension"},"has_obtained_a_forecast":{"type":"boolean","example":true,"description":"Have you recently obtained a forecast"},"date_of_forecast":{"type":"string","example":"2026-05-08","description":"What is the date of the obtained forecast","format":"date"},"projected_state_pension":{"type":"integer","example":50000,"description":"What is the projected State Pension"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"description":"How many years have you made Nation Insurance Contributions"},"pension_notes":{"type":"string","example":"","description":"Notes on the pension"},"date_of_marriage":{"type":"string","example":"2026-05-08","description":"Date of marriage","format":"date"},"is_deceased":{"type":"boolean","example":false,"description":"Denotes if the client is deceased"},"deceased_at":{"type":"string","example":"2026-05-08","description":"Date of death","format":"date"},"is_married_to_partner":{"type":"boolean","example":true,"description":"Denotes if the client is married to their partner"},"checked_sanctions_at":{"type":"string","example":"2026-05-08","description":"Date the client was checked for sanctions","format":"date"},"lead_source":{"type":"string","example":"LeadGen Company","description":"Marks the lead source of the client"},"write_to_whom":{"type":"string","example":"Gareth","description":"Marks the name of the client to write to"},"passport_number":{"type":"string","example":"123456","description":"The passport number of the client"},"do_not_contact_via_fax":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_mail":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via mail"},"do_not_contact_via_sms":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via SMS"},"do_not_contact_via_email":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via email"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via telephone"},"do_not_visit":{"type":"boolean","example":false,"description":"Denotes if the client can be visited"},"do_not_market":{"type":"boolean","example":false,"description":"Denotes if the client can be visited"},"status_uuid":{"type":"string","example":"c376287f-d512-4e0e-801e-315c2f72dee6","description":"The status of the client.","format":"uuid"},"groups":{"type":"array","example":["c700491f-6ade-4f68-862b-a4da87880e12","e97ea868-4f2c-460d-ab84-203d194ffab8","d369dc5e-f4c1-4299-8c0a-7d52e2bc3007"],"description":"Group UUIDs to sync client to. Null can be provided to clear a clients groups.","items":{"type":"string","example":"6e840bfc-5466-4216-b1e2-d9fffdd76798","format":"uuid"}},"client_regulatory_classification":{"type":"string","example":"professional_client","description":"The regulatory classification of the client. Possible values are: retail_client, professional_client, eligible_counterparty, not_applicable and unknown"}}},"App_Http_Requests_Expenditure_StoreOrUpdateExpenditureRequest":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","example":50000,"description":"The amount of the expenditure in pennies."},"life_stage_section_uuid":{"type":"string","example":"826ee696-6ac5-4252-85db-abbebea37784","description":"The life stage section UUID.","format":"uuid"}}},"App_Http_Requests_StoreGoalRequest":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string","example":"Reduced Mileage","description":"The goal's name."},"description":{"type":"string","example":"Reduce the amount of gas spent yearly.","description":"The goal's description."},"target_amount":{"type":"integer","example":5000,"description":"The goal's target amount."},"progress":{"type":"number","example":68.0,"description":"The goal's progress as a percentage.","format":"float","minimum":0.0,"maximum":100.0},"timeframe":{"type":"string","example":"Within the year.","description":"The goal's timeframe."},"complete_goal_by":{"type":"string","example":"2027-05-08T14:41:54+01:00","description":"The goal's deadline as a specific date."},"priority":{"type":"integer","example":4,"description":"The goal's priority on a scale from 1 to 5.","enum":[1,2,3,4,5]},"shared_owner_uuid":{"type":"string","example":"f539ab38-52d4-493e-9e71-1b1ffd472c70","description":"Optional UUID of an owner account. The client must be a shared type."}}},"App_Http_Requests_UpdateGoalRequest":{"type":"object","properties":{"name":{"type":"string","example":"Reduced Mileage","description":"The goal's name."},"description":{"type":"string","example":"Reduce the amount of gas spent yearly.","description":"The goal's description."},"target_amount":{"type":"integer","example":5000,"description":"The goal's target amount."},"progress":{"type":"number","example":68.0,"description":"The goal's progress as a percentage.","format":"float","minimum":0.0,"maximum":100.0},"timeframe":{"type":"string","example":"Within the year.","description":"The goal's timeframe."},"complete_goal_by":{"type":"string","example":"2027-05-08","description":"The goal's deadline as a specific date.","format":"date"},"priority":{"type":"integer","example":4,"description":"The goal's priority on a scale from 1 to 5.","enum":[1,2,3,4,5]},"shared_owner_uuid":{"type":"string","example":"c2fb5a87-77b9-42b9-9138-513780559996","description":"Optional UUID of an owner account. The client must be a shared type.","format":"uuid"}}},"App_Http_Requests_Risk_StoreRiskRequest":{"type":"object","required":["completed_at","completed_by"],"properties":{"level":{"type":"integer","example":52,"description":"The risk level of the clients risk assessment. Number between 1 and 1,000. Cannot be set with level_string"},"level_string":{"type":"string","example":"Moderately Aggressive","description":"The risk level of the client as a string/text. Cannot be set with level."},"completed_at":{"type":"string","example":"2025-05-08","description":"Date of risk assessment completion.","format":"date"},"completed_by":{"type":"string","example":"aa2ab8bc-49ae-4b25-9897-e1331cb3cebf","description":"Uuid of the employee that completed the risk assessment","format":"uuid"},"risk_assessment_provider":{"type":"string","example":"Defaqto","description":"Name of provider for the risk assessment"},"time_horizon":{"type":"string","example":"For the next 5 years","description":"Time horizon: how long the risk assessment will last for the client."}}},"App_Http_Requests_Risk_UpdateRiskRequest":{"type":"object","properties":{"level":{"type":"integer","example":7,"description":"The risk level of the clients risk assessment. Number between 1 and 1,000. Cannot be set with level_string"},"level_string":{"type":"string","example":"Moderately Aggressive","description":"The risk level of the client as a string/text. Cannot be set with level."},"completed_at":{"type":"string","example":"2025-05-08","description":"Date of risk assessment completion.","format":"date"},"completed_by":{"type":"string","example":"3254b7c5-25a4-4348-9762-010ab779b9de","description":"Uuid of the employee that completed the risk assessment","format":"uuid"},"risk_assessment_provider":{"type":"string","example":"Defaqto","description":"Name of provider for the risk assessment"},"time_horizon":{"type":"string","example":"For the next 5 years","description":"Time horizon: how long the risk assessment will last for the client."}}},"App_Http_Requests_Client_StoreClientLinkRequest":{"type":"object","required":["account_uuid","relationship","inverse_relationship"],"properties":{"account_uuid":{"type":"string","example":"ac6781c5-63cf-48d4-a6f6-38f0378bca69","description":"The client that you would like to be linked.","format":"uuid"},"relationship":{"type":"string","example":"Son","description":"The relationship to the linked client."},"inverse_relationship":{"type":"string","example":"Father","description":"The inverse relationship to the client."}}},"App_Http_Requests_Client_UpdateClientLinkRequest":{"type":"object","required":["relationship","inverse_relationship"],"properties":{"relationship":{"type":"string","example":"Son","description":"The relationship to the linked client."},"inverse_relationship":{"type":"string","example":"Father","description":"The inverse relationship to the client."}}},"App_Http_Requests_Client_ManageClientOwnersRequest":{"type":"object","required":["mode","owners"],"properties":{"mode":{"type":"string","example":"attach","description":"The mode that you want to apply when managing owners. Available options: attach, detach, sync.","enum":["attach","detach","sync"]},"owners":{"type":"array","example":["ff384773-1fe4-4022-8be6-d1a9db3a9889","cdcc8118-0b6d-45d5-85f8-5cc6fd312d3f","58393ff9-7a43-4ac4-a848-9ce8ad4cde92"],"description":"An array containing the owners you want to manage.","items":{"type":"string","example":"e3b83645-c9ec-4d7b-81b0-bea8c531a957","format":"uuid"}}}},"App_Http_Requests_Client_UpdateOwnersPersonalDetailsRequest":{"type":"object","properties":{"title":{"type":"string","example":"mr","description":"|\n\nTitle\n\n| Value | Description |\n| ----- | ----------- |\n|mr|Mr|\n|mrs|Mrs|\n|ms|Ms|\n|miss|Miss|\n|admiral|Admiral|\n|air_commodore|Air Commodore|\n|air_vice_marshall|Air Vice Marshall|\n|archdeacon|Archdeacon|\n|baron|Baron|\n|baroness|Baroness|\n|bishop|Bishop|\n|brigadier|Brigadier|\n|canon|Canon|\n|captain|Captain|\n|colonel|Colonel|\n|commander|Commander|\n|commodore|Commodore|\n|corporal|Corporal|\n|count|Count|\n|countess|Countess|\n|dame|Dame|\n|deacon|Deacon|\n|deaconess|Deaconess|\n|dr|Dr|\n|duchess|Duchess|\n|father|Father|\n|flight_lieutenant|Flight Lieutenant|\n|group_captain|Group Captain|\n|judge|Judge|\n|lady|Lady|\n|lance_corporal|Lance Corporal|\n|lieutenant|Lieutenant|\n|lieutenant_colonel|Lieutenant Colonel|\n|lieutenant_commander|Lieutenant Commander|\n|lord|Lord|\n|madam|Madam|\n|major|Major|\n|major_general|Major General|\n|master|Master|\n|monsignor|Monsignor|\n|mx|Mx|\n|other|Other|\n|pastor|Pastor|\n|prince|Prince|\n|princess|Princess|\n|private|Private|\n|professor|Professor|\n|rabbi|Rabbi|\n|rear_admiral|Rear Admiral|\n|reverend|Reverend|\n|reverend_doctor|Reverend Doctor|\n|right_honourable|Right Honourable|\n|right_honourable_lord|Right Honourable Lord|\n|right_reverend|Right Reverend|\n|second_lieutenant|Second Lieutenant|\n|sergeant|Sergeant|\n|sheriff|Sheriff|\n|sir|Sir|\n|sister|Sister|\n|squadron_leader|Squadron Leader|\n|staff_sergeant|Staff Sergeant|\n|surgeon_captain|Surgeon Captain|\n|the_earl_of|The Earl of|\n|the_honourable|The Honourable|\n|the_reverend_canon|The Reverend Canon|\n|trooper|Trooper|\n|unspecified|Unspecified|\n|venerable|Venerable|\n|very_reverend|Very Reverend|\n|viscount|Viscount|\n|viscountess|Viscountess|\n|wing_commander|Wing Commander|","enum":["mr","mrs","ms","miss","admiral","air_commodore","air_vice_marshall","archdeacon","baron","baroness","bishop","brigadier","canon","captain","colonel","commander","commodore","corporal","count","countess","dame","deacon","deaconess","dr","duchess","father","flight_lieutenant","group_captain","judge","lady","lance_corporal","lieutenant","lieutenant_colonel","lieutenant_commander","lord","madam","major","major_general","master","monsignor","mx","other","pastor","prince","princess","private","professor","rabbi","rear_admiral","reverend","reverend_doctor","right_honourable","right_honourable_lord","right_reverend","second_lieutenant","sergeant","sheriff","sir","sister","squadron_leader","staff_sergeant","surgeon_captain","the_earl_of","the_honourable","the_reverend_canon","trooper","unspecified","venerable","very_reverend","viscount","viscountess","wing_commander"]},"first_name":{"type":"string","example":"Gareth","description":"First name"},"middle_name":{"type":"string","example":"Alex","description":"Middle name."},"last_name":{"type":"string","example":"Thompson","description":"Last name"},"maiden_name":{"type":"string","example":"Thompson","description":"Maiden name."},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email address"},"date_of_birth":{"type":"string","example":"1976-05-08","description":"Date of birth","format":"date"},"gender":{"type":"string","example":"male","description":"|\n\nGender\n\n| Value | Description |\n| ----- | ----------- |\n|male|male|\n|female|female|\n|non-binary|non-binary|\n|transgender|transgender|\n|intersex|intersex|\n|other|other|\n|unknown|unknown|","enum":["male","female","non-binary","transgender","intersex","other","unknown"]},"ni_number":{"type":"string","example":"AB 12 34 56 C","description":"National Insurance Number"},"target_retirement_age":{"type":"integer","example":60,"description":"Target retirement age."},"pronouns":{"type":"string","example":"he/him","description":"Pronouns"},"smoker_status":{"type":"string","example":"smoker","description":"|\n\nSmoker Status\n\n| Value | Description |\n| ----- | ----------- |\n|smoker|Smoker|\n|non-smoker|Non Smoker|\n|vaper|Vaper|\n|ex-smoker|Ex Smoker|\n|never-smoked|Never Smoked|\n|unknown|Unknown|","enum":["smoker","non-smoker","vaper","ex-smoker","never-smoked","unknown"]},"residential_status":{"type":"string","example":"homeowner","description":"|\n\nResidential status\n\n| Value | Description |\n| ----- | ----------- |\n|homeowner|Homeowner|\n|renting|Renting|\n|living_with_parents|Living With Parents|\n|other|Other|","enum":["homeowner","renting","living_with_parents","other"]},"country_of_residence":{"type":"string","example":"United Kingdom","description":"Country of residence"},"marital_status":{"type":"string","example":"single","description":"|\n\nMarital Status\n\n| Value | Description |\n| ----- | ----------- |\n|single|single|\n|cohabiting|cohabiting|\n|married|married|\n|divorced|divorced|\n|civil-partnership|civil partnership|\n|dissolved-civil-partnership|dissolved-civil-partnership|\n|widowed|widowed|\n|separated|separated|\n|engaged|engaged|\n|in-relationship|in a relationship|\n|other|other|\n|unknown|unknown|","enum":["single","cohabiting","married","divorced","civil-partnership","dissolved-civil-partnership","widowed","separated","engaged","in-relationship","other","unknown"]},"is_vulnerable":{"type":"string","example":"possibly","description":"whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\""},"is_uk_resident":{"type":"boolean","example":true,"description":"Whether the client is a UK resident or not."},"is_uk_domicile":{"type":"boolean","example":true,"description":"Whether the client is a uk domicile or not."},"expected_retirement_age":{"type":"integer","example":60,"description":"The expected retirement age."},"state_retirement_age":{"type":"integer","example":60,"description":"The state retirement age."},"nationalities":{"type":"array","example":["British","Romanian"],"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","description":"Any details regarding the client's vulnerabilities."},"vulnerability_sub_type":{"type":"array","example":[],"description":"One or more vulnerability sub types.","items":{"type":"string","example":"health","enum":["health","life_events","resilience","capability"]}},"vulnerability_last_assessment_date":{"type":"string","example":"2026-02-08","description":"The date of the last vulnerability assessment.","format":"date","nullable":true},"vulnerability_duration":{"type":"string","example":"temporary","description":"|\n\nWhether the vulnerability is temporary or permanent.\n\n| Value | Description |\n| ----- | ----------- |\n|temporary|Temporary|\n|permanent|Permanent|","enum":["temporary","permanent"]},"third_party_offered":{"type":"boolean","example":true,"description":"Whether the client has been offered any third party."},"procedure_adaptation":{"type":"boolean","example":false,"description":"Whether any procedures need to be adapted to the client."},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","description":"Any client preferences."},"current_state_of_health":{"type":"string","example":"Fit and healthy","description":"The client's current state of health."},"state_of_health_explanation":{"type":"string","example":"They go to the gym every week","description":"Any explanation on the client's state of health."},"cigarettes_daily":{"type":"integer","example":6,"description":"The amount of cigarettes the client smokes a day."},"smoker_since":{"type":"string","example":"2022-05-08","description":"The date of when the client started smoking.","format":"date"},"last_used_nicotine_products_date":{"type":"string","example":"2026-05-08","description":"The date of the last time the client used nicotine products.","format":"date"},"long_term_care_needed":{"type":"boolean","example":false,"description":"Whether the client required long term care."},"long_term_care_notes":{"type":"string","example":" No Notes.","description":"Notes on the client's long term care."},"has_will":{"type":"boolean","example":true,"description":"Whether the client has a will or not."},"will_notes":{"type":"string","example":"No Notes.","description":"Notes on the client's will."},"will_last_reviewed":{"type":"string","example":"2026-05-08","description":"The date of the last time the will's been reviewed.","format":"date"},"has_power_of_attorney":{"type":"boolean","example":true,"description":"Whether the client has power of attorney."},"power_of_attorney_notes":{"type":"string","example":"Power of Attorney for themself \u0026 partner.","description":"Notes on the client's power of attorney."},"first_contact_date":{"type":"string","example":"2025-05-08","description":"The date of the first contact.","format":"date"},"next_review_date":{"type":"string","example":"2027-05-08","description":"The date of the next review.","format":"date"},"units_of_alcohol_weekly":{"type":"integer","example":12,"description":"The units of alcohol digested weekly."},"height":{"type":"integer","example":180,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"description":"The weight of the client in pounds."},"health_notes":{"type":"string","example":"No Notes.","description":"Notes on the client's health."},"has_iht_planning":{"type":"boolean","example":true,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"iht_planning_notes":{"type":"string","example":"No Notes.","description":"Notes on the client's Inheritance Tax (IHT) planning."},"has_gifted_family":{"type":"boolean","example":true,"description":"Whether the client has gifted the family."},"gift_notes":{"type":"string","example":"No Notes.","description":"Notes on the gifts."},"is_anticipating_inheritance":{"type":"boolean","example":true,"description":"Whether the client is anticipating/expecting any inheritance."},"anticipating_inheritance_notes":{"type":"string","example":"No Notes.","description":"Notes on the client's inheritance anticipation/expectations."}}},"App_Http_Requests_Dependants_StoreDependantRequest":{"type":"object","required":["first_name","last_name","relationship"],"properties":{"first_name":{"type":"string","example":"Christopher","description":"The first name of the dependant."},"last_name":{"type":"string","example":"Nolan","description":"The last name of the dependant."},"known_as":{"type":"string","example":"Chris","description":"An optional nickname for the dependant."},"relationship":{"type":"string","example":"Brother","description":"The relationship of the dependant."},"date_of_birth":{"type":"string","example":"2006-05-08","description":"The date of birth of the dependant. Must be in Y-m-d format. Example: 1990-12-25.","format":"date"},"is_financially_dependant":{"type":"boolean","example":true,"description":"Denotes if the dependant is financially dependant on the client."},"notes":{"type":"string","example":"Example notes","description":"Optional notes for the dependant."},"shared_owner_uuid":{"type":"string","example":"d0f65c8a-2f86-41fd-97e7-0efbb7891cbf","description":"Optional UUID of an owner account. The client must be a shared type.","format":"uuid"}}},"App_Http_Requests_Dependants_UpdateDependantRequest":{"type":"object","properties":{"first_name":{"type":"string","example":"Christopher","description":"The first name of the dependant."},"last_name":{"type":"string","example":"Nolan","description":"The last name of the dependant."},"known_as":{"type":"string","example":"Chris","description":"An optional nickname for the dependant."},"relationship":{"type":"string","example":"Brother","description":"The relationship of the dependant."},"date_of_birth":{"type":"string","example":"2006-05-08","description":"The date of birth of the dependant. Must be in Y-m-d format. Example: 1990-12-25.","format":"date"},"is_financially_dependant":{"type":"boolean","example":true,"description":"Denotes if the dependant is financially dependant on the client."},"notes":{"type":"string","example":"Example notes","description":"Optional notes for the dependant."},"shared_owner_uuid":{"type":"string","example":"6a7caf7a-1f5f-432b-ae50-ce83a00485c5","description":"Optional UUID of an owner account. The client must be a shared type.","format":"uuid"}}},"App_Http_Requests_Employments_StoreEmploymentRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","example":"employed","description":"|\n\nThe employment status for the given employment. Available values: employed, self_employed, student, unemployed, house_person, retired and other\n\n| Value | Description |\n| ----- | ----------- |\n|employed|Employed|\n|self_employed|Self Employed|\n|student|Student|\n|unemployed|Unemployed|\n|house_person|House Person|\n|retired|Retired|\n|other|Other|","enum":["employed","self_employed","student","unemployed","house_person","retired","other"]},"primary":{"type":"boolean","example":true,"description":"Make this employment the primary employment.  Will make all other employments no longer primary."},"occupation_code":{"type":"string","example":"FAC02774","description":"The Origo occupation code for the given employment. You can use the /api/v1/static/occupations endpoint to get a list of occupations."},"job_title":{"type":"string","example":"Senior Developer","description":"Job title if no suitable occupation code is found."},"employer":{"type":"string","example":"Plannr Technologies Ltd","description":"The name of the employer/business."},"started_at":{"type":"string","example":"2021-05-08","description":"An optional start date of the employment.","format":"date"},"ended_at":{"type":"string","example":"2022-05-08","description":"An optional end date of the employment.","format":"date"},"is_business_owner":{"type":"boolean","example":true,"description":"Denotes if the employment owner is the business owner."},"percentage_of_business_owned":{"type":"integer","example":50,"description":"The percentage of the business owned."},"address":{"$ref":"#/components/schemas/SimpleAddress"},"email_address":{"type":"string","example":"gareth@plannrcrm.com","description":"The email address of the employer. Will be added as a contact detail."},"phone_number":{"type":"string","example":"+443330509960","description":"The phone number of the employer. In E.164 format. Will be added as a contact detail."},"shared_owner_uuid":{"type":"string","example":"6e61de63-f66b-4744-ae49-f561b3dec2ec","description":"Optional UUID of an owner account. The client must be a shared type."},"last_salary_increase":{"type":"string","example":"2019-01-01","description":"The date of the last salary increase.","format":"date"},"business_name":{"type":"string","example":"My Business","description":"The name of the business."},"business_year_end":{"type":"string","example":"2019-01-01","description":"The year end of the business."},"business_value":{"type":"integer","example":5000000,"description":"The value of the business in pennies."},"directors":{"type":"string","example":"John Doe","description":"The directors of the business."},"shareholding_in_business":{"type":"number","example":50.5,"description":"The shareholding in the business in percentage.","format":"float"},"profit":{"type":"integer","example":5000000,"description":"The profit of the business in pennies."},"turnover_history":{"type":"array","example":[],"description":"The turnover history of the business for each year.  All values must be in pennies as integers.","items":{"type":"object","example":[{"year":2022,"value":5000000},{"year":2021,"value":4500000}],"properties":{"year":{"type":"string","example":"2022","description":"Year for this history item"},"value":{"type":"integer","example":4500000,"description":"The Value for the year specified"}}}},"accountant_company_name":{"type":"string","example":"My Company","description":"The name of the accountant company."},"accountant_email":{"type":"string","example":"accountant@email.com","description":"The email of the accountant."},"accountant_telephone_number":{"type":"string","example":"0123456789","description":"The telephone number of the accountant."},"accountant_address":{"type":"string","example":"1 My Street, My Town, My Country","description":"The address of the accountant."}}},"App_Http_Requests_Employments_UpdateEmploymentRequest":{"type":"object","properties":{"status":{"type":"string","example":"employed","description":"The employment status for the given employment. Available values: employed, self_employed, student, unemployed, house_person, retired and other"},"primary":{"type":"boolean","example":true,"description":"Make this employment the primary employment.  Will make all other employments no longer primary."},"occupation_code":{"type":"string","example":"FAC02774","description":"The Origo occupation code for the given employment. You can use the /api/v1/static/occupations endpoint to get a list of occupations."},"job_title":{"type":"string","example":"Senior Developer","description":"Job title if no suitable occupation code is found."},"employer":{"type":"string","example":"Plannr Technologies Ltd","description":"The name of the employer/business."},"started_at":{"type":"string","example":"2021-05-08T14:41:54+01:00","description":"An optional start date of the employment.","format":"date"},"ended_at":{"type":"string","example":"2022-05-08T14:41:54+01:00","description":"An optional end date of the employment.","format":"date"},"is_business_owner":{"type":"boolean","example":true,"description":"Denotes if the employment owner is the business owner."},"percentage_of_business_owned":{"type":"integer","example":50,"description":"The percentage of the business owned."},"address":{"$ref":"#/components/schemas/SimpleAddress"},"email_address":{"type":"string","example":"gareth@plannrcrm.com","description":"The email address of the employer. Will be added as a contact detail."},"phone_number":{"type":"string","example":"+443330509960","description":"The phone number of the employer. In E.164 format. Will be added as a contact detail."},"shared_owner_uuid":{"type":"string","example":"d8a61f63-4c17-4d79-a58b-08249b7e4f49","description":"Optional UUID of an owner account. The client must be a shared type.","format":"uuid"},"last_salary_increase":{"type":"string","example":"2019-01-01","description":"The date of the last salary increase.","format":"date"},"business_name":{"type":"string","example":"My Business","description":"The name of the business."},"business_year_end":{"type":"string","example":"2019-01-01","description":"The year end of the business.","format":"date"},"business_value":{"type":"integer","example":5000000,"description":"The value of the business in pennies."},"directors":{"type":"string","example":"John Doe","description":"The directors of the business."},"shareholding_in_business":{"type":"integer","example":50,"description":"The shareholding in the business in percentage."},"profit":{"type":"integer","example":5000000,"description":"The profit of the business in pennies."},"turnover_history":{"type":"array","example":[],"description":"The turnover history of the business for each year.  All values must be in pennies as integers.","items":{"type":"object","example":[{"year":2022,"value":5000000},{"year":2021,"value":4500000}],"properties":{"year":{"type":"string","example":"2022","description":"Year for this history item"},"value":{"type":"integer","example":4500000,"description":"The Value for the year specified"}}}},"accountant_company_name":{"type":"string","example":"My Company","description":"The name of the accountant company."},"accountant_email":{"type":"string","example":"accountant@email.com","description":"The email of the accountant."},"accountant_telephone_number":{"type":"string","example":"0123456789","description":"The telephone number of the accountant."},"accountant_address":{"type":"string","example":"1 My Street, My Town, My Country","description":"The address of the accountant."}}},"App_Http_Requests_StoreIncomeRequest":{"type":"object","required":["name","type","amount","amount_type","frequency"],"properties":{"name":{"type":"string","example":"My Salary","description":"The name of the income."},"type":{"type":"string","example":"salary","description":"|\n\nThe type of income. Possible values:\n\n| Value | Description |\n| ----- | ----------- |\n|salary|Salary|\n|dividend|Dividend|\n|bonus|Bonus|\n|benefit|Benefit|\n|other|Other|\n|investment|Investment|\n|rental|Rental|\n|pension|Pension|\n|capital_gains|Capital Gains|\n|business_loan|Business Loan|\n|investor_funding|Investor Funding|\n|grant|Grant|\n|charity|Charity|\n|crowdfunding|Crowdfunding|\n|gross_profit|Gross Profit|\n|operating_profit|Operating Profit|\n|operating_revenue|Operating Revenue|\n|non_operating_revenue|Non Operating Revenue|\n|net_profit|Net Profit|","enum":["salary","dividend","bonus","benefit","other","investment","rental","pension","capital_gains","business_loan","investor_funding","grant","charity","crowdfunding","gross_profit","operating_profit","operating_revenue","non_operating_revenue","net_profit"]},"type_other":{"type":"string","example":"null","description":"The other type of income. This is required if the type is \"other\"."},"amount":{"type":"integer","example":5000000,"description":"The amount of the income in pennies. For example, £50,000 would be 5000000."},"amount_type":{"type":"string","example":"net","description":"|\n\nThe type of the amount.\n\n| Value | Description |\n| ----- | ----------- |\n|net|Net|\n|gross|Gross|","enum":["net","gross"]},"start_date":{"type":"string","example":"2025-05-08","description":"The start date of the income.","format":"date"},"end_date":{"type":"string","example":"2026-05-08","description":"The end date of the income.","format":"date"},"frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency of the income.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"is_taxable":{"type":"boolean","example":true,"description":"Denotes if the income is taxable or not."},"shared_owner_uuid":{"type":"string","example":"147c1a10-ba40-450a-bf85-00c86ac95830","description":"Optional UUID of an owner account. The client must be a shared type.","format":"uuid"},"employment_uuid":{"type":"string","example":"d3cb6018-ae7a-449a-bbd7-a756871a4c4c","description":"Employment to link to this salary, dividend, bonus, benefit, other type incomes.","format":"uuid"}}},"App_Http_Requests_UpdateIncomeRequest":{"type":"object","properties":{"name":{"type":"string","example":"My Salary","description":"The name of the income."},"type":{"type":"string","example":"salary","description":"|\n\nThe type of income.\n\n| Value | Description |\n| ----- | ----------- |\n|salary|Salary|\n|dividend|Dividend|\n|bonus|Bonus|\n|benefit|Benefit|\n|other|Other|\n|investment|Investment|\n|rental|Rental|\n|pension|Pension|\n|capital_gains|Capital Gains|\n|business_loan|Business Loan|\n|investor_funding|Investor Funding|\n|grant|Grant|\n|charity|Charity|\n|crowdfunding|Crowdfunding|\n|gross_profit|Gross Profit|\n|operating_profit|Operating Profit|\n|operating_revenue|Operating Revenue|\n|non_operating_revenue|Non Operating Revenue|\n|net_profit|Net Profit|","enum":["salary","dividend","bonus","benefit","other","investment","rental","pension","capital_gains","business_loan","investor_funding","grant","charity","crowdfunding","gross_profit","operating_profit","operating_revenue","non_operating_revenue","net_profit"]},"type_other":{"type":"string","example":"My Other Income","description":"The type of income when the type is set to \"other\"."},"amount":{"type":"integer","example":5000000,"description":"The amount of the income in pennies. For example, £50,000 would be 5000000."},"amount_type":{"type":"string","example":"net","description":"|\n\nThe type of the amount.\n\n| Value | Description |\n| ----- | ----------- |\n|net|Net|\n|gross|Gross|","enum":["net","gross"]},"start_date":{"type":"string","example":"2026-05-08","description":"The start date of the income.","format":"date"},"end_date":{"type":"string","example":"2026-05-08","description":"The end date of the income.","format":"date"},"frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency of the income.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"is_taxable":{"type":"boolean","example":true,"description":"Denotes if the income is taxable or not."},"shared_owner_uuid":{"type":"string","example":"2b3bf643-ff7e-4eec-9015-c661eb3ed1ff","description":"Optional UUID of an owner account. The client must be a shared type.","format":"uuid"},"employment_uuid":{"type":"string","example":"89cf58bb-c270-4d88-a62d-c9c04f76ec6a","description":"Employment to link to this salary, dividend, bonus, benefit, other type incomes.","format":"uuid"}}},"App_Http_Requests_Client_StoreStaffMemberRequest":{"type":"object","required":["account_uuid","hired_at"],"properties":{"account_uuid":{"type":"string","example":"49ef9109-5c47-46f9-a3cb-246d0774e4e5","description":"UUID of another client account in Plannr. This account must be an individual.","format":"uuid"},"hired_at":{"type":"string","example":"2018-01-15","description":"Date (y-m-d) of when the staff member was hired.","format":"date"},"left_at":{"type":"string","example":"2025-01-15","description":"Date (y-m-d) of when the staff member left.","format":"date"},"job_title":{"type":"string","example":"Chief Coffee Maker","description":"The job title of the staff member."},"basic_annual_salary":{"type":"integer","example":5000000,"description":"The basic annual salary of the staff member. Must be in pennies, for example: £50,000 would be 5000000."},"payroll_number":{"type":"string","example":"#12345","description":"The payroll number of the staff member."}}},"App_Http_Requests_Client_UpdateStaffMemberRequest":{"type":"object","properties":{"hired_at":{"type":"string","example":"2018-01-15","description":"Date (y-m-d) of when the staff member was hired.","format":"date"},"left_at":{"type":"string","example":"2025-01-15","description":"Date (y-m-d) of when the staff member left.","format":"date"},"job_title":{"type":"string","example":"Chief Coffee Maker","description":"The job title of the staff member."},"basic_annual_salary":{"type":"integer","example":5000000,"description":"The basic annual salary of the staff member. Must be in pennies, for example: £50,000 would be 5000000."},"payroll_number":{"type":"string","example":"#12345","description":"The payroll number of the staff member."}}},"App_Http_Requests_StoreClientStatusRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Active","description":"The name of the status."},"colour":{"type":"string","example":"#FFFFFF","description":"The colour of the status."}}},"App_Http_Requests_UpdateClientStatusRequest":{"type":"object","properties":{"name":{"type":"string","example":"Inactive","description":"The name of the status."},"colour":{"type":"string","example":"#FFFFFF","description":"The colour of the status."}}},"App_Http_Requests_TransferClientsStatusRequest":{"type":"object","required":["new_status_uuid"],"properties":{"new_status_uuid":{"type":"string","example":"7e6231e1-adf8-4be6-88f7-18ca7f33e3bd","description":"The UUID of the new status to be assigned.","format":"uuid"}}},"App_Http_Requests_External_StoreIntroducerRequest":{"type":"object","required":["first_name","last_name","entity_name","email"],"properties":{"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Patrick","description":"First name"},"last_name":{"type":"string","example":"Stanton","description":"Last name"},"entity_name":{"type":"string","example":"PatrickCo","description":"Entity/business name"},"email":{"type":"string","example":"patrick@plannercrm.com","description":"Account email"},"assigned_adviser_uuid":{"type":"string","example":"2b16e394-3030-4d7d-8130-341a22f017b3","description":"UUID of the account that this account reports to","format":"uuid"},"groups":{"type":"array","example":["b68dd5ae-0f5e-43ae-9aee-6f842318723a","f6b3f807-ef86-4549-9981-00ca292cb190","1f22f74e-d4e5-4c91-96aa-dc0fa9225d05"],"description":"Group uuids belonging to the firm.","items":{"type":"string","example":"93cb902c-702f-4cec-8906-6bc129a760d9","format":"uuid"}},"charge_split_schema_uuid":{"type":"string","example":"ab093b2d-d9e0-4b0a-a26d-310be10d6ecd","description":"Charge split schema that is always used when adding a charge split for this introducer","format":"uuid"}}},"App_Http_Requests_UpdateIntroducerRequest":{"type":"object","properties":{"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Patrick","description":"First name"},"last_name":{"type":"string","example":"Stanton","description":"Last name"},"entity_name":{"type":"string","example":"PatrickCo","description":"Entity/business name"},"assigned_adviser_uuid":{"type":"string","example":"33c76757-7e4c-4c69-b889-de4a3218a65b","description":"UUID of the account that this account reports to","format":"uuid"},"charge_split_schema_uuid":{"type":"string","example":"25cfa0ed-5c3c-4c78-bcbe-cc03e8e05fcd","description":"Charge split schema that is always used when adding a charge split for this introducer","format":"uuid"},"groups":{"type":"array","example":["6e4a8855-cf3c-4972-bb7b-4755f7abf8f6","85d74753-60c6-4bd1-aa07-26f5e2d42dd4","c0ba5802-38f1-49ce-85e4-333ce85de87d"],"description":"Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups","items":{"type":"string","example":"afdc965e-0fea-4d8b-93a9-e6b53753d508","format":"uuid"}}}},"App_Http_Requests_ReferralConnection_StoreReferralConnectionRequest":{"type":"object","required":["adviser_key"],"properties":{"adviser_key":{"type":"string","example":"ABC12345","description":"The 8-character referral code of the adviser you want to connect with."}}},"App_Http_Requests_Referral_StoreReferralRequest":{"type":"object","required":["connection_uuid","client_uuids","advice_type","shared_data"],"properties":{"connection_uuid":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000","description":"The UUID of an accepted referral connection."},"client_uuids":{"type":"array","example":["550e8400-e29b-41d4-a716-446655440001","550e8400-e29b-41d4-a716-446655440002"],"description":"Array of client account UUIDs to refer."},"advice_type":{"type":"string","example":"investments","description":"|\n\nThe type of advice being referred. Options: investments, protection, mortgages, estate_planning, other, pensions and tax\n\n| Value | Description |\n| ----- | ----------- |\n|investments|Investments|\n|protection|Protection|\n|mortgages|Mortgages|\n|estate_planning|Estate Planning|\n|other|Other|\n|pensions|Pensions|\n|tax|Tax|","enum":["investments","protection","mortgages","estate_planning","other","pensions","tax"]},"duration_months":{"type":"integer","example":3,"description":"Duration in months for the referral. Options: 1, 2, 3, 6. Null for lifetime."},"shared_data":{"type":"array","example":["basic_details","contact_details","notes"],"description":"Data categories to share. Options: basic_details, contact_details, income, expenditure, dependants, investments_and_plans, pensions, liabilities, protection, cash_accounts, goals and notes"},"sla_deadline":{"type":"string","example":"2026-02-28","description":"SLA deadline for the recipient to respond.","format":"date"},"note":{"type":"string","example":"Client needs help with retirement planning.","description":"Additional notes about the referral."}}},"App_Http_Requests_Referral_RejectReferralRequest":{"type":"object","required":["rejection_reason"],"properties":{"rejection_reason":{"type":"string","example":"Unable to take on new clients at this time.","description":"The reason for rejecting this referral."}}},"App_Http_Requests_BusinessUnit_UpdateBusinessUnitBrandingRequest":{"type":"object","properties":{"settings":{"type":"array","example":[],"description":"List of scalar settings to update (colours, booleans, HTML). File fields must use dedicated upload fields.","items":{"type":"object","example":{"key":"sidebar_background","value":"#0E0E56"},"properties":{"key":{"type":"string","example":"sidebar_background","description":"The setting key (must be a valid PlannrSettingKey value)."},"value":{"type":"string","example":"#0E0E56","description":"The setting value."}}}},"logo":{"type":"string","example":"file-contents","description":"Image file for the logo. Max 10 MB.","format":"binary"},"logo_icon":{"type":"string","example":"file-contents","description":"Image file for the logo icon. Max 10 MB, 50–150px square, 1:1 ratio.","format":"binary"},"email_logo":{"type":"string","example":"file-contents","description":"Image file for the email logo. Max 10 MB.","format":"binary"},"banner":{"type":"string","example":"file-contents","description":"Image file for the banner. Max 25 MB.","format":"binary"},"branded_auth_background":{"type":"string","example":"file-contents","description":"Image file for the branded auth background. Max 25 MB.","format":"binary"}}},"App_Http_Requests_BusinessUnit_ManageBusinessUnitMembersRequest":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"array","example":["a716cf30-e38f-4769-bcbe-98fa8521555b","1673dc13-0f12-409e-b557-2f580a9ef839","cf353a12-bcac-4d85-a7b0-15f0a33d185f"],"description":"UUIDs of accounts to add to or remove from the business unit.","items":{"type":"string","example":"08912b7f-2654-435a-8826-0e290554e5c5","format":"uuid"}}}},"App_Http_Requests_Group_StoreGroupRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Accounting","description":"Group name that must be unique."},"participants":{"type":"array","example":["74740dbc-8644-4296-8097-27e43fd91630","34b9a067-3f35-4703-8868-2ec49828ac25","435e9321-4578-4bd8-8bc2-35c243416abf"],"description":"UUIDs of accounts to add to the group.","items":{"type":"string","example":"0d500371-981a-4656-85f7-ce6f036bfa90","format":"uuid"}},"business_unit":{"type":"string","example":"d065d1fb-0db7-406b-86d7-e1cb50e8f6c1","description":"UUID of business unit to link this group to","format":"uuid","nullable":true}}},"App_Http_Requests_Group_UpdateGroupRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Accounting","description":"Group name that must be unique."},"business_unit":{"type":"string","example":"b19738b0-09b5-46d4-b313-20758c98f286","description":"UUID of business unit to link this group to","format":"uuid","nullable":true}}},"App_Http_Requests_Group_AddAccountsToGroupRequest":{"type":"object","required":["participants"],"properties":{"participants":{"type":"array","example":["b0a5d1aa-c4ef-468c-9d15-b546bdee78eb","1113fbc0-dbc0-43a5-9bc2-93cde09eb222","a1faffcb-dd05-4d7f-9a08-eb26b0b1f2fd"],"description":"UUIDs of accounts to add to the group.","items":{"type":"string","example":"3b1dcd5f-6fef-4e2c-a8e3-56d10d3b72a5","format":"uuid"}}}},"App_Http_Requests_Group_RemoveAccountsFromGroupRequest":{"type":"object","required":["participants"],"properties":{"participants":{"type":"array","example":["1ade9038-d460-4b1c-93ed-75a7043ee977","76124e02-2e68-42a0-8999-be71a454e14c","74e6bb0d-1574-48e9-96ea-1393b1d5bb43"],"description":"UUIDs of accounts to remove from the group.","items":{"type":"string","example":"56405f38-9bb0-4b95-8f30-f8912d519117","format":"uuid"}}}},"App_Http_Requests_Cases_StoreCasesRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Patrick's Case","description":"The name of the case"},"participants":{"type":"array","example":["3969e669-14c3-4cd4-8964-c4db67714fcb","0e6d39d9-b3e7-4652-bb8f-eca9d344012e","788651aa-8add-4cd4-875b-0bd4a4cf737b"],"description":"Account uuids belonging to the firm. Must include at least one client.","items":{"type":"string","example":"5f48c6f4-eb88-494e-8f48-706ccac53deb","format":"uuid"}},"assigned_to_uuids":{"type":"array","example":["4f29c3a1-db02-48f8-ad62-13e3b4a3465b","06bb8d2b-3e32-4913-8e8e-5c8fc7fd785e","b389da4b-6d64-44fb-9ce4-b22e07f9235d"],"description":"Array of account UUIDs to assign to the case.","items":{"type":"string","example":"1a526cd1-e994-417e-b36b-56ee0103156c","format":"uuid"}},"group_uuids":{"type":"array","example":["37be3b7d-0461-4307-848a-66fafd1bb623","c5401aae-895b-4d7d-9dba-5e3e9e7c8619","76c19891-45d2-4399-b9c6-6b0ec5b1b976"],"description":"UUIDs of groups that will be assigned when the case is created.","items":{"type":"string","example":"6049e3b9-9f0a-4fbf-804e-5461d27d6c6a","format":"uuid"}},"status":{"type":"string","example":"41998846-b700-48d1-ab87-90a9a3fefcee","description":"The uuid of the status chosen for the case","format":"uuid"},"review_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The date the case should be reviewed","format":"date-time"},"type":{"type":"string","example":"87e54877-7118-4d98-ae2b-461a4bf1c9e4","description":"The uuid of the type chosen for the case","format":"uuid"},"value":{"type":"integer","example":15099,"description":"Expect value the case will generate in pennies"},"plans":{"type":"array","example":["05085c06-6690-4f6b-982c-84390d84c365","e594d023-c5d7-4a65-a5e3-db1019fcdf6d","80831452-e243-48d8-8e32-10e3e45a315b"],"description":"The uuids of the plans chosen for the case","items":{"type":"string","example":"544735a2-8875-4bcd-9489-f0c50086fc68","format":"uuid"}},"custom_fields":{"type":"object","description":"Custom field values keyed by the custom field reference. Only references configured for cases (and matching the supplied case type/status, where conditional) are accepted.","example":{"ongoing_case":"Ongoing"},"additionalProperties":true}}},"App_Http_Requests_Cases_UpdateCasesRequest":{"type":"object","properties":{"name":{"type":"string","example":"Annual review","description":"Name of the case"},"status":{"type":"string","example":"553f793f-658d-48a1-92bc-96ef753288f3","description":"The uuid of the status chosen for the case","format":"uuid"},"status_position":{"type":"integer","example":4,"description":"The case status's new position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout."},"assigned_to_uuids":{"type":"array","example":["6e62265f-0051-445f-9e3c-2413dd187e1e","aa2f039e-e423-4d58-bc1a-daf9740c6d4c","3baf8030-8f23-4f58-803c-cccefc4c229d"],"description":"Array of account UUIDs","items":{"type":"string","example":"9aaf7a50-fb55-4736-aaa1-572efc0d5c28","format":"uuid"}},"group_uuids":{"type":"array","example":["033f08f3-ff8e-439d-a278-1637699804f6","c68f41ad-04bd-4e3a-9389-c1dc23f93cef","8b591bdb-69f1-4b8c-9915-f9ac41f4d813"],"description":"UUIDs of groups that will be assigned when the case is created.","items":{"type":"string","example":"c646a824-b24d-4601-93c5-412b07e249a5","format":"uuid"}},"review_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the case will be reviewed","format":"date-time"},"type":{"type":"string","example":"9e4ae424-183e-44c2-bf8c-c88308791853","description":"The uuid of the type chosen for the case","format":"uuid"},"value":{"type":"integer","example":15099,"description":"Expect value the case will generate in pennies"},"completed_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the case was completed","format":"date-time"},"plans":{"type":"array","example":["af585924-2e85-4d41-81f2-e6b3447cc66c","5d50ede6-e8ac-47ba-8b74-26da3b72babd","78d786f4-52b8-49d3-b48d-27c5b256f270"],"description":"The uuids of the plans that will be associated to the case when it is created. Leave NULL to disassociate all plans from the case.","items":{"type":"string","example":"5d15dcbe-aef3-4352-aeeb-e63270c4a9f1","format":"uuid"}},"custom_fields":{"type":"object","description":"Custom field values keyed by the custom field reference. Only references configured for cases (and matching the case's type/status, where conditional) are accepted.","example":{"ongoing_case":"Not Ongoing"},"additionalProperties":true}}},"App_Http_Requests_Cases_AddAccountsToCasesRequest":{"type":"object","required":["participants"],"properties":{"participants":{"type":"array","example":["b9ac4803-597f-452d-8f07-5db7b268c792","1723bdd0-311e-41f9-be1f-b9ddde29e3da","487ee8ac-496f-469c-830a-b92f2e2940a8"],"description":"Account uuids belonging to the firm.","items":{"type":"string","example":"ff5f5053-add5-4e51-b842-545de53059d9","format":"uuid"}}}},"App_Http_Requests_Cases_RemoveAccountsFromCasesRequest":{"type":"object","required":["participants"],"properties":{"participants":{"type":"array","example":["7b17fd60-e103-429b-856b-d4241a0ee16a","3f251719-33ea-46f7-ae37-62d6a6730604","c62cda65-8b7c-4243-b565-6d0f2e0faad7"],"description":"Account uuids belonging to the firm.  At least one client must remain in the case.","items":{"type":"string","example":"fa02d6bb-5cc9-4596-bc66-96fe52757411","format":"uuid"}}}},"App_Http_Requests_CasesStatus_StoreCaseStatusRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"In Progress","description":"The name of the status."},"colour":{"type":"string","example":"#23852B","description":"The colour of the status."}}},"App_Http_Requests_CasesStatus_UpdateCaseStatusRequest":{"type":"object","properties":{"name":{"type":"string","example":"In Progress","description":"The name of the status."},"colour":{"type":"string","example":"#23852B","description":"The colour of the status."},"position":{"type":"integer","example":5,"description":"The position of the status."}}},"App_Http_Requests_CasesType_StoreCasesTypeRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Mortgage Plan","description":"name of the type"}}},"App_Http_Requests_CasesType_UpdateCasesTypeRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Mortgage Plan","description":"name of the type"}}},"App_Http_Requests_Conversation_StoreConversationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Annual Review","description":"Conversation title"},"case":{"type":"string","example":"cb247ea9-8720-4518-adfa-1e1a24197310","description":"Case UUID to assign this conversation to","format":"uuid"},"participants":{"type":"array","example":["abffcfc3-8f5c-4eee-92f1-cc5ba09c1e74","9320ffd0-f6cf-4839-a787-3e842715bcbd","a81aa66d-f542-4924-b564-2c545e462017"],"description":"Account UUIDs belonging to the firm","items":{"type":"string","example":"26322291-ff2f-485d-abb9-64855cc9b067","format":"uuid"}},"message":{"type":"string","example":"Hello world!","description":"Contents of first message to be created alongside the conversation."}}},"App_Http_Requests_Conversation_UpdateConversationRequest":{"type":"object","properties":{"name":{"type":"string","example":"Annual Review","description":"Conversation title"}}},"App_Http_Requests_Conversation_ConversationNotificationsRequest":{"type":"object","properties":{"timestamp":{"type":"string","example":"2022-01-30 12:00:00","description":"Timestamp to mute notifications until.  Null to unmute a conversation."}}},"App_Http_Requests_Conversation_PinConversationRequest":{"type":"object","required":["pin"],"properties":{"pin":{"type":"boolean","example":true,"description":"Boolean to denote the whether the conversation is to be pinned for the account or not."}}},"App_Http_Requests_Conversation_AddAccountsToConversationRequest":{"type":"object","required":["participants"],"properties":{"participants":{"type":"array","example":["ba7e968c-00e6-4122-9368-0337ed736889","79199fd2-950b-4b74-b6eb-aae6dd49af08","830fcd8a-9c1f-4401-8ab5-ae7a74949eca"],"description":"Account uuids belonging to the firm","items":{"type":"string","example":"991337ba-f89b-49c2-99f7-e6b01673d79f","format":"uuid"}}}},"App_Http_Requests_Conversation_RemoveAccountsFromConversationRequest":{"type":"object","required":["participants"],"properties":{"participants":{"type":"array","example":["433d5279-55ec-438e-915b-dca6493984d4","8c017e42-b5c3-44d9-a8b4-ed35243296d0","797005bd-21d3-4831-8e64-312f43a284ac"],"description":"Conversation participant account uuids to remove from conversation","items":{"type":"string","example":"d7f9b00b-d707-41d1-9b61-5866ee6d714e","format":"uuid"}}}},"App_Http_Requests_Conversation_PromoteToConversationAdminRequest":{"type":"object","required":["participant"],"properties":{"participant":{"type":"string","example":"be69da46-158f-4699-822e-c8aa7e23513c","description":"Conversation participant account uuids to promote to conversation admin","format":"uuid"}}},"App_Http_Requests_Conversation_RevokeConversationAdminRequest":{"type":"object","required":["participant"],"properties":{"participant":{"type":"string","example":"6ac86573-6ee0-4489-8abe-086a0c374fbe","description":"Conversation admins account uuids to revoke admin privileges","format":"uuid"}}},"App_Http_Requests_Message_StoreMessageWithInlineFilesRequest":{"type":"object","required":["files"],"properties":{"contents":{"type":"string","example":"Hello, welcome to Plannr.","description":"Contents of the message."},"files":{"type":"array","example":[],"description":"An array of files. This request should be sent with a Content-Type of multipart/form-data.","items":{"type":"string","example":"file-contents","format":"binary"}}}},"App_Http_Requests_Message_StoreMessageRequest":{"type":"object","properties":{"contents":{"type":"string","example":"Hello, welcome to Plannr.","description":"Contents of the message."},"files":{"type":"array","example":["ddd7cd7d-2de0-4be4-afc0-c084141aa949","3940cfa7-07a0-42c8-bf8d-3f4762072f86","951e223d-b01d-402f-ad6a-a383c672b6bf"],"description":"File UUIDs which are uploading, or has been uploaded but not yet been assigned to a model.","items":{"type":"string","example":"f98a9130-ea5e-4e2e-a44c-430628cf1160","format":"uuid"}}}},"App_Http_Requests_Message_UpdateMessageRequest":{"type":"object","required":["contents"],"properties":{"contents":{"type":"string","example":"Hello, welcome to Plannr.","description":"Contents of the message"}}},"App_Http_Requests_FormBuilder_StoreFormRequest":{"type":"object","required":["title"],"properties":{"title":{"type":"string","example":"Annual Survey Form","description":"The title of the form"},"description":{"type":"string","example":"This is the annual survey form for 2022","description":"The description of the form"},"visibility":{"type":"string","example":"public","description":"|\n\nThe visibility of the form.\n\n| Value | Description |\n| ----- | ----------- |\n|public|Public|\n|private|Private|\n|hidden|Hidden|\n|internal|Internal|","enum":["public","private","hidden","internal"]},"allowed_hosts":{"type":"array","example":["example.com","example.org"],"description":"Domain hosts to allow viewing this form when embedded","items":{"type":"string","example":"example.com","format":"hostname"}},"create_client":{"type":"boolean","example":false,"description":"Should this form create a new client if a submission comes form no registered account"},"client_type":{"type":"string","example":"client","description":"|\n\nRequired if create client is true, the type of client to create on form submission.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|prospect|Prospect|","enum":["client","prospect"]}}},"App_Http_Requests_FormBuilder_UpdateFormRequest":{"type":"object","properties":{"title":{"type":"string","example":"Annual Survey 2022 Form","description":"The title of the form"},"description":{"type":"string","example":"This is the annual survey form for 2022","description":"The description of the form"},"visibility":{"type":"string","example":"public","description":"|\n\nThe visibility of the form.\n\n| Value | Description |\n| ----- | ----------- |\n|public|Public|\n|private|Private|\n|hidden|Hidden|\n|internal|Internal|","enum":["public","private","hidden","internal"]},"allowed_hosts":{"type":"array","example":["example.com","example.org"],"description":"Domain hosts to allow viewing this form when embedded","items":{"type":"string","example":"example.com","format":"hostname"}},"create_client":{"type":"boolean","example":false,"description":"Should this form create a new client if a submission comes form no registered account"},"client_type":{"type":"string","example":"client","description":"|\n\nRequired if create client is true, the type of client to create on form submission.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|prospect|Prospect|","enum":["client","prospect"]}}},"App_Http_Requests_FormBuilder_StoreFormSectionRequest":{"type":"object","required":["title"],"properties":{"title":{"type":"string","example":"Section 1.1","description":"The title of the section"}}},"App_Http_Requests_FormBuilder_UpdateFormSectionRequest":{"type":"object","required":["title"],"properties":{"title":{"type":"string","example":"Section 1.1","description":"The title of the section"},"position":{"type":"integer","example":0,"description":"The position of the section in the form."}}},"App_Http_Requests_FormBuilder_StoreFormQuestionRequest":{"type":"object","required":["type","required","title","position","selection_options","section_uuid"],"properties":{"type":{"type":"string","example":"string","description":"The type of the question"},"required":{"type":"boolean","example":true,"description":"Whether the question is required or not"},"title":{"type":"string","example":"What is your name?","description":"The title of the question"},"help_text":{"type":"string","example":"Gareth","description":"Input placeholder"},"caption":{"type":"string","example":"Enter your full legal name","description":"User friendly description of what should be input"},"position":{"type":"integer","example":0,"description":"The position of the question in the section."},"selection_options":{"type":"array","example":["apple","orange"],"description":"The selection options for the question IF the question is of type selection."},"section_uuid":{"type":"string","example":"db3ba368-5cd3-4a8b-817d-0d3006faf524","description":"The uuid of the section to move the question to.","format":"uuid"},"target_field":{"type":"string","example":"client.first_name","description":"The field to update if the question is filled in"},"linked_question_field":{"type":"string","example":"first_name","description":"Create a question from a linked field, with this, the type and selection options can be ignored"},"linked_primary":{"type":"boolean","example":false,"description":"If this is a contact detail or address field, should it be made primary?"}}},"App_Http_Requests_FormBuilder_UpdateFormQuestionRequest":{"type":"object","required":["section_uuid"],"properties":{"type":{"type":"string","example":"string","description":"The type of the question"},"required":{"type":"boolean","example":true,"description":"Whether the question is required or not"},"title":{"type":"string","example":"What is your name?","description":"The title of the question"},"help_text":{"type":"string","example":"Gareth","description":"Input placeholder"},"caption":{"type":"string","example":"Enter your full legal name","description":"Field description"},"position":{"type":"integer","example":2,"description":"The position of the question in the section."},"selection_options":{"type":"array","example":["apple","orange"],"description":"The selection options for the question IF the question is of type selection.","items":{"type":"string","example":"apple"}},"section_uuid":{"type":"string","example":"90961679-d86a-49ab-9c88-11e3c8bd0aac","description":"The uuid of the section to move the question to.","format":"uuid"}}},"App_Http_Requests_FormBuilder_StoreFormSubmissionRequest":{"type":"object","properties":{"account_uuid":{"type":"string","example":"e83aa34c-80fe-4a4c-8f44-d7b47b98c66b","description":"UUID of the account to attach the form submission to, if left blank will use the authenticated account","format":"uuid"}}},"App_Http_Requests_FormBuilder_AnswerFormSubmissionRequest":{"type":"object","required":["answers"],"properties":{"answers":{"type":"object","description":"Answers linked with questions keys array","example":{"first_name":"John","last_name":"Cena","another.field":"Some value"},"additionalProperties":true}}},"App_Http_Requests_FormBuilder_UpdateFormSubmissionRequestRequest":{"type":"object","properties":{"description":{"type":"string","example":"Please can you submit your annual survey form","description":"Description of the submission request"}}},"App_Http_Requests_FormBuilder_StoreFormSubmissionRequestRequest":{"type":"object","properties":{"description":{"type":"string","example":"Please can you submit your annual survey form","description":"Description of the submission request"}}},"App_Http_Requests_Tasks_StoreTaskStatusRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Incomplete","description":"Name of the task status"},"colour":{"type":"string","example":"#ff0000","description":"Colour of the task status"}}},"App_Http_Requests_Tasks_UpdateTaskStatusRequest":{"type":"object","properties":{"name":{"type":"string","example":"Incomplete","description":"Name of the task status"},"colour":{"type":"string","example":"#ff0000","description":"Colour of the task status"},"position":{"type":"integer","example":1,"description":"Position of the task status"}}},"App_Http_Requests_Tasks_StoreTaskRequest":{"type":"object","required":["name","taskable_type","taskable_uuid","task_status_uuid"],"properties":{"name":{"type":"string","example":"Check details","description":"The name of the task"},"description":{"type":"string","example":"Check details","description":"The description of the task"},"priority":{"type":"string","example":"low","description":"|\n\nThe task's priority. Available options: low, medium, high and highest\n\n| Value | Description |\n| ----- | ----------- |\n|low|Low|\n|medium|Medium|\n|high|High|\n|highest|Highest|","enum":["low","medium","high","highest"]},"due_at":{"type":"string","example":"2026-05-13","description":"The task due date","format":"date"},"taskable_type":{"type":"string","example":"client","description":"The taskable type. Available Options: client, case, plan","enum":["client","case","plan"]},"taskable_uuid":{"type":"string","example":"1ca285cd-d3ba-4ea2-874f-051f5131bc53","description":"The taskable UUID","format":"uuid"},"task_status_uuid":{"type":"string","example":"094ab370-0a9e-40ce-96de-d74265314b9e","description":"The task status UUID","format":"uuid"},"parent_task_uuid":{"type":"string","example":"56bce371-f113-47d3-8963-9c971b552c21","description":"The parent task UUID","format":"uuid"},"assigned_to_uuids":{"type":"array","example":["c4ff1b3d-316b-4db3-91f6-55cddcde912f","d107a663-744b-4074-bc82-840c1848e144","bc5e5939-9d79-48f5-b374-3d5b4df530ec"],"description":"Array of account UUIDs","items":{"type":"string","example":"cd7051f3-a79c-4c82-8821-761c60b780c0","format":"uuid"}},"custom_fields":{"type":"object","description":"Additional custom fields","example":{"favourite_pet":"Dog"},"additionalProperties":true},"group_uuids":{"type":"array","example":["89b4298a-ce75-4a5d-b45b-da92065a17de","261c7aa9-ef89-4570-ac1f-f97ededcb370","d0cf0777-4edf-4d68-9ec4-0c93adaf4e1e"],"description":"UUIDs of groups that will be assigned when the task is created.","items":{"type":"string","example":"dc3061c0-99ea-4e65-b6c9-67da86426b1b","format":"uuid"}},"is_recurring":{"type":"boolean","example":true,"description":"Whether the task should be recurring or not. Subtasks cannot be recurring."},"recurring_frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency at which the task should recur. This field is required if is_recurring is set to true.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|weekdays|Weekdays|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","weekdays"]}}},"App_Http_Requests_Tasks_UpdateTaskRequest":{"type":"object","properties":{"name":{"type":"string","example":"Check details","description":"The name of the task"},"description":{"type":"string","example":"Check details","description":"The description of the task"},"priority":{"type":"string","example":"low","description":"|\n\nThe task's priority. Available options: low, medium, high and highest\n\n| Value | Description |\n| ----- | ----------- |\n|low|Low|\n|medium|Medium|\n|high|High|\n|highest|Highest|","enum":["low","medium","high","highest"]},"due_at":{"type":"string","example":"2026-05-15","description":"The task due date","format":"date"},"taskable_type":{"type":"string","example":"client","description":"The taskable type. Available Options: client, case, plan","enum":["client","case","plan"]},"taskable_uuid":{"type":"string","example":"75503f9a-4676-4029-9718-eb56f448dca7","description":"The taskable UUID","format":"uuid"},"task_status_uuid":{"type":"string","example":"13c7764c-31ab-48f7-aa07-5a0bb324f2ed","description":"The task status UUID","format":"uuid"},"parent_task_uuid":{"type":"string","example":"0790ae4f-d1c6-40d3-bba9-b740e2b8782c","description":"The parent task UUID","format":"uuid"},"assigned_to_uuids":{"type":"array","example":["4d0f4981-7afa-49a0-bbff-0553e4b745de","3c5df38f-2105-410b-ba51-543f3978b045","910b256b-2be5-4cea-8557-070aa183b8ea"],"description":"Array of account UUIDs","items":{"type":"string","example":"933f573f-bf04-4f32-94f8-39adb7c614c9","format":"uuid"}},"custom_fields":{"type":"object","description":"Additional custom fields","example":{"favourite_pet":"Dog"},"additionalProperties":true},"group_uuids":{"type":"array","example":["fb1a6fc5-a3d6-4331-ae6a-cc910e29ab38","bc09775d-6965-4288-bc1b-738a951158b9","79badcbf-d360-440d-a4eb-498ce5af4b91"],"description":"UUIDs of groups that will be assigned when the task is updated.","items":{"type":"string","example":"c83ac556-ce8a-47f9-8b15-a010182f7dfa","format":"uuid"}},"is_recurring":{"type":"boolean","example":true,"description":"Whether the task should be recurring or not. Subtasks cannot be recurring."},"recurring_frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency at which the task should recur. This field is required if is_recurring is set to true.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|weekdays|Weekdays|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","weekdays"]}}},"App_Http_Requests_Board_StoreWorkflowRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Pension Review","description":"The name of the workflow, must be unique."}}},"App_Http_Requests_Board_UpdateWorkflowRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Pension Review","description":"The name of the workflow, must be unique."}}},"App_Http_Requests_Board_StoreWorkflowTaskRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Mortgage Review","description":"The name of the task."},"visible_to_clients":{"type":"boolean","example":true,"description":"Denotes if the task is visible to clients."},"priority":{"type":"string","example":"low","description":"The priority of the workflow task. Possible values are: high, low and null"},"description":{"type":"string","example":"We need to run through a mortgage review with Gareth, as he can probably find a better deal.","description":"The extra description added to a task."},"task_status_uuid":{"type":"string","example":"051290ad-7ac0-44ce-9686-6ce2c5080bfb","description":"The UUID of the task status to use as the default for new tasks created in this workflow."},"offset_due_at_by":{"type":"integer","example":5,"description":"The number of days the due_at should be set when the workflow has been triggered."},"participants":{"type":"array","example":["4245f8fe-9abd-45a7-badb-70f3bdf90fce","02010212-62d9-4e5c-8f60-092c5472473f","4f719262-2319-459b-a938-be7e0859991f"],"description":"Account UUIDs to be assigned to the task.","items":{"type":"string","example":"034e3a8c-7819-47bb-abe4-f94b66419ee3","format":"uuid"}},"parent_uuid":{"type":"string","example":"e60e1fca-e1ef-4158-aaf8-e79bded36ff8","description":"The parent task. Apply this if you want the task to be one of a tasks sub-tasks.","format":"uuid"},"trigger_uuid":{"type":"string","example":"de9abaee-1aa5-47ee-bd67-a0dd80682150","description":"The task that will trigger this task to be created.","format":"uuid"},"auto_assign_assigned_adviser":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the assigned adviser of the client as a participant of the task. Only works when a workflow is run on a client."},"auto_assign_assigned_administrator":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the administrator of the client as a participant of the task. Only works when a workflow is run on a client."},"auto_assign_assigned_paraplanner":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the assigned paraplanner of the client as a participant of the task. Only works when a workflow is run on a client."},"auto_assign_clients":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the client as a participant of the task."},"groups":{"type":"array","example":["d66d8dce-768e-4f6f-83bc-0ae97b183ec8","c7fdbb05-d4fa-4b16-90ad-e5bdc211cfd3","f8567937-0029-45d2-a8f1-e4a6d5e8880e"],"description":"UUIDs of groups that will be assigned when the task is created.","items":{"type":"string","example":"39271894-ade0-4fe3-9d79-a7571bac6513","format":"uuid"}}}},"App_Http_Requests_Board_UpdateWorkflowTaskRequest":{"type":"object","properties":{"name":{"type":"string","example":"Mortgage Review","description":"The name of the task."},"visible_to_clients":{"type":"boolean","example":true,"description":"Denotes if the task is visible to clients."},"priority":{"type":"string","example":"low","description":"|\n\nThe priority of the workflow task. Possible values are: high, low and null.\n\n| Value | Description |\n| ----- | ----------- |\n|low|Low|\n|medium|Medium|\n|high|High|\n|highest|Highest|","enum":["low","medium","high","highest"]},"description":{"type":"string","example":"We need to run through a mortgage review with Gareth, as he can probably find a better deal.","description":"The extra description added to a task."},"position":{"type":"integer","example":4,"description":"The task positioning within the sub tasks or trigger tasks."},"offset_due_at_by":{"type":"integer","example":5,"description":"The number of days the due_at should be set when the workflow has been triggered."},"task_status_uuid":{"type":"string","example":"b75a045b-7cac-4ef9-abca-5d47c7a7c0d9","description":"The UUID of the task status to use as the default for new tasks created in this workflow."},"participants":{"type":"array","example":["0975283b-169a-42a7-9138-1dcd56a5f666","1c430740-4d8c-44e0-b5d8-e343de451201","4126e71a-7a9f-41cb-8f05-924a8061f60e"],"description":"Account UUIDs to be assigned to the task.","items":{"type":"string","example":"4bf12611-e66e-4fd2-ab2d-082d71844e0b","format":"uuid"}},"parent_uuid":{"type":"string","example":"46101587-358b-413f-839a-c0730a386812","description":"The parent task. Apply this if you want the task to be one of a tasks sub-tasks.","format":"uuid"},"trigger_uuid":{"type":"string","example":"4c8ab27b-de7e-44fc-8610-d684c56f70a6","description":"The task that will trigger this task to be created.","format":"uuid"},"auto_assign_assigned_adviser":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the assigned adviser of the client as a participant of the task. Only works when a workflow is run on a client."},"auto_assign_assigned_administrator":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the administrator of the client as a participant of the task. Only works when a workflow is run on a client."},"auto_assign_assigned_paraplanner":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the assigned paraplanner of the client as a participant of the task. Only works when a workflow is run on a client."},"auto_assign_clients":{"type":"boolean","example":true,"description":"Denotes that when the workflow is run, should we assign the client as a participant of the task."},"groups":{"type":"array","example":["84b59b48-0eb4-45de-b2fa-b1a69aaca3b0","1361c3e0-6207-4b72-ac21-7febb63bd1e4","f6a9eac1-8b8e-4cd4-b94c-1545790f957b"],"description":"UUIDs of groups that will be assigned when the task is created.","items":{"type":"string","example":"f47860f4-334b-4ca5-ba60-e6f7f572ef80","format":"uuid"}}}},"App_Http_Requests_Board_AddParticipantsToWorkflowTaskRequest":{"type":"object","properties":{"participants":{"type":"array","example":["80d01f30-2670-42d1-8fc0-2bfc8bfefb7c","1442aad7-66e3-4842-95fd-8c682bade99b","8eecbc76-4eee-4461-b41a-d734984cd494"],"description":"Account uuids belonging to the workflow board task.","items":{"type":"string","example":"8a1fb6e0-56a1-4237-8cb5-ac8b678de95c","format":"uuid"}}}},"App_Http_Requests_Board_RemoveParticipantsFromWorkflowTaskRequest":{"type":"object","properties":{"participants":{"type":"array","example":["405c9198-f8ae-4339-92e0-91d977d7ad1e","ebeda8de-abaa-488c-a625-a5243436708e","b90e85ca-73a1-4601-996a-fb2ce2837ffe"],"description":"Account uuids belonging to the workflow board task.","items":{"type":"string","example":"1f5cef92-429c-463e-8871-5eeb8a31035c","format":"uuid"}}}},"App_Http_Requests_Board_RunWorkflowRequest":{"type":"object","required":["model_type","model_uuid"],"properties":{"model_type":{"type":"string","example":"client","description":"|\n\nThe type of model to trigger a workflow on.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|case|Case|","enum":["client","case"]},"model_uuid":{"type":"string","example":"9181f8e9-c539-4357-bc4b-09846a4340ab","description":"The uuid of the model to trigger a workflow on.","format":"uuid"}}},"App_Http_Requests_Tag_StoreTagRequest":{"type":"object","required":["mode","taggable_type","taggable_uuid","tags"],"properties":{"mode":{"type":"string","example":"attach","description":"Mode for dealing with tags. Attach will add the tags to the model, sync will remove all other tags and add the ones provided, detach will remove the tags from the model, create will create the tags without attaching them to a model.","enum":["attach","sync","detach","create"]},"taggable_type":{"type":"string","example":"account","description":"Model type to assign these tags to.","enum":["account","board","board_task","case","conversation","file","note","plan"]},"taggable_uuid":{"type":"string","example":"816b4b4b-844d-482c-b449-8e27869d24be","description":"Model UUID to assign these tags to.","format":"uuid"},"tags":{"type":"array","example":["Reviewed","b9ed0237-7259-4933-8295-7c1198c068bd",{"name":"Urgent","colour":"#FF0000"}],"description":"Tags can be provided in various formats. If you do not provide a colour a random one will be chosen for you.","items":{"anyOf":[{"type":"string","example":"Reviewed","description":"Tag name as a string. The tag will be created if it does not already exist."},{"type":"string","example":"56649f01-1d62-4c97-92f8-548e55883a8f","description":"Tag UUID. The tag must already exist.","format":"uuid"},{"type":"object","description":"Tag object with name and optional colour.","example":{"name":"Urgent","colour":"#FF0000"},"properties":{"name":{"type":"string","example":"Urgent","description":"Name of the tag to create."},"colour":{"type":"string","example":"#FF0000","description":"Hex colour code for the tag. If not provided a random colour will be chosen."}},"required":["name"]}]}}}},"App_Http_Requests_Tag_UpdateTagRequest":{"type":"object","required":["name","colour"],"properties":{"name":{"type":"string","example":"Urgent","description":"Update tag description"},"colour":{"type":"string","example":"#ef4582","description":"Update tag colour"}}},"App_Http_Requests_ExecuteBulkActionRequest":{"type":"object","required":["items"],"properties":{"type":{"type":"string","example":"linked_policy_numbers_delete","description":"|\n\nThe name of the bulk action to perform. Options:linked_policy_numbers_delete, tasks_archive, tasks_attach, tasks_complete, tasks_delete, tasks_detach, tasks_due_date, tasks_priority, tasks_status, tasks_sync and tasks_taskable.\n                * \"tasks_complete\" allows for the mass completion of tasks.\n                * \"tasks_delete\" allows for the mass deletion of tasks.\n                * \"tasks_sync\" is intended for syncing the chosen tasks with the selected accounts (This will overwrite any members previously selected with the newly chosen members.).\n                * \"tasks_attach\" is intended for attaching the chosen members to the selected tasks.\n                * \"tasks_detach\" is intended for detaching the chosen members from the selected tasks.\n                * \"tasks_archive\" is intended for archiving the chosen tasks.\n                \n\n| Value | Description |\n| ----- | ----------- |\n|linked_policy_numbers_delete|Delete Linked Policy Numbers|\n|tasks_archive|Archive Tasks|\n|tasks_attach|Attach Assignee To Tasks|\n|tasks_complete|Complete Tasks|\n|tasks_delete|Delete Tasks|\n|tasks_detach|Detach Assignee From Tasks|\n|tasks_due_date|Update Due Date On Tasks|\n|tasks_priority|Prioritise Tasks|\n|tasks_status|Update Status On Tasks|\n|tasks_sync|Sync Assignees On Tasks|\n|tasks_taskable|Update Taskable On Tasks|","enum":["linked_policy_numbers_delete","tasks_archive","tasks_attach","tasks_complete","tasks_delete","tasks_detach","tasks_due_date","tasks_priority","tasks_status","tasks_sync","tasks_taskable"]},"is_recursive":{"type":"boolean","example":true,"description":"Only used for task bulk actions, whether to perform the bulk action recursively over all sub-tasks."},"items":{"type":"array","example":["c28c7d4e-164c-4463-82a6-b0a306aeac55","a9297687-4ec4-4242-bc7f-93d9dbe933df"],"description":"The items to perform the bulk action on. Send an array with a single * value instead of an array to select all items. Use filter to constrain all items."},"filters":{"type":"object","description":"The filters to apply to the bulk action. These can only be used on a catch-all bulk action.","example":{"taskable_uuid":"5adf8c00-0995-411f-97c2-6d29a38ac2f8","taskable_type":"client"},"properties":{"taskable_uuid":{"type":"string","example":"5adf8c00-0995-411f-97c2-6d29a38ac2f8","description":"Filter by uuid","format":"uuid"},"taskable_type":{"type":"string","example":"client","description":"Taskable type","enum":["client","case","plan"]}}},"data":{"type":"object","description":"Optional data reserved for specific bulk action requirements.","additionalProperties":true}}},"App_Http_Requests_Folder_StoreFolderRequest":{"type":"object","required":["name","parent"],"properties":{"name":{"type":"string","example":"Important Documents","description":"Folder name."},"parent":{"type":"string","example":"b2e72369-e2d9-4e70-8001-cfa87c9e2293","description":"Parent folder UUID to create this folder under.","format":"uuid"}}},"App_Http_Requests_Folder_UpdateFolderRequest":{"type":"object","properties":{"name":{"type":"string","example":"Important Documents","description":"Folder name."},"parent":{"type":"string","example":"1154d03f-b590-4076-9a23-d6bdd0de8f5f","description":"Move current folder in to this parent folder.","format":"uuid"}}},"App_Http_Requests_Folder_UpdateFolderPermissionRequest":{"type":"object","required":["clients_read","clients_write"],"properties":{"clients_read":{"type":"boolean","example":false,"description":"Give read access to all clients that can view the documentable item."},"clients_write":{"type":"boolean","example":false,"description":"Give write access to all clients that can view the documentable item."},"participants":{"type":"array","example":[],"description":"Give read and write access to specific people that can view the documentable item.","items":{"type":"object","example":[{"uuid":"1dbed4b3-8677-4124-8bb4-5ec83a69c440","write":false},{"uuid":"5c725c73-e3f4-449b-91f3-7cc680f04d59","write":true}],"properties":{"uuid":{"type":"string","example":"d9e4a673-f61d-4e1c-8656-5fd5be0075da","description":"The UUID of the participant to give permissions to.","format":"uuid"},"write":{"type":"boolean","example":false,"description":"Write permission for this participant."}}}}}},"App_Http_Requests_File_DirectFileUploadRequest":{"type":"object","required":["name","file","folder_uuid"],"properties":{"name":{"type":"string","example":"Plannr Welcome Pack","description":"The name of the file."},"file":{"type":"string","example":"file-contents","description":"The file being uploaded.","format":"binary"},"folder_uuid":{"type":"string","example":"cf145fae-473d-4ee0-bb04-d0f67e7c51e5","description":"The UUID of the folder to upload the file to.","format":"uuid"},"original_created_at":{"type":"string","example":"2026-05-08 14:41:55","description":"The original created at date of the file.","format":"date"}}},"App_Http_Requests_File_StoreFileRequest":{"type":"object","required":["files"],"properties":{"folder":{"type":"string","example":"15da7211-2ac8-419e-896c-e86982c1a775","description":"Parent folder UUID to store this file under.","format":"uuid"},"files":{"type":"array","example":["1ec04104-d6eb-4337-a02b-558c1cf938b5","6df8441c-26dd-4c96-90e5-7df5d2f9bbeb","86c770ae-a8ab-4e12-81cc-f23e4f1a588c"],"description":"File UUIDs which are uploading, or has been uploaded but not yet been assigned to a model.","items":{"type":"string","example":"0e4937ef-6382-48fc-9376-e523d129f396","format":"uuid"}}}},"App_Http_Requests_File_UpdateFileRequest":{"type":"object","required":["name","folder_uuid"],"properties":{"name":{"type":"string","example":"Important Document","description":"Rename the file."},"folder_uuid":{"type":"string","example":"d03e8fd7-5d72-413a-a9cc-8ca8d58cfd45","description":"Move the file to this folder.","format":"uuid"},"original_created_at":{"type":"string","example":"2026-05-08 14:41:55","description":"Update the original created at date of the file.","format":"date"}}},"App_Http_Requests_File_CopyFileRequest":{"type":"object","required":["folder"],"properties":{"folder":{"type":"string","example":"986a903a-e5b5-45b2-817e-67712c328e70","description":"Copy file to this folder.","format":"uuid"}}},"App_Http_Requests_TimeEntry_StoreTimeEntryRequest":{"type":"object","required":["trackable_type","trackable_uuid","name"],"properties":{"trackable_type":{"type":"string","example":"client","description":"The type of the model that is being tracked..  Valid types are: client, board_task, case, circle, firm, task","enum":["client","board_task","case","circle","firm","task"]},"trackable_uuid":{"type":"string","example":"c3316c26-f507-4775-8b46-4aedd5a87ba3","description":"The UUID of the model that is being tracked","format":"uuid"},"name":{"type":"string","example":"Research","description":"The name of the time entry."},"description":{"type":"string","example":"Research for the new project.","description":"The description of the time entry."},"start_date":{"type":"string","example":"2026-03-24","description":"The start time of the time entry.","format":"date"},"end_date":{"type":"string","example":"2026-05-08","description":"The end time of the time entry.","format":"date"},"total_time_in_minutes":{"type":"integer","example":200,"description":"The length of the time entry, can be used instead of dates."}}},"App_Http_Requests_TimeEntry_UpdateTimeEntryRequest":{"type":"object","required":["trackable_type","trackable_uuid"],"properties":{"trackable_type":{"type":"string","example":"client","description":"The type of the model that is being tracked..  Valid types are: client, board_task, case, circle, firm, task","enum":["client","board_task","case","circle","firm","task"]},"trackable_uuid":{"type":"string","example":"474083eb-a271-4cd0-8e09-92939855113c","description":"The UUID of the model that is being tracked","format":"uuid"},"name":{"type":"string","example":"Research","description":"The name of the time entry."},"description":{"type":"string","example":"Research for the client","description":"The description of the time entry."},"start_date":{"type":"string","example":"2026-03-24","description":"The start time of the time entry.","format":"date"},"end_date":{"type":"string","example":"2026-05-08","description":"The end time of the time entry.","format":"date"},"total_time_in_minutes":{"type":"integer","example":200,"description":"The length of the time entry, can be used instead of dates."}}},"App_Http_Requests_Note_StoreNoteRequest":{"type":"object","required":["notable_type","notable_uuid","contents"],"properties":{"notable_type":{"type":"string","example":"account","description":"The model type that the note is for. Available options are: account, bank_transaction, case, charge, check, circle, conversation, expectation, illustration, mortgage_search, plan, risk, statement, statement_transaction, task","enum":["account","bank_transaction","case","charge","check","circle","conversation","expectation","illustration","mortgage_search","plan","risk","statement","statement_transaction","task"]},"notable_uuid":{"type":"string","example":"1175b7d1-698d-425b-b7d7-31cbe0f78617","description":"The UUID of the model that the note is for.","format":"uuid"},"contents":{"type":"string","example":"This guy rocks.","description":"The note's contents."},"type":{"type":"string","example":"call","description":"|\n\nType of note. Available note types are: call, note, meeting and email\n\n| Value | Description |\n| ----- | ----------- |\n|call|Call|\n|note|Note|\n|meeting|Meeting|\n|email|Email|","enum":["call","note","meeting","email"]},"path":{"type":"string","example":"gifts","description":"Note path, used for note grouping"},"is_pinned":{"type":"boolean","example":false,"description":"Is this note pinned to the top of any results"},"visible_to_clients":{"type":"boolean","example":false,"description":"Is this note visible to client accounts"}}},"App_Http_Requests_Note_UpdateNoteRequest":{"type":"object","required":["contents"],"properties":{"contents":{"type":"string","example":"This guy rocks.","description":"The note's contents."},"type":{"type":"string","example":"meeting","description":"Type of note. Available note types are: call, note, meeting and email"},"path":{"type":"string","example":"gifts","description":"Note path, used for note grouping"},"is_pinned":{"type":"boolean","example":false,"description":"Is this note pinned to the top of any results"},"visible_to_clients":{"type":"boolean","example":false,"description":"Is this note visible to client accounts"}}},"App_Http_Requests_DocumentBuilder_StoreDocumentTemplateRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Client Service Agreement","description":"The name of the document template."}}},"App_Http_Requests_DocumentBuilder_UpdateDocumentTemplateRequest":{"type":"object","properties":{"name":{"type":"string","example":"Welcome Template","description":"The name of the document template."}}},"App_Http_Requests_DocumentBuilder_UploadTemplateDocxContentRequest":{"type":"object","required":["file"],"properties":{"file":{"type":"string","example":"file-contents","description":"The DOCX file - must be less than 50mb in size.","format":"binary"}}},"App_Http_Requests_DocumentBuilder_StoreDocumentRequest":{"type":"object","required":["name","client_uuids"],"properties":{"name":{"type":"string","example":"Client Service Agreement","description":"The name of the document."},"client_uuids":{"type":"array","example":["60b03829-6ea5-41a4-9ea3-ad055363040e","5ddaab8d-fd58-46e7-b417-c739ecf5c48e","cb6c784d-b977-4452-8d82-c9740852ac6a"],"description":"An array containing the client uuids that should be sent the document when it is built.","items":{"type":"string","example":"4712669f-f011-44b2-a6f0-e794d672590e","format":"uuid"}},"template_uuid":{"type":"string","example":"ad20b46e-0cb8-42de-bf2c-eb0086067d56","description":"The UUID of the document template you want to be used with this document. You must not provide the sfdt or docx fields when creating from a template.","format":"uuid"},"known_dependants":{"type":"object","description":"Optional: The document variable dependants. Used to swap variables out for real data.","example":{"client-1":"5f50a34b-7bf4-47e5-b7e7-ec3df0e68009"},"additionalProperties":true}}},"App_Http_Requests_DocumentBuilder_UpdateDocumentRequest":{"type":"object","properties":{"name":{"type":"string","example":"Client Service Agreement","description":"The name of the document."},"client_uuids":{"type":"array","example":["e9c5b07f-a7e2-481d-8821-a74d9e6ad755","1cb82211-8d20-41d8-9c13-a1c233a57525","c448d98f-2879-400c-bd38-366faca52615"],"description":"An array containing the client uuids that should be sent the document when it is built.","items":{"type":"string","example":"2a48dfb3-d0b4-4003-9b1d-c4809643e11a","format":"uuid"}},"known_dependants":{"type":"object","description":"Optional: The document variable dependants. Used to swap variables out for real data.","example":{"client-1":"03e08b91-2b2e-4d2b-a69a-0c60fb697759"},"additionalProperties":true}}},"App_Http_Requests_DocumentBuilder_UploadDocumentDocxContentRequest":{"type":"object","required":["file"],"properties":{"file":{"type":"string","example":"file-contents","description":"The DOCX file - must be less than 50mb in size.","format":"binary"}}},"App_Http_Requests_DocumentSigning_StoreDocumentPackRequest":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string","example":"Terms and Conditions","description":"Name of the document pack."},"description":{"type":"string","example":"Terms and Conditions for our services","description":"Short description of the document pack."},"is_template":{"type":"boolean","example":true,"description":"Denotes whether document pack is a template or not."}}},"App_Http_Requests_DocumentSigning_UpdateDocumentPackRequest":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string","example":"Terms and Conditions","description":"Name of the document pack."},"description":{"type":"string","example":"Terms and Conditions for our services","description":"Short description of the document pack."},"is_template":{"type":"boolean","example":true,"description":"Denotes whether document pack is a template or not."}}},"App_Http_Requests_DocumentBuilder_LaunchDocumentSigningRequest":{"type":"object","required":["participant_uuids","document_template_uuids"],"properties":{"participant_uuids":{"type":"array","example":["ba76a264-a98b-42c2-91ed-e6440668c1a4","3af83cbd-3aed-4fba-a135-1458e3f07db9","f4017ced-684b-46ab-ade3-ef06f572c34e"],"description":"Participants who will be viewing and signing the documents. Must be given in the order you would like the participants to view the documents.","items":{"type":"string","example":"ef267e07-1085-4d31-8ead-01d53e3736fd","format":"uuid"}},"document_template_uuids":{"type":"array","example":["61f2afeb-348c-4f3d-8091-b515ef5e6be7","e813c455-ae31-428b-a355-ccfbb20aa192","9bdb19a7-8301-4b4e-8fca-da7a5cc83ea9"],"description":"Array document template UUIDs to be added as adhoc documents of the document signing process. Required without document_pack.","items":{"type":"string","example":"52db97aa-9cd2-4d83-bd6b-af1dc10d486c","format":"uuid"}},"document_template_dependants":{"type":"object","description":"Array variable dependant models that are needed for variable replacing across all documents that are provided.","example":{"client-1":"23d44e0f-fb2d-4ad9-9271-371d42e88e59","client-2":"c4e231e1-3bb8-4640-906c-8416c6bca5b1"},"additionalProperties":true}}},"App_Http_Requests_Plans_StorePlanRequest":{"type":"object","required":["client_uuid","type","sub_type","provider_uuid","status","visible_on_client_portal","include_in_client_valuation","on_panel"],"properties":{"name":{"type":"string","example":"Johns ISA","description":"Descriptive name of the plan","maxLength":255,"nullable":true},"client_uuid":{"type":"string","example":"c6502fef-a167-453a-9c6c-cd48c3f72ee9","description":"[DEPRECATED] Please use accounts instead. Account uuid linked with the plan","format":"uuid"},"accounts":{"type":"array","example":[],"description":"Accounts that own this plan, along with their percentage ownership. Any percentages that have not be defined will be split equally against the remaining percentage.","items":{"type":"object","example":[{"account_uuid":"257c4ade-1afc-4dbf-86bd-b2bb61b38658"},{"account_uuid":"cc94d662-a9ea-469f-9ed2-6f2bec128929","ownership_percentage":75.0},{"account_uuid":"89865380-4aaf-41ac-803f-1d41c5c26cf0","ownership_percentage":null}],"properties":{"account_uuid":{"type":"string","example":"33cbaf6f-54ff-4eaa-b3d0-1f0579aff136","description":"uuid of the account owner","format":"uuid"},"ownership_percentage":{"type":"number","example":75.0,"description":"Percentage ownership of this account. If not provided, the remaining percentage will be split equally between any accounts without a defined percentage.","format":"float","minimum":0.0,"maximum":100.0,"nullable":true}}}},"type":{"type":"string","example":"annuity","description":"|\n\nType of plan.\n\n| Value | Description |\n| ----- | ----------- |\n|annuity|Annuity|\n|cash_account|Cash Account|\n|fixed_asset|Fixed Asset|\n|general_insurance|General Insurance|\n|group_protection|Group Protection|\n|investment|Investment|\n|loan_credit|Loan Credit|\n|mortgage|Mortgage|\n|pension|Pension|\n|protection_policy|Protection Policy|","enum":["annuity","cash_account","fixed_asset","general_insurance","group_protection","investment","loan_credit","mortgage","pension","protection_policy"]},"sub_type":{"type":"string","example":"cash_account","description":"|\n\nPlan sub type\n\n| Value | Description |\n| ----- | ----------- |\n|cash_account|Cash Account|\n|cash_deposit|Cash Deposit|\n|isa_mini_cash|ISA (Mini Cash)|\n|isa_tessa_only|ISA (TESSA Only)|\n|lifetime_isa_cash|Lifetime ISA (Cash)|\n|national_savings|National Savings|\n|national_savings_child_bonus_bond|National Savings (Child Bonus Bond)|\n|national_savings_fixed_interest_certificate|National Savings (Fixed Interest Certificate)|\n|national_savings_guaranteed_equity_bond|National Savings (Guaranteed Equity Bond)|\n|national_savings_income_bond|National Savings (Income Bond)|\n|national_savings_index_linked_certificate|National Savings (Index Linked Certificate)|\n|national_savings_national_savings_certificate|National Savings (National Savings Certificate)|\n|national_savings_premium_bonds|National Savings (Premium Bonds)|\n|cash_account_unknown|Unknown|\n|aim_investment_tax_service|AIM Investment Tax Service|\n|bes|BES|\n|business_premises_renovation_allowance|Business Premises Renovation Allowance|\n|child_trust_fund|Child Trust Fund|\n|collective_investment_account|Collective Investment Account|\n|commercial_property_purchase_scheme|Commercial Property Purchase Scheme|\n|debenture|Debenture|\n|discretionary_managed_service|Discretionary Managed Service|\n|employee_benefit_trust|Employee Benefit Trust|\n|enterprise_investment_scheme_non_regulated|Enterprise Investment Scheme (Non-Regulated)|\n|enterprise_investment_scheme_regulated|Enterprise Investment Scheme (Regulated)|\n|enterprise_investment_zone_trust|Enterprise Investment Zone Trust|\n|enterprise_zone_syndicate|Enterprise Zone Syndicate|\n|equity_holdings|Equity Holdings|\n|exchange_traded_fund|Exchange Traded Fund|\n|exempt_property_unit_trust|Exempt Property Unit Trust|\n|film_partnership|Film Partnership|\n|geared_investments|Geared Investments|\n|general_investment_account|General Investment Account|\n|hedge_fund|Hedge Fund|\n|investment_bond|Investment Bond|\n|investment_tax_service|Investment Tax Service|\n|investment_trust|Investment Trust|\n|isa_aim|ISA (AIM)|\n|isa_cash|ISA (Cash)|\n|isa_help_to_buy|ISA (Help To Buy)|\n|isa_maxi|ISA (Maxi)|\n|isa_maxi_mini_transfer|ISA (Maxi/Mini Transfer)|\n|isa_mini_equity|ISA (Mini Equity)|\n|isa_nisa|ISA (Nisa)|\n|isa_stocks_and_shares|ISA (Stocks And Shares)|\n|junior_isa_cash|Junior ISA (Cash)|\n|junior_isa_nisa|Junior ISA (Nisa)|\n|junior_isa_stocks_and_shares|Junior ISA (Stocks And Shares)|\n|lifetime_isa_stocks_and_shares|Lifetime ISA (Stocks And Shares)|\n|maximum_investment_plan_investment|Maximum Investment Plan|\n|non_discretionary_managed_service|Non Discretionary Managed Service|\n|oeic_unit_trust|Oeic/Unit Trust|\n|offshore_bond|Offshore Bond|\n|offshore_deposit|Offshore Deposit|\n|offshore_oeic_fund|Offshore Oeic/Fund|\n|offshore_savings_plan|Offshore Savings Plan|\n|onshore_bond|Onshore Bond|\n|personal_equity_plan|Personal Equity Plan|\n|property_holdings|Property Holdings|\n|property_partnership|Property Partnership|\n|property_syndicate|Property Syndicate|\n|residential_property_development|Residential Property Development|\n|savings_account|Savings Account|\n|seed_enterprise_investment_scheme_non_regulated|Seed Enterprise Investment Scheme (Non-Regulated)|\n|seed_enterprise_investment_scheme_regulated|Seed Enterprise Investment Scheme (Regulated)|\n|share_incentive_plan|Share Incentive Plan|\n|share_save_scheme|Share Save Scheme|\n|sicav|SICAV|\n|structured_plan|Structured Plan|\n|structured_plan_cash_isa|Structured Plan (Cash ISA)|\n|structured_plan_deposit|Structured Plan (Deposit)|\n|structured_plan_medium_term_note|Structured Plan (Medium Term Note)|\n|structured_plan_stocks_shares_isa|Structured Plan (Stocks \u0026 Shares ISA)|\n|tessa|TESSA|\n|trust|Trust|\n|unit_trust|Unit Trust|\n|unregulated_collective_investments|Unregulated Collective Investments|\n|venture_capital_trust_non_regulated|Venture Capital Trust (Non-Regulated)|\n|venture_capital_trust_regulated|Venture Capital Trust (Regulated)|\n|wrap|Wrap|\n|investment_unknown|Unknown|\n|accident_and_sickness_insurance|Accident And Sickness Insurance|\n|accident_sickness_and_unemployment_insurance|Accident Sickness And Unemployment Insurance|\n|accidental_death_insurance|Accidental Death Insurance|\n|business_loan_protection|Business Loan Protection|\n|capital_redemption_policy|Capital Redemption Policy|\n|death_in_service|Death In Service|\n|endowment|Endowment|\n|flexible_plan|Flexible Plan|\n|general_insurance_income_protection|General Insurance (Income Protection)|\n|gift_inter_vivos|Gift Inter Vivos|\n|health_assessment|Health Assessment|\n|income_protection|Income Protection|\n|income_protection_executive|Income Protection (Executive)|\n|income_protection_key_person|Income Protection (Key Person)|\n|life_settlement_fund|Life Settlement Fund|\n|maximum_investment_plan|Maximum Investment Plan|\n|multi_benefit_protection|Multi Benefit Protection|\n|pension_contribution_insurance|Pension Contribution Insurance|\n|pension_term_assurance|Pension Term Assurance|\n|pre_paid_funeral_plan|Pre-Paid Funeral Plan|\n|redundancy_insurance|Redundancy Insurance|\n|relevant_life_policy|Relevant Life Policy|\n|renewable_convertible_term|Renewable Convertible Term|\n|term_protection|Term Protection|\n|term_protection_convertible|Term Protection (Convertible)|\n|term_protection_critical_illness|Term Protection (Critical Illness)|\n|term_protection_decreasing_term|Term Protection (Decreasing Term)|\n|term_protection_decreasing_term_ci|Term Protection (Decreasing Term - CI)|\n|term_protection_decreasing_term_life_ci|Term Protection (Decreasing Term - Life \u0026 CI)|\n|term_protection_directors_share_protection|Term Protection (Directors Share Protection)|\n|term_protection_family_income_protection|Term Protection (Family Income Protection)|\n|term_protection_family_income_protection_ci|Term Protection (Family Income Protection - CI)|\n|term_protection_family_income_protection_life_ci|Term Protection (Family Income Protection - Life \u0026 CI)|\n|term_protection_increasing_term|Term Protection (Increasing Term)|\n|term_protection_key_person_assurance|Term Protection (Key Person Assurance)|\n|term_protection_level|Term Protection (Level)|\n|term_protection_level_ci|Term Protection (Level - CI)|\n|term_protection_level_life_ci|Term Protection (Level - Life \u0026 CI)|\n|term_protection_mortgage_protection|Term Protection (Mortgage Protection)|\n|term_protection_partnership_protection|Term Protection (Partnership Protection)|\n|term_protection_renewable|Term Protection (Renewable)|\n|unemployment_insurance|Unemployment Insurance|\n|whole_of_life|Whole Of Life|\n|whole_of_life_non_investment|Whole Of Life (Non Investment)|\n|will|Will|\n|protection_policy_unknown|Unknown|\n|alternatively_secured_pension_plan|Alternatively Secured Pension Plan|\n|appropriate_personal_pension|Appropriate Personal Pension|\n|avc|AVC|\n|cimp|CIMP|\n|cimp_comp|CIMP \u0026 COMP|\n|comp|COMP|\n|deferred_sipp|Deferred SIPP|\n|defined_benefit_pension|Defined Benefit Pension|\n|dependants_pension|Dependants Pension|\n|efrbs|EFRBS|\n|equivalent_pension_benefits|Equivalent Pension Benefits|\n|executive_pension_plan|Executive Pension Plan|\n|family_sipp|Family SIPP|\n|final_salary_scheme|Final Salary Scheme|\n|fsavc|FSAVC|\n|furbs|FURBS|\n|group_cimp|Group CIMP|\n|group_comp|Group COMP|\n|group_dependants_pension|Group Dependants Pension|\n|group_offshore_pension_scheme|Group Offshore Pension Scheme|\n|group_personal_pension|Group Personal Pension|\n|group_s32_buyout_bond|Group S32 Buyout Bond|\n|group_sipp|Group SIPP|\n|group_stakeholder_pension|Group Stakeholder Pension|\n|income_drawdown_beneficiary|Income Drawdown (Beneficiary)|\n|income_drawdown_capped|Income Drawdown (Capped)|\n|income_drawdown_flexi_access|Income Drawdown (Flexi-Access)|\n|income_drawdown_flexible|Income Drawdown (Flexible)|\n|independent_retirement_advice|Independent Retirement Advice (IRA)|\n|individual_retirement_account|Individual Retirement Account|\n|inherited_independent_retirement_advice|Inherited Independent Retirement Advice (Inherited IRA)|\n|junior_personal_pension_plan|Junior SIPP|\n|master_trust_pension|Master Trust Pension|\n|money_purchase_contracted|Money Purchase Contracted|\n|national_employers_savings_trust|National Employers Savings Trust (NEST)|\n|offshore_pension|Offshore Pension|\n|pension_fund_withdrawal|Pension Fund Withdrawal|\n|personal_pension_plan|Personal Pension Plan|\n|phased_retirement|Phased Retirement|\n|pia_non_protected_rights|PIA (Non Protected Rights)|\n|qnups|QNUPs|\n|qnups_wrapper|QNUPs Wrapper|\n|qrops|QROPs|\n|qrops_wrapper|QROPs Wrapper|\n|rnups_wrapper|RNUPs Wrapper|\n|roth_inherited_independent_retirement_advice|Roth Inherited Independent Retirement Advice (Roth IRA)|\n|s226_rac|S226 RAC|\n|s32_buyout_bond|S32 Buyout Bond|\n|sipp|SIPP|\n|sipp_wrapper|SIPP Wrapper|\n|ssas|Ssas|\n|stakeholder_individual|Stakeholder Individual|\n|third_way_pensions|Third Way Pensions|\n|trustee_investment_plan|Trustee Investment Plan|\n|unsecured_pension|Unsecured Pension|\n|uurbs|UURBs|\n|workplace_pension_scheme|Workplace Pension Scheme|\n|pension_unknown|Unknown|\n|annuity_non_pension|Annuity (Non Pension)|\n|compulsory_purchase_life_annuity|Compulsory Purchase Life Annuity|\n|deferred_annuity|Deferred Annuity|\n|defined_benefit_trustee_buy_in|Defined Benefit Trustee Buy In|\n|enhanced_pension_annuity|Enhanced Pension Annuity|\n|fixed_term_annuity|Fixed Term Annuity|\n|group_final_salary|Group Final Salary|\n|hancock_annuity|Hancock Annuity|\n|impaired_life_annuity|Impaired Life Annuity|\n|ivpp|IVPP|\n|lifetime_annuity|Lifetime Annuity|\n|pension_annuity|Pension Annuity|\n|pension_annuity_conventional|Pension Annuity (Conventional)|\n|pension_annuity_flexible|Pension Annuity (Flexible)|\n|pension_annuity_impaired_life|Pension Annuity (Impaired Life)|\n|pension_annuity_temporary|Pension Annuity (Temporary)|\n|pension_annuity_unit_linked|Pension Annuity (Unit Linked)|\n|pension_annuity_with_profits|Pension Annuity (With Profits)|\n|purchased_life_annuity|Purchased Life Annuity|\n|scheme_pension|Scheme Pension|\n|annuity_unknown|Unknown|\n|dental_insurance|Dental Insurance|\n|general_insurance_building|General Insurance (Building)|\n|general_insurance_building_contents|General Insurance (Building \u0026 Contents)|\n|general_insurance_commercial_combined|General Insurance (Commercial Combined)|\n|general_insurance_commercial_motor|General Insurance (Commercial Motor)|\n|general_insurance_contents|General Insurance (Contents)|\n|general_insurance_directors_and_officers|General Insurance (Directors And Officers)|\n|general_insurance_extended_warranty|General Insurance (Extended Warranty)|\n|general_insurance_legal_expenses|General Insurance (Legal Expenses)|\n|general_insurance_let_property|General Insurance (Let Property)|\n|general_insurance_liability|General Insurance (Liability)|\n|general_insurance_other|General Insurance Other|\n|general_insurance_payment_protection|General Insurance (Payment Protection)|\n|general_insurance_private_motor|General Insurance (Private Motor)|\n|general_insurance_professional_indemnity|General Insurance (Professional Indemnity)|\n|general_insurance_travel|General Insurance (Travel)|\n|group_travel_insurance|Group Travel Insurance|\n|healthcare_cash_plan|Healthcare Cash Plan|\n|international_private_medical_insurance|International Private Medical Insurance (IPMI)|\n|locum_insurance|Locum Insurance|\n|long_term_care|Long Term Care|\n|long_term_care_immediate|Long Term Care (Immediate)|\n|long_term_care_pre_funded|Long Term Care (Pre-Funded)|\n|private_medical_insurance|Private Medical Insurance|\n|general_insurance_unknown|Unknown|\n|cpb|CPB|\n|employee_assistance_scheme|Employee Assistance Scheme|\n|flexible_benefits|Flexible Benefits|\n|group_accident_and_sickness|Group Accident And Sickness|\n|group_critical_illness|Group Critical Illness|\n|group_death_in_service|Group Death In Service|\n|group_dental_insurance|Group Dental Insurance|\n|group_healthcare_cash_plan|Group Healthcare Cash Plan|\n|group_income_protection|Group Income Protection|\n|group_income_protection_key_person|Group Income Protection (Key Person)|\n|group_key_person_assurance|Group Key Person Assurance|\n|group_life|Group Life|\n|group_life_excepted|Group Life (Excepted)|\n|group_life_registered|Group Life (Registered)|\n|group_partnership_protection|Group Partnership Protection|\n|group_personal_accident|Group Personal Accident|\n|group_pmi|Group PMI|\n|group_relevant_life|Group Relevant Life|\n|group_term|Group Term|\n|group_protection_unknown|Unknown|\n|equity_release|Equity Release|\n|mortgage|Mortgage|\n|mortgage_bridging_loan|Bridging Loan Mortgage|\n|mortgage_business_buy_to_let|Mortgage Business Buy To Let|\n|mortgage_buy_to_let|Buy To Let Mortgage|\n|mortgage_consumer_buy_to_let|Consumer Buy To Let Mortgage|\n|mortgage_council_tenant_to_buy|Council/Tenant To Buy Mortgage|\n|mortgage_foreign_currency|Foreign Currency Mortgage|\n|mortgage_full_status|Mortgage Full Status|\n|mortgage_further_advance|Further Advance Mortgage|\n|mortgage_government_home_ownership_scheme|Government Home Ownership Scheme Mortgage|\n|mortgage_home_purchase_plan|Home Purchase Plan Mortgage|\n|mortgage_investment_property_islamic|Investment Property Islamic Mortgage|\n|mortgage_let_to_buy|Let To Buy Mortgage|\n|mortgage_lifetime|Mortgage Lifetime|\n|mortgage_non_status|Mortgage Non Status|\n|mortgage_primary_residence_islamic|Primary Residence Islamic Mortgage|\n|mortgage_product_transfer|Product Transfer Mortgage|\n|mortgage_remortgage|Remortgage Mortgage|\n|mortgage_right_to_buy|Right To Buy Mortgage|\n|mortgage_second_charge|Second Charge Mortgage|\n|mortgage_second_home|Second Home Mortgage|\n|mortgage_self_build|Self-Build Mortgage|\n|mortgage_self_cert|Mortgage Self Cert|\n|mortgage_shared_ownership|Shared Ownership Mortgage|\n|mortgage_standard_residential|Standard Residential Mortgage|\n|mortgage_non_regulated_bridging_loan|Non-Regulated Bridging Loan Mortgage|\n|mortgage_non_regulated_buy_to_let|Non-Regulated Buy To Let Mortgage|\n|mortgage_non_regulated_commercial|Non-Regulated Commercial Mortgage|\n|mortgage_non_regulated_further_advance|Non-Regulated Further Advance Mortgage|\n|mortgage_non_regulated_offshore|Non-Regulated Offshore Mortgage|\n|mortgage_non_regulated_overseas|Non-Regulated Overseas Mortgage|\n|mortgage_non_regulated_product_transfer|Non-Regulated Product Transfer Mortgage|\n|third_party_mortgage|Third Party Mortgage|\n|mortgage_unknown|Unknown|\n|bridging_loan|Bridging Loan|\n|car_finance|Car Finance|\n|commercial_finance|Commercial Finance|\n|consumer_finance|Consumer Finance|\n|credit_card|Credit Card|\n|landlords|Landlords|\n|other_long_term_loan|Other Long Term Loan|\n|overdraft|Overdraft|\n|partner_loan|Partner Loan|\n|peer_to_peer_loan|Peer To Peer Loan|\n|personal_loan|Personal Loan|\n|personal_loan_secured|Personal Loan (Secured)|\n|personal_loan_unsecured|Personal Loan (Unsecured)|\n|public_liability|Public Liability|\n|student_loan|Student Loan|\n|will_trust_loan|Will Trust Loan|\n|loan_credit_unknown|Unknown|\n|boat|Boat|\n|collectible_art_other|Collectible/Art/Other|\n|land|Land|\n|motor_vehicle|Motor Vehicle|\n|other|Other|\n|own_business|Own Business|\n|property|Property|\n|property_btl|Property (Btl)|\n|property_investment|Property (Investment)|\n|property_rental|Property (Rental)|\n|property_other|Property (Other)|\n|property_overseas|Property (Overseas)|\n|fixed_asset_unknown|Unknown|","enum":["cash_account","cash_deposit","isa_mini_cash","isa_tessa_only","lifetime_isa_cash","national_savings","national_savings_child_bonus_bond","national_savings_fixed_interest_certificate","national_savings_guaranteed_equity_bond","national_savings_income_bond","national_savings_index_linked_certificate","national_savings_national_savings_certificate","national_savings_premium_bonds","cash_account_unknown","aim_investment_tax_service","bes","business_premises_renovation_allowance","child_trust_fund","collective_investment_account","commercial_property_purchase_scheme","debenture","discretionary_managed_service","employee_benefit_trust","enterprise_investment_scheme_non_regulated","enterprise_investment_scheme_regulated","enterprise_investment_zone_trust","enterprise_zone_syndicate","equity_holdings","exchange_traded_fund","exempt_property_unit_trust","film_partnership","geared_investments","general_investment_account","hedge_fund","investment_bond","investment_tax_service","investment_trust","isa_aim","isa_cash","isa_help_to_buy","isa_maxi","isa_maxi_mini_transfer","isa_mini_equity","isa_nisa","isa_stocks_and_shares","junior_isa_cash","junior_isa_nisa","junior_isa_stocks_and_shares","lifetime_isa_stocks_and_shares","maximum_investment_plan_investment","non_discretionary_managed_service","oeic_unit_trust","offshore_bond","offshore_deposit","offshore_oeic_fund","offshore_savings_plan","onshore_bond","personal_equity_plan","property_holdings","property_partnership","property_syndicate","residential_property_development","savings_account","seed_enterprise_investment_scheme_non_regulated","seed_enterprise_investment_scheme_regulated","share_incentive_plan","share_save_scheme","sicav","structured_plan","structured_plan_cash_isa","structured_plan_deposit","structured_plan_medium_term_note","structured_plan_stocks_shares_isa","tessa","trust","unit_trust","unregulated_collective_investments","venture_capital_trust_non_regulated","venture_capital_trust_regulated","wrap","investment_unknown","accident_and_sickness_insurance","accident_sickness_and_unemployment_insurance","accidental_death_insurance","business_loan_protection","capital_redemption_policy","death_in_service","endowment","flexible_plan","general_insurance_income_protection","gift_inter_vivos","health_assessment","income_protection","income_protection_executive","income_protection_key_person","life_settlement_fund","maximum_investment_plan","multi_benefit_protection","pension_contribution_insurance","pension_term_assurance","pre_paid_funeral_plan","redundancy_insurance","relevant_life_policy","renewable_convertible_term","term_protection","term_protection_convertible","term_protection_critical_illness","term_protection_decreasing_term","term_protection_decreasing_term_ci","term_protection_decreasing_term_life_ci","term_protection_directors_share_protection","term_protection_family_income_protection","term_protection_family_income_protection_ci","term_protection_family_income_protection_life_ci","term_protection_increasing_term","term_protection_key_person_assurance","term_protection_level","term_protection_level_ci","term_protection_level_life_ci","term_protection_mortgage_protection","term_protection_partnership_protection","term_protection_renewable","unemployment_insurance","whole_of_life","whole_of_life_non_investment","will","protection_policy_unknown","alternatively_secured_pension_plan","appropriate_personal_pension","avc","cimp","cimp_comp","comp","deferred_sipp","defined_benefit_pension","dependants_pension","efrbs","equivalent_pension_benefits","executive_pension_plan","family_sipp","final_salary_scheme","fsavc","furbs","group_cimp","group_comp","group_dependants_pension","group_offshore_pension_scheme","group_personal_pension","group_s32_buyout_bond","group_sipp","group_stakeholder_pension","income_drawdown_beneficiary","income_drawdown_capped","income_drawdown_flexi_access","income_drawdown_flexible","independent_retirement_advice","individual_retirement_account","inherited_independent_retirement_advice","junior_personal_pension_plan","master_trust_pension","money_purchase_contracted","national_employers_savings_trust","offshore_pension","pension_fund_withdrawal","personal_pension_plan","phased_retirement","pia_non_protected_rights","qnups","qnups_wrapper","qrops","qrops_wrapper","rnups_wrapper","roth_inherited_independent_retirement_advice","s226_rac","s32_buyout_bond","sipp","sipp_wrapper","ssas","stakeholder_individual","third_way_pensions","trustee_investment_plan","unsecured_pension","uurbs","workplace_pension_scheme","pension_unknown","annuity_non_pension","compulsory_purchase_life_annuity","deferred_annuity","defined_benefit_trustee_buy_in","enhanced_pension_annuity","fixed_term_annuity","group_final_salary","hancock_annuity","impaired_life_annuity","ivpp","lifetime_annuity","pension_annuity","pension_annuity_conventional","pension_annuity_flexible","pension_annuity_impaired_life","pension_annuity_temporary","pension_annuity_unit_linked","pension_annuity_with_profits","purchased_life_annuity","scheme_pension","annuity_unknown","dental_insurance","general_insurance_building","general_insurance_building_contents","general_insurance_commercial_combined","general_insurance_commercial_motor","general_insurance_contents","general_insurance_directors_and_officers","general_insurance_extended_warranty","general_insurance_legal_expenses","general_insurance_let_property","general_insurance_liability","general_insurance_other","general_insurance_payment_protection","general_insurance_private_motor","general_insurance_professional_indemnity","general_insurance_travel","group_travel_insurance","healthcare_cash_plan","international_private_medical_insurance","locum_insurance","long_term_care","long_term_care_immediate","long_term_care_pre_funded","private_medical_insurance","general_insurance_unknown","cpb","employee_assistance_scheme","flexible_benefits","group_accident_and_sickness","group_critical_illness","group_death_in_service","group_dental_insurance","group_healthcare_cash_plan","group_income_protection","group_income_protection_key_person","group_key_person_assurance","group_life","group_life_excepted","group_life_registered","group_partnership_protection","group_personal_accident","group_pmi","group_relevant_life","group_term","group_protection_unknown","equity_release","mortgage","mortgage_bridging_loan","mortgage_business_buy_to_let","mortgage_buy_to_let","mortgage_consumer_buy_to_let","mortgage_council_tenant_to_buy","mortgage_foreign_currency","mortgage_full_status","mortgage_further_advance","mortgage_government_home_ownership_scheme","mortgage_home_purchase_plan","mortgage_investment_property_islamic","mortgage_let_to_buy","mortgage_lifetime","mortgage_non_status","mortgage_primary_residence_islamic","mortgage_product_transfer","mortgage_remortgage","mortgage_right_to_buy","mortgage_second_charge","mortgage_second_home","mortgage_self_build","mortgage_self_cert","mortgage_shared_ownership","mortgage_standard_residential","mortgage_non_regulated_bridging_loan","mortgage_non_regulated_buy_to_let","mortgage_non_regulated_commercial","mortgage_non_regulated_further_advance","mortgage_non_regulated_offshore","mortgage_non_regulated_overseas","mortgage_non_regulated_product_transfer","third_party_mortgage","mortgage_unknown","bridging_loan","car_finance","commercial_finance","consumer_finance","credit_card","landlords","other_long_term_loan","overdraft","partner_loan","peer_to_peer_loan","personal_loan","personal_loan_secured","personal_loan_unsecured","public_liability","student_loan","will_trust_loan","loan_credit_unknown","boat","collectible_art_other","land","motor_vehicle","other","own_business","property","property_btl","property_investment","property_rental","property_other","property_overseas","fixed_asset_unknown"]},"provider_uuid":{"type":"string","example":"5d4e8025-13fe-4d63-a572-8be4cd8b111e","description":"uuid of the provider","format":"uuid","nullable":true},"policy_number":{"type":"string","example":"AVI-43135","description":"Main policy number for the plan, will be stored as the main accounts policy number","maxLength":255,"nullable":true},"proposal_reference":{"type":"string","example":"AB12345","description":"Main proposal reference for the plan, will be stored as the main accounts proposal reference","maxLength":255,"nullable":true},"status":{"type":"string","example":"active","description":"|\n\nStatus of plan.\n\n| Value | Description |\n| ----- | ----------- |\n|active|Active|\n|inactive|Inactive|\n|proposed|Proposed|","enum":["active","inactive","proposed"]},"opened_at":{"type":"string","example":"2026-05-04","description":"date when the plan was purchased or account was opened","format":"date","nullable":true},"inactive_at":{"type":"string","example":"2026-05-08","description":"Date when plan went inactive","format":"date","nullable":true},"inactive_reason":{"type":"string","example":"accepted","description":"|\n\nReason for inactivity.\n\n| Value | Description |\n| ----- | ----------- |\n|accepted|Accepted|\n|agency_transferred|Agency Transferred|\n|cancelled|Cancelled|\n|claimed|Claimed|\n|complete|Complete|\n|death_event|Death Event|\n|deferred|Deferred|\n|drawdown|Drawdown|\n|expired|Expired|\n|full_drawdown|Full Drawdown|\n|issued|Issued|\n|lapsed|Lapsed|\n|matured|Matured|\n|not_proceeded_with|Not Proceeded With|\n|not_taken_up|Not Taken Up|\n|offered|Offered|\n|paid_up|Paid Up|\n|partial_drawdown|Partial Drawdown|\n|partial_surrender|Partial Surrender|\n|proposed|Proposed|\n|prospect|Prospect|\n|refunded|Refunded|\n|refused|Refused|\n|surrendered|Surrendered|\n|transfer|Transfer|\n|transferred|Transferred|\n|underwriting|Underwriting|\n|vested|Vested|\n|declined|Declined|\n|encashment|Encashment|\n|left_service|Left Service|\n|premium_holiday|Premium Holiday|\n|other|Other|","enum":["accepted","agency_transferred","cancelled","claimed","complete","death_event","deferred","drawdown","expired","full_drawdown","issued","lapsed","matured","not_proceeded_with","not_taken_up","offered","paid_up","partial_drawdown","partial_surrender","proposed","prospect","refunded","refused","surrendered","transfer","transferred","underwriting","vested","declined","encashment","left_service","premium_holiday","other"],"nullable":true},"agency_in_your_name":{"type":"boolean","example":true,"description":"Agency in your name","nullable":true},"agency_in_your_name_from":{"type":"string","example":"2026-01-28","description":"Date agency was in your name from","format":"date","nullable":true},"originally_sold_by_firm":{"type":"boolean","example":true,"description":"Whether the plan was originally sold by your firm","nullable":true},"under_advice":{"type":"boolean","example":true,"description":"Under advice","nullable":true},"visible_on_client_portal":{"type":"boolean","example":true,"description":"Whether this plan will be shown to clients in their client portal. Will default to true if not provided."},"include_in_client_valuation":{"type":"boolean","example":true,"description":"Include in client valuation. Will default to true if not provided."},"show_on_joint":{"type":"boolean","example":true,"description":"@Deprecated","nullable":true},"shown_on_circles":{"type":"boolean","example":false,"description":"Determines if plan should be shown on a circle"},"review_date":{"type":"string","example":"2027-05-08","description":"Next review date","format":"date","nullable":true},"on_panel":{"type":"boolean","example":true,"description":"On panel","nullable":true},"cases":{"type":"array","example":["185d1a5c-836a-4537-86e5-9a0354d34d53","33e49df8-7f15-4d45-8bcd-0b21023263f5","86c3a346-598d-4944-885a-321088724e0c"],"description":"Array of case uuids","items":{"type":"string","example":"e3e186b0-a03c-4579-9900-b08f4eb0fc82","format":"uuid"}},"seller_uuid":{"type":"string","example":"628e1782-9439-42b0-8834-23a10f528ac7","description":"Employee account that sold this plan","format":"uuid","nullable":true},"seller_name":{"type":"string","example":"Jane Doe","description":"Name of the employee that sold this plan","maxLength":255,"nullable":true},"active_adviser_uuid":{"type":"string","example":"045fbb36-0a09-4a81-ab4f-b4cb6c7ffa6e","description":"Employee account that is managing this plan","format":"uuid","nullable":true},"adviser_split_uuid":{"type":"string","example":"b48eb797-56b7-4613-9cd0-e3947dcf3960","description":"A plan adviser split to be applied to charges to this plan","format":"uuid"},"linked_owners":{"type":"array","example":["2df34848-65ad-461c-9f42-a5e0de9af020","8a572519-bc8f-47ee-8d55-25541acab16b","ef53306f-3af0-453b-ada2-d036fdb56aaa"],"description":"Linked clients who should be added as extra owners of the plan.","items":{"type":"string","example":"5ef26768-49db-44a0-97f5-66c9672b847f","format":"uuid"}},"visible_to_circles_uuids":{"type":"array","example":["1cfdd6b4-fce4-4f56-8372-03bae0595d70","1787149b-dcbd-4118-b7c4-6f5dfce502d5","168e3489-0218-45b6-a2e2-d9f37a248150"],"description":"Circles UUIDs that can view the plan when filtering plans by circles. Leaving blank means the plan will be visible for all circles which contains the plan owners.","items":{"type":"string","example":"c5864ba0-fa32-4ee9-809d-2738d3aafe56","format":"uuid"},"nullable":true},"current_value":{"type":"integer","example":5000,"description":"The current value of the plan in pennies. Can be provided with `current_value_at` to specify the date that the plan was valued at.","nullable":true},"current_value_at":{"type":"string","example":"2026-05-08","description":"Optional date to be used with `current_value`. If left blank it will default to the current day.","format":"date","nullable":true},"is_group_scheme":{"type":"boolean","example":false,"description":"Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes. Only business clients can have group schemes. Will default to false if not provided.","nullable":true},"is_wrap_product":{"type":"boolean","example":false,"description":"Denotes if the plan is a wrap product, and can have plans linked under it. Will default to false if not provided.","nullable":true},"wrap_uuid":{"type":"string","example":"eaef1010-4cab-4d5c-baa8-91ad7fbb78d5","description":"The UUID of the wrap product to link this plan too","format":"uuid","nullable":true},"contract_enquiry_account_uuid":{"type":"string","example":"3323e27d-d540-4b82-97db-9c15bd6fafff","description":"The UUID of the account used for contract enquiry.","format":"uuid","nullable":true},"beneficiaries":{"type":"array","example":[],"description":"The beneficiaries of the plan.","items":{"type":"object","example":[{"name":"John Smith","percentage":20.5},{"name":"Jane Doe","percentage":50.5}],"properties":{"name":{"type":"string","example":"John Smith","description":"Name of the beneficiary."},"percentage":{"type":"number","example":20.5,"description":"Percentage share of the beneficiary.","format":"float","minimum":0.0,"maximum":100.0}}}},"platform_provider":{"example":"(platform_provider)","description":"platform_provider field, this is found on types (annuity cash_account investment pension)","type":"string"},"life_assured":{"example":"(life_assured)","description":"life_assured field, this is found on types (annuity)","type":"string"},"sum_assured":{"example":"(sum_assured)","description":"sum_assured field, this is found on types (annuity)","type":"string"},"term_type":{"example":"(term_type)","description":"term_type field, this is found on types (annuity cash_account general_insurance group_protection investment loan_credit mortgage pension protection_policy)","type":"string"},"term_maturity_date":{"example":"(term_maturity_date)","description":"term_maturity_date field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)","type":"string"},"term_age":{"example":"(term_age)","description":"term_age field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)","type":"string"},"term_maturity_value":{"example":"(term_maturity_value)","description":"term_maturity_value field, this is found on types (annuity)","type":"string"},"guaranteed_term":{"example":"(guaranteed_term)","description":"guaranteed_term field, this is found on types (annuity)","type":"string"},"payment_type":{"example":"(payment_type)","description":"payment_type field, this is found on types (annuity)","type":"string"},"income_amount":{"example":"(income_amount)","description":"income_amount field, this is found on types (annuity)","type":"string"},"income_frequency":{"example":"(income_frequency)","description":"income_frequency field, this is found on types (annuity)","type":"string"},"income_from":{"example":"(income_from)","description":"income_from field, this is found on types (annuity)","type":"string"},"income_escalation":{"example":"(income_escalation)","description":"income_escalation field, this is found on types (annuity)","type":"string"},"initial_purchase_amount":{"example":"(initial_purchase_amount)","description":"initial_purchase_amount field, this is found on types (annuity)","type":"string"},"interest_type":{"example":"(interest_type)","description":"interest_type field, this is found on types (cash_account investment loan_credit mortgage)","type":"string"},"interest_rate":{"example":"(interest_rate)","description":"interest_rate field, this is found on types (cash_account investment loan_credit mortgage)","type":"string"},"address_1":{"example":"(address_1)","description":"address_1 field, this is found on types (fixed_asset)","type":"string"},"address_2":{"example":"(address_2)","description":"address_2 field, this is found on types (fixed_asset)","type":"string"},"address_3":{"example":"(address_3)","description":"address_3 field, this is found on types (fixed_asset)","type":"string"},"address_4":{"example":"(address_4)","description":"address_4 field, this is found on types (fixed_asset)","type":"string"},"town_city":{"example":"(town_city)","description":"town_city field, this is found on types (fixed_asset)","type":"string"},"county":{"example":"(county)","description":"county field, this is found on types (fixed_asset)","type":"string"},"postcode":{"example":"(postcode)","description":"postcode field, this is found on types (fixed_asset)","type":"string"},"country":{"example":"(country)","description":"country field, this is found on types (fixed_asset)","type":"string"},"new_property":{"example":"(new_property)","description":"new_property field, this is found on types (fixed_asset)","type":"string"},"price_listed":{"example":"(price_listed)","description":"price_listed field, this is found on types (fixed_asset)","type":"string"},"purchase_price":{"example":"(purchase_price)","description":"purchase_price field, this is found on types (fixed_asset)","type":"string"},"asset_description":{"example":"(asset_description)","description":"asset_description field, this is found on types (fixed_asset)","type":"string"},"asset_image":{"example":"(asset_image)","description":"asset_image field, this is found on types (fixed_asset)","type":"string"},"ncd":{"example":"(ncd)","description":"ncd field, this is found on types (general_insurance)","type":"string"},"ncd_protected":{"example":"(ncd_protected)","description":"ncd_protected field, this is found on types (general_insurance)","type":"string"},"ncd_years":{"example":"(ncd_years)","description":"ncd_years field, this is found on types (general_insurance)","type":"string"},"renewal_date":{"example":"(renewal_date)","description":"renewal_date field, this is found on types (general_insurance group_protection)","type":"string"},"offshore":{"example":"(offshore)","description":"offshore field, this is found on types (investment)","type":"string"},"in_trust":{"example":"(in_trust)","description":"in_trust field, this is found on types (investment protection_policy)","type":"string"},"trustee_details":{"example":"(trustee_details)","description":"trustee_details field, this is found on types (investment protection_policy)","type":"string"},"original_balance":{"example":"(original_balance)","description":"original_balance field, this is found on types (loan_credit mortgage)","type":"string"},"outstanding_balance":{"example":"(outstanding_balance)","description":"outstanding_balance field, this is found on types (loan_credit mortgage)","type":"string"},"loan_amount":{"example":"(loan_amount)","description":"loan_amount field, this is found on types (loan_credit)","type":"string"},"repayment_amount":{"example":"(repayment_amount)","description":"repayment_amount field, this is found on types (loan_credit)","type":"string"},"repayment_frequency":{"example":"(repayment_frequency)","description":"repayment_frequency field, this is found on types (loan_credit)","type":"string"},"details":{"example":"(details)","description":"details field, this is found on types (loan_credit)","type":"string"},"property_type":{"example":"(property_type)","description":"property_type field, this is found on types (mortgage)","type":"string"},"payment_amount":{"example":"(payment_amount)","description":"payment_amount field, this is found on types (mortgage)","type":"string"},"payment_frequency":{"example":"(payment_frequency)","description":"payment_frequency field, this is found on types (mortgage)","type":"string"},"initial_interest":{"example":"(initial_interest)","description":"initial_interest field, this is found on types (mortgage)","type":"string"},"initial_period_end":{"example":"(initial_period_end)","description":"initial_period_end field, this is found on types (mortgage)","type":"string"},"initial_payment":{"example":"(initial_payment)","description":"initial_payment field, this is found on types (mortgage)","type":"string"},"equity_released":{"example":"(equity_released)","description":"equity_released field, this is found on types (mortgage)","type":"string"},"loan_quote":{"example":"(loan_quote)","description":"loan_quote field, this is found on types (mortgage)","type":"string"},"loan_type":{"example":"(loan_type)","description":"loan_type field, this is found on types (mortgage)","type":"string"},"mig_added":{"example":"(mig_added)","description":"mig_added field, this is found on types (mortgage)","type":"string"},"mig_premium":{"example":"(mig_premium)","description":"mig_premium field, this is found on types (mortgage)","type":"string"},"repayment_type":{"example":"(repayment_type)","description":"repayment_type field, this is found on types (mortgage)","type":"string"},"repayment_method":{"example":"(repayment_method)","description":"repayment_method field, this is found on types (mortgage)","type":"string"},"repayment_term":{"example":"(repayment_term)","description":"repayment_term field, this is found on types (mortgage)","type":"string"},"other_repayment_method":{"example":"(other_repayment_method)","description":"other_repayment_method field, this is found on types (mortgage)","type":"string"},"scheme_fixed_date":{"example":"(scheme_fixed_date)","description":"scheme_fixed_date field, this is found on types (mortgage)","type":"string"},"transaction_details":{"example":"(transaction_details)","description":"transaction_details field, this is found on types (mortgage)","type":"string"},"base_payment":{"example":"(base_payment)","description":"base_payment field, this is found on types (mortgage)","type":"string"},"has_transfer_penalties":{"example":"(has_transfer_penalties)","description":"has_transfer_penalties field, this is found on types (mortgage)","type":"string"},"is_portable_mortgage":{"example":"(is_portable_mortgage)","description":"is_portable_mortgage field, this is found on types (mortgage)","type":"string"},"transfer_consent":{"example":"(transfer_consent)","description":"transfer_consent field, this is found on types (mortgage)","type":"string"},"transfer_penalty":{"example":"(transfer_penalty)","description":"transfer_penalty field, this is found on types (mortgage)","type":"string"},"contract_exchanged":{"example":"(contract_exchanged)","description":"contract_exchanged field, this is found on types (mortgage)","type":"string"},"date_complete":{"example":"(date_complete)","description":"date_complete field, this is found on types (mortgage)","type":"string"},"date_confirmed":{"example":"(date_confirmed)","description":"date_confirmed field, this is found on types (mortgage)","type":"string"},"date_exchanged":{"example":"(date_exchanged)","description":"date_exchanged field, this is found on types (mortgage)","type":"string"},"date_submitted":{"example":"(date_submitted)","description":"date_submitted field, this is found on types (mortgage)","type":"string"},"mortgage_completed":{"example":"(mortgage_completed)","description":"mortgage_completed field, this is found on types (mortgage)","type":"string"},"offer_confirmed":{"example":"(offer_confirmed)","description":"offer_confirmed field, this is found on types (mortgage)","type":"string"},"offer_confirmed_date":{"example":"(offer_confirmed_date)","description":"offer_confirmed_date field, this is found on types (mortgage)","type":"string"},"offer_date":{"example":"(offer_date)","description":"offer_date field, this is found on types (mortgage)","type":"string"},"offer_issued":{"example":"(offer_issued)","description":"offer_issued field, this is found on types (mortgage)","type":"string"},"on_risk":{"example":"(on_risk)","description":"on_risk field, this is found on types (mortgage)","type":"string"},"proposal_date":{"example":"(proposal_date)","description":"proposal_date field, this is found on types (mortgage)","type":"string"},"submitted":{"example":"(submitted)","description":"submitted field, this is found on types (mortgage)","type":"string"},"declined_notes":{"example":"(declined_notes)","description":"declined_notes field, this is found on types (mortgage)","type":"string"},"accrual_rate":{"example":"(accrual_rate)","description":"accrual_rate field, this is found on types (pension)","type":"string"},"year_accrued":{"example":"(year_accrued)","description":"year_accrued field, this is found on types (pension)","type":"string"},"retirement_date":{"example":"(retirement_date)","description":"retirement_date field, this is found on types (pension)","type":"string"},"pensionable_salary":{"example":"(pensionable_salary)","description":"pensionable_salary field, this is found on types (pension)","type":"string"},"transfer_value":{"example":"(transfer_value)","description":"transfer_value field, this is found on types (pension)","type":"string"},"date_of_transfer_valuation":{"example":"(date_of_transfer_valuation)","description":"date_of_transfer_valuation field, this is found on types (pension)","type":"string"},"widows_percentage":{"example":"(widows_percentage)","description":"widows_percentage field, this is found on types (pension)","type":"string"},"contracted_out":{"example":"(contracted_out)","description":"contracted_out field, this is found on types (pension)","type":"string"},"had_avc":{"example":"(had_avc)","description":"had_avc field, this is found on types (pension)","type":"string"},"in_house_avc_amount":{"example":"(in_house_avc_amount)","description":"in_house_avc_amount field, this is found on types (pension)","type":"string"},"in_house_avc_percentage":{"example":"(in_house_avc_percentage)","description":"in_house_avc_percentage field, this is found on types (pension)","type":"string"},"death_benefit_amount":{"example":"(death_benefit_amount)","description":"death_benefit_amount field, this is found on types (pension)","type":"string"},"projected_income":{"example":"(projected_income)","description":"projected_income field, this is found on types (pension)","type":"string"},"plan_retirement_age":{"example":"(plan_retirement_age)","description":"plan_retirement_age field, this is found on types (pension)","type":"string"},"state_retirement_age":{"example":"(state_retirement_age)","description":"state_retirement_age field, this is found on types (pension)","type":"string"},"salary_sacrifice":{"example":"(salary_sacrifice)","description":"salary_sacrifice field, this is found on types (pension)","type":"string"},"waiver":{"example":"(waiver)","description":"waiver field, this is found on types (pension)","type":"string"},"is_crystallised":{"example":"(is_crystallised)","description":"is_crystallised field, this is found on types (pension)","type":"string"},"crystallisation_amount":{"example":"(crystallisation_amount)","description":"crystallisation_amount field, this is found on types (pension)","type":"string"},"crystallisation_benefit":{"example":"(crystallisation_benefit)","description":"crystallisation_benefit field, this is found on types (pension)","type":"string"},"crystallisation_fund":{"example":"(crystallisation_fund)","description":"crystallisation_fund field, this is found on types (pension)","type":"string"},"crystallisation_start_date":{"example":"(crystallisation_start_date)","description":"crystallisation_start_date field, this is found on types (pension)","type":"string"},"crystallisation_end_date":{"example":"(crystallisation_end_date)","description":"crystallisation_end_date field, this is found on types (pension)","type":"string"},"crystallisation_frequency":{"example":"(crystallisation_frequency)","description":"crystallisation_frequency field, this is found on types (pension)","type":"string"},"fund_amount":{"example":"(fund_amount)","description":"fund_amount field, this is found on types (pension)","type":"string"},"uncrystallised_fund":{"example":"(uncrystallised_fund)","description":"uncrystallised_fund field, this is found on types (pension)","type":"string"},"income_taken_amount":{"example":"(income_taken_amount)","description":"income_taken_amount field, this is found on types (pension)","type":"string"},"maximum_income_amount":{"example":"(maximum_income_amount)","description":"maximum_income_amount field, this is found on types (pension)","type":"string"},"tax_free_amount":{"example":"(tax_free_amount)","description":"tax_free_amount field, this is found on types (pension)","type":"string"},"lifetime_allowance_percentage":{"example":"(lifetime_allowance_percentage)","description":"lifetime_allowance_percentage field, this is found on types (pension)","type":"string"},"lta_applied":{"example":"(lta_applied)","description":"lta_applied field, this is found on types (pension)","type":"string"},"mpaa_trigger":{"example":"(mpaa_trigger)","description":"mpaa_trigger field, this is found on types (pension)","type":"string"},"pcls_percentage":{"example":"(pcls_percentage)","description":"pcls_percentage field, this is found on types (pension)","type":"string"},"reason":{"example":"(reason)","description":"reason field, this is found on types (pension)","type":"string"},"has_pre_existing_conditions":{"example":"(has_pre_existing_conditions)","description":"has_pre_existing_conditions field, this is found on types (protection_policy)","type":"string"},"pre_existing_conditions_notes":{"example":"(pre_existing_conditions_notes)","description":"pre_existing_conditions_notes field, this is found on types (protection_policy)","type":"string"},"external_reference":{"$ref":"#/components/schemas/ExternalReference"}}},"App_Http_Requests_Plans_UpdatePlanRequest":{"type":"object","properties":{"name":{"type":"string","example":"Johns ISA","description":"Descriptive name of the plan","maxLength":255,"nullable":true},"client_uuid":{"type":"string","example":"11d899be-1752-48a1-b605-c96c06925e2b","description":"[DEPRECATED] Please use accounts instead. Account uuid linked with the plan","format":"uuid"},"accounts":{"type":"array","example":[],"description":"Accounts that own this plan, along with their percentage ownership. Any percentages that have not be defined will be split equally against the remaining percentage.","items":{"type":"object","example":[{"account_uuid":"1dd36b67-39b3-40f9-aacf-0b0af6f36eb9"},{"account_uuid":"e755e401-ec82-4603-bb9f-42ff7ed10241","ownership_percentage":75.0},{"account_uuid":"0ad3b60d-2736-42a1-85e0-72cdd3ad1e0b","ownership_percentage":null}],"properties":{"account_uuid":{"type":"string","example":"50811c29-572b-4cec-9757-fdd1c108a42b","description":"uuid of the account owner","format":"uuid"},"ownership_percentage":{"type":"number","example":75.0,"description":"Percentage ownership of this account. If not provided, the remaining percentage will be split equally between any accounts without a defined percentage.","format":"float","minimum":0.0,"maximum":100.0,"nullable":true}}}},"sub_type":{"type":"string","example":"cash_account","description":"|\n\nPlan sub type\n\n| Value | Description |\n| ----- | ----------- |\n|cash_account|Cash Account|\n|cash_deposit|Cash Deposit|\n|isa_mini_cash|ISA (Mini Cash)|\n|isa_tessa_only|ISA (TESSA Only)|\n|lifetime_isa_cash|Lifetime ISA (Cash)|\n|national_savings|National Savings|\n|national_savings_child_bonus_bond|National Savings (Child Bonus Bond)|\n|national_savings_fixed_interest_certificate|National Savings (Fixed Interest Certificate)|\n|national_savings_guaranteed_equity_bond|National Savings (Guaranteed Equity Bond)|\n|national_savings_income_bond|National Savings (Income Bond)|\n|national_savings_index_linked_certificate|National Savings (Index Linked Certificate)|\n|national_savings_national_savings_certificate|National Savings (National Savings Certificate)|\n|national_savings_premium_bonds|National Savings (Premium Bonds)|\n|cash_account_unknown|Unknown|\n|aim_investment_tax_service|AIM Investment Tax Service|\n|bes|BES|\n|business_premises_renovation_allowance|Business Premises Renovation Allowance|\n|child_trust_fund|Child Trust Fund|\n|collective_investment_account|Collective Investment Account|\n|commercial_property_purchase_scheme|Commercial Property Purchase Scheme|\n|debenture|Debenture|\n|discretionary_managed_service|Discretionary Managed Service|\n|employee_benefit_trust|Employee Benefit Trust|\n|enterprise_investment_scheme_non_regulated|Enterprise Investment Scheme (Non-Regulated)|\n|enterprise_investment_scheme_regulated|Enterprise Investment Scheme (Regulated)|\n|enterprise_investment_zone_trust|Enterprise Investment Zone Trust|\n|enterprise_zone_syndicate|Enterprise Zone Syndicate|\n|equity_holdings|Equity Holdings|\n|exchange_traded_fund|Exchange Traded Fund|\n|exempt_property_unit_trust|Exempt Property Unit Trust|\n|film_partnership|Film Partnership|\n|geared_investments|Geared Investments|\n|general_investment_account|General Investment Account|\n|hedge_fund|Hedge Fund|\n|investment_bond|Investment Bond|\n|investment_tax_service|Investment Tax Service|\n|investment_trust|Investment Trust|\n|isa_aim|ISA (AIM)|\n|isa_cash|ISA (Cash)|\n|isa_help_to_buy|ISA (Help To Buy)|\n|isa_maxi|ISA (Maxi)|\n|isa_maxi_mini_transfer|ISA (Maxi/Mini Transfer)|\n|isa_mini_equity|ISA (Mini Equity)|\n|isa_nisa|ISA (Nisa)|\n|isa_stocks_and_shares|ISA (Stocks And Shares)|\n|junior_isa_cash|Junior ISA (Cash)|\n|junior_isa_nisa|Junior ISA (Nisa)|\n|junior_isa_stocks_and_shares|Junior ISA (Stocks And Shares)|\n|lifetime_isa_stocks_and_shares|Lifetime ISA (Stocks And Shares)|\n|maximum_investment_plan_investment|Maximum Investment Plan|\n|non_discretionary_managed_service|Non Discretionary Managed Service|\n|oeic_unit_trust|Oeic/Unit Trust|\n|offshore_bond|Offshore Bond|\n|offshore_deposit|Offshore Deposit|\n|offshore_oeic_fund|Offshore Oeic/Fund|\n|offshore_savings_plan|Offshore Savings Plan|\n|onshore_bond|Onshore Bond|\n|personal_equity_plan|Personal Equity Plan|\n|property_holdings|Property Holdings|\n|property_partnership|Property Partnership|\n|property_syndicate|Property Syndicate|\n|residential_property_development|Residential Property Development|\n|savings_account|Savings Account|\n|seed_enterprise_investment_scheme_non_regulated|Seed Enterprise Investment Scheme (Non-Regulated)|\n|seed_enterprise_investment_scheme_regulated|Seed Enterprise Investment Scheme (Regulated)|\n|share_incentive_plan|Share Incentive Plan|\n|share_save_scheme|Share Save Scheme|\n|sicav|SICAV|\n|structured_plan|Structured Plan|\n|structured_plan_cash_isa|Structured Plan (Cash ISA)|\n|structured_plan_deposit|Structured Plan (Deposit)|\n|structured_plan_medium_term_note|Structured Plan (Medium Term Note)|\n|structured_plan_stocks_shares_isa|Structured Plan (Stocks \u0026 Shares ISA)|\n|tessa|TESSA|\n|trust|Trust|\n|unit_trust|Unit Trust|\n|unregulated_collective_investments|Unregulated Collective Investments|\n|venture_capital_trust_non_regulated|Venture Capital Trust (Non-Regulated)|\n|venture_capital_trust_regulated|Venture Capital Trust (Regulated)|\n|wrap|Wrap|\n|investment_unknown|Unknown|\n|accident_and_sickness_insurance|Accident And Sickness Insurance|\n|accident_sickness_and_unemployment_insurance|Accident Sickness And Unemployment Insurance|\n|accidental_death_insurance|Accidental Death Insurance|\n|business_loan_protection|Business Loan Protection|\n|capital_redemption_policy|Capital Redemption Policy|\n|death_in_service|Death In Service|\n|endowment|Endowment|\n|flexible_plan|Flexible Plan|\n|general_insurance_income_protection|General Insurance (Income Protection)|\n|gift_inter_vivos|Gift Inter Vivos|\n|health_assessment|Health Assessment|\n|income_protection|Income Protection|\n|income_protection_executive|Income Protection (Executive)|\n|income_protection_key_person|Income Protection (Key Person)|\n|life_settlement_fund|Life Settlement Fund|\n|maximum_investment_plan|Maximum Investment Plan|\n|multi_benefit_protection|Multi Benefit Protection|\n|pension_contribution_insurance|Pension Contribution Insurance|\n|pension_term_assurance|Pension Term Assurance|\n|pre_paid_funeral_plan|Pre-Paid Funeral Plan|\n|redundancy_insurance|Redundancy Insurance|\n|relevant_life_policy|Relevant Life Policy|\n|renewable_convertible_term|Renewable Convertible Term|\n|term_protection|Term Protection|\n|term_protection_convertible|Term Protection (Convertible)|\n|term_protection_critical_illness|Term Protection (Critical Illness)|\n|term_protection_decreasing_term|Term Protection (Decreasing Term)|\n|term_protection_decreasing_term_ci|Term Protection (Decreasing Term - CI)|\n|term_protection_decreasing_term_life_ci|Term Protection (Decreasing Term - Life \u0026 CI)|\n|term_protection_directors_share_protection|Term Protection (Directors Share Protection)|\n|term_protection_family_income_protection|Term Protection (Family Income Protection)|\n|term_protection_family_income_protection_ci|Term Protection (Family Income Protection - CI)|\n|term_protection_family_income_protection_life_ci|Term Protection (Family Income Protection - Life \u0026 CI)|\n|term_protection_increasing_term|Term Protection (Increasing Term)|\n|term_protection_key_person_assurance|Term Protection (Key Person Assurance)|\n|term_protection_level|Term Protection (Level)|\n|term_protection_level_ci|Term Protection (Level - CI)|\n|term_protection_level_life_ci|Term Protection (Level - Life \u0026 CI)|\n|term_protection_mortgage_protection|Term Protection (Mortgage Protection)|\n|term_protection_partnership_protection|Term Protection (Partnership Protection)|\n|term_protection_renewable|Term Protection (Renewable)|\n|unemployment_insurance|Unemployment Insurance|\n|whole_of_life|Whole Of Life|\n|whole_of_life_non_investment|Whole Of Life (Non Investment)|\n|will|Will|\n|protection_policy_unknown|Unknown|\n|alternatively_secured_pension_plan|Alternatively Secured Pension Plan|\n|appropriate_personal_pension|Appropriate Personal Pension|\n|avc|AVC|\n|cimp|CIMP|\n|cimp_comp|CIMP \u0026 COMP|\n|comp|COMP|\n|deferred_sipp|Deferred SIPP|\n|defined_benefit_pension|Defined Benefit Pension|\n|dependants_pension|Dependants Pension|\n|efrbs|EFRBS|\n|equivalent_pension_benefits|Equivalent Pension Benefits|\n|executive_pension_plan|Executive Pension Plan|\n|family_sipp|Family SIPP|\n|final_salary_scheme|Final Salary Scheme|\n|fsavc|FSAVC|\n|furbs|FURBS|\n|group_cimp|Group CIMP|\n|group_comp|Group COMP|\n|group_dependants_pension|Group Dependants Pension|\n|group_offshore_pension_scheme|Group Offshore Pension Scheme|\n|group_personal_pension|Group Personal Pension|\n|group_s32_buyout_bond|Group S32 Buyout Bond|\n|group_sipp|Group SIPP|\n|group_stakeholder_pension|Group Stakeholder Pension|\n|income_drawdown_beneficiary|Income Drawdown (Beneficiary)|\n|income_drawdown_capped|Income Drawdown (Capped)|\n|income_drawdown_flexi_access|Income Drawdown (Flexi-Access)|\n|income_drawdown_flexible|Income Drawdown (Flexible)|\n|independent_retirement_advice|Independent Retirement Advice (IRA)|\n|individual_retirement_account|Individual Retirement Account|\n|inherited_independent_retirement_advice|Inherited Independent Retirement Advice (Inherited IRA)|\n|junior_personal_pension_plan|Junior SIPP|\n|master_trust_pension|Master Trust Pension|\n|money_purchase_contracted|Money Purchase Contracted|\n|national_employers_savings_trust|National Employers Savings Trust (NEST)|\n|offshore_pension|Offshore Pension|\n|pension_fund_withdrawal|Pension Fund Withdrawal|\n|personal_pension_plan|Personal Pension Plan|\n|phased_retirement|Phased Retirement|\n|pia_non_protected_rights|PIA (Non Protected Rights)|\n|qnups|QNUPs|\n|qnups_wrapper|QNUPs Wrapper|\n|qrops|QROPs|\n|qrops_wrapper|QROPs Wrapper|\n|rnups_wrapper|RNUPs Wrapper|\n|roth_inherited_independent_retirement_advice|Roth Inherited Independent Retirement Advice (Roth IRA)|\n|s226_rac|S226 RAC|\n|s32_buyout_bond|S32 Buyout Bond|\n|sipp|SIPP|\n|sipp_wrapper|SIPP Wrapper|\n|ssas|Ssas|\n|stakeholder_individual|Stakeholder Individual|\n|third_way_pensions|Third Way Pensions|\n|trustee_investment_plan|Trustee Investment Plan|\n|unsecured_pension|Unsecured Pension|\n|uurbs|UURBs|\n|workplace_pension_scheme|Workplace Pension Scheme|\n|pension_unknown|Unknown|\n|annuity_non_pension|Annuity (Non Pension)|\n|compulsory_purchase_life_annuity|Compulsory Purchase Life Annuity|\n|deferred_annuity|Deferred Annuity|\n|defined_benefit_trustee_buy_in|Defined Benefit Trustee Buy In|\n|enhanced_pension_annuity|Enhanced Pension Annuity|\n|fixed_term_annuity|Fixed Term Annuity|\n|group_final_salary|Group Final Salary|\n|hancock_annuity|Hancock Annuity|\n|impaired_life_annuity|Impaired Life Annuity|\n|ivpp|IVPP|\n|lifetime_annuity|Lifetime Annuity|\n|pension_annuity|Pension Annuity|\n|pension_annuity_conventional|Pension Annuity (Conventional)|\n|pension_annuity_flexible|Pension Annuity (Flexible)|\n|pension_annuity_impaired_life|Pension Annuity (Impaired Life)|\n|pension_annuity_temporary|Pension Annuity (Temporary)|\n|pension_annuity_unit_linked|Pension Annuity (Unit Linked)|\n|pension_annuity_with_profits|Pension Annuity (With Profits)|\n|purchased_life_annuity|Purchased Life Annuity|\n|scheme_pension|Scheme Pension|\n|annuity_unknown|Unknown|\n|dental_insurance|Dental Insurance|\n|general_insurance_building|General Insurance (Building)|\n|general_insurance_building_contents|General Insurance (Building \u0026 Contents)|\n|general_insurance_commercial_combined|General Insurance (Commercial Combined)|\n|general_insurance_commercial_motor|General Insurance (Commercial Motor)|\n|general_insurance_contents|General Insurance (Contents)|\n|general_insurance_directors_and_officers|General Insurance (Directors And Officers)|\n|general_insurance_extended_warranty|General Insurance (Extended Warranty)|\n|general_insurance_legal_expenses|General Insurance (Legal Expenses)|\n|general_insurance_let_property|General Insurance (Let Property)|\n|general_insurance_liability|General Insurance (Liability)|\n|general_insurance_other|General Insurance Other|\n|general_insurance_payment_protection|General Insurance (Payment Protection)|\n|general_insurance_private_motor|General Insurance (Private Motor)|\n|general_insurance_professional_indemnity|General Insurance (Professional Indemnity)|\n|general_insurance_travel|General Insurance (Travel)|\n|group_travel_insurance|Group Travel Insurance|\n|healthcare_cash_plan|Healthcare Cash Plan|\n|international_private_medical_insurance|International Private Medical Insurance (IPMI)|\n|locum_insurance|Locum Insurance|\n|long_term_care|Long Term Care|\n|long_term_care_immediate|Long Term Care (Immediate)|\n|long_term_care_pre_funded|Long Term Care (Pre-Funded)|\n|private_medical_insurance|Private Medical Insurance|\n|general_insurance_unknown|Unknown|\n|cpb|CPB|\n|employee_assistance_scheme|Employee Assistance Scheme|\n|flexible_benefits|Flexible Benefits|\n|group_accident_and_sickness|Group Accident And Sickness|\n|group_critical_illness|Group Critical Illness|\n|group_death_in_service|Group Death In Service|\n|group_dental_insurance|Group Dental Insurance|\n|group_healthcare_cash_plan|Group Healthcare Cash Plan|\n|group_income_protection|Group Income Protection|\n|group_income_protection_key_person|Group Income Protection (Key Person)|\n|group_key_person_assurance|Group Key Person Assurance|\n|group_life|Group Life|\n|group_life_excepted|Group Life (Excepted)|\n|group_life_registered|Group Life (Registered)|\n|group_partnership_protection|Group Partnership Protection|\n|group_personal_accident|Group Personal Accident|\n|group_pmi|Group PMI|\n|group_relevant_life|Group Relevant Life|\n|group_term|Group Term|\n|group_protection_unknown|Unknown|\n|equity_release|Equity Release|\n|mortgage|Mortgage|\n|mortgage_bridging_loan|Bridging Loan Mortgage|\n|mortgage_business_buy_to_let|Mortgage Business Buy To Let|\n|mortgage_buy_to_let|Buy To Let Mortgage|\n|mortgage_consumer_buy_to_let|Consumer Buy To Let Mortgage|\n|mortgage_council_tenant_to_buy|Council/Tenant To Buy Mortgage|\n|mortgage_foreign_currency|Foreign Currency Mortgage|\n|mortgage_full_status|Mortgage Full Status|\n|mortgage_further_advance|Further Advance Mortgage|\n|mortgage_government_home_ownership_scheme|Government Home Ownership Scheme Mortgage|\n|mortgage_home_purchase_plan|Home Purchase Plan Mortgage|\n|mortgage_investment_property_islamic|Investment Property Islamic Mortgage|\n|mortgage_let_to_buy|Let To Buy Mortgage|\n|mortgage_lifetime|Mortgage Lifetime|\n|mortgage_non_status|Mortgage Non Status|\n|mortgage_primary_residence_islamic|Primary Residence Islamic Mortgage|\n|mortgage_product_transfer|Product Transfer Mortgage|\n|mortgage_remortgage|Remortgage Mortgage|\n|mortgage_right_to_buy|Right To Buy Mortgage|\n|mortgage_second_charge|Second Charge Mortgage|\n|mortgage_second_home|Second Home Mortgage|\n|mortgage_self_build|Self-Build Mortgage|\n|mortgage_self_cert|Mortgage Self Cert|\n|mortgage_shared_ownership|Shared Ownership Mortgage|\n|mortgage_standard_residential|Standard Residential Mortgage|\n|mortgage_non_regulated_bridging_loan|Non-Regulated Bridging Loan Mortgage|\n|mortgage_non_regulated_buy_to_let|Non-Regulated Buy To Let Mortgage|\n|mortgage_non_regulated_commercial|Non-Regulated Commercial Mortgage|\n|mortgage_non_regulated_further_advance|Non-Regulated Further Advance Mortgage|\n|mortgage_non_regulated_offshore|Non-Regulated Offshore Mortgage|\n|mortgage_non_regulated_overseas|Non-Regulated Overseas Mortgage|\n|mortgage_non_regulated_product_transfer|Non-Regulated Product Transfer Mortgage|\n|third_party_mortgage|Third Party Mortgage|\n|mortgage_unknown|Unknown|\n|bridging_loan|Bridging Loan|\n|car_finance|Car Finance|\n|commercial_finance|Commercial Finance|\n|consumer_finance|Consumer Finance|\n|credit_card|Credit Card|\n|landlords|Landlords|\n|other_long_term_loan|Other Long Term Loan|\n|overdraft|Overdraft|\n|partner_loan|Partner Loan|\n|peer_to_peer_loan|Peer To Peer Loan|\n|personal_loan|Personal Loan|\n|personal_loan_secured|Personal Loan (Secured)|\n|personal_loan_unsecured|Personal Loan (Unsecured)|\n|public_liability|Public Liability|\n|student_loan|Student Loan|\n|will_trust_loan|Will Trust Loan|\n|loan_credit_unknown|Unknown|\n|boat|Boat|\n|collectible_art_other|Collectible/Art/Other|\n|land|Land|\n|motor_vehicle|Motor Vehicle|\n|other|Other|\n|own_business|Own Business|\n|property|Property|\n|property_btl|Property (Btl)|\n|property_investment|Property (Investment)|\n|property_rental|Property (Rental)|\n|property_other|Property (Other)|\n|property_overseas|Property (Overseas)|\n|fixed_asset_unknown|Unknown|","enum":["cash_account","cash_deposit","isa_mini_cash","isa_tessa_only","lifetime_isa_cash","national_savings","national_savings_child_bonus_bond","national_savings_fixed_interest_certificate","national_savings_guaranteed_equity_bond","national_savings_income_bond","national_savings_index_linked_certificate","national_savings_national_savings_certificate","national_savings_premium_bonds","cash_account_unknown","aim_investment_tax_service","bes","business_premises_renovation_allowance","child_trust_fund","collective_investment_account","commercial_property_purchase_scheme","debenture","discretionary_managed_service","employee_benefit_trust","enterprise_investment_scheme_non_regulated","enterprise_investment_scheme_regulated","enterprise_investment_zone_trust","enterprise_zone_syndicate","equity_holdings","exchange_traded_fund","exempt_property_unit_trust","film_partnership","geared_investments","general_investment_account","hedge_fund","investment_bond","investment_tax_service","investment_trust","isa_aim","isa_cash","isa_help_to_buy","isa_maxi","isa_maxi_mini_transfer","isa_mini_equity","isa_nisa","isa_stocks_and_shares","junior_isa_cash","junior_isa_nisa","junior_isa_stocks_and_shares","lifetime_isa_stocks_and_shares","maximum_investment_plan_investment","non_discretionary_managed_service","oeic_unit_trust","offshore_bond","offshore_deposit","offshore_oeic_fund","offshore_savings_plan","onshore_bond","personal_equity_plan","property_holdings","property_partnership","property_syndicate","residential_property_development","savings_account","seed_enterprise_investment_scheme_non_regulated","seed_enterprise_investment_scheme_regulated","share_incentive_plan","share_save_scheme","sicav","structured_plan","structured_plan_cash_isa","structured_plan_deposit","structured_plan_medium_term_note","structured_plan_stocks_shares_isa","tessa","trust","unit_trust","unregulated_collective_investments","venture_capital_trust_non_regulated","venture_capital_trust_regulated","wrap","investment_unknown","accident_and_sickness_insurance","accident_sickness_and_unemployment_insurance","accidental_death_insurance","business_loan_protection","capital_redemption_policy","death_in_service","endowment","flexible_plan","general_insurance_income_protection","gift_inter_vivos","health_assessment","income_protection","income_protection_executive","income_protection_key_person","life_settlement_fund","maximum_investment_plan","multi_benefit_protection","pension_contribution_insurance","pension_term_assurance","pre_paid_funeral_plan","redundancy_insurance","relevant_life_policy","renewable_convertible_term","term_protection","term_protection_convertible","term_protection_critical_illness","term_protection_decreasing_term","term_protection_decreasing_term_ci","term_protection_decreasing_term_life_ci","term_protection_directors_share_protection","term_protection_family_income_protection","term_protection_family_income_protection_ci","term_protection_family_income_protection_life_ci","term_protection_increasing_term","term_protection_key_person_assurance","term_protection_level","term_protection_level_ci","term_protection_level_life_ci","term_protection_mortgage_protection","term_protection_partnership_protection","term_protection_renewable","unemployment_insurance","whole_of_life","whole_of_life_non_investment","will","protection_policy_unknown","alternatively_secured_pension_plan","appropriate_personal_pension","avc","cimp","cimp_comp","comp","deferred_sipp","defined_benefit_pension","dependants_pension","efrbs","equivalent_pension_benefits","executive_pension_plan","family_sipp","final_salary_scheme","fsavc","furbs","group_cimp","group_comp","group_dependants_pension","group_offshore_pension_scheme","group_personal_pension","group_s32_buyout_bond","group_sipp","group_stakeholder_pension","income_drawdown_beneficiary","income_drawdown_capped","income_drawdown_flexi_access","income_drawdown_flexible","independent_retirement_advice","individual_retirement_account","inherited_independent_retirement_advice","junior_personal_pension_plan","master_trust_pension","money_purchase_contracted","national_employers_savings_trust","offshore_pension","pension_fund_withdrawal","personal_pension_plan","phased_retirement","pia_non_protected_rights","qnups","qnups_wrapper","qrops","qrops_wrapper","rnups_wrapper","roth_inherited_independent_retirement_advice","s226_rac","s32_buyout_bond","sipp","sipp_wrapper","ssas","stakeholder_individual","third_way_pensions","trustee_investment_plan","unsecured_pension","uurbs","workplace_pension_scheme","pension_unknown","annuity_non_pension","compulsory_purchase_life_annuity","deferred_annuity","defined_benefit_trustee_buy_in","enhanced_pension_annuity","fixed_term_annuity","group_final_salary","hancock_annuity","impaired_life_annuity","ivpp","lifetime_annuity","pension_annuity","pension_annuity_conventional","pension_annuity_flexible","pension_annuity_impaired_life","pension_annuity_temporary","pension_annuity_unit_linked","pension_annuity_with_profits","purchased_life_annuity","scheme_pension","annuity_unknown","dental_insurance","general_insurance_building","general_insurance_building_contents","general_insurance_commercial_combined","general_insurance_commercial_motor","general_insurance_contents","general_insurance_directors_and_officers","general_insurance_extended_warranty","general_insurance_legal_expenses","general_insurance_let_property","general_insurance_liability","general_insurance_other","general_insurance_payment_protection","general_insurance_private_motor","general_insurance_professional_indemnity","general_insurance_travel","group_travel_insurance","healthcare_cash_plan","international_private_medical_insurance","locum_insurance","long_term_care","long_term_care_immediate","long_term_care_pre_funded","private_medical_insurance","general_insurance_unknown","cpb","employee_assistance_scheme","flexible_benefits","group_accident_and_sickness","group_critical_illness","group_death_in_service","group_dental_insurance","group_healthcare_cash_plan","group_income_protection","group_income_protection_key_person","group_key_person_assurance","group_life","group_life_excepted","group_life_registered","group_partnership_protection","group_personal_accident","group_pmi","group_relevant_life","group_term","group_protection_unknown","equity_release","mortgage","mortgage_bridging_loan","mortgage_business_buy_to_let","mortgage_buy_to_let","mortgage_consumer_buy_to_let","mortgage_council_tenant_to_buy","mortgage_foreign_currency","mortgage_full_status","mortgage_further_advance","mortgage_government_home_ownership_scheme","mortgage_home_purchase_plan","mortgage_investment_property_islamic","mortgage_let_to_buy","mortgage_lifetime","mortgage_non_status","mortgage_primary_residence_islamic","mortgage_product_transfer","mortgage_remortgage","mortgage_right_to_buy","mortgage_second_charge","mortgage_second_home","mortgage_self_build","mortgage_self_cert","mortgage_shared_ownership","mortgage_standard_residential","mortgage_non_regulated_bridging_loan","mortgage_non_regulated_buy_to_let","mortgage_non_regulated_commercial","mortgage_non_regulated_further_advance","mortgage_non_regulated_offshore","mortgage_non_regulated_overseas","mortgage_non_regulated_product_transfer","third_party_mortgage","mortgage_unknown","bridging_loan","car_finance","commercial_finance","consumer_finance","credit_card","landlords","other_long_term_loan","overdraft","partner_loan","peer_to_peer_loan","personal_loan","personal_loan_secured","personal_loan_unsecured","public_liability","student_loan","will_trust_loan","loan_credit_unknown","boat","collectible_art_other","land","motor_vehicle","other","own_business","property","property_btl","property_investment","property_rental","property_other","property_overseas","fixed_asset_unknown"]},"provider_uuid":{"type":"string","example":"f7277e6a-b4e6-4f0b-bc3f-bdc7fe939fc2","description":"UUID of the provider. Use null to remove the provider from the plan","format":"uuid","nullable":true},"policy_number":{"type":"string","example":"AVI-43135","description":"Main policy number for the plan, will be stored as the main accounts policy number","maxLength":255,"nullable":true},"proposal_reference":{"type":"string","example":"AB12345","description":"Main proposal reference for the plan, will be stored as the main accounts proposal reference","maxLength":255,"nullable":true},"opened_at":{"type":"string","example":"2026-05-01","description":"date when the plan was purchased or account was opened","format":"date","nullable":true},"status":{"type":"string","example":"active","description":"|\n\nStatus of plan\n\n| Value | Description |\n| ----- | ----------- |\n|active|Active|\n|inactive|Inactive|\n|proposed|Proposed|","enum":["active","inactive","proposed"]},"inactive_at":{"type":"string","example":"2026-05-06","description":"Date when plan went inactive","format":"date","nullable":true},"inactive_reason":{"type":"string","example":"accepted","description":"|\n\nReason of inactivity\n\n| Value | Description |\n| ----- | ----------- |\n|accepted|Accepted|\n|agency_transferred|Agency Transferred|\n|cancelled|Cancelled|\n|claimed|Claimed|\n|complete|Complete|\n|death_event|Death Event|\n|deferred|Deferred|\n|drawdown|Drawdown|\n|expired|Expired|\n|full_drawdown|Full Drawdown|\n|issued|Issued|\n|lapsed|Lapsed|\n|matured|Matured|\n|not_proceeded_with|Not Proceeded With|\n|not_taken_up|Not Taken Up|\n|offered|Offered|\n|paid_up|Paid Up|\n|partial_drawdown|Partial Drawdown|\n|partial_surrender|Partial Surrender|\n|proposed|Proposed|\n|prospect|Prospect|\n|refunded|Refunded|\n|refused|Refused|\n|surrendered|Surrendered|\n|transfer|Transfer|\n|transferred|Transferred|\n|underwriting|Underwriting|\n|vested|Vested|\n|declined|Declined|\n|encashment|Encashment|\n|left_service|Left Service|\n|premium_holiday|Premium Holiday|\n|other|Other|","enum":["accepted","agency_transferred","cancelled","claimed","complete","death_event","deferred","drawdown","expired","full_drawdown","issued","lapsed","matured","not_proceeded_with","not_taken_up","offered","paid_up","partial_drawdown","partial_surrender","proposed","prospect","refunded","refused","surrendered","transfer","transferred","underwriting","vested","declined","encashment","left_service","premium_holiday","other"],"nullable":true},"agency_in_your_name":{"type":"boolean","example":true,"description":"Agency in your name","nullable":true},"agency_in_your_name_from":{"type":"string","example":"2026-01-28","description":"Date agency was in your name from","format":"date","nullable":true},"originally_sold_by_firm":{"type":"boolean","example":true,"description":"Whether the plan was originally sold by your firm","nullable":true},"under_advice":{"type":"boolean","example":true,"description":"Under advice","nullable":true},"visible_on_client_portal":{"type":"boolean","example":true,"description":"Whether this plan will be shown to clients in their client portal"},"include_in_client_valuation":{"type":"boolean","example":true,"description":"Include in client valuation"},"show_on_joint":{"type":"boolean","example":true,"description":"@Deprecated"},"shown_on_circles":{"type":"boolean","example":false,"description":"Determines if plan should be shown on a circle"},"review_date":{"type":"string","example":"2027-05-08","description":"Next review date","format":"date","nullable":true},"on_panel":{"type":"boolean","example":true,"description":"On panel","nullable":true},"cases":{"type":"array","example":["cf95012a-d358-489c-8e78-d53360f515c7","b6e68475-cb40-4682-a215-183acdbfb21b","43c08e83-9da0-44d0-a7bd-324dbf2520f1"],"description":"Array of case UUIDs that you want to associate to the plan with. To remove cases from the plan, pass in null","items":{"type":"string","example":"c5264abb-cf2a-4b5c-b7f4-2c00341deacb","format":"uuid"},"nullable":true},"seller_uuid":{"type":"string","example":"422ccf66-e464-4284-a127-e5728d623d73","description":"Employee account UUID that sold the plan. Updating this will affect future charge splitting","format":"uuid","nullable":true},"seller_name":{"type":"string","example":"Jane Doe","description":"Name of the employee that sold the plan. Used if seller_uuid is not provided","maxLength":255,"nullable":true},"active_adviser_uuid":{"type":"string","example":"d2da12d5-714a-4078-86e0-2c68eac00a14","description":"Employee account that is managing this plan","format":"uuid","nullable":true},"adviser_split_uuid":{"type":"string","example":"50c86e1e-1255-4c31-a851-ee0a6a9e4d1e","description":"A plan adviser split to be applied to charges to this plan","format":"uuid"},"linked_owners":{"type":"array","example":["f4e81414-c12d-4ff8-bd45-a7939eb007e8","312769b8-1c7d-4eaa-bfaa-dc1c296e377a","9152f680-f275-4f04-a1f7-ea19f663309f"],"description":"Linked clients who should be synced as extra owners of the plan","items":{"type":"string","example":"cbfb0639-a344-44b0-b162-0400b6c027dc","format":"uuid"}},"linked_plans":{"type":"array","example":["e67d7187-a0d9-45da-bbe9-ab5735667de9","95d76f25-ce08-4c12-a2e3-825215ff05c4","120b20fc-db21-4464-a554-cf95b33e39f3"],"description":"Sync link other plans of the client to this plan. Providing null or empty array will unlink all linked plans.","items":{"type":"string","example":"a993481e-e002-4923-a6f6-ce96d25cdc29","format":"uuid"}},"visible_to_circles_uuids":{"type":"array","example":["4019c73b-a2a4-42ae-8ab4-0735affc8290","3d65a5c6-10b9-400a-bcc0-c74e781f7a28","ca62e877-aea4-44d4-880e-8e1c42198eae"],"description":"Circles UUIDs that can view the plan when filtering plans by circles. Leaving blank means the plan will be visible for all circles which contains the plan owners.","items":{"type":"string","example":"ffdcd24e-78bc-4b16-86a5-240fac461c5e","format":"uuid"},"nullable":true},"current_value":{"type":"integer","example":5000,"description":"The current value of the plan in pennies. Can be provided with `current_value_at` to specify the date that the plan was valued at.","nullable":true},"current_value_at":{"type":"string","example":"2026-05-08","description":"Optional date to be used with `current_value`. If left blank it will default to the current day.","format":"date","nullable":true},"is_group_scheme":{"type":"boolean","example":false,"description":"Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes. Only business clients can have group schemes."},"is_wrap_product":{"type":"boolean","example":false,"description":"Denotes if the plan is a wrap product, and can have plans linked under it"},"group_scheme_member_detail":{"type":"object","description":"Additional fields to update if the is_group_scheme_member field is true.","example":{"workplace_location":"Waterlooville","employer_division":"Sales"},"properties":{"workplace_location":{"type":"string","example":"Waterlooville","description":"The workplace location of the group scheme member.","maxLength":255,"nullable":true},"employment_division":{"type":"string","example":"Sales","description":"The employment division of the group scheme member.","maxLength":255,"nullable":true}}},"wrap_uuid":{"type":"string","example":"6e54a582-6023-4e3b-9857-71327f7ccb75","description":"The UUID of the wrap product to link this plan too","format":"uuid","nullable":true},"contract_enquiry_account_uuid":{"type":"string","example":"4a8c1137-4820-40dc-bbd9-1616b18651a4","description":"The UUID of the account used for contract enquiry.","format":"uuid","nullable":true},"beneficiaries":{"type":"array","example":[],"description":"The beneficiaries of the plan.","items":{"type":"object","example":[{"uuid":"e16c15a1-eee0-454c-9de3-0cfeaac464f8","name":"John Smith","percentage":50},{"name":"Jane Doe","percentage":20}],"properties":{"uuid":{"type":"string","example":"78fcd83d-f9e1-4691-93f9-cb2db84a8104","description":"The UUID of the beneficiary. Leave blank when creating a new beneficiary.","format":"uuid"},"name":{"type":"string","example":"John Smith","description":"The name of the beneficiary.","maxLength":255},"percentage":{"type":"number","example":50.0,"description":"The percentage allocated to the beneficiary.","format":"float","minimum":0.0,"maximum":100.0}}}},"platform_provider":{"example":"(platform_provider)","description":"platform_provider field, this is found on types (annuity cash_account investment pension)","type":"string"},"life_assured":{"example":"(life_assured)","description":"life_assured field, this is found on types (annuity)","type":"string"},"sum_assured":{"example":"(sum_assured)","description":"sum_assured field, this is found on types (annuity)","type":"string"},"term_type":{"example":"(term_type)","description":"term_type field, this is found on types (annuity cash_account general_insurance group_protection investment loan_credit mortgage pension protection_policy)","type":"string"},"term_maturity_date":{"example":"(term_maturity_date)","description":"term_maturity_date field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)","type":"string"},"term_age":{"example":"(term_age)","description":"term_age field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)","type":"string"},"term_maturity_value":{"example":"(term_maturity_value)","description":"term_maturity_value field, this is found on types (annuity)","type":"string"},"guaranteed_term":{"example":"(guaranteed_term)","description":"guaranteed_term field, this is found on types (annuity)","type":"string"},"payment_type":{"example":"(payment_type)","description":"payment_type field, this is found on types (annuity)","type":"string"},"income_amount":{"example":"(income_amount)","description":"income_amount field, this is found on types (annuity)","type":"string"},"income_frequency":{"example":"(income_frequency)","description":"income_frequency field, this is found on types (annuity)","type":"string"},"income_from":{"example":"(income_from)","description":"income_from field, this is found on types (annuity)","type":"string"},"income_escalation":{"example":"(income_escalation)","description":"income_escalation field, this is found on types (annuity)","type":"string"},"initial_purchase_amount":{"example":"(initial_purchase_amount)","description":"initial_purchase_amount field, this is found on types (annuity)","type":"string"},"interest_type":{"example":"(interest_type)","description":"interest_type field, this is found on types (cash_account investment loan_credit mortgage)","type":"string"},"interest_rate":{"example":"(interest_rate)","description":"interest_rate field, this is found on types (cash_account investment loan_credit mortgage)","type":"string"},"address_1":{"example":"(address_1)","description":"address_1 field, this is found on types (fixed_asset)","type":"string"},"address_2":{"example":"(address_2)","description":"address_2 field, this is found on types (fixed_asset)","type":"string"},"address_3":{"example":"(address_3)","description":"address_3 field, this is found on types (fixed_asset)","type":"string"},"address_4":{"example":"(address_4)","description":"address_4 field, this is found on types (fixed_asset)","type":"string"},"town_city":{"example":"(town_city)","description":"town_city field, this is found on types (fixed_asset)","type":"string"},"county":{"example":"(county)","description":"county field, this is found on types (fixed_asset)","type":"string"},"postcode":{"example":"(postcode)","description":"postcode field, this is found on types (fixed_asset)","type":"string"},"country":{"example":"(country)","description":"country field, this is found on types (fixed_asset)","type":"string"},"new_property":{"example":"(new_property)","description":"new_property field, this is found on types (fixed_asset)","type":"string"},"price_listed":{"example":"(price_listed)","description":"price_listed field, this is found on types (fixed_asset)","type":"string"},"purchase_price":{"example":"(purchase_price)","description":"purchase_price field, this is found on types (fixed_asset)","type":"string"},"asset_description":{"example":"(asset_description)","description":"asset_description field, this is found on types (fixed_asset)","type":"string"},"asset_image":{"example":"(asset_image)","description":"asset_image field, this is found on types (fixed_asset)","type":"string"},"ncd":{"example":"(ncd)","description":"ncd field, this is found on types (general_insurance)","type":"string"},"ncd_protected":{"example":"(ncd_protected)","description":"ncd_protected field, this is found on types (general_insurance)","type":"string"},"ncd_years":{"example":"(ncd_years)","description":"ncd_years field, this is found on types (general_insurance)","type":"string"},"renewal_date":{"example":"(renewal_date)","description":"renewal_date field, this is found on types (general_insurance group_protection)","type":"string"},"offshore":{"example":"(offshore)","description":"offshore field, this is found on types (investment)","type":"string"},"in_trust":{"example":"(in_trust)","description":"in_trust field, this is found on types (investment protection_policy)","type":"string"},"trustee_details":{"example":"(trustee_details)","description":"trustee_details field, this is found on types (investment protection_policy)","type":"string"},"original_balance":{"example":"(original_balance)","description":"original_balance field, this is found on types (loan_credit mortgage)","type":"string"},"outstanding_balance":{"example":"(outstanding_balance)","description":"outstanding_balance field, this is found on types (loan_credit mortgage)","type":"string"},"loan_amount":{"example":"(loan_amount)","description":"loan_amount field, this is found on types (loan_credit)","type":"string"},"repayment_amount":{"example":"(repayment_amount)","description":"repayment_amount field, this is found on types (loan_credit)","type":"string"},"repayment_frequency":{"example":"(repayment_frequency)","description":"repayment_frequency field, this is found on types (loan_credit)","type":"string"},"details":{"example":"(details)","description":"details field, this is found on types (loan_credit)","type":"string"},"property_type":{"example":"(property_type)","description":"property_type field, this is found on types (mortgage)","type":"string"},"payment_amount":{"example":"(payment_amount)","description":"payment_amount field, this is found on types (mortgage)","type":"string"},"payment_frequency":{"example":"(payment_frequency)","description":"payment_frequency field, this is found on types (mortgage)","type":"string"},"initial_interest":{"example":"(initial_interest)","description":"initial_interest field, this is found on types (mortgage)","type":"string"},"initial_period_end":{"example":"(initial_period_end)","description":"initial_period_end field, this is found on types (mortgage)","type":"string"},"initial_payment":{"example":"(initial_payment)","description":"initial_payment field, this is found on types (mortgage)","type":"string"},"equity_released":{"example":"(equity_released)","description":"equity_released field, this is found on types (mortgage)","type":"string"},"loan_quote":{"example":"(loan_quote)","description":"loan_quote field, this is found on types (mortgage)","type":"string"},"loan_type":{"example":"(loan_type)","description":"loan_type field, this is found on types (mortgage)","type":"string"},"mig_added":{"example":"(mig_added)","description":"mig_added field, this is found on types (mortgage)","type":"string"},"mig_premium":{"example":"(mig_premium)","description":"mig_premium field, this is found on types (mortgage)","type":"string"},"repayment_type":{"example":"(repayment_type)","description":"repayment_type field, this is found on types (mortgage)","type":"string"},"repayment_method":{"example":"(repayment_method)","description":"repayment_method field, this is found on types (mortgage)","type":"string"},"repayment_term":{"example":"(repayment_term)","description":"repayment_term field, this is found on types (mortgage)","type":"string"},"other_repayment_method":{"example":"(other_repayment_method)","description":"other_repayment_method field, this is found on types (mortgage)","type":"string"},"scheme_fixed_date":{"example":"(scheme_fixed_date)","description":"scheme_fixed_date field, this is found on types (mortgage)","type":"string"},"transaction_details":{"example":"(transaction_details)","description":"transaction_details field, this is found on types (mortgage)","type":"string"},"base_payment":{"example":"(base_payment)","description":"base_payment field, this is found on types (mortgage)","type":"string"},"has_transfer_penalties":{"example":"(has_transfer_penalties)","description":"has_transfer_penalties field, this is found on types (mortgage)","type":"string"},"is_portable_mortgage":{"example":"(is_portable_mortgage)","description":"is_portable_mortgage field, this is found on types (mortgage)","type":"string"},"transfer_consent":{"example":"(transfer_consent)","description":"transfer_consent field, this is found on types (mortgage)","type":"string"},"transfer_penalty":{"example":"(transfer_penalty)","description":"transfer_penalty field, this is found on types (mortgage)","type":"string"},"contract_exchanged":{"example":"(contract_exchanged)","description":"contract_exchanged field, this is found on types (mortgage)","type":"string"},"date_complete":{"example":"(date_complete)","description":"date_complete field, this is found on types (mortgage)","type":"string"},"date_confirmed":{"example":"(date_confirmed)","description":"date_confirmed field, this is found on types (mortgage)","type":"string"},"date_exchanged":{"example":"(date_exchanged)","description":"date_exchanged field, this is found on types (mortgage)","type":"string"},"date_submitted":{"example":"(date_submitted)","description":"date_submitted field, this is found on types (mortgage)","type":"string"},"mortgage_completed":{"example":"(mortgage_completed)","description":"mortgage_completed field, this is found on types (mortgage)","type":"string"},"offer_confirmed":{"example":"(offer_confirmed)","description":"offer_confirmed field, this is found on types (mortgage)","type":"string"},"offer_confirmed_date":{"example":"(offer_confirmed_date)","description":"offer_confirmed_date field, this is found on types (mortgage)","type":"string"},"offer_date":{"example":"(offer_date)","description":"offer_date field, this is found on types (mortgage)","type":"string"},"offer_issued":{"example":"(offer_issued)","description":"offer_issued field, this is found on types (mortgage)","type":"string"},"on_risk":{"example":"(on_risk)","description":"on_risk field, this is found on types (mortgage)","type":"string"},"proposal_date":{"example":"(proposal_date)","description":"proposal_date field, this is found on types (mortgage)","type":"string"},"submitted":{"example":"(submitted)","description":"submitted field, this is found on types (mortgage)","type":"string"},"declined_notes":{"example":"(declined_notes)","description":"declined_notes field, this is found on types (mortgage)","type":"string"},"accrual_rate":{"example":"(accrual_rate)","description":"accrual_rate field, this is found on types (pension)","type":"string"},"year_accrued":{"example":"(year_accrued)","description":"year_accrued field, this is found on types (pension)","type":"string"},"retirement_date":{"example":"(retirement_date)","description":"retirement_date field, this is found on types (pension)","type":"string"},"pensionable_salary":{"example":"(pensionable_salary)","description":"pensionable_salary field, this is found on types (pension)","type":"string"},"transfer_value":{"example":"(transfer_value)","description":"transfer_value field, this is found on types (pension)","type":"string"},"date_of_transfer_valuation":{"example":"(date_of_transfer_valuation)","description":"date_of_transfer_valuation field, this is found on types (pension)","type":"string"},"widows_percentage":{"example":"(widows_percentage)","description":"widows_percentage field, this is found on types (pension)","type":"string"},"contracted_out":{"example":"(contracted_out)","description":"contracted_out field, this is found on types (pension)","type":"string"},"had_avc":{"example":"(had_avc)","description":"had_avc field, this is found on types (pension)","type":"string"},"in_house_avc_amount":{"example":"(in_house_avc_amount)","description":"in_house_avc_amount field, this is found on types (pension)","type":"string"},"in_house_avc_percentage":{"example":"(in_house_avc_percentage)","description":"in_house_avc_percentage field, this is found on types (pension)","type":"string"},"death_benefit_amount":{"example":"(death_benefit_amount)","description":"death_benefit_amount field, this is found on types (pension)","type":"string"},"projected_income":{"example":"(projected_income)","description":"projected_income field, this is found on types (pension)","type":"string"},"plan_retirement_age":{"example":"(plan_retirement_age)","description":"plan_retirement_age field, this is found on types (pension)","type":"string"},"state_retirement_age":{"example":"(state_retirement_age)","description":"state_retirement_age field, this is found on types (pension)","type":"string"},"salary_sacrifice":{"example":"(salary_sacrifice)","description":"salary_sacrifice field, this is found on types (pension)","type":"string"},"waiver":{"example":"(waiver)","description":"waiver field, this is found on types (pension)","type":"string"},"is_crystallised":{"example":"(is_crystallised)","description":"is_crystallised field, this is found on types (pension)","type":"string"},"crystallisation_amount":{"example":"(crystallisation_amount)","description":"crystallisation_amount field, this is found on types (pension)","type":"string"},"crystallisation_benefit":{"example":"(crystallisation_benefit)","description":"crystallisation_benefit field, this is found on types (pension)","type":"string"},"crystallisation_fund":{"example":"(crystallisation_fund)","description":"crystallisation_fund field, this is found on types (pension)","type":"string"},"crystallisation_start_date":{"example":"(crystallisation_start_date)","description":"crystallisation_start_date field, this is found on types (pension)","type":"string"},"crystallisation_end_date":{"example":"(crystallisation_end_date)","description":"crystallisation_end_date field, this is found on types (pension)","type":"string"},"crystallisation_frequency":{"example":"(crystallisation_frequency)","description":"crystallisation_frequency field, this is found on types (pension)","type":"string"},"fund_amount":{"example":"(fund_amount)","description":"fund_amount field, this is found on types (pension)","type":"string"},"uncrystallised_fund":{"example":"(uncrystallised_fund)","description":"uncrystallised_fund field, this is found on types (pension)","type":"string"},"income_taken_amount":{"example":"(income_taken_amount)","description":"income_taken_amount field, this is found on types (pension)","type":"string"},"maximum_income_amount":{"example":"(maximum_income_amount)","description":"maximum_income_amount field, this is found on types (pension)","type":"string"},"tax_free_amount":{"example":"(tax_free_amount)","description":"tax_free_amount field, this is found on types (pension)","type":"string"},"lifetime_allowance_percentage":{"example":"(lifetime_allowance_percentage)","description":"lifetime_allowance_percentage field, this is found on types (pension)","type":"string"},"lta_applied":{"example":"(lta_applied)","description":"lta_applied field, this is found on types (pension)","type":"string"},"mpaa_trigger":{"example":"(mpaa_trigger)","description":"mpaa_trigger field, this is found on types (pension)","type":"string"},"pcls_percentage":{"example":"(pcls_percentage)","description":"pcls_percentage field, this is found on types (pension)","type":"string"},"reason":{"example":"(reason)","description":"reason field, this is found on types (pension)","type":"string"},"has_pre_existing_conditions":{"example":"(has_pre_existing_conditions)","description":"has_pre_existing_conditions field, this is found on types (protection_policy)","type":"string"},"pre_existing_conditions_notes":{"example":"(pre_existing_conditions_notes)","description":"pre_existing_conditions_notes field, this is found on types (protection_policy)","type":"string"}}},"App_Http_Requests_Plans_StoreSubAccountRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Johns ISA","description":"Descriptive name of the sub account"},"policy_number":{"type":"string","example":"AVF-4355432","description":"Sub account policy number"},"proposal_reference":{"type":"string","example":"BtMWiy0JwHtogU4","description":"Sub account proposal number"}}},"App_Http_Requests_Plans_UpdateSubAccountRequest":{"type":"object","properties":{"name":{"type":"string","example":"Johns ISA","description":"Descriptive name of the sub account"},"policy_number":{"type":"string","example":"AVF-4355432","description":"Sub account policy number"},"proposal_reference":{"type":"string","example":"BtMWiy0JwHtogU4","description":"Sub account proposal number"},"active_portfolio_uuid":{"type":"string","example":"1d18f6e1-a349-468c-b539-359cee343039","description":"The active portfolio UUID of the sub-account.","format":"uuid"}}},"App_Http_Requests_Transaction_StoreTransactionRequest":{"type":"object","properties":{"sub_account_uuid":{"type":"string","example":"6dfebca0-d393-4d44-b5f9-ce9b7e9131ea","description":"Sub account to add the transaction to, if not provided if will go to the plan's main account","format":"uuid"},"holding_uuid":{"type":"string","example":"bb7e48a4-c2d2-4ebf-b694-03efc78d73f9","description":"Holding to add the transaction to.  Holding must exist for the main account, or to the sub account if sub_account_uuid is provided","format":"uuid"},"type":{"type":"string","example":"adjustment","description":"|\n\nTransaction type.\n\n| Value | Description |\n| ----- | ----------- |\n|adjustment|Adjustment|\n|adviser_fee|Adviser Fee|\n|contribution|Contribution|\n|corporate_action|Corporate Action|\n|distribution|Distribution|\n|fee|Fee|\n|income|Income|\n|payment|Payment|\n|provider_fee|Provider Fee|\n|rebate|Rebate|\n|trade|Trade|\n|transfer|Transfer|\n|withdrawal|Withdrawal|\n|other|Other|","enum":["adjustment","adviser_fee","contribution","corporate_action","distribution","fee","income","payment","provider_fee","rebate","trade","transfer","withdrawal","other"]},"sub_type":{"type":"string","example":"advice_fee_adjustments","description":"|\n\nTransaction sub type\n\n| Value | Description |\n| ----- | ----------- |\n|advice_fee_adjustments|Advice Fee Adjustments|\n|advice_fee_refunds|Advice Fee Refunds|\n|advice_fees_ad_hoc|Advice Fees Ad Hoc|\n|advice_fees_annual|Advice Fees Annual|\n|advice_fees_initial|Advice Fees Initial|\n|discretionary_fund_manager_fees|Discretionary Fund Manager Fees|\n|nucleus_fee_rebates|Nucleus Fee Rebates|\n|nucleus_fees|Nucleus Fees|\n|product_fees|Product Fees|\n|provider_fee_rebates|Provider Fee Rebates|\n|provider_fees|Provider Fees|\n|bed_and_isa_transfers|Bed And Isa Transfers|\n|cash_transfers_in|Cash Transfers In|\n|cash_transfers_out|Cash Transfers Out|\n|inter_account_transfers_in|Inter Account Transfers In|\n|inter_account_transfers_out|Inter Account Transfers Out|\n|reregistrations_in|Reregistrations In|\n|reregistrations_out|Reregistrations Out|\n|acquisitions|Acquisitions|\n|asset_closures|Asset Closures|\n|bonus_issues|Bonus Issues|\n|capital_reorganisations|Capital Reorganisations|\n|capital_returns|Capital Returns|\n|closed_offers|Closed Offers|\n|compulsory_call_payments|Compulsory Call Payments|\n|consolidations|Consolidations|\n|de_mergers|De Mergers|\n|early_withdrawals|Early Withdrawals|\n|fund_mergers|Fund Mergers|\n|liquidations|Liquidations|\n|mergers|Mergers|\n|open_offers|Open Offers|\n|optional_call_conversions|Optional Call Conversions|\n|optional_call_payments|Optional Call Payments|\n|optional_conversions|Optional Conversions|\n|optional_redemptions|Optional Redemptions|\n|rights_issues|Rights Issues|\n|scheme_of_arrangements|Scheme Of Arrangements|\n|scrip_dividends|Scrip Dividends|\n|share_offers|Share Offers|\n|stock_splits|Stock Splits|\n|subdivisions|Subdivisions|\n|subscription_offers|Subscription Offers|\n|subscriptions|Subscriptions|\n|take_overs|Take Overs|\n|tender_offers|Tender Offers|\n|credit_adjustments|Credit Adjustments|\n|debit_adjustments|Debit Adjustments|\n|early_redemption|Early Redemption|\n|external_value|External Value|\n|insurance_premium_adjustments|Insurance Premium Adjustments|\n|interest_adjustments|Interest Adjustments|\n|share_capital_reductions|Share Capital Reductions|\n|surcharge_adjustments|Surcharge Adjustments|\n|trade_correction|Trade Correction|\n|lump_sum|Lump Sum|\n|regular|Regular|\n|reinvestment_of_income|Reinvestment Of Income|\n|transfer_in|Transfer In|\n|amc_cash_rebates|Amc Cash Rebates|\n|amc_unit_rebates|Amc Unit Rebates|\n|tax_rebates|Tax Rebates|\n|asset_conversions|Asset Conversions|\n|auto_disinvestments|Auto Disinvestments|\n|buys|Buys|\n|rebalances|Rebalances|\n|sells|Sells|\n|switches|Switches|\n|dividend|Dividend|\n|dividend_tax|Dividend Tax|\n|interest|Interest|\n|bed_and_isa_payments|Bed And Isa Payments|\n|corrections|Corrections|\n|lump_sum_payments|Lump Sum Payments|\n|pension_tax_relief|Pension Tax Relief|\n|regular_employer_payments|Regular Employer Payments|\n|regular_payments|Regular Payments|\n|bond_assignments|Bond Assignments|\n|lump_sum_withdrawals|Lump Sum Withdrawals|\n|natural_income|Natural Income|\n|regular_withdrawals|Regular Withdrawals|\n|income_distributions|Income Distributions|\n|interest_distributions|Interest Distributions|\n|other|Other|","enum":["advice_fee_adjustments","advice_fee_refunds","advice_fees_ad_hoc","advice_fees_annual","advice_fees_initial","discretionary_fund_manager_fees","nucleus_fee_rebates","nucleus_fees","product_fees","provider_fee_rebates","provider_fees","bed_and_isa_transfers","cash_transfers_in","cash_transfers_out","inter_account_transfers_in","inter_account_transfers_out","reregistrations_in","reregistrations_out","acquisitions","asset_closures","bonus_issues","capital_reorganisations","capital_returns","closed_offers","compulsory_call_payments","consolidations","de_mergers","early_withdrawals","fund_mergers","liquidations","mergers","open_offers","optional_call_conversions","optional_call_payments","optional_conversions","optional_redemptions","rights_issues","scheme_of_arrangements","scrip_dividends","share_offers","stock_splits","subdivisions","subscription_offers","subscriptions","take_overs","tender_offers","credit_adjustments","debit_adjustments","early_redemption","external_value","insurance_premium_adjustments","interest_adjustments","share_capital_reductions","surcharge_adjustments","trade_correction","lump_sum","regular","reinvestment_of_income","transfer_in","amc_cash_rebates","amc_unit_rebates","tax_rebates","asset_conversions","auto_disinvestments","buys","rebalances","sells","switches","dividend","dividend_tax","interest","bed_and_isa_payments","corrections","lump_sum_payments","pension_tax_relief","regular_employer_payments","regular_payments","bond_assignments","lump_sum_withdrawals","natural_income","regular_withdrawals","income_distributions","interest_distributions","other"]},"amount":{"type":"integer","example":1099,"description":"Transaction amount in pennies"},"date":{"type":"string","example":"2026-05-08","description":"Transaction date","format":"date"},"notes":{"type":"string","example":"Notes about the transaction","description":"Transaction note","maxLength":1000,"nullable":true}}},"App_Http_Requests_Transaction_UpdateTransactionRequest":{"type":"object","properties":{"type":{"type":"string","example":"adjustment","description":"|\n\nTransaction type.\n\n| Value | Description |\n| ----- | ----------- |\n|adjustment|Adjustment|\n|adviser_fee|Adviser Fee|\n|contribution|Contribution|\n|corporate_action|Corporate Action|\n|distribution|Distribution|\n|fee|Fee|\n|income|Income|\n|payment|Payment|\n|provider_fee|Provider Fee|\n|rebate|Rebate|\n|trade|Trade|\n|transfer|Transfer|\n|withdrawal|Withdrawal|\n|other|Other|","enum":["adjustment","adviser_fee","contribution","corporate_action","distribution","fee","income","payment","provider_fee","rebate","trade","transfer","withdrawal","other"]},"sub_type":{"type":"string","example":"advice_fee_adjustments","description":"|\n\nTransaction sub type\n\n| Value | Description |\n| ----- | ----------- |\n|advice_fee_adjustments|Advice Fee Adjustments|\n|advice_fee_refunds|Advice Fee Refunds|\n|advice_fees_ad_hoc|Advice Fees Ad Hoc|\n|advice_fees_annual|Advice Fees Annual|\n|advice_fees_initial|Advice Fees Initial|\n|discretionary_fund_manager_fees|Discretionary Fund Manager Fees|\n|nucleus_fee_rebates|Nucleus Fee Rebates|\n|nucleus_fees|Nucleus Fees|\n|product_fees|Product Fees|\n|provider_fee_rebates|Provider Fee Rebates|\n|provider_fees|Provider Fees|\n|bed_and_isa_transfers|Bed And Isa Transfers|\n|cash_transfers_in|Cash Transfers In|\n|cash_transfers_out|Cash Transfers Out|\n|inter_account_transfers_in|Inter Account Transfers In|\n|inter_account_transfers_out|Inter Account Transfers Out|\n|reregistrations_in|Reregistrations In|\n|reregistrations_out|Reregistrations Out|\n|acquisitions|Acquisitions|\n|asset_closures|Asset Closures|\n|bonus_issues|Bonus Issues|\n|capital_reorganisations|Capital Reorganisations|\n|capital_returns|Capital Returns|\n|closed_offers|Closed Offers|\n|compulsory_call_payments|Compulsory Call Payments|\n|consolidations|Consolidations|\n|de_mergers|De Mergers|\n|early_withdrawals|Early Withdrawals|\n|fund_mergers|Fund Mergers|\n|liquidations|Liquidations|\n|mergers|Mergers|\n|open_offers|Open Offers|\n|optional_call_conversions|Optional Call Conversions|\n|optional_call_payments|Optional Call Payments|\n|optional_conversions|Optional Conversions|\n|optional_redemptions|Optional Redemptions|\n|rights_issues|Rights Issues|\n|scheme_of_arrangements|Scheme Of Arrangements|\n|scrip_dividends|Scrip Dividends|\n|share_offers|Share Offers|\n|stock_splits|Stock Splits|\n|subdivisions|Subdivisions|\n|subscription_offers|Subscription Offers|\n|subscriptions|Subscriptions|\n|take_overs|Take Overs|\n|tender_offers|Tender Offers|\n|credit_adjustments|Credit Adjustments|\n|debit_adjustments|Debit Adjustments|\n|early_redemption|Early Redemption|\n|external_value|External Value|\n|insurance_premium_adjustments|Insurance Premium Adjustments|\n|interest_adjustments|Interest Adjustments|\n|share_capital_reductions|Share Capital Reductions|\n|surcharge_adjustments|Surcharge Adjustments|\n|trade_correction|Trade Correction|\n|lump_sum|Lump Sum|\n|regular|Regular|\n|reinvestment_of_income|Reinvestment Of Income|\n|transfer_in|Transfer In|\n|amc_cash_rebates|Amc Cash Rebates|\n|amc_unit_rebates|Amc Unit Rebates|\n|tax_rebates|Tax Rebates|\n|asset_conversions|Asset Conversions|\n|auto_disinvestments|Auto Disinvestments|\n|buys|Buys|\n|rebalances|Rebalances|\n|sells|Sells|\n|switches|Switches|\n|dividend|Dividend|\n|dividend_tax|Dividend Tax|\n|interest|Interest|\n|bed_and_isa_payments|Bed And Isa Payments|\n|corrections|Corrections|\n|lump_sum_payments|Lump Sum Payments|\n|pension_tax_relief|Pension Tax Relief|\n|regular_employer_payments|Regular Employer Payments|\n|regular_payments|Regular Payments|\n|bond_assignments|Bond Assignments|\n|lump_sum_withdrawals|Lump Sum Withdrawals|\n|natural_income|Natural Income|\n|regular_withdrawals|Regular Withdrawals|\n|income_distributions|Income Distributions|\n|interest_distributions|Interest Distributions|\n|other|Other|","enum":["advice_fee_adjustments","advice_fee_refunds","advice_fees_ad_hoc","advice_fees_annual","advice_fees_initial","discretionary_fund_manager_fees","nucleus_fee_rebates","nucleus_fees","product_fees","provider_fee_rebates","provider_fees","bed_and_isa_transfers","cash_transfers_in","cash_transfers_out","inter_account_transfers_in","inter_account_transfers_out","reregistrations_in","reregistrations_out","acquisitions","asset_closures","bonus_issues","capital_reorganisations","capital_returns","closed_offers","compulsory_call_payments","consolidations","de_mergers","early_withdrawals","fund_mergers","liquidations","mergers","open_offers","optional_call_conversions","optional_call_payments","optional_conversions","optional_redemptions","rights_issues","scheme_of_arrangements","scrip_dividends","share_offers","stock_splits","subdivisions","subscription_offers","subscriptions","take_overs","tender_offers","credit_adjustments","debit_adjustments","early_redemption","external_value","insurance_premium_adjustments","interest_adjustments","share_capital_reductions","surcharge_adjustments","trade_correction","lump_sum","regular","reinvestment_of_income","transfer_in","amc_cash_rebates","amc_unit_rebates","tax_rebates","asset_conversions","auto_disinvestments","buys","rebalances","sells","switches","dividend","dividend_tax","interest","bed_and_isa_payments","corrections","lump_sum_payments","pension_tax_relief","regular_employer_payments","regular_payments","bond_assignments","lump_sum_withdrawals","natural_income","regular_withdrawals","income_distributions","interest_distributions","other"]},"amount":{"type":"integer","example":1099,"description":"Transaction amount in pennies"},"date":{"type":"string","example":"2026-05-08","description":"Transaction date","format":"date"},"notes":{"type":"string","example":"Notes about the transaction","description":"Transaction note","maxLength":1000,"nullable":true}}},"App_Http_Requests_Transaction_StoreTransactionScheduleRequest":{"type":"object","required":["type","amount","frequency","start_date"],"properties":{"sub_account_uuid":{"type":"string","example":"dc3eb6c9-325e-4b7d-934c-95c0e4d90a59","description":"Sub account to add the transaction to, if not provided if will go to the plan's main account","format":"uuid"},"holding_uuid":{"type":"string","example":"075364e1-2170-43f6-b5d3-b0ce54d03eda","description":"Holding to add the transaction to.  Holding must exist for the main account, or to the sub account if sub_account_uuid is provided","format":"uuid"},"type":{"type":"string","example":"adjustment","description":"|\n\nTransaction type.  Valid types are: adjustment, adviser_fee, contribution, corporate_action, distribution, fee, income, payment, provider_fee, rebate, trade, transfer, withdrawal and other\n\n| Value | Description |\n| ----- | ----------- |\n|adjustment|Adjustment|\n|adviser_fee|Adviser Fee|\n|contribution|Contribution|\n|corporate_action|Corporate Action|\n|distribution|Distribution|\n|fee|Fee|\n|income|Income|\n|payment|Payment|\n|provider_fee|Provider Fee|\n|rebate|Rebate|\n|trade|Trade|\n|transfer|Transfer|\n|withdrawal|Withdrawal|\n|other|Other|","enum":["adjustment","adviser_fee","contribution","corporate_action","distribution","fee","income","payment","provider_fee","rebate","trade","transfer","withdrawal","other"]},"sub_type":{"type":"string","example":"advice_fee_adjustments","description":"|\n\nTransaction sub type. Valid types are: advice_fee_adjustments, advice_fee_refunds, advice_fees_ad_hoc, advice_fees_annual, advice_fees_initial, discretionary_fund_manager_fees, nucleus_fee_rebates, nucleus_fees, product_fees, provider_fee_rebates, provider_fees, bed_and_isa_transfers, cash_transfers_in, cash_transfers_out, inter_account_transfers_in, inter_account_transfers_out, reregistrations_in, reregistrations_out, acquisitions, asset_closures, bonus_issues, capital_reorganisations, capital_returns, closed_offers, compulsory_call_payments, consolidations, de_mergers, early_withdrawals, fund_mergers, liquidations, mergers, open_offers, optional_call_conversions, optional_call_payments, optional_conversions, optional_redemptions, rights_issues, scheme_of_arrangements, scrip_dividends, share_offers, stock_splits, subdivisions, subscription_offers, subscriptions, take_overs, tender_offers, credit_adjustments, debit_adjustments, early_redemption, external_value, insurance_premium_adjustments, interest_adjustments, share_capital_reductions, surcharge_adjustments, trade_correction, lump_sum, regular, reinvestment_of_income, transfer_in, amc_cash_rebates, amc_unit_rebates, tax_rebates, asset_conversions, auto_disinvestments, buys, rebalances, sells, switches, dividend, dividend_tax, interest, bed_and_isa_payments, corrections, lump_sum_payments, pension_tax_relief, regular_employer_payments, regular_payments, bond_assignments, lump_sum_withdrawals, natural_income, regular_withdrawals, income_distributions, interest_distributions and other\n\n| Value | Description |\n| ----- | ----------- |\n|advice_fee_adjustments|Advice Fee Adjustments|\n|advice_fee_refunds|Advice Fee Refunds|\n|advice_fees_ad_hoc|Advice Fees Ad Hoc|\n|advice_fees_annual|Advice Fees Annual|\n|advice_fees_initial|Advice Fees Initial|\n|discretionary_fund_manager_fees|Discretionary Fund Manager Fees|\n|nucleus_fee_rebates|Nucleus Fee Rebates|\n|nucleus_fees|Nucleus Fees|\n|product_fees|Product Fees|\n|provider_fee_rebates|Provider Fee Rebates|\n|provider_fees|Provider Fees|\n|bed_and_isa_transfers|Bed And Isa Transfers|\n|cash_transfers_in|Cash Transfers In|\n|cash_transfers_out|Cash Transfers Out|\n|inter_account_transfers_in|Inter Account Transfers In|\n|inter_account_transfers_out|Inter Account Transfers Out|\n|reregistrations_in|Reregistrations In|\n|reregistrations_out|Reregistrations Out|\n|acquisitions|Acquisitions|\n|asset_closures|Asset Closures|\n|bonus_issues|Bonus Issues|\n|capital_reorganisations|Capital Reorganisations|\n|capital_returns|Capital Returns|\n|closed_offers|Closed Offers|\n|compulsory_call_payments|Compulsory Call Payments|\n|consolidations|Consolidations|\n|de_mergers|De Mergers|\n|early_withdrawals|Early Withdrawals|\n|fund_mergers|Fund Mergers|\n|liquidations|Liquidations|\n|mergers|Mergers|\n|open_offers|Open Offers|\n|optional_call_conversions|Optional Call Conversions|\n|optional_call_payments|Optional Call Payments|\n|optional_conversions|Optional Conversions|\n|optional_redemptions|Optional Redemptions|\n|rights_issues|Rights Issues|\n|scheme_of_arrangements|Scheme Of Arrangements|\n|scrip_dividends|Scrip Dividends|\n|share_offers|Share Offers|\n|stock_splits|Stock Splits|\n|subdivisions|Subdivisions|\n|subscription_offers|Subscription Offers|\n|subscriptions|Subscriptions|\n|take_overs|Take Overs|\n|tender_offers|Tender Offers|\n|credit_adjustments|Credit Adjustments|\n|debit_adjustments|Debit Adjustments|\n|early_redemption|Early Redemption|\n|external_value|External Value|\n|insurance_premium_adjustments|Insurance Premium Adjustments|\n|interest_adjustments|Interest Adjustments|\n|share_capital_reductions|Share Capital Reductions|\n|surcharge_adjustments|Surcharge Adjustments|\n|trade_correction|Trade Correction|\n|lump_sum|Lump Sum|\n|regular|Regular|\n|reinvestment_of_income|Reinvestment Of Income|\n|transfer_in|Transfer In|\n|amc_cash_rebates|Amc Cash Rebates|\n|amc_unit_rebates|Amc Unit Rebates|\n|tax_rebates|Tax Rebates|\n|asset_conversions|Asset Conversions|\n|auto_disinvestments|Auto Disinvestments|\n|buys|Buys|\n|rebalances|Rebalances|\n|sells|Sells|\n|switches|Switches|\n|dividend|Dividend|\n|dividend_tax|Dividend Tax|\n|interest|Interest|\n|bed_and_isa_payments|Bed And Isa Payments|\n|corrections|Corrections|\n|lump_sum_payments|Lump Sum Payments|\n|pension_tax_relief|Pension Tax Relief|\n|regular_employer_payments|Regular Employer Payments|\n|regular_payments|Regular Payments|\n|bond_assignments|Bond Assignments|\n|lump_sum_withdrawals|Lump Sum Withdrawals|\n|natural_income|Natural Income|\n|regular_withdrawals|Regular Withdrawals|\n|income_distributions|Income Distributions|\n|interest_distributions|Interest Distributions|\n|other|Other|","enum":["advice_fee_adjustments","advice_fee_refunds","advice_fees_ad_hoc","advice_fees_annual","advice_fees_initial","discretionary_fund_manager_fees","nucleus_fee_rebates","nucleus_fees","product_fees","provider_fee_rebates","provider_fees","bed_and_isa_transfers","cash_transfers_in","cash_transfers_out","inter_account_transfers_in","inter_account_transfers_out","reregistrations_in","reregistrations_out","acquisitions","asset_closures","bonus_issues","capital_reorganisations","capital_returns","closed_offers","compulsory_call_payments","consolidations","de_mergers","early_withdrawals","fund_mergers","liquidations","mergers","open_offers","optional_call_conversions","optional_call_payments","optional_conversions","optional_redemptions","rights_issues","scheme_of_arrangements","scrip_dividends","share_offers","stock_splits","subdivisions","subscription_offers","subscriptions","take_overs","tender_offers","credit_adjustments","debit_adjustments","early_redemption","external_value","insurance_premium_adjustments","interest_adjustments","share_capital_reductions","surcharge_adjustments","trade_correction","lump_sum","regular","reinvestment_of_income","transfer_in","amc_cash_rebates","amc_unit_rebates","tax_rebates","asset_conversions","auto_disinvestments","buys","rebalances","sells","switches","dividend","dividend_tax","interest","bed_and_isa_payments","corrections","lump_sum_payments","pension_tax_relief","regular_employer_payments","regular_payments","bond_assignments","lump_sum_withdrawals","natural_income","regular_withdrawals","income_distributions","interest_distributions","other"]},"amount":{"type":"integer","example":1099,"description":"Transaction amount in pennies"},"frequency":{"type":"string","example":"daily","description":"|\n\nHow often to automatically create transactions\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually"]},"start_date":{"type":"string","example":"2026-05-08","description":"Automatically create transactions from this date","format":"date"},"end_date":{"type":"string","example":"2029-02-01","description":"Stop automatically creating transactions after this date. Leave as null for indefinitely.","format":"date"},"provider_controlled":{"type":"boolean","example":false,"description":"Boolean to denote whether the provider feeds (if available) are responsible for creating the recurring transactions. If false then Plannr will create these recurring transactions using this transaction schedule"},"backdate_transactions":{"type":"boolean","example":true,"description":"When true this will create the transactions from the given start date"}}},"App_Http_Requests_Transaction_UpdateTransactionScheduleRequest":{"type":"object","properties":{"type":{"type":"string","example":"adjustment","description":"|\n\nTransaction type.  Valid types are: adjustment, adviser_fee, contribution, corporate_action, distribution, fee, income, payment, provider_fee, rebate, trade, transfer, withdrawal and other\n\n| Value | Description |\n| ----- | ----------- |\n|adjustment|Adjustment|\n|adviser_fee|Adviser Fee|\n|contribution|Contribution|\n|corporate_action|Corporate Action|\n|distribution|Distribution|\n|fee|Fee|\n|income|Income|\n|payment|Payment|\n|provider_fee|Provider Fee|\n|rebate|Rebate|\n|trade|Trade|\n|transfer|Transfer|\n|withdrawal|Withdrawal|\n|other|Other|","enum":["adjustment","adviser_fee","contribution","corporate_action","distribution","fee","income","payment","provider_fee","rebate","trade","transfer","withdrawal","other"]},"sub_type":{"type":"string","example":"advice_fee_adjustments","description":"|\n\nTransaction sub type. Valid types are: advice_fee_adjustments, advice_fee_refunds, advice_fees_ad_hoc, advice_fees_annual, advice_fees_initial, discretionary_fund_manager_fees, nucleus_fee_rebates, nucleus_fees, product_fees, provider_fee_rebates, provider_fees, bed_and_isa_transfers, cash_transfers_in, cash_transfers_out, inter_account_transfers_in, inter_account_transfers_out, reregistrations_in, reregistrations_out, acquisitions, asset_closures, bonus_issues, capital_reorganisations, capital_returns, closed_offers, compulsory_call_payments, consolidations, de_mergers, early_withdrawals, fund_mergers, liquidations, mergers, open_offers, optional_call_conversions, optional_call_payments, optional_conversions, optional_redemptions, rights_issues, scheme_of_arrangements, scrip_dividends, share_offers, stock_splits, subdivisions, subscription_offers, subscriptions, take_overs, tender_offers, credit_adjustments, debit_adjustments, early_redemption, external_value, insurance_premium_adjustments, interest_adjustments, share_capital_reductions, surcharge_adjustments, trade_correction, lump_sum, regular, reinvestment_of_income, transfer_in, amc_cash_rebates, amc_unit_rebates, tax_rebates, asset_conversions, auto_disinvestments, buys, rebalances, sells, switches, dividend, dividend_tax, interest, bed_and_isa_payments, corrections, lump_sum_payments, pension_tax_relief, regular_employer_payments, regular_payments, bond_assignments, lump_sum_withdrawals, natural_income, regular_withdrawals, income_distributions, interest_distributions and other\n\n| Value | Description |\n| ----- | ----------- |\n|advice_fee_adjustments|Advice Fee Adjustments|\n|advice_fee_refunds|Advice Fee Refunds|\n|advice_fees_ad_hoc|Advice Fees Ad Hoc|\n|advice_fees_annual|Advice Fees Annual|\n|advice_fees_initial|Advice Fees Initial|\n|discretionary_fund_manager_fees|Discretionary Fund Manager Fees|\n|nucleus_fee_rebates|Nucleus Fee Rebates|\n|nucleus_fees|Nucleus Fees|\n|product_fees|Product Fees|\n|provider_fee_rebates|Provider Fee Rebates|\n|provider_fees|Provider Fees|\n|bed_and_isa_transfers|Bed And Isa Transfers|\n|cash_transfers_in|Cash Transfers In|\n|cash_transfers_out|Cash Transfers Out|\n|inter_account_transfers_in|Inter Account Transfers In|\n|inter_account_transfers_out|Inter Account Transfers Out|\n|reregistrations_in|Reregistrations In|\n|reregistrations_out|Reregistrations Out|\n|acquisitions|Acquisitions|\n|asset_closures|Asset Closures|\n|bonus_issues|Bonus Issues|\n|capital_reorganisations|Capital Reorganisations|\n|capital_returns|Capital Returns|\n|closed_offers|Closed Offers|\n|compulsory_call_payments|Compulsory Call Payments|\n|consolidations|Consolidations|\n|de_mergers|De Mergers|\n|early_withdrawals|Early Withdrawals|\n|fund_mergers|Fund Mergers|\n|liquidations|Liquidations|\n|mergers|Mergers|\n|open_offers|Open Offers|\n|optional_call_conversions|Optional Call Conversions|\n|optional_call_payments|Optional Call Payments|\n|optional_conversions|Optional Conversions|\n|optional_redemptions|Optional Redemptions|\n|rights_issues|Rights Issues|\n|scheme_of_arrangements|Scheme Of Arrangements|\n|scrip_dividends|Scrip Dividends|\n|share_offers|Share Offers|\n|stock_splits|Stock Splits|\n|subdivisions|Subdivisions|\n|subscription_offers|Subscription Offers|\n|subscriptions|Subscriptions|\n|take_overs|Take Overs|\n|tender_offers|Tender Offers|\n|credit_adjustments|Credit Adjustments|\n|debit_adjustments|Debit Adjustments|\n|early_redemption|Early Redemption|\n|external_value|External Value|\n|insurance_premium_adjustments|Insurance Premium Adjustments|\n|interest_adjustments|Interest Adjustments|\n|share_capital_reductions|Share Capital Reductions|\n|surcharge_adjustments|Surcharge Adjustments|\n|trade_correction|Trade Correction|\n|lump_sum|Lump Sum|\n|regular|Regular|\n|reinvestment_of_income|Reinvestment Of Income|\n|transfer_in|Transfer In|\n|amc_cash_rebates|Amc Cash Rebates|\n|amc_unit_rebates|Amc Unit Rebates|\n|tax_rebates|Tax Rebates|\n|asset_conversions|Asset Conversions|\n|auto_disinvestments|Auto Disinvestments|\n|buys|Buys|\n|rebalances|Rebalances|\n|sells|Sells|\n|switches|Switches|\n|dividend|Dividend|\n|dividend_tax|Dividend Tax|\n|interest|Interest|\n|bed_and_isa_payments|Bed And Isa Payments|\n|corrections|Corrections|\n|lump_sum_payments|Lump Sum Payments|\n|pension_tax_relief|Pension Tax Relief|\n|regular_employer_payments|Regular Employer Payments|\n|regular_payments|Regular Payments|\n|bond_assignments|Bond Assignments|\n|lump_sum_withdrawals|Lump Sum Withdrawals|\n|natural_income|Natural Income|\n|regular_withdrawals|Regular Withdrawals|\n|income_distributions|Income Distributions|\n|interest_distributions|Interest Distributions|\n|other|Other|","enum":["advice_fee_adjustments","advice_fee_refunds","advice_fees_ad_hoc","advice_fees_annual","advice_fees_initial","discretionary_fund_manager_fees","nucleus_fee_rebates","nucleus_fees","product_fees","provider_fee_rebates","provider_fees","bed_and_isa_transfers","cash_transfers_in","cash_transfers_out","inter_account_transfers_in","inter_account_transfers_out","reregistrations_in","reregistrations_out","acquisitions","asset_closures","bonus_issues","capital_reorganisations","capital_returns","closed_offers","compulsory_call_payments","consolidations","de_mergers","early_withdrawals","fund_mergers","liquidations","mergers","open_offers","optional_call_conversions","optional_call_payments","optional_conversions","optional_redemptions","rights_issues","scheme_of_arrangements","scrip_dividends","share_offers","stock_splits","subdivisions","subscription_offers","subscriptions","take_overs","tender_offers","credit_adjustments","debit_adjustments","early_redemption","external_value","insurance_premium_adjustments","interest_adjustments","share_capital_reductions","surcharge_adjustments","trade_correction","lump_sum","regular","reinvestment_of_income","transfer_in","amc_cash_rebates","amc_unit_rebates","tax_rebates","asset_conversions","auto_disinvestments","buys","rebalances","sells","switches","dividend","dividend_tax","interest","bed_and_isa_payments","corrections","lump_sum_payments","pension_tax_relief","regular_employer_payments","regular_payments","bond_assignments","lump_sum_withdrawals","natural_income","regular_withdrawals","income_distributions","interest_distributions","other"]},"amount":{"type":"integer","example":1099,"description":"Transaction amount in pennies"},"frequency":{"type":"string","example":"daily","description":"|\n\nHow often to automatically create transactions\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually"]},"start_date":{"type":"string","example":"2026-05-08","description":"Automatically create transactions from this date","format":"date"},"end_date":{"type":"string","example":"2029-02-01","description":"Stop automatically creating transactions after this date","format":"date"},"provider_controlled":{"type":"boolean","example":false,"description":"Boolean to denote whether the provider feeds (if available) are responsible for creating the recurring transactions. If false then Plannr will create these recurring transactions using this transaction schedule"},"paused_until":{"type":"string","example":"2027-01-08","description":"Pause creating transactions up until this date. To unpause set to null","format":"date"}}},"App_Http_Requests_Plans_StoreCoverRequest":{"type":"object","required":["cover_type","benefit_amount","benefit_frequency","benefit_status","indexation","excess"],"properties":{"client_uuid":{"type":"string","example":"3577d096-55f7-4900-82ad-9593f0ab3a02","description":"Client who is claiming this cover. Must be able to access this plan. Only for protection policies.","format":"uuid"},"cover_type":{"type":"string","example":"asu","description":"Cover type.","enum":["asu","additional_rider_benefit","critical_illness","family_income_benefit","income_insurance","life_assurance","tpd_total_permanent_disability","trauma_insurance","waiver_of_premium","unknown","3rd_party","3rd_party_fire_and_theft","accidental_damage","ambulance","buildings","buildings_and_contents","business","comprehensive","contents","dental","extras","hospital_cash","optical","personal_possessions","private","private_hospital","specialist"]},"benefit_amount":{"type":"integer","example":892176,"description":"Benefit amount in pennies. Only for protection policies."},"benefit_frequency":{"type":"string","example":"daily","description":"|\n\nBenefit frequency. Only for protection policies.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"benefit_status":{"type":"string","example":"active","description":"|\n\nBenefit status. Only for protection policies.\n\n| Value | Description |\n| ----- | ----------- |\n|active|Active|\n|inactive|Inactive|\n|proposed|Proposed|","enum":["active","inactive","proposed"]},"indexation":{"type":"number","example":1.45,"description":"Indexation. Only for protection policies.","format":"float"},"excess":{"type":"integer","example":150000,"description":"Excess amount in pennies. Only for insurance policies."},"beneficiaries":{"type":"array","example":[],"description":"The beneficiaries of the plan.","items":{"type":"object","example":[{"name":"John Smith","percentage":50},{"name":"Jane Doe","percentage":20}],"properties":{"name":{"type":"string","example":"John Smith","description":"The name of the beneficiary."},"percentage":{"type":"number","example":50.0,"description":"The percentage allocated to the beneficiary.","format":"float","minimum":0.0,"maximum":100.0}}}}}},"App_Http_Requests_Plans_UpdateCoverRequest":{"type":"object","properties":{"cover_type":{"type":"string","example":"3rd_party","description":"|\n\nCover type.\n\n| Value | Description |\n| ----- | ----------- |\n|3rd_party|3rd Party|\n|3rd_party_fire_and_theft|3rd Party Fire And Theft|\n|accidental_damage|Accidental Damage|\n|additional_rider_benefit|Additional Rider Benefit|\n|ambulance|Ambulance|\n|asu|ASU|\n|buildings|Buildings|\n|buildings_and_contents|Buildings And Contents|\n|business|Business|\n|comprehensive|Comprehensive|\n|contents|Contents|\n|critical_illness|Critical Illness|\n|dental|Dental|\n|extras|Extras|\n|family_income_benefit|Family Income Benefit|\n|hospital_cash|Hospital Cash|\n|income_insurance|Income Insurance|\n|life_assurance|Life Assurance|\n|optical|Optical|\n|personal_possessions|Personal Possessions|\n|private|Private|\n|private_hospital|Private Hospital|\n|specialist|Specialist|\n|tpd_total_permanent_disability|TPD (Total Permanent Disability)|\n|trauma_insurance|Trauma Insurance|\n|waiver_of_premium|Waiver Of Premium|\n|unknown|Unknown|","enum":["3rd_party","3rd_party_fire_and_theft","accidental_damage","additional_rider_benefit","ambulance","asu","buildings","buildings_and_contents","business","comprehensive","contents","critical_illness","dental","extras","family_income_benefit","hospital_cash","income_insurance","life_assurance","optical","personal_possessions","private","private_hospital","specialist","tpd_total_permanent_disability","trauma_insurance","waiver_of_premium","unknown"]},"benefit_amount":{"type":"integer","example":892176,"description":"Benefit amount in pennies. Only for protection policies."},"benefit_status":{"type":"string","example":"active","description":"|\n\nBenefit status. Only for protection policies. Valid options are: active, inactive and proposed\n\n| Value | Description |\n| ----- | ----------- |\n|active|Active|\n|inactive|Inactive|\n|proposed|Proposed|","enum":["active","inactive","proposed"]},"indexation":{"type":"number","example":1.45,"description":"Indexation. Only for protection policies.","format":"float"},"excess":{"type":"integer","example":150000,"description":"Excess amount in pennies. Only for insurance policies."},"beneficiaries":{"type":"array","example":[],"description":"The beneficiaries of the plan. UUID is a required property to update an exising beneficiary. Any beneficiaries UUIDs not included will be deleted on the plan. Any beneficiaries without a UUID are assumed to be a new beneficiary and will be created.","items":{"type":"object","example":{"name":"John Smith","percentage":20.02,"uuid":"5dd734b0-b086-4f87-8023-476a898e5fdf"},"properties":{"name":{"type":"string","example":"John Smith","description":"The name of the beneficiary."},"percentage":{"type":"number","example":20.02,"description":"Percentage due to the beneficiary.","format":"float","minimum":0.0,"maximum":100.0},"uuid":{"type":"string","example":"5dd734b0-b086-4f87-8023-476a898e5fdf","description":"The UUID of the beneficiary - if not present a new beneficiary will be created.","format":"uuid"}}}}}},"App_Http_Requests_Plans_StoreClaimRequest":{"type":"object","required":["claim_amount","claim_start_date"],"properties":{"client_uuid":{"type":"string","example":"264a570b-4f69-441e-9e15-97f6acee149f","description":"Client who is claiming this cover. Must be able to access this plan.","format":"uuid"},"claim_amount":{"type":"integer","example":892176,"description":"Claim amount in pennies."},"claim_start_date":{"type":"string","example":"2024-05-08","description":"Claim start date","format":"date"},"claim_end_date":{"type":"string","example":"2031-05-08","description":"Claim end date","format":"date"},"claim_notes":{"type":"string","example":"Claim notes","description":"Claim notes","format":"date"}}},"App_Http_Requests_Plans_UpdateClaimRequest":{"type":"object","properties":{"claim_amount":{"type":"integer","example":892176,"description":"Claim amount in pennies."},"claim_start_date":{"type":"string","example":"2024-05-08","description":"Claim start date","format":"date"},"claim_end_date":{"type":"string","example":"2031-05-08","description":"Claim end date","format":"date","nullable":true},"claim_notes":{"type":"string","example":"Claim notes","description":"Claim notes","nullable":true}}},"App_Http_Requests_Plans_StoreBeneficiaryRequest":{"type":"object","required":["name","percentage"],"properties":{"name":{"type":"string","example":"John Smith","description":"Name of the beneficiary."},"percentage":{"type":"number","example":50.25,"description":"Percentage due to the beneficiary.","format":"float","minimum":0.0,"maximum":100.0}}},"App_Http_Requests_Plans_UpdateBeneficiaryRequest":{"type":"object","properties":{"name":{"type":"string","example":"John Smith","description":"Name of the beneficiary."},"percentage":{"type":"number","example":50.75,"description":"Percentage due to the beneficiary.","format":"float","minimum":0.0,"maximum":100.0}}},"App_Http_Requests_Plans_StorePremiumRequest":{"type":"object","required":["transfer_type","date_advice_given","amount","percentage","frequency","payment_method","start_date"],"properties":{"transfer_type":{"type":"string","example":"switch","description":"|\n\nTransfer type.\n\n| Value | Description |\n| ----- | ----------- |\n|switch|Switch|\n|transfer|Transfer|","enum":["switch","transfer"]},"date_advice_given":{"type":"string","example":"2025-11-15","description":"Date advice given","format":"date"},"amount":{"type":"integer","example":250000,"description":"Premium amount in pennies. Either amount or percentage can be given in request"},"percentage":{"type":"number","example":5.5,"description":"Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request","format":"float","minimum":0.0,"maximum":100.0},"frequency":{"type":"string","example":"daily","description":"|\n\nPremium frequency\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"source":{"type":"string","example":"employee","description":"|\n\nPremium source, only for pension plans.\n\n| Value | Description |\n| ----- | ----------- |\n|employee|Employee|\n|employer|Employer|","enum":["employee","employer"]},"payment_method":{"type":"string","example":"salary_sacrifice","description":"|\n\nPayment method.\n\n| Value | Description |\n| ----- | ----------- |\n|salary_sacrifice|Salary Sacrifice|\n|salary_deduction|Salary Deduction|\n|direct_debit|Direct Debit|\n|standing_order|Standing Order|\n|cheque|Cheque|\n|bank_transfer|Bank Transfer|","enum":["salary_sacrifice","salary_deduction","direct_debit","standing_order","cheque","bank_transfer"]},"start_date":{"type":"string","example":"2026-03-24","description":"Start date","format":"date"},"end_date":{"type":"string","example":"2028-05-08","description":"End date. Leave blank for ongoing","format":"date"},"details":{"type":"string","example":"Any extra details about the premium","description":"Details"},"transferred_from_plan_uuid":{"type":"string","example":"7d3e3d8e-9a99-4bd7-965a-58315afb849d","description":"The plan UUID this premium was transferred from","format":"uuid"},"transferred_from_plan_type":{"type":"string","example":"annuity","description":"|\n\nThe plan type this premium was transferred from if the actual plan UUID is unknown\n\n| Value | Description |\n| ----- | ----------- |\n|annuity|Annuity|\n|cash_account|Cash Account|\n|fixed_asset|Fixed Asset|\n|general_insurance|General Insurance|\n|group_protection|Group Protection|\n|investment|Investment|\n|loan_credit|Loan Credit|\n|mortgage|Mortgage|\n|pension|Pension|\n|protection_policy|Protection Policy|","enum":["annuity","cash_account","fixed_asset","general_insurance","group_protection","investment","loan_credit","mortgage","pension","protection_policy"]},"transferred_from_plan_sub_type":{"type":"string","example":"cash_account","description":"|\n\nThe plan sub type this premium was transferred from if the actual plan UUID is unknown\n\n| Value | Description |\n| ----- | ----------- |\n|cash_account|Cash Account|\n|cash_deposit|Cash Deposit|\n|isa_mini_cash|ISA (Mini Cash)|\n|isa_tessa_only|ISA (TESSA Only)|\n|lifetime_isa_cash|Lifetime ISA (Cash)|\n|national_savings|National Savings|\n|national_savings_child_bonus_bond|National Savings (Child Bonus Bond)|\n|national_savings_fixed_interest_certificate|National Savings (Fixed Interest Certificate)|\n|national_savings_guaranteed_equity_bond|National Savings (Guaranteed Equity Bond)|\n|national_savings_income_bond|National Savings (Income Bond)|\n|national_savings_index_linked_certificate|National Savings (Index Linked Certificate)|\n|national_savings_national_savings_certificate|National Savings (National Savings Certificate)|\n|national_savings_premium_bonds|National Savings (Premium Bonds)|\n|cash_account_unknown|Unknown|\n|aim_investment_tax_service|AIM Investment Tax Service|\n|bes|BES|\n|business_premises_renovation_allowance|Business Premises Renovation Allowance|\n|child_trust_fund|Child Trust Fund|\n|collective_investment_account|Collective Investment Account|\n|commercial_property_purchase_scheme|Commercial Property Purchase Scheme|\n|debenture|Debenture|\n|discretionary_managed_service|Discretionary Managed Service|\n|employee_benefit_trust|Employee Benefit Trust|\n|enterprise_investment_scheme_non_regulated|Enterprise Investment Scheme (Non-Regulated)|\n|enterprise_investment_scheme_regulated|Enterprise Investment Scheme (Regulated)|\n|enterprise_investment_zone_trust|Enterprise Investment Zone Trust|\n|enterprise_zone_syndicate|Enterprise Zone Syndicate|\n|equity_holdings|Equity Holdings|\n|exchange_traded_fund|Exchange Traded Fund|\n|exempt_property_unit_trust|Exempt Property Unit Trust|\n|film_partnership|Film Partnership|\n|geared_investments|Geared Investments|\n|general_investment_account|General Investment Account|\n|hedge_fund|Hedge Fund|\n|investment_bond|Investment Bond|\n|investment_tax_service|Investment Tax Service|\n|investment_trust|Investment Trust|\n|isa_aim|ISA (AIM)|\n|isa_cash|ISA (Cash)|\n|isa_help_to_buy|ISA (Help To Buy)|\n|isa_maxi|ISA (Maxi)|\n|isa_maxi_mini_transfer|ISA (Maxi/Mini Transfer)|\n|isa_mini_equity|ISA (Mini Equity)|\n|isa_nisa|ISA (Nisa)|\n|isa_stocks_and_shares|ISA (Stocks And Shares)|\n|junior_isa_cash|Junior ISA (Cash)|\n|junior_isa_nisa|Junior ISA (Nisa)|\n|junior_isa_stocks_and_shares|Junior ISA (Stocks And Shares)|\n|lifetime_isa_stocks_and_shares|Lifetime ISA (Stocks And Shares)|\n|maximum_investment_plan_investment|Maximum Investment Plan|\n|non_discretionary_managed_service|Non Discretionary Managed Service|\n|oeic_unit_trust|Oeic/Unit Trust|\n|offshore_bond|Offshore Bond|\n|offshore_deposit|Offshore Deposit|\n|offshore_oeic_fund|Offshore Oeic/Fund|\n|offshore_savings_plan|Offshore Savings Plan|\n|onshore_bond|Onshore Bond|\n|personal_equity_plan|Personal Equity Plan|\n|property_holdings|Property Holdings|\n|property_partnership|Property Partnership|\n|property_syndicate|Property Syndicate|\n|residential_property_development|Residential Property Development|\n|savings_account|Savings Account|\n|seed_enterprise_investment_scheme_non_regulated|Seed Enterprise Investment Scheme (Non-Regulated)|\n|seed_enterprise_investment_scheme_regulated|Seed Enterprise Investment Scheme (Regulated)|\n|share_incentive_plan|Share Incentive Plan|\n|share_save_scheme|Share Save Scheme|\n|sicav|SICAV|\n|structured_plan|Structured Plan|\n|structured_plan_cash_isa|Structured Plan (Cash ISA)|\n|structured_plan_deposit|Structured Plan (Deposit)|\n|structured_plan_medium_term_note|Structured Plan (Medium Term Note)|\n|structured_plan_stocks_shares_isa|Structured Plan (Stocks \u0026 Shares ISA)|\n|tessa|TESSA|\n|trust|Trust|\n|unit_trust|Unit Trust|\n|unregulated_collective_investments|Unregulated Collective Investments|\n|venture_capital_trust_non_regulated|Venture Capital Trust (Non-Regulated)|\n|venture_capital_trust_regulated|Venture Capital Trust (Regulated)|\n|wrap|Wrap|\n|investment_unknown|Unknown|\n|accident_and_sickness_insurance|Accident And Sickness Insurance|\n|accident_sickness_and_unemployment_insurance|Accident Sickness And Unemployment Insurance|\n|accidental_death_insurance|Accidental Death Insurance|\n|business_loan_protection|Business Loan Protection|\n|capital_redemption_policy|Capital Redemption Policy|\n|death_in_service|Death In Service|\n|endowment|Endowment|\n|flexible_plan|Flexible Plan|\n|general_insurance_income_protection|General Insurance (Income Protection)|\n|gift_inter_vivos|Gift Inter Vivos|\n|health_assessment|Health Assessment|\n|income_protection|Income Protection|\n|income_protection_executive|Income Protection (Executive)|\n|income_protection_key_person|Income Protection (Key Person)|\n|life_settlement_fund|Life Settlement Fund|\n|maximum_investment_plan|Maximum Investment Plan|\n|multi_benefit_protection|Multi Benefit Protection|\n|pension_contribution_insurance|Pension Contribution Insurance|\n|pension_term_assurance|Pension Term Assurance|\n|pre_paid_funeral_plan|Pre-Paid Funeral Plan|\n|redundancy_insurance|Redundancy Insurance|\n|relevant_life_policy|Relevant Life Policy|\n|renewable_convertible_term|Renewable Convertible Term|\n|term_protection|Term Protection|\n|term_protection_convertible|Term Protection (Convertible)|\n|term_protection_critical_illness|Term Protection (Critical Illness)|\n|term_protection_decreasing_term|Term Protection (Decreasing Term)|\n|term_protection_decreasing_term_ci|Term Protection (Decreasing Term - CI)|\n|term_protection_decreasing_term_life_ci|Term Protection (Decreasing Term - Life \u0026 CI)|\n|term_protection_directors_share_protection|Term Protection (Directors Share Protection)|\n|term_protection_family_income_protection|Term Protection (Family Income Protection)|\n|term_protection_family_income_protection_ci|Term Protection (Family Income Protection - CI)|\n|term_protection_family_income_protection_life_ci|Term Protection (Family Income Protection - Life \u0026 CI)|\n|term_protection_increasing_term|Term Protection (Increasing Term)|\n|term_protection_key_person_assurance|Term Protection (Key Person Assurance)|\n|term_protection_level|Term Protection (Level)|\n|term_protection_level_ci|Term Protection (Level - CI)|\n|term_protection_level_life_ci|Term Protection (Level - Life \u0026 CI)|\n|term_protection_mortgage_protection|Term Protection (Mortgage Protection)|\n|term_protection_partnership_protection|Term Protection (Partnership Protection)|\n|term_protection_renewable|Term Protection (Renewable)|\n|unemployment_insurance|Unemployment Insurance|\n|whole_of_life|Whole Of Life|\n|whole_of_life_non_investment|Whole Of Life (Non Investment)|\n|will|Will|\n|protection_policy_unknown|Unknown|\n|alternatively_secured_pension_plan|Alternatively Secured Pension Plan|\n|appropriate_personal_pension|Appropriate Personal Pension|\n|avc|AVC|\n|cimp|CIMP|\n|cimp_comp|CIMP \u0026 COMP|\n|comp|COMP|\n|deferred_sipp|Deferred SIPP|\n|defined_benefit_pension|Defined Benefit Pension|\n|dependants_pension|Dependants Pension|\n|efrbs|EFRBS|\n|equivalent_pension_benefits|Equivalent Pension Benefits|\n|executive_pension_plan|Executive Pension Plan|\n|family_sipp|Family SIPP|\n|final_salary_scheme|Final Salary Scheme|\n|fsavc|FSAVC|\n|furbs|FURBS|\n|group_cimp|Group CIMP|\n|group_comp|Group COMP|\n|group_dependants_pension|Group Dependants Pension|\n|group_offshore_pension_scheme|Group Offshore Pension Scheme|\n|group_personal_pension|Group Personal Pension|\n|group_s32_buyout_bond|Group S32 Buyout Bond|\n|group_sipp|Group SIPP|\n|group_stakeholder_pension|Group Stakeholder Pension|\n|income_drawdown_beneficiary|Income Drawdown (Beneficiary)|\n|income_drawdown_capped|Income Drawdown (Capped)|\n|income_drawdown_flexi_access|Income Drawdown (Flexi-Access)|\n|income_drawdown_flexible|Income Drawdown (Flexible)|\n|independent_retirement_advice|Independent Retirement Advice (IRA)|\n|individual_retirement_account|Individual Retirement Account|\n|inherited_independent_retirement_advice|Inherited Independent Retirement Advice (Inherited IRA)|\n|junior_personal_pension_plan|Junior SIPP|\n|master_trust_pension|Master Trust Pension|\n|money_purchase_contracted|Money Purchase Contracted|\n|national_employers_savings_trust|National Employers Savings Trust (NEST)|\n|offshore_pension|Offshore Pension|\n|pension_fund_withdrawal|Pension Fund Withdrawal|\n|personal_pension_plan|Personal Pension Plan|\n|phased_retirement|Phased Retirement|\n|pia_non_protected_rights|PIA (Non Protected Rights)|\n|qnups|QNUPs|\n|qnups_wrapper|QNUPs Wrapper|\n|qrops|QROPs|\n|qrops_wrapper|QROPs Wrapper|\n|rnups_wrapper|RNUPs Wrapper|\n|roth_inherited_independent_retirement_advice|Roth Inherited Independent Retirement Advice (Roth IRA)|\n|s226_rac|S226 RAC|\n|s32_buyout_bond|S32 Buyout Bond|\n|sipp|SIPP|\n|sipp_wrapper|SIPP Wrapper|\n|ssas|Ssas|\n|stakeholder_individual|Stakeholder Individual|\n|third_way_pensions|Third Way Pensions|\n|trustee_investment_plan|Trustee Investment Plan|\n|unsecured_pension|Unsecured Pension|\n|uurbs|UURBs|\n|workplace_pension_scheme|Workplace Pension Scheme|\n|pension_unknown|Unknown|\n|annuity_non_pension|Annuity (Non Pension)|\n|compulsory_purchase_life_annuity|Compulsory Purchase Life Annuity|\n|deferred_annuity|Deferred Annuity|\n|defined_benefit_trustee_buy_in|Defined Benefit Trustee Buy In|\n|enhanced_pension_annuity|Enhanced Pension Annuity|\n|fixed_term_annuity|Fixed Term Annuity|\n|group_final_salary|Group Final Salary|\n|hancock_annuity|Hancock Annuity|\n|impaired_life_annuity|Impaired Life Annuity|\n|ivpp|IVPP|\n|lifetime_annuity|Lifetime Annuity|\n|pension_annuity|Pension Annuity|\n|pension_annuity_conventional|Pension Annuity (Conventional)|\n|pension_annuity_flexible|Pension Annuity (Flexible)|\n|pension_annuity_impaired_life|Pension Annuity (Impaired Life)|\n|pension_annuity_temporary|Pension Annuity (Temporary)|\n|pension_annuity_unit_linked|Pension Annuity (Unit Linked)|\n|pension_annuity_with_profits|Pension Annuity (With Profits)|\n|purchased_life_annuity|Purchased Life Annuity|\n|scheme_pension|Scheme Pension|\n|annuity_unknown|Unknown|\n|dental_insurance|Dental Insurance|\n|general_insurance_building|General Insurance (Building)|\n|general_insurance_building_contents|General Insurance (Building \u0026 Contents)|\n|general_insurance_commercial_combined|General Insurance (Commercial Combined)|\n|general_insurance_commercial_motor|General Insurance (Commercial Motor)|\n|general_insurance_contents|General Insurance (Contents)|\n|general_insurance_directors_and_officers|General Insurance (Directors And Officers)|\n|general_insurance_extended_warranty|General Insurance (Extended Warranty)|\n|general_insurance_legal_expenses|General Insurance (Legal Expenses)|\n|general_insurance_let_property|General Insurance (Let Property)|\n|general_insurance_liability|General Insurance (Liability)|\n|general_insurance_other|General Insurance Other|\n|general_insurance_payment_protection|General Insurance (Payment Protection)|\n|general_insurance_private_motor|General Insurance (Private Motor)|\n|general_insurance_professional_indemnity|General Insurance (Professional Indemnity)|\n|general_insurance_travel|General Insurance (Travel)|\n|group_travel_insurance|Group Travel Insurance|\n|healthcare_cash_plan|Healthcare Cash Plan|\n|international_private_medical_insurance|International Private Medical Insurance (IPMI)|\n|locum_insurance|Locum Insurance|\n|long_term_care|Long Term Care|\n|long_term_care_immediate|Long Term Care (Immediate)|\n|long_term_care_pre_funded|Long Term Care (Pre-Funded)|\n|private_medical_insurance|Private Medical Insurance|\n|general_insurance_unknown|Unknown|\n|cpb|CPB|\n|employee_assistance_scheme|Employee Assistance Scheme|\n|flexible_benefits|Flexible Benefits|\n|group_accident_and_sickness|Group Accident And Sickness|\n|group_critical_illness|Group Critical Illness|\n|group_death_in_service|Group Death In Service|\n|group_dental_insurance|Group Dental Insurance|\n|group_healthcare_cash_plan|Group Healthcare Cash Plan|\n|group_income_protection|Group Income Protection|\n|group_income_protection_key_person|Group Income Protection (Key Person)|\n|group_key_person_assurance|Group Key Person Assurance|\n|group_life|Group Life|\n|group_life_excepted|Group Life (Excepted)|\n|group_life_registered|Group Life (Registered)|\n|group_partnership_protection|Group Partnership Protection|\n|group_personal_accident|Group Personal Accident|\n|group_pmi|Group PMI|\n|group_relevant_life|Group Relevant Life|\n|group_term|Group Term|\n|group_protection_unknown|Unknown|\n|equity_release|Equity Release|\n|mortgage|Mortgage|\n|mortgage_bridging_loan|Bridging Loan Mortgage|\n|mortgage_business_buy_to_let|Mortgage Business Buy To Let|\n|mortgage_buy_to_let|Buy To Let Mortgage|\n|mortgage_consumer_buy_to_let|Consumer Buy To Let Mortgage|\n|mortgage_council_tenant_to_buy|Council/Tenant To Buy Mortgage|\n|mortgage_foreign_currency|Foreign Currency Mortgage|\n|mortgage_full_status|Mortgage Full Status|\n|mortgage_further_advance|Further Advance Mortgage|\n|mortgage_government_home_ownership_scheme|Government Home Ownership Scheme Mortgage|\n|mortgage_home_purchase_plan|Home Purchase Plan Mortgage|\n|mortgage_investment_property_islamic|Investment Property Islamic Mortgage|\n|mortgage_let_to_buy|Let To Buy Mortgage|\n|mortgage_lifetime|Mortgage Lifetime|\n|mortgage_non_status|Mortgage Non Status|\n|mortgage_primary_residence_islamic|Primary Residence Islamic Mortgage|\n|mortgage_product_transfer|Product Transfer Mortgage|\n|mortgage_remortgage|Remortgage Mortgage|\n|mortgage_right_to_buy|Right To Buy Mortgage|\n|mortgage_second_charge|Second Charge Mortgage|\n|mortgage_second_home|Second Home Mortgage|\n|mortgage_self_build|Self-Build Mortgage|\n|mortgage_self_cert|Mortgage Self Cert|\n|mortgage_shared_ownership|Shared Ownership Mortgage|\n|mortgage_standard_residential|Standard Residential Mortgage|\n|mortgage_non_regulated_bridging_loan|Non-Regulated Bridging Loan Mortgage|\n|mortgage_non_regulated_buy_to_let|Non-Regulated Buy To Let Mortgage|\n|mortgage_non_regulated_commercial|Non-Regulated Commercial Mortgage|\n|mortgage_non_regulated_further_advance|Non-Regulated Further Advance Mortgage|\n|mortgage_non_regulated_offshore|Non-Regulated Offshore Mortgage|\n|mortgage_non_regulated_overseas|Non-Regulated Overseas Mortgage|\n|mortgage_non_regulated_product_transfer|Non-Regulated Product Transfer Mortgage|\n|third_party_mortgage|Third Party Mortgage|\n|mortgage_unknown|Unknown|\n|bridging_loan|Bridging Loan|\n|car_finance|Car Finance|\n|commercial_finance|Commercial Finance|\n|consumer_finance|Consumer Finance|\n|credit_card|Credit Card|\n|landlords|Landlords|\n|other_long_term_loan|Other Long Term Loan|\n|overdraft|Overdraft|\n|partner_loan|Partner Loan|\n|peer_to_peer_loan|Peer To Peer Loan|\n|personal_loan|Personal Loan|\n|personal_loan_secured|Personal Loan (Secured)|\n|personal_loan_unsecured|Personal Loan (Unsecured)|\n|public_liability|Public Liability|\n|student_loan|Student Loan|\n|will_trust_loan|Will Trust Loan|\n|loan_credit_unknown|Unknown|\n|boat|Boat|\n|collectible_art_other|Collectible/Art/Other|\n|land|Land|\n|motor_vehicle|Motor Vehicle|\n|other|Other|\n|own_business|Own Business|\n|property|Property|\n|property_btl|Property (Btl)|\n|property_investment|Property (Investment)|\n|property_rental|Property (Rental)|\n|property_other|Property (Other)|\n|property_overseas|Property (Overseas)|\n|fixed_asset_unknown|Unknown|","enum":["cash_account","cash_deposit","isa_mini_cash","isa_tessa_only","lifetime_isa_cash","national_savings","national_savings_child_bonus_bond","national_savings_fixed_interest_certificate","national_savings_guaranteed_equity_bond","national_savings_income_bond","national_savings_index_linked_certificate","national_savings_national_savings_certificate","national_savings_premium_bonds","cash_account_unknown","aim_investment_tax_service","bes","business_premises_renovation_allowance","child_trust_fund","collective_investment_account","commercial_property_purchase_scheme","debenture","discretionary_managed_service","employee_benefit_trust","enterprise_investment_scheme_non_regulated","enterprise_investment_scheme_regulated","enterprise_investment_zone_trust","enterprise_zone_syndicate","equity_holdings","exchange_traded_fund","exempt_property_unit_trust","film_partnership","geared_investments","general_investment_account","hedge_fund","investment_bond","investment_tax_service","investment_trust","isa_aim","isa_cash","isa_help_to_buy","isa_maxi","isa_maxi_mini_transfer","isa_mini_equity","isa_nisa","isa_stocks_and_shares","junior_isa_cash","junior_isa_nisa","junior_isa_stocks_and_shares","lifetime_isa_stocks_and_shares","maximum_investment_plan_investment","non_discretionary_managed_service","oeic_unit_trust","offshore_bond","offshore_deposit","offshore_oeic_fund","offshore_savings_plan","onshore_bond","personal_equity_plan","property_holdings","property_partnership","property_syndicate","residential_property_development","savings_account","seed_enterprise_investment_scheme_non_regulated","seed_enterprise_investment_scheme_regulated","share_incentive_plan","share_save_scheme","sicav","structured_plan","structured_plan_cash_isa","structured_plan_deposit","structured_plan_medium_term_note","structured_plan_stocks_shares_isa","tessa","trust","unit_trust","unregulated_collective_investments","venture_capital_trust_non_regulated","venture_capital_trust_regulated","wrap","investment_unknown","accident_and_sickness_insurance","accident_sickness_and_unemployment_insurance","accidental_death_insurance","business_loan_protection","capital_redemption_policy","death_in_service","endowment","flexible_plan","general_insurance_income_protection","gift_inter_vivos","health_assessment","income_protection","income_protection_executive","income_protection_key_person","life_settlement_fund","maximum_investment_plan","multi_benefit_protection","pension_contribution_insurance","pension_term_assurance","pre_paid_funeral_plan","redundancy_insurance","relevant_life_policy","renewable_convertible_term","term_protection","term_protection_convertible","term_protection_critical_illness","term_protection_decreasing_term","term_protection_decreasing_term_ci","term_protection_decreasing_term_life_ci","term_protection_directors_share_protection","term_protection_family_income_protection","term_protection_family_income_protection_ci","term_protection_family_income_protection_life_ci","term_protection_increasing_term","term_protection_key_person_assurance","term_protection_level","term_protection_level_ci","term_protection_level_life_ci","term_protection_mortgage_protection","term_protection_partnership_protection","term_protection_renewable","unemployment_insurance","whole_of_life","whole_of_life_non_investment","will","protection_policy_unknown","alternatively_secured_pension_plan","appropriate_personal_pension","avc","cimp","cimp_comp","comp","deferred_sipp","defined_benefit_pension","dependants_pension","efrbs","equivalent_pension_benefits","executive_pension_plan","family_sipp","final_salary_scheme","fsavc","furbs","group_cimp","group_comp","group_dependants_pension","group_offshore_pension_scheme","group_personal_pension","group_s32_buyout_bond","group_sipp","group_stakeholder_pension","income_drawdown_beneficiary","income_drawdown_capped","income_drawdown_flexi_access","income_drawdown_flexible","independent_retirement_advice","individual_retirement_account","inherited_independent_retirement_advice","junior_personal_pension_plan","master_trust_pension","money_purchase_contracted","national_employers_savings_trust","offshore_pension","pension_fund_withdrawal","personal_pension_plan","phased_retirement","pia_non_protected_rights","qnups","qnups_wrapper","qrops","qrops_wrapper","rnups_wrapper","roth_inherited_independent_retirement_advice","s226_rac","s32_buyout_bond","sipp","sipp_wrapper","ssas","stakeholder_individual","third_way_pensions","trustee_investment_plan","unsecured_pension","uurbs","workplace_pension_scheme","pension_unknown","annuity_non_pension","compulsory_purchase_life_annuity","deferred_annuity","defined_benefit_trustee_buy_in","enhanced_pension_annuity","fixed_term_annuity","group_final_salary","hancock_annuity","impaired_life_annuity","ivpp","lifetime_annuity","pension_annuity","pension_annuity_conventional","pension_annuity_flexible","pension_annuity_impaired_life","pension_annuity_temporary","pension_annuity_unit_linked","pension_annuity_with_profits","purchased_life_annuity","scheme_pension","annuity_unknown","dental_insurance","general_insurance_building","general_insurance_building_contents","general_insurance_commercial_combined","general_insurance_commercial_motor","general_insurance_contents","general_insurance_directors_and_officers","general_insurance_extended_warranty","general_insurance_legal_expenses","general_insurance_let_property","general_insurance_liability","general_insurance_other","general_insurance_payment_protection","general_insurance_private_motor","general_insurance_professional_indemnity","general_insurance_travel","group_travel_insurance","healthcare_cash_plan","international_private_medical_insurance","locum_insurance","long_term_care","long_term_care_immediate","long_term_care_pre_funded","private_medical_insurance","general_insurance_unknown","cpb","employee_assistance_scheme","flexible_benefits","group_accident_and_sickness","group_critical_illness","group_death_in_service","group_dental_insurance","group_healthcare_cash_plan","group_income_protection","group_income_protection_key_person","group_key_person_assurance","group_life","group_life_excepted","group_life_registered","group_partnership_protection","group_personal_accident","group_pmi","group_relevant_life","group_term","group_protection_unknown","equity_release","mortgage","mortgage_bridging_loan","mortgage_business_buy_to_let","mortgage_buy_to_let","mortgage_consumer_buy_to_let","mortgage_council_tenant_to_buy","mortgage_foreign_currency","mortgage_full_status","mortgage_further_advance","mortgage_government_home_ownership_scheme","mortgage_home_purchase_plan","mortgage_investment_property_islamic","mortgage_let_to_buy","mortgage_lifetime","mortgage_non_status","mortgage_primary_residence_islamic","mortgage_product_transfer","mortgage_remortgage","mortgage_right_to_buy","mortgage_second_charge","mortgage_second_home","mortgage_self_build","mortgage_self_cert","mortgage_shared_ownership","mortgage_standard_residential","mortgage_non_regulated_bridging_loan","mortgage_non_regulated_buy_to_let","mortgage_non_regulated_commercial","mortgage_non_regulated_further_advance","mortgage_non_regulated_offshore","mortgage_non_regulated_overseas","mortgage_non_regulated_product_transfer","third_party_mortgage","mortgage_unknown","bridging_loan","car_finance","commercial_finance","consumer_finance","credit_card","landlords","other_long_term_loan","overdraft","partner_loan","peer_to_peer_loan","personal_loan","personal_loan_secured","personal_loan_unsecured","public_liability","student_loan","will_trust_loan","loan_credit_unknown","boat","collectible_art_other","land","motor_vehicle","other","own_business","property","property_btl","property_investment","property_rental","property_other","property_overseas","fixed_asset_unknown"]},"external_reference":{"$ref":"#/components/schemas/ExternalReference"}}},"App_Http_Requests_Plans_UpdatePremiumRequest":{"type":"object","properties":{"transfer_type":{"type":"string","example":"switch","description":"|\n\nTransfer type.\n\n| Value | Description |\n| ----- | ----------- |\n|switch|Switch|\n|transfer|Transfer|","enum":["switch","transfer"],"nullable":true},"date_advice_given":{"type":"string","example":"2025-11-15","description":"Date advice given","format":"date","nullable":true},"amount":{"type":"integer","example":250000,"description":"Premium amount in pennies. Either amount or percentage can be given in request","nullable":true},"percentage":{"type":"number","example":5.5,"description":"Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request","format":"float","minimum":0.0,"maximum":100.0,"nullable":true},"frequency":{"type":"string","example":"daily","description":"|\n\nPremium frequency\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"source":{"type":"string","example":"employee","description":"|\n\nPremium source, only for pension plans.\n\n| Value | Description |\n| ----- | ----------- |\n|employee|Employee|\n|employer|Employer|","enum":["employee","employer"],"nullable":true},"payment_method":{"type":"string","example":"salary_sacrifice","description":"|\n\nPayment method.\n\n| Value | Description |\n| ----- | ----------- |\n|salary_sacrifice|Salary Sacrifice|\n|salary_deduction|Salary Deduction|\n|direct_debit|Direct Debit|\n|standing_order|Standing Order|\n|cheque|Cheque|\n|bank_transfer|Bank Transfer|","enum":["salary_sacrifice","salary_deduction","direct_debit","standing_order","cheque","bank_transfer"],"nullable":true},"start_date":{"type":"string","example":"2026-03-24","description":"Start date","format":"date"},"end_date":{"type":"string","example":"2028-05-08","description":"End date. Leave blank for ongoing","format":"date","nullable":true},"pensionable_salary":{"type":"integer","example":10000000,"description":"Update the pensionable_salary that was used for this premium. Only valid for pension plans"},"details":{"type":"string","example":"Any extra details about the premium.","description":"Details","maxLength":65000,"nullable":true},"transferred_from_plan_uuid":{"type":"string","example":"de4cbc64-47f4-4508-80c5-cd8f70d0352b","description":"The plan UUID this premium was transferred from","format":"uuid","nullable":true},"transferred_from_plan_type":{"type":"string","example":"annuity","description":"|\n\nThe plan type this premium was transferred from if the actual plan UUID is unknown\n\n| Value | Description |\n| ----- | ----------- |\n|annuity|Annuity|\n|cash_account|Cash Account|\n|fixed_asset|Fixed Asset|\n|general_insurance|General Insurance|\n|group_protection|Group Protection|\n|investment|Investment|\n|loan_credit|Loan Credit|\n|mortgage|Mortgage|\n|pension|Pension|\n|protection_policy|Protection Policy|","enum":["annuity","cash_account","fixed_asset","general_insurance","group_protection","investment","loan_credit","mortgage","pension","protection_policy"],"nullable":true},"transferred_from_plan_sub_type":{"type":"string","example":"cash_account","description":"|\n\nThe plan sub type this premium was transferred from if the actual plan UUID is unknown\n\n| Value | Description |\n| ----- | ----------- |\n|cash_account|Cash Account|\n|cash_deposit|Cash Deposit|\n|isa_mini_cash|ISA (Mini Cash)|\n|isa_tessa_only|ISA (TESSA Only)|\n|lifetime_isa_cash|Lifetime ISA (Cash)|\n|national_savings|National Savings|\n|national_savings_child_bonus_bond|National Savings (Child Bonus Bond)|\n|national_savings_fixed_interest_certificate|National Savings (Fixed Interest Certificate)|\n|national_savings_guaranteed_equity_bond|National Savings (Guaranteed Equity Bond)|\n|national_savings_income_bond|National Savings (Income Bond)|\n|national_savings_index_linked_certificate|National Savings (Index Linked Certificate)|\n|national_savings_national_savings_certificate|National Savings (National Savings Certificate)|\n|national_savings_premium_bonds|National Savings (Premium Bonds)|\n|cash_account_unknown|Unknown|\n|aim_investment_tax_service|AIM Investment Tax Service|\n|bes|BES|\n|business_premises_renovation_allowance|Business Premises Renovation Allowance|\n|child_trust_fund|Child Trust Fund|\n|collective_investment_account|Collective Investment Account|\n|commercial_property_purchase_scheme|Commercial Property Purchase Scheme|\n|debenture|Debenture|\n|discretionary_managed_service|Discretionary Managed Service|\n|employee_benefit_trust|Employee Benefit Trust|\n|enterprise_investment_scheme_non_regulated|Enterprise Investment Scheme (Non-Regulated)|\n|enterprise_investment_scheme_regulated|Enterprise Investment Scheme (Regulated)|\n|enterprise_investment_zone_trust|Enterprise Investment Zone Trust|\n|enterprise_zone_syndicate|Enterprise Zone Syndicate|\n|equity_holdings|Equity Holdings|\n|exchange_traded_fund|Exchange Traded Fund|\n|exempt_property_unit_trust|Exempt Property Unit Trust|\n|film_partnership|Film Partnership|\n|geared_investments|Geared Investments|\n|general_investment_account|General Investment Account|\n|hedge_fund|Hedge Fund|\n|investment_bond|Investment Bond|\n|investment_tax_service|Investment Tax Service|\n|investment_trust|Investment Trust|\n|isa_aim|ISA (AIM)|\n|isa_cash|ISA (Cash)|\n|isa_help_to_buy|ISA (Help To Buy)|\n|isa_maxi|ISA (Maxi)|\n|isa_maxi_mini_transfer|ISA (Maxi/Mini Transfer)|\n|isa_mini_equity|ISA (Mini Equity)|\n|isa_nisa|ISA (Nisa)|\n|isa_stocks_and_shares|ISA (Stocks And Shares)|\n|junior_isa_cash|Junior ISA (Cash)|\n|junior_isa_nisa|Junior ISA (Nisa)|\n|junior_isa_stocks_and_shares|Junior ISA (Stocks And Shares)|\n|lifetime_isa_stocks_and_shares|Lifetime ISA (Stocks And Shares)|\n|maximum_investment_plan_investment|Maximum Investment Plan|\n|non_discretionary_managed_service|Non Discretionary Managed Service|\n|oeic_unit_trust|Oeic/Unit Trust|\n|offshore_bond|Offshore Bond|\n|offshore_deposit|Offshore Deposit|\n|offshore_oeic_fund|Offshore Oeic/Fund|\n|offshore_savings_plan|Offshore Savings Plan|\n|onshore_bond|Onshore Bond|\n|personal_equity_plan|Personal Equity Plan|\n|property_holdings|Property Holdings|\n|property_partnership|Property Partnership|\n|property_syndicate|Property Syndicate|\n|residential_property_development|Residential Property Development|\n|savings_account|Savings Account|\n|seed_enterprise_investment_scheme_non_regulated|Seed Enterprise Investment Scheme (Non-Regulated)|\n|seed_enterprise_investment_scheme_regulated|Seed Enterprise Investment Scheme (Regulated)|\n|share_incentive_plan|Share Incentive Plan|\n|share_save_scheme|Share Save Scheme|\n|sicav|SICAV|\n|structured_plan|Structured Plan|\n|structured_plan_cash_isa|Structured Plan (Cash ISA)|\n|structured_plan_deposit|Structured Plan (Deposit)|\n|structured_plan_medium_term_note|Structured Plan (Medium Term Note)|\n|structured_plan_stocks_shares_isa|Structured Plan (Stocks \u0026 Shares ISA)|\n|tessa|TESSA|\n|trust|Trust|\n|unit_trust|Unit Trust|\n|unregulated_collective_investments|Unregulated Collective Investments|\n|venture_capital_trust_non_regulated|Venture Capital Trust (Non-Regulated)|\n|venture_capital_trust_regulated|Venture Capital Trust (Regulated)|\n|wrap|Wrap|\n|investment_unknown|Unknown|\n|accident_and_sickness_insurance|Accident And Sickness Insurance|\n|accident_sickness_and_unemployment_insurance|Accident Sickness And Unemployment Insurance|\n|accidental_death_insurance|Accidental Death Insurance|\n|business_loan_protection|Business Loan Protection|\n|capital_redemption_policy|Capital Redemption Policy|\n|death_in_service|Death In Service|\n|endowment|Endowment|\n|flexible_plan|Flexible Plan|\n|general_insurance_income_protection|General Insurance (Income Protection)|\n|gift_inter_vivos|Gift Inter Vivos|\n|health_assessment|Health Assessment|\n|income_protection|Income Protection|\n|income_protection_executive|Income Protection (Executive)|\n|income_protection_key_person|Income Protection (Key Person)|\n|life_settlement_fund|Life Settlement Fund|\n|maximum_investment_plan|Maximum Investment Plan|\n|multi_benefit_protection|Multi Benefit Protection|\n|pension_contribution_insurance|Pension Contribution Insurance|\n|pension_term_assurance|Pension Term Assurance|\n|pre_paid_funeral_plan|Pre-Paid Funeral Plan|\n|redundancy_insurance|Redundancy Insurance|\n|relevant_life_policy|Relevant Life Policy|\n|renewable_convertible_term|Renewable Convertible Term|\n|term_protection|Term Protection|\n|term_protection_convertible|Term Protection (Convertible)|\n|term_protection_critical_illness|Term Protection (Critical Illness)|\n|term_protection_decreasing_term|Term Protection (Decreasing Term)|\n|term_protection_decreasing_term_ci|Term Protection (Decreasing Term - CI)|\n|term_protection_decreasing_term_life_ci|Term Protection (Decreasing Term - Life \u0026 CI)|\n|term_protection_directors_share_protection|Term Protection (Directors Share Protection)|\n|term_protection_family_income_protection|Term Protection (Family Income Protection)|\n|term_protection_family_income_protection_ci|Term Protection (Family Income Protection - CI)|\n|term_protection_family_income_protection_life_ci|Term Protection (Family Income Protection - Life \u0026 CI)|\n|term_protection_increasing_term|Term Protection (Increasing Term)|\n|term_protection_key_person_assurance|Term Protection (Key Person Assurance)|\n|term_protection_level|Term Protection (Level)|\n|term_protection_level_ci|Term Protection (Level - CI)|\n|term_protection_level_life_ci|Term Protection (Level - Life \u0026 CI)|\n|term_protection_mortgage_protection|Term Protection (Mortgage Protection)|\n|term_protection_partnership_protection|Term Protection (Partnership Protection)|\n|term_protection_renewable|Term Protection (Renewable)|\n|unemployment_insurance|Unemployment Insurance|\n|whole_of_life|Whole Of Life|\n|whole_of_life_non_investment|Whole Of Life (Non Investment)|\n|will|Will|\n|protection_policy_unknown|Unknown|\n|alternatively_secured_pension_plan|Alternatively Secured Pension Plan|\n|appropriate_personal_pension|Appropriate Personal Pension|\n|avc|AVC|\n|cimp|CIMP|\n|cimp_comp|CIMP \u0026 COMP|\n|comp|COMP|\n|deferred_sipp|Deferred SIPP|\n|defined_benefit_pension|Defined Benefit Pension|\n|dependants_pension|Dependants Pension|\n|efrbs|EFRBS|\n|equivalent_pension_benefits|Equivalent Pension Benefits|\n|executive_pension_plan|Executive Pension Plan|\n|family_sipp|Family SIPP|\n|final_salary_scheme|Final Salary Scheme|\n|fsavc|FSAVC|\n|furbs|FURBS|\n|group_cimp|Group CIMP|\n|group_comp|Group COMP|\n|group_dependants_pension|Group Dependants Pension|\n|group_offshore_pension_scheme|Group Offshore Pension Scheme|\n|group_personal_pension|Group Personal Pension|\n|group_s32_buyout_bond|Group S32 Buyout Bond|\n|group_sipp|Group SIPP|\n|group_stakeholder_pension|Group Stakeholder Pension|\n|income_drawdown_beneficiary|Income Drawdown (Beneficiary)|\n|income_drawdown_capped|Income Drawdown (Capped)|\n|income_drawdown_flexi_access|Income Drawdown (Flexi-Access)|\n|income_drawdown_flexible|Income Drawdown (Flexible)|\n|independent_retirement_advice|Independent Retirement Advice (IRA)|\n|individual_retirement_account|Individual Retirement Account|\n|inherited_independent_retirement_advice|Inherited Independent Retirement Advice (Inherited IRA)|\n|junior_personal_pension_plan|Junior SIPP|\n|master_trust_pension|Master Trust Pension|\n|money_purchase_contracted|Money Purchase Contracted|\n|national_employers_savings_trust|National Employers Savings Trust (NEST)|\n|offshore_pension|Offshore Pension|\n|pension_fund_withdrawal|Pension Fund Withdrawal|\n|personal_pension_plan|Personal Pension Plan|\n|phased_retirement|Phased Retirement|\n|pia_non_protected_rights|PIA (Non Protected Rights)|\n|qnups|QNUPs|\n|qnups_wrapper|QNUPs Wrapper|\n|qrops|QROPs|\n|qrops_wrapper|QROPs Wrapper|\n|rnups_wrapper|RNUPs Wrapper|\n|roth_inherited_independent_retirement_advice|Roth Inherited Independent Retirement Advice (Roth IRA)|\n|s226_rac|S226 RAC|\n|s32_buyout_bond|S32 Buyout Bond|\n|sipp|SIPP|\n|sipp_wrapper|SIPP Wrapper|\n|ssas|Ssas|\n|stakeholder_individual|Stakeholder Individual|\n|third_way_pensions|Third Way Pensions|\n|trustee_investment_plan|Trustee Investment Plan|\n|unsecured_pension|Unsecured Pension|\n|uurbs|UURBs|\n|workplace_pension_scheme|Workplace Pension Scheme|\n|pension_unknown|Unknown|\n|annuity_non_pension|Annuity (Non Pension)|\n|compulsory_purchase_life_annuity|Compulsory Purchase Life Annuity|\n|deferred_annuity|Deferred Annuity|\n|defined_benefit_trustee_buy_in|Defined Benefit Trustee Buy In|\n|enhanced_pension_annuity|Enhanced Pension Annuity|\n|fixed_term_annuity|Fixed Term Annuity|\n|group_final_salary|Group Final Salary|\n|hancock_annuity|Hancock Annuity|\n|impaired_life_annuity|Impaired Life Annuity|\n|ivpp|IVPP|\n|lifetime_annuity|Lifetime Annuity|\n|pension_annuity|Pension Annuity|\n|pension_annuity_conventional|Pension Annuity (Conventional)|\n|pension_annuity_flexible|Pension Annuity (Flexible)|\n|pension_annuity_impaired_life|Pension Annuity (Impaired Life)|\n|pension_annuity_temporary|Pension Annuity (Temporary)|\n|pension_annuity_unit_linked|Pension Annuity (Unit Linked)|\n|pension_annuity_with_profits|Pension Annuity (With Profits)|\n|purchased_life_annuity|Purchased Life Annuity|\n|scheme_pension|Scheme Pension|\n|annuity_unknown|Unknown|\n|dental_insurance|Dental Insurance|\n|general_insurance_building|General Insurance (Building)|\n|general_insurance_building_contents|General Insurance (Building \u0026 Contents)|\n|general_insurance_commercial_combined|General Insurance (Commercial Combined)|\n|general_insurance_commercial_motor|General Insurance (Commercial Motor)|\n|general_insurance_contents|General Insurance (Contents)|\n|general_insurance_directors_and_officers|General Insurance (Directors And Officers)|\n|general_insurance_extended_warranty|General Insurance (Extended Warranty)|\n|general_insurance_legal_expenses|General Insurance (Legal Expenses)|\n|general_insurance_let_property|General Insurance (Let Property)|\n|general_insurance_liability|General Insurance (Liability)|\n|general_insurance_other|General Insurance Other|\n|general_insurance_payment_protection|General Insurance (Payment Protection)|\n|general_insurance_private_motor|General Insurance (Private Motor)|\n|general_insurance_professional_indemnity|General Insurance (Professional Indemnity)|\n|general_insurance_travel|General Insurance (Travel)|\n|group_travel_insurance|Group Travel Insurance|\n|healthcare_cash_plan|Healthcare Cash Plan|\n|international_private_medical_insurance|International Private Medical Insurance (IPMI)|\n|locum_insurance|Locum Insurance|\n|long_term_care|Long Term Care|\n|long_term_care_immediate|Long Term Care (Immediate)|\n|long_term_care_pre_funded|Long Term Care (Pre-Funded)|\n|private_medical_insurance|Private Medical Insurance|\n|general_insurance_unknown|Unknown|\n|cpb|CPB|\n|employee_assistance_scheme|Employee Assistance Scheme|\n|flexible_benefits|Flexible Benefits|\n|group_accident_and_sickness|Group Accident And Sickness|\n|group_critical_illness|Group Critical Illness|\n|group_death_in_service|Group Death In Service|\n|group_dental_insurance|Group Dental Insurance|\n|group_healthcare_cash_plan|Group Healthcare Cash Plan|\n|group_income_protection|Group Income Protection|\n|group_income_protection_key_person|Group Income Protection (Key Person)|\n|group_key_person_assurance|Group Key Person Assurance|\n|group_life|Group Life|\n|group_life_excepted|Group Life (Excepted)|\n|group_life_registered|Group Life (Registered)|\n|group_partnership_protection|Group Partnership Protection|\n|group_personal_accident|Group Personal Accident|\n|group_pmi|Group PMI|\n|group_relevant_life|Group Relevant Life|\n|group_term|Group Term|\n|group_protection_unknown|Unknown|\n|equity_release|Equity Release|\n|mortgage|Mortgage|\n|mortgage_bridging_loan|Bridging Loan Mortgage|\n|mortgage_business_buy_to_let|Mortgage Business Buy To Let|\n|mortgage_buy_to_let|Buy To Let Mortgage|\n|mortgage_consumer_buy_to_let|Consumer Buy To Let Mortgage|\n|mortgage_council_tenant_to_buy|Council/Tenant To Buy Mortgage|\n|mortgage_foreign_currency|Foreign Currency Mortgage|\n|mortgage_full_status|Mortgage Full Status|\n|mortgage_further_advance|Further Advance Mortgage|\n|mortgage_government_home_ownership_scheme|Government Home Ownership Scheme Mortgage|\n|mortgage_home_purchase_plan|Home Purchase Plan Mortgage|\n|mortgage_investment_property_islamic|Investment Property Islamic Mortgage|\n|mortgage_let_to_buy|Let To Buy Mortgage|\n|mortgage_lifetime|Mortgage Lifetime|\n|mortgage_non_status|Mortgage Non Status|\n|mortgage_primary_residence_islamic|Primary Residence Islamic Mortgage|\n|mortgage_product_transfer|Product Transfer Mortgage|\n|mortgage_remortgage|Remortgage Mortgage|\n|mortgage_right_to_buy|Right To Buy Mortgage|\n|mortgage_second_charge|Second Charge Mortgage|\n|mortgage_second_home|Second Home Mortgage|\n|mortgage_self_build|Self-Build Mortgage|\n|mortgage_self_cert|Mortgage Self Cert|\n|mortgage_shared_ownership|Shared Ownership Mortgage|\n|mortgage_standard_residential|Standard Residential Mortgage|\n|mortgage_non_regulated_bridging_loan|Non-Regulated Bridging Loan Mortgage|\n|mortgage_non_regulated_buy_to_let|Non-Regulated Buy To Let Mortgage|\n|mortgage_non_regulated_commercial|Non-Regulated Commercial Mortgage|\n|mortgage_non_regulated_further_advance|Non-Regulated Further Advance Mortgage|\n|mortgage_non_regulated_offshore|Non-Regulated Offshore Mortgage|\n|mortgage_non_regulated_overseas|Non-Regulated Overseas Mortgage|\n|mortgage_non_regulated_product_transfer|Non-Regulated Product Transfer Mortgage|\n|third_party_mortgage|Third Party Mortgage|\n|mortgage_unknown|Unknown|\n|bridging_loan|Bridging Loan|\n|car_finance|Car Finance|\n|commercial_finance|Commercial Finance|\n|consumer_finance|Consumer Finance|\n|credit_card|Credit Card|\n|landlords|Landlords|\n|other_long_term_loan|Other Long Term Loan|\n|overdraft|Overdraft|\n|partner_loan|Partner Loan|\n|peer_to_peer_loan|Peer To Peer Loan|\n|personal_loan|Personal Loan|\n|personal_loan_secured|Personal Loan (Secured)|\n|personal_loan_unsecured|Personal Loan (Unsecured)|\n|public_liability|Public Liability|\n|student_loan|Student Loan|\n|will_trust_loan|Will Trust Loan|\n|loan_credit_unknown|Unknown|\n|boat|Boat|\n|collectible_art_other|Collectible/Art/Other|\n|land|Land|\n|motor_vehicle|Motor Vehicle|\n|other|Other|\n|own_business|Own Business|\n|property|Property|\n|property_btl|Property (Btl)|\n|property_investment|Property (Investment)|\n|property_rental|Property (Rental)|\n|property_other|Property (Other)|\n|property_overseas|Property (Overseas)|\n|fixed_asset_unknown|Unknown|","enum":["cash_account","cash_deposit","isa_mini_cash","isa_tessa_only","lifetime_isa_cash","national_savings","national_savings_child_bonus_bond","national_savings_fixed_interest_certificate","national_savings_guaranteed_equity_bond","national_savings_income_bond","national_savings_index_linked_certificate","national_savings_national_savings_certificate","national_savings_premium_bonds","cash_account_unknown","aim_investment_tax_service","bes","business_premises_renovation_allowance","child_trust_fund","collective_investment_account","commercial_property_purchase_scheme","debenture","discretionary_managed_service","employee_benefit_trust","enterprise_investment_scheme_non_regulated","enterprise_investment_scheme_regulated","enterprise_investment_zone_trust","enterprise_zone_syndicate","equity_holdings","exchange_traded_fund","exempt_property_unit_trust","film_partnership","geared_investments","general_investment_account","hedge_fund","investment_bond","investment_tax_service","investment_trust","isa_aim","isa_cash","isa_help_to_buy","isa_maxi","isa_maxi_mini_transfer","isa_mini_equity","isa_nisa","isa_stocks_and_shares","junior_isa_cash","junior_isa_nisa","junior_isa_stocks_and_shares","lifetime_isa_stocks_and_shares","maximum_investment_plan_investment","non_discretionary_managed_service","oeic_unit_trust","offshore_bond","offshore_deposit","offshore_oeic_fund","offshore_savings_plan","onshore_bond","personal_equity_plan","property_holdings","property_partnership","property_syndicate","residential_property_development","savings_account","seed_enterprise_investment_scheme_non_regulated","seed_enterprise_investment_scheme_regulated","share_incentive_plan","share_save_scheme","sicav","structured_plan","structured_plan_cash_isa","structured_plan_deposit","structured_plan_medium_term_note","structured_plan_stocks_shares_isa","tessa","trust","unit_trust","unregulated_collective_investments","venture_capital_trust_non_regulated","venture_capital_trust_regulated","wrap","investment_unknown","accident_and_sickness_insurance","accident_sickness_and_unemployment_insurance","accidental_death_insurance","business_loan_protection","capital_redemption_policy","death_in_service","endowment","flexible_plan","general_insurance_income_protection","gift_inter_vivos","health_assessment","income_protection","income_protection_executive","income_protection_key_person","life_settlement_fund","maximum_investment_plan","multi_benefit_protection","pension_contribution_insurance","pension_term_assurance","pre_paid_funeral_plan","redundancy_insurance","relevant_life_policy","renewable_convertible_term","term_protection","term_protection_convertible","term_protection_critical_illness","term_protection_decreasing_term","term_protection_decreasing_term_ci","term_protection_decreasing_term_life_ci","term_protection_directors_share_protection","term_protection_family_income_protection","term_protection_family_income_protection_ci","term_protection_family_income_protection_life_ci","term_protection_increasing_term","term_protection_key_person_assurance","term_protection_level","term_protection_level_ci","term_protection_level_life_ci","term_protection_mortgage_protection","term_protection_partnership_protection","term_protection_renewable","unemployment_insurance","whole_of_life","whole_of_life_non_investment","will","protection_policy_unknown","alternatively_secured_pension_plan","appropriate_personal_pension","avc","cimp","cimp_comp","comp","deferred_sipp","defined_benefit_pension","dependants_pension","efrbs","equivalent_pension_benefits","executive_pension_plan","family_sipp","final_salary_scheme","fsavc","furbs","group_cimp","group_comp","group_dependants_pension","group_offshore_pension_scheme","group_personal_pension","group_s32_buyout_bond","group_sipp","group_stakeholder_pension","income_drawdown_beneficiary","income_drawdown_capped","income_drawdown_flexi_access","income_drawdown_flexible","independent_retirement_advice","individual_retirement_account","inherited_independent_retirement_advice","junior_personal_pension_plan","master_trust_pension","money_purchase_contracted","national_employers_savings_trust","offshore_pension","pension_fund_withdrawal","personal_pension_plan","phased_retirement","pia_non_protected_rights","qnups","qnups_wrapper","qrops","qrops_wrapper","rnups_wrapper","roth_inherited_independent_retirement_advice","s226_rac","s32_buyout_bond","sipp","sipp_wrapper","ssas","stakeholder_individual","third_way_pensions","trustee_investment_plan","unsecured_pension","uurbs","workplace_pension_scheme","pension_unknown","annuity_non_pension","compulsory_purchase_life_annuity","deferred_annuity","defined_benefit_trustee_buy_in","enhanced_pension_annuity","fixed_term_annuity","group_final_salary","hancock_annuity","impaired_life_annuity","ivpp","lifetime_annuity","pension_annuity","pension_annuity_conventional","pension_annuity_flexible","pension_annuity_impaired_life","pension_annuity_temporary","pension_annuity_unit_linked","pension_annuity_with_profits","purchased_life_annuity","scheme_pension","annuity_unknown","dental_insurance","general_insurance_building","general_insurance_building_contents","general_insurance_commercial_combined","general_insurance_commercial_motor","general_insurance_contents","general_insurance_directors_and_officers","general_insurance_extended_warranty","general_insurance_legal_expenses","general_insurance_let_property","general_insurance_liability","general_insurance_other","general_insurance_payment_protection","general_insurance_private_motor","general_insurance_professional_indemnity","general_insurance_travel","group_travel_insurance","healthcare_cash_plan","international_private_medical_insurance","locum_insurance","long_term_care","long_term_care_immediate","long_term_care_pre_funded","private_medical_insurance","general_insurance_unknown","cpb","employee_assistance_scheme","flexible_benefits","group_accident_and_sickness","group_critical_illness","group_death_in_service","group_dental_insurance","group_healthcare_cash_plan","group_income_protection","group_income_protection_key_person","group_key_person_assurance","group_life","group_life_excepted","group_life_registered","group_partnership_protection","group_personal_accident","group_pmi","group_relevant_life","group_term","group_protection_unknown","equity_release","mortgage","mortgage_bridging_loan","mortgage_business_buy_to_let","mortgage_buy_to_let","mortgage_consumer_buy_to_let","mortgage_council_tenant_to_buy","mortgage_foreign_currency","mortgage_full_status","mortgage_further_advance","mortgage_government_home_ownership_scheme","mortgage_home_purchase_plan","mortgage_investment_property_islamic","mortgage_let_to_buy","mortgage_lifetime","mortgage_non_status","mortgage_primary_residence_islamic","mortgage_product_transfer","mortgage_remortgage","mortgage_right_to_buy","mortgage_second_charge","mortgage_second_home","mortgage_self_build","mortgage_self_cert","mortgage_shared_ownership","mortgage_standard_residential","mortgage_non_regulated_bridging_loan","mortgage_non_regulated_buy_to_let","mortgage_non_regulated_commercial","mortgage_non_regulated_further_advance","mortgage_non_regulated_offshore","mortgage_non_regulated_overseas","mortgage_non_regulated_product_transfer","third_party_mortgage","mortgage_unknown","bridging_loan","car_finance","commercial_finance","consumer_finance","credit_card","landlords","other_long_term_loan","overdraft","partner_loan","peer_to_peer_loan","personal_loan","personal_loan_secured","personal_loan_unsecured","public_liability","student_loan","will_trust_loan","loan_credit_unknown","boat","collectible_art_other","land","motor_vehicle","other","own_business","property","property_btl","property_investment","property_rental","property_other","property_overseas","fixed_asset_unknown"],"nullable":true}}},"App_Http_Requests_Plans_UpdatePlanOwnershipRequest":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"array","example":[],"description":"List of account ownership details.","items":{"type":"object","example":{"account_uuid":"4c627e86-afc0-40af-b923-824b84ffb01d","ownership_percentage":25.0},"properties":{"account_uuid":{"type":"string","example":"4c627e86-afc0-40af-b923-824b84ffb01d","description":"The account UUID of the owner.","format":"uuid"},"ownership_percentage":{"type":"number","example":25.0,"description":"The ownership percentage for this account. If omitted, the ownership will be assumed to be equal among all accounts.","format":"float","minimum":0.0,"maximum":100.0,"nullable":true}}}}}},"App_Http_Requests_Plans_StoreValuationRequest":{"type":"object","required":["valued_at","value"],"properties":{"valued_at":{"type":"string","example":"2026-05-08","description":"Date the valuation was valued at","format":"date"},"value":{"type":"integer","example":4000,"description":"Money value of the valuation as an integer eg 4000 = £40.00"}}},"App_Http_Requests_Plans_UpdateValuationRequest":{"type":"object","required":["value"],"properties":{"value":{"type":"integer","example":4000,"description":"Money value of the valuation as an integer eg 4000 = £40.00"}}},"App_Http_Requests_Contribution_StoreContributionRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"recurring","description":"|\n\nThe type of contribution. Available options: recurring and adhoc\n\n| Value | Description |\n| ----- | ----------- |\n|recurring|Recurring|\n|adhoc|Adhoc|","enum":["recurring","adhoc"]},"contributor_type":{"type":"string","example":"self","description":"|\n\nThe type of contributor. Available options: self, employer, family, government, salary_sacrifice and other\n\n| Value | Description |\n| ----- | ----------- |\n|self|Self|\n|employer|Employer|\n|family|Family|\n|government|Government|\n|salary_sacrifice|Salary Sacrifice|\n|other|Other|","enum":["self","employer","family","government","salary_sacrifice","other"]},"frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency of the contribution. Required if the contribution type is \"recurring\". Available options: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"started_at":{"type":"string","example":"2026-04-08","description":"The start date of a recurring contribution. Required if the contribution type is \"recurring\".","format":"date"},"ended_at":{"type":"string","example":"2026-05-08","description":"The end date of a recurring contribution. Required if the contribution type is \"recurring\".","format":"date"},"paid_at":{"type":"string","example":"2026-05-08","description":"The date the adhoc contribution was paid. Required if the contribution type is \"adhoc\".","format":"date"},"value":{"type":"integer","example":4000,"description":"The value of the contribution in pennies. For example, £40.00 would be 4000."},"notes":{"type":"string","example":"Example Notes","description":"Optional notes to add to the contribution."}}},"App_Http_Requests_Contribution_UpdateContributionRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"recurring","description":"|\n\nThe type of contribution. Available options: recurring and adhoc\n\n| Value | Description |\n| ----- | ----------- |\n|recurring|Recurring|\n|adhoc|Adhoc|","enum":["recurring","adhoc"]},"contributor_type":{"type":"string","example":"self","description":"|\n\nThe type of contributor. Available options: self, employer, family, government, salary_sacrifice and other\n\n| Value | Description |\n| ----- | ----------- |\n|self|Self|\n|employer|Employer|\n|family|Family|\n|government|Government|\n|salary_sacrifice|Salary Sacrifice|\n|other|Other|","enum":["self","employer","family","government","salary_sacrifice","other"]},"frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency of the contribution. Required if the contribution type is \"recurring\". Available options: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"started_at":{"type":"string","example":"2026-04-08","description":"The start date of a recurring contribution. Required if the contribution type is \"recurring\".","format":"date"},"ended_at":{"type":"string","example":"2026-05-08","description":"The end date of a recurring contribution. Required if the contribution type is \"recurring\".","format":"date"},"paid_at":{"type":"string","example":"2026-05-08","description":"The date the adhoc contribution was paid. Required if the contribution type is \"adhoc\".","format":"date"},"value":{"type":"integer","example":4000,"description":"The value of the contribution in pennies. For example, £40.00 would be 4000."},"notes":{"type":"string","example":"Example Notes","description":"Optional notes to add to the contribution."}}},"App_Http_Requests_Withdrawal_StoreWithdrawalRequest":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","example":"recurring","description":"The type of withdrawal. Available options: recurring and adhoc"},"frequency":{"type":"string","example":"monthly","description":"The frequency of the withdrawal. Available options: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off"},"started_at":{"type":"string","example":"2026-04-08","description":"The start date of a recurring withdrawal. Required if the withdrawal type is \"recurring\".","format":"date"},"ended_at":{"type":"string","example":"2026-05-08","description":"The end date of a recurring withdrawal. Required if the withdrawal type is \"recurring\".","format":"date"},"withdrawn_at":{"type":"string","example":"2026-05-08","description":"The date the withdrawal was made. Required if the withdrawal type is \"adhoc\".","format":"date"},"value":{"type":"integer","example":50000,"description":"The value of the withdrawal."},"notes":{"type":"string","example":"Example Notes","description":"Notes about the withdrawal."}}},"App_Http_Requests_Withdrawal_UpdateWithdrawalRequest":{"type":"object","required":["value"],"properties":{"type":{"type":"string","example":"recurring","description":"The type of withdrawal. Available options: recurring and adhoc"},"frequency":{"type":"string","example":"monthly","description":"The frequency of the withdrawal. Available options: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off"},"started_at":{"type":"string","example":"2026-04-08","description":"The start date of a recurring withdrawal. Required if the withdrawal type is \"recurring\".","format":"date"},"ended_at":{"type":"string","example":"2026-05-08","description":"The end date of a recurring withdrawal. Required if the withdrawal type is \"recurring\".","format":"date"},"withdrawn_at":{"type":"string","example":"2026-05-08","description":"The date the withdrawal was made. Required if the withdrawal type is \"adhoc\".","format":"date"},"value":{"type":"integer","example":50000,"description":"The value of the withdrawal."},"notes":{"type":"string","example":"Example Notes","description":"Notes about the withdrawal."}}},"App_Http_Requests_Plans_StoreHoldingRequest":{"type":"object","required":["fund_name","units"],"properties":{"fund_name":{"type":"string","example":"My Fund","description":"The name of the fund for the holding."},"reference":{"type":"string","example":"ABC12345","description":"The reference of the holding/fund."},"provider":{"type":"string","example":"Financial Provider","description":"The provider of the holding/fund."},"sector":{"type":"string","example":"Europe","description":"The sector of the holding/fund."},"sedol":{"type":"string","example":"ABC12345","description":"The SEDOL of the holding/fund."},"isin":{"type":"string","example":"ABC12345","description":"The ISIN of the holding/fund."},"citi":{"type":"string","example":"ABC12345","description":"The CITI of the holding/fund."},"units":{"type":"number","example":10.0,"description":"The units of the holding","format":"float"},"unit_price":{"type":"integer","example":10000,"description":"The current price of the units in pennies."},"unit_price_raw":{"type":"number","example":100.2334234,"description":"The current price of the units in it's raw format with decimals.","format":"float"},"purchase_price":{"type":"integer","example":5000,"description":"The original purchase price of the holding in pennies."},"currency":{"type":"string","example":"GBP","description":"The currency of the holding."},"is_active":{"type":"boolean","example":true,"description":"Denotes if the holding is active/inactive."},"portfolio_uuid":{"type":"string","example":"2b945cb7-8681-47bd-9c67-fff979472126","description":"Optional UUID of a portfolio to add the holding to.","format":"uuid"}}},"App_Http_Requests_Plans_UpdateHoldingRequest":{"type":"object","properties":{"fund_name":{"type":"string","example":"My Fund","description":"The name of the fund for the holding."},"reference":{"type":"string","example":"ABC12345","description":"The reference of the holding/fund."},"provider":{"type":"string","example":"Financial Provider","description":"The provider of the holding/fund."},"sector":{"type":"string","example":"Europe","description":"The sector of the holding/fund."},"sedol":{"type":"string","example":"ABC12345","description":"The SEDOL of the holding/fund."},"isin":{"type":"string","example":"ABC12345","description":"The ISIN of the holding/fund."},"citi":{"type":"string","example":"ABC12345","description":"The CITI of the holding/fund."},"units":{"type":"number","example":10.0,"description":"The units of the holding","format":"float","minimum":0.0,"maximum":999999.999999},"unit_price":{"type":"integer","example":10000,"description":"The current price of the units in pennies."},"unit_price_raw":{"type":"number","example":100.2334234,"description":"The current price of the units in it's raw format with decimals.","format":"float"},"purchase_price":{"type":"integer","example":5000,"description":"The original purchase price of the holding in pennies."},"currency":{"type":"string","example":"GBP","description":"The currency of the holding."},"is_active":{"type":"boolean","example":true,"description":"Denotes if the holding is active/inactive."},"portfolio_uuid":{"type":"string","example":"38d46979-2da6-43c5-bf1b-b8e56ca074ed","description":"Optional UUID of a portfolio to add the holding to.","format":"uuid"}}},"App_Http_Requests_StorePortfolioRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Risky Portfolio","description":"The name of the portfolio. Must be unique within the sub-account it is created on."},"is_proposed":{"type":"boolean","example":false,"description":"Denotes if the portfolio is proposed"},"proposed_at":{"type":"string","example":"2023-09-25","description":"The proposed date of the portfolio. When omitted from the request the proposed date will be the date of creation.","format":"date"}}},"App_Http_Requests_UpdatePortfolioRequest":{"type":"object","properties":{"name":{"type":"string","example":"Risky Portfolio","description":"The name of the portfolio. Must be unique within the sub-account it is created on."},"is_proposed":{"type":"boolean","example":false,"description":"Denotes if the portfolio is proposed"},"proposed_at":{"type":"string","example":"2023-09-25","description":"The proposed date of the portfolio.","format":"date"}}},"App_Http_Requests_Plans_SyncHoldingsRequest":{"type":"object","required":["holdings"],"properties":{"holdings":{"type":"array","example":[],"description":"Holdings array to sync. all other holdings on this sub account will be marked as inactive","items":{"$ref":"#/components/schemas/SubAccountHolding"}},"portfolio_name":{"type":"string","example":"Proposed Holdings 2023","description":"Optional name of the portfolio when the holdings are synced"},"is_proposed_portfolio":{"type":"boolean","example":true,"description":"Denotes if the portfolio that is created should be proposed or not."}}},"App_Http_Requests_Plans_ShowValuationsGraphRequest":{"type":"object","properties":{"start_date":{"type":"string","example":"2026-05-08","description":"The start date for the valuations graph in YYYY-MM-DD format. Optional.","format":"date"},"end_date":{"type":"string","example":"2026-05-09","description":"The end date for the valuations graph in YYYY-MM-DD format. Optional.","format":"date"},"limit":{"type":"integer","example":4259,"description":"The maximum number of data points to return for the valuations graph. Optional.","minimum":1,"maximum":0},"account_uuid":{"type":"string","example":"3c0073f2-3bbb-4cb7-9611-435da21219c7","description":"The UUID of the client account to filter valuations by. Optional.","format":"uuid"}}},"App_Http_Requests_Plans_StoreGroupSchemeMemberRequest":{"type":"object","required":["account_uuid","status"],"properties":{"account_uuid":{"type":"string","example":"9c58b5d8-a88e-46fb-bd50-144f01174423","description":"The client account that will be the member on the group scheme. Must already be a staff member on the business client that the plan belongs to.","format":"uuid"},"status":{"type":"string","example":"active","description":"|\n\nPlan status for the member.\n\n| Value | Description |\n| ----- | ----------- |\n|active|Active|\n|inactive|Inactive|\n|proposed|Proposed|","enum":["active","inactive","proposed"]},"inactive_status":{"type":"string","example":"accepted","description":"|\n\nOptional inactive status when the status is inactive.\n\n| Value | Description |\n| ----- | ----------- |\n|accepted|Accepted|\n|agency_transferred|Agency Transferred|\n|cancelled|Cancelled|\n|claimed|Claimed|\n|complete|Complete|\n|death_event|Death Event|\n|deferred|Deferred|\n|drawdown|Drawdown|\n|expired|Expired|\n|full_drawdown|Full Drawdown|\n|issued|Issued|\n|lapsed|Lapsed|\n|matured|Matured|\n|not_proceeded_with|Not Proceeded With|\n|not_taken_up|Not Taken Up|\n|offered|Offered|\n|paid_up|Paid Up|\n|partial_drawdown|Partial Drawdown|\n|partial_surrender|Partial Surrender|\n|proposed|Proposed|\n|prospect|Prospect|\n|refunded|Refunded|\n|refused|Refused|\n|surrendered|Surrendered|\n|transfer|Transfer|\n|transferred|Transferred|\n|underwriting|Underwriting|\n|vested|Vested|\n|declined|Declined|\n|encashment|Encashment|\n|left_service|Left Service|\n|premium_holiday|Premium Holiday|\n|other|Other|","enum":["accepted","agency_transferred","cancelled","claimed","complete","death_event","deferred","drawdown","expired","full_drawdown","issued","lapsed","matured","not_proceeded_with","not_taken_up","offered","paid_up","partial_drawdown","partial_surrender","proposed","prospect","refunded","refused","surrendered","transfer","transferred","underwriting","vested","declined","encashment","left_service","premium_holiday","other"]},"policy_number":{"type":"string","example":"AVIVA-123","description":"Optional policy number if the group scheme has separate policy numbers per member.","maxLength":255},"on_risk_at":{"type":"string","example":"2023-03-26","description":"Date when the policy went \"on risk\".","format":"date","nullable":true},"inactive_at":{"type":"string","example":"2024-03-26","description":"Date when the policy was made inactive.","format":"date"},"pensionable_salary":{"type":"integer","example":7000000,"description":"Optional \"pensionable\" salary used for group scheme pensions. Value must be in pennies for example £70,000 is 7000000"},"workplace_location":{"type":"string","example":"London","description":"Optional workplace location for the group scheme member."},"employment_division":{"type":"string","example":"Management","description":"Optional employment division for the group scheme member."}}},"App_Http_Requests_Plans_StoreSubGroupSchemeRequest":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","example":"Families","description":"The name for the sub-scheme","maxLength":255},"status":{"type":"string","example":"active","description":"|\n\nPlan status for the member.\n\n| Value | Description |\n| ----- | ----------- |\n|active|Active|\n|inactive|Inactive|\n|proposed|Proposed|","enum":["active","inactive","proposed"]},"inactive_status":{"type":"string","example":"accepted","description":"|\n\nOptional inactive status when the status is inactive.\n\n| Value | Description |\n| ----- | ----------- |\n|accepted|Accepted|\n|agency_transferred|Agency Transferred|\n|cancelled|Cancelled|\n|claimed|Claimed|\n|complete|Complete|\n|death_event|Death Event|\n|deferred|Deferred|\n|drawdown|Drawdown|\n|expired|Expired|\n|full_drawdown|Full Drawdown|\n|issued|Issued|\n|lapsed|Lapsed|\n|matured|Matured|\n|not_proceeded_with|Not Proceeded With|\n|not_taken_up|Not Taken Up|\n|offered|Offered|\n|paid_up|Paid Up|\n|partial_drawdown|Partial Drawdown|\n|partial_surrender|Partial Surrender|\n|proposed|Proposed|\n|prospect|Prospect|\n|refunded|Refunded|\n|refused|Refused|\n|surrendered|Surrendered|\n|transfer|Transfer|\n|transferred|Transferred|\n|underwriting|Underwriting|\n|vested|Vested|\n|declined|Declined|\n|encashment|Encashment|\n|left_service|Left Service|\n|premium_holiday|Premium Holiday|\n|other|Other|","enum":["accepted","agency_transferred","cancelled","claimed","complete","death_event","deferred","drawdown","expired","full_drawdown","issued","lapsed","matured","not_proceeded_with","not_taken_up","offered","paid_up","partial_drawdown","partial_surrender","proposed","prospect","refunded","refused","surrendered","transfer","transferred","underwriting","vested","declined","encashment","left_service","premium_holiday","other"]},"policy_number":{"type":"string","example":"AVIVA-123","description":"Optional policy number if the sub scheme has separate policy numbers per member.","maxLength":255,"nullable":true},"inactive_at":{"type":"string","example":"2024-03-26","description":"Date when the policy was made inactive.","format":"date","nullable":true},"on_risk_at":{"type":"string","example":"2023-03-26","description":"Date when the policy went \"on risk\".","format":"date","nullable":true},"employer_percentage":{"type":"number","example":1.24,"description":"Employer percentage being paid in to pension plan.","format":"float","minimum":0.0,"maximum":100.0},"employer_frequency":{"type":"string","example":"monthly","description":"Frequency of the employer percentage being paid in to pension plan."},"employee_percentage":{"type":"number","example":9.65,"description":"Employee percentage being paid in to pension plan.","format":"float","minimum":0.0,"maximum":100.0},"employee_frequency":{"type":"string","example":"daily","description":"|\n\nFrequency of the employee percentage being paid in to pension plan.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]}}},"App_Http_Requests_Automation_StoreAutomationBlueprintRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Add a new client to system on calendly webhook","description":"Name of the automation"},"trigger":{"type":"string","example":"webhook","description":"What triggers this automation, leave null if activation is manual"},"is_active":{"type":"boolean","example":false,"description":"Is this automation currently active, defaults to false"},"conditions":{"type":"array","example":[{"field":"client.is_prospect","operator":"equals","value":true}],"description":"List of conditions to evaluate on the trigger before running automation, operator types can be on ofequals, not_equal_to, more_than, less_than, less_than_or_equal_to and more_than_or_equal_to"},"configuration":{"type":"array","example":[],"description":"Extra configuration options for the trigger of this blueprint"}}},"App_Http_Requests_Automation_UpdateAutomationBlueprintRequest":{"type":"object","properties":{"name":{"type":"string","example":"Add a new client to system on calendly webhook","description":"Name of the automation"},"trigger":{"type":"string","example":"webhook","description":"What triggers this automation"},"is_active":{"type":"boolean","example":false,"description":"Is this automation currently active"},"conditions":{"type":"array","example":[],"description":"List of conditions to evaluate on the trigger before running automation, operator types can be on ofequals, not_equal_to, more_than, less_than, less_than_or_equal_to and more_than_or_equal_to","items":{"type":"object","example":[{"field":"client.is_prospect","operator":"equals","value":true}],"properties":{"field":{"type":"string","example":"client.is_prospect","description":"field name for the condition"},"operator":{"type":"string","example":"equals","description":"|\n\noperator for the condition\n\n| Value | Description |\n| ----- | ----------- |\n|equals|Equals|\n|not_equal_to|Not Equal To|\n|more_than|More Than|\n|less_than|Less Than|\n|less_than_or_equal_to|Less Than Or Equal To|\n|more_than_or_equal_to|More Than Or Equal To|","enum":["equals","not_equal_to","more_than","less_than","less_than_or_equal_to","more_than_or_equal_to"]},"value":{"type":"string","example":"true","description":"value for condition to check against"}}}},"configuration":{"type":"object","description":"Extra configuration options for the trigger of this blueprint","additionalProperties":true}}},"App_Http_Requests_Automation_TriggerAutomationRequest":{"type":"object","required":["client_uuid"],"properties":{"client_uuid":{"type":"string","example":"faaabf00-efae-4c6f-a165-47de35ce77a1","description":"The client to pass into the automation instance","format":"uuid"}}},"App_Http_Requests_Automation_StoreBlueprintStepRequest":{"type":"object","required":["name","type","configuration"],"properties":{"name":{"type":"string","example":"send an email","description":"Name of the automation step "},"type":{"type":"string","example":"mail.send","description":"Must be a verified action type or a condition"},"configuration":{"type":"array","example":{"params":{"account_uuid":{"type":"ref","value":"trigger.account.uuid"}}},"description":"Configuration options for this step, requirements depend on type"},"parent_step_uuid":{"type":"string","example":null,"description":"Uuid of the step that run before this step, if the parent step is a condition type then a condition state must be given"},"condition_state":{"type":"boolean","example":true,"description":"Only required if parent step is a condition, the condition state will determine if this step runs in the true branch or the false branch of the parent condition"}}},"App_Http_Requests_Automation_UpdateBlueprintStepRequest":{"type":"object","required":["configuration"],"properties":{"name":{"type":"string","example":"send an email","description":"Name of the automation step"},"type":{"type":"string","example":"mail.send","description":"must be a verified action type or a condition"},"configuration":{"type":"object","description":"Configuration options for this step, requirements depend on type","example":{"params":{"account_uuid":{"type":"ref","value":"trigger.account.uuid"}}},"properties":{"params":{"type":"array","example":[],"description":"List of parameters for this step","items":{"type":"object","example":{"type":"ref","value":"trigger.account.uuid"},"properties":{"type":{"type":"string","example":"ref","description":"The type of parameter, either ref or const","enum":["ref","const"]},"value":{"type":"string","example":"trigger.account.uuid","description":"The value of the parameter, either a reference to another step or a constant value"}}}}}},"parent_step_uuid":{"type":"string","example":"0ee9c5e2-5f03-45b4-b305-7e32403af597","description":"Uuid of the step that run before this step, if the parent step is a condition type then a condition state must be given","format":"uuid"},"condition_state":{"type":"boolean","example":true,"description":"Only required if parent step is a condition, the condition state will determine if this step runs in the true branch or the false branch of the parent condition"}}},"App_Http_Requests_FactFind_StoreFactFindSchemaRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Mortgage Client Fact Find","description":"The name of the fact find schema. Must be unique."},"introduction_html":{"type":"string","example":"Welcome to our fact find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e","description":"The name of the fact find schema. Must be unique."}}},"App_Http_Requests_FactFind_UpdateFactFindSchemaRequest":{"type":"object","properties":{"name":{"type":"string","example":"Mortgage Client Fact Find","description":"The name of the fact find schema. Must be unique."},"introduction_html":{"type":"string","example":"Welcome to our fact find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e","description":"The name of the fact find schema. Must be unique."}}},"App_Http_Requests_FactFind_StoreFactFindSchemaSectionRequest":{"type":"object","required":["name","front_end_section"],"properties":{"name":{"type":"string","example":"Basic Details","description":"The name of the fact find schema section. Must be unique."},"front_end_section":{"type":"string","example":"basic_details","description":"|\n\nThe reference to the Plannr front-end. Must be unique.\n\n| Value | Description |\n| ----- | ----------- |\n|basic_details|Basic Details|\n|be_iq_profiler|Be Iq Profiler|\n|contact_details|Contact Details|\n|debt|Debt|\n|dependants|Dependants|\n|employment|Employment|\n|employment_and_income|Employment And Income|\n|estate|Estate|\n|expenses|Expenses|\n|fixed_assets|Fixed Assets|\n|goals|Goals|\n|health|Health|\n|income|Income|\n|introduction|Introduction|\n|investments|Investments|\n|personal_details|Personal Details|\n|plans|Plans|\n|property|Property|\n|protection|Protection|\n|state_pension|State Pension|\n|summary|Summary|\n|vulnerability|Vulnerability|","enum":["basic_details","be_iq_profiler","contact_details","debt","dependants","employment","employment_and_income","estate","expenses","fixed_assets","goals","health","income","introduction","investments","personal_details","plans","property","protection","state_pension","summary","vulnerability"]},"introduction_html":{"type":"string","example":"\u003cp\u003ePlease tell us your \u003cb\u003ebasic details.\u003c/b\u003e\u003c/p\u003e","description":"The HTML that should be displayed on the section."}}},"App_Http_Requests_FactFind_UpdateFactFindSchemaSectionRequest":{"type":"object","properties":{"name":{"type":"string","example":"Basic Details","description":"The name of the fact find schema section. Must be unique."},"front_end_section":{"type":"string","example":"basic_details","description":"|\n\nThe reference to the Plannr front-end. Must be unique.\n\n| Value | Description |\n| ----- | ----------- |\n|basic_details|Basic Details|\n|be_iq_profiler|Be Iq Profiler|\n|contact_details|Contact Details|\n|debt|Debt|\n|dependants|Dependants|\n|employment|Employment|\n|employment_and_income|Employment And Income|\n|estate|Estate|\n|expenses|Expenses|\n|fixed_assets|Fixed Assets|\n|goals|Goals|\n|health|Health|\n|income|Income|\n|introduction|Introduction|\n|investments|Investments|\n|personal_details|Personal Details|\n|plans|Plans|\n|property|Property|\n|protection|Protection|\n|state_pension|State Pension|\n|summary|Summary|\n|vulnerability|Vulnerability|","enum":["basic_details","be_iq_profiler","contact_details","debt","dependants","employment","employment_and_income","estate","expenses","fixed_assets","goals","health","income","introduction","investments","personal_details","plans","property","protection","state_pension","summary","vulnerability"]},"introduction_html":{"type":"string","example":"\u003cp\u003ePlease tell us your \u003cb\u003ebasic details.\u003c/b\u003e\u003c/p\u003e","description":"The HTML that should be displayed on the section."},"position":{"type":"integer","example":1,"description":"The position/order of the section"}}},"App_Http_Requests_FactFind_GenerateFactFindPdfRequest":{"type":"object","required":["client_uuid"],"properties":{"client_uuid":{"type":"string","example":"40473846-bd6a-4351-8658-58641db2651d","description":"The UUID of the client.","format":"uuid"}}},"App_Http_Requests_FactFind_UpdateSectionProgressRequest":{"type":"object","required":["fact_find_pass_uuid","is_complete"],"properties":{"fact_find_pass_uuid":{"type":"string","example":"913fb6f0-3673-4fce-be3a-92e20a5c56d5","description":"The fact find pass that is completing the fact find.","format":"uuid"},"is_complete":{"type":"boolean","example":true,"description":"Determines if the section is complete."}}},"App_Http_Requests_FactFind_StoreFactFindRequestRequest":{"type":"object","required":["fact_find_schema_uuid","client_uuid","circle_uuid"],"properties":{"fact_find_schema_uuid":{"type":"string","example":"ba59fbd0-12ae-4001-b7e9-ac7a5bd0ab8e","description":"The UUID of the fact find schema that you would like the client to use.","format":"uuid"},"client_uuid":{"type":"string","example":"e039f684-30b4-4cdf-b4af-89c60bb387e9","description":"The UUID of the client account to send the fact find request. This must only be individual clients. Cannot be used with circle_uuid.","format":"uuid"},"circle_uuid":{"type":"string","example":"8b921d7f-d3c8-40a8-8b31-c6bdbc30f2ac","description":"The UUID of the circle to send the fact find request to. Cannot be used with client_uuid.","format":"uuid"},"send_invitation_email":{"type":"boolean","example":true,"description":"This controls if an email to the client is sent to invite them to complete a fact find. Set this to false if you are going to send your own invitation."},"invitation_text":{"type":"string","example":"Please complete this fact find.","description":"The text that will appear in the invitation email sent to the client (if enabled)"}}},"App_Http_Requests_FactFind_CompleteFactFindRequest":{"type":"object","required":["fact_find_pass_uuid"],"properties":{"fact_find_pass_uuid":{"type":"string","example":"0ff922b9-c435-4d38-a366-7ad4345765aa","description":"The fact find pass that is completing the fact find.","format":"uuid"}}},"App_Http_Requests_FactFind_CreateAccountOnFactFindRequest":{"type":"object","required":["first_name","last_name","email"],"properties":{"first_name":{"type":"string","example":"John","description":"First name"},"last_name":{"type":"string","example":"Doe","description":"Last name"},"email":{"type":"string","example":"email@example.com","description":"Email address","format":"email"},"relationship":{"type":"string","example":"Spouse","description":"Relationship to the primary account holder"},"inverse_relationship":{"type":"string","example":"Self","description":"Relationship to the secondary account holder"}}},"App_Http_Requests_IncomeReconciliation_UploadProviderStatementRequest":{"type":"object","required":["statement_uuid","provider_uuid","date","statement_transactions"],"properties":{"statement_uuid":{"type":"string","example":"940242e5-ea19-431c-968c-7be6ea31d4b0","description":"Payment period statement UUID, must be unlocked.","format":"uuid"},"provider_uuid":{"type":"string","example":"74dcacaa-3a57-4112-b95f-c827b2687be8","description":"Provider UUID","format":"uuid"},"date":{"type":"string","example":"2026-05-08","description":"Provider statement date","format":"date"},"reference":{"type":"string","example":"SW#8434","description":"Statement reference given by provider"},"statement_transactions":{"type":"array","example":[],"description":"An array of statement_transactions. Required data are policy_number, gross_amount, and category. If expected payments date is not provided it will use the provider statement date. All amounts must be in pennies. Valid category values are: adhoc, administration, adjustment, bond_renewal, clawback, dss_rebate, fund, indemnity, initial_fee, level, non_indemnity, one_off, ongoing_fee, other_fee, procuration_fee, protected_rights, renewal, switch and unknown. Can also provide extra metadata which can be the rest of the columns of the provider statement.","items":{"type":"object","example":[{"client_name":"Gareth Thompson","policy_number":"AVIVA_0001","date":"2026-05-06","gross_amount":15000,"net_amount":15000,"transaction_reference":"Gxp1ngyF","agency_number":"YpNT9WLF","product_reference":"zmK3ID4P","category":"ongoing_fee","adviser_name":"Bill Gates","sender_id_sib_number":"Sender ID/SIB number","reason":"Provider Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","metadata":{"sub_reference":"GPS7m","postcode":"SW1A 2AA"}},{"client_first_name":"Barry","client_last_name":"Allen","policy_number":"AVIVA_0002","gross_amount":8999,"category":"renewal","adviser_first_name":"Bruce","adviser_last_name":"Wayne"}],"properties":{"policy_number":{"type":"string","example":"AVIVA_0001","description":"Policy number associated with the transaction."},"gross_amount":{"type":"integer","example":15000,"description":"Gross amount of the transaction in pennies."},"category":{"type":"string","example":"adhoc","description":"|\n\nCategory of the charge.\n\n| Value | Description |\n| ----- | ----------- |\n|adhoc|Adhoc|\n|administration|Administration|\n|adjustment|Adjustment|\n|bond_renewal|Bond Renewal|\n|clawback|Clawback|\n|dss_rebate|Dss Rebate|\n|fund|Fund|\n|indemnity|Indemnity|\n|initial_fee|Initial Fee|\n|level|Level|\n|non_indemnity|Non Indemnity|\n|one_off|One Off|\n|ongoing_fee|Ongoing Fee|\n|other_fee|Other Fee|\n|procuration_fee|Procuration Fee|\n|protected_rights|Protected Rights|\n|renewal|Renewal|\n|switch|Switch|\n|unknown|Unknown|","enum":["adhoc","administration","adjustment","bond_renewal","clawback","dss_rebate","fund","indemnity","initial_fee","level","non_indemnity","one_off","ongoing_fee","other_fee","procuration_fee","protected_rights","renewal","switch","unknown"]},"client_name":{"type":"string","example":"Gareth Thompson","description":"Name of the client associated with the transaction."},"date":{"type":"string","example":"2026-05-06","description":"Date of the transaction. If not provided the provider statement date will be used.","format":"date"},"net_amount":{"type":"integer","example":15000,"description":"Net amount of the transaction in pennies."},"transaction_reference":{"type":"string","example":"TRX123456","description":"Transaction reference provided by the provider."},"agency_number":{"type":"string","example":"AGENCY123","description":"Agency number associated with the transaction."},"product_reference":{"type":"string","example":"PROD456","description":"Product reference associated with the transaction."},"adviser_name":{"type":"string","example":"Bill Gates","description":"Name of the adviser associated with the transaction."},"sender_id_sib_number":{"type":"string","example":"Sender ID/SIB number","description":"Sender ID or SIB number associated with the transaction."},"reason":{"type":"string","example":"Provider Reason","description":"Reason for the transaction provided by the provider."},"scheme_name":{"type":"string","example":"Scheme name","description":"Scheme name associated with the transaction."},"scheme_number":{"type":"string","example":"Scheme number","description":"Scheme number associated with the transaction."},"customer_number":{"type":"string","example":"Customer number","description":"Customer number associated with the transaction."},"policy_market_value":{"type":"string","example":"Policy market value","description":"Market value of the policy associated with the transaction."},"metadata":{"type":"object","description":"Extra metadata which can be the rest of the columns of the provider statement.","additionalProperties":true}}}},"category_mapper":{"type":"object","description":"Array to convert statement transactions category in to a valid category for Plannr. Array key is original csv category value and array element is valid Plannr category. Valid Plannr categories are: adhoc, administration, adjustment, bond_renewal, clawback, dss_rebate, fund, indemnity, initial_fee, level, non_indemnity, one_off, ongoing_fee, other_fee, procuration_fee, protected_rights, renewal, switch and unknown","example":{"ADVISERFEE":"adhoc","PAYMENT":"initial"},"additionalProperties":true},"filename":{"type":"string","example":"provider-statement_transactions-2022-04-05.csv","description":"Filename of the CSV import statement_transactions."}}},"App_Http_Requests_IncomeReconciliation_ImportProviderStatementRequest":{"type":"object","required":["import_file","provider_statement","mapping","parameters"],"properties":{"import_file":{"type":"string","example":"file-contents","description":"The provider statement file csv.","format":"binary"},"provider_statement":{"type":"array","example":[],"description":"An array of provider statement properties.","items":{"type":"object","example":{"provider_statement":{"statement_uuid":null,"provider_uuid":null,"date":"2025-07-11","name":"July Statement","reference":"Aviva AV#834","origin":"upload"}},"properties":{"statement_uuid":{"type":"string","example":"0c6e0f9b-b1db-4ac6-9517-9de415cb918f","description":"The uuid of the statement this refers to.","format":"uuid"},"provider_uuid":{"type":"string","example":"903f545f-cbb5-424d-8380-52b576aa856d","description":"The uuid of the provider.","format":"uuid"},"date":{"type":"string","example":"2026-05-06","description":"Date of the provider statement.","format":"date"},"name":{"type":"string","example":"January Statement","description":"Name of the provider statement.","nullable":true},"reference":{"type":"string","example":"ABC123","description":"Reference of the provider statement.","nullable":true},"origin":{"type":"string","example":"edi","description":"|\n\nThe origin of the provider statement.\n\n| Value | Description |\n| ----- | ----------- |\n|edi|Edi|\n|manual|Manual|\n|upload|Upload|\n|auto|Auto|","enum":["edi","manual","upload","auto"],"nullable":true}}}},"mapping":{"type":"object","description":"Array of mappings for the provider statement import. This defines how the columns in the CSV file map to the fields in the system.","example":{"adviser_name":"adviser_name","agency_number":"agency_number","client_name":"client_name","customer_number":"customer_number","date":"date","gross_amount":"gross_amount","net_amount":"net_amount","policy_number":"policy_number","product_reference":"product_reference","scheme_name":"scheme_name","scheme_number":"scheme_number","sender_id_sib_number":"sender_id_sib_number","transaction_reference":"transaction_reference","category":"revenue_type"},"additionalProperties":true},"parameters":{"type":"array","example":[],"description":"Array of additional data to complete the request.","items":{"type":"object","example":{"parameters":{"revenue_type_mapping":{"ADJ":"adjustment","IF":"initial_fee"}}},"properties":{"revenue_type_mapping":{"type":"object","description":"Mapping of revenue types for the provider statement import. This defines how the revenue types in the CSV file map to the charge categories in the system.","example":{"ADJ":"adjustment","IF":"initial_fee"},"additionalProperties":true}}}}}},"App_Http_Requests_IncomeReconciliation_StoreProviderStatementRequest":{"type":"object","required":["statement_uuid","provider_uuid","date"],"properties":{"statement_uuid":{"type":"string","example":"f50a29ad-1dd7-414f-bc5b-9f1988405f1c","description":"Payment period statement UUID","format":"uuid"},"provider_uuid":{"type":"string","example":"6a9544c2-666f-4f85-bb57-c3d0f07feb4c","description":"Provider UUID","format":"uuid"},"date":{"type":"string","example":"2026-05-08","description":"Statement date","format":"date"},"name":{"type":"string","example":"Aviva Statement #3894","description":"Optional title to name the provider statement. If null an auto generated name will be created as provider name and statement date."},"reference":{"type":"string","example":"SW#8434","description":"Statement reference given by provider"}}},"App_Http_Requests_IncomeReconciliation_UpdateProviderStatementRequest":{"type":"object","properties":{"date":{"type":"string","example":"2026-05-08","description":"Statement date","format":"date"},"name":{"type":"string","example":"Aviva Statement #3894","description":"Optional title to name the provider statement. If null a auto generated name will be created as provider name and statement date."},"reference":{"type":"string","example":"SW#8434","description":"Statement reference given by provider"}}},"App_Http_Requests_IncomeReconciliation_UploadBankStatementRequest":{"type":"object","required":["statement_uuid","date","bank_transactions"],"properties":{"statement_uuid":{"type":"string","example":"ddca0ce0-f63c-44f9-874a-938bbbd93918","description":"Payment period statement UUID, must be unlocked.","format":"uuid"},"date":{"type":"string","example":"2026-05-08","description":"Bank statement date","format":"date"},"reference":{"type":"string","example":"Natwest Statement #8434","description":"Statement reference given by bank"},"bank_transactions":{"type":"array","example":[],"description":"An array of payments on a bank statement. All statement transactions amounts must be in pennies.","items":{"type":"object","example":[{"date":"2022-07-15","amount":12345,"reference":"AvivaRef#34"},{"date":"2022-07-14","amount":19855,"reference":"VIT_LTD"}],"properties":{"date":{"type":"string","example":"2022-07-15","description":"The date of the bank transaction.","format":"date"},"amount":{"type":"integer","example":19855,"description":"The amount of the bank transaction in pennies."},"reference":{"type":"string","example":"AvivaRef#34","description":"The reference of the bank transaction."}}}},"filename":{"type":"string","example":"natwest-statement-2022-04-05.csv","description":"Filename of the CSV import payments."}}},"App_Http_Requests_IncomeReconciliation_StoreBankStatementRequest":{"type":"object","required":["statement_uuid","date"],"properties":{"statement_uuid":{"type":"string","example":"5aa4f83f-dda0-478b-bdfe-38446425b0c9","description":"Payment period statement UUID","format":"uuid"},"date":{"type":"string","example":"2026-05-08","description":"Statement date","format":"date"},"name":{"type":"string","example":"Natwest Statement #8434","description":"Optional title to name the bank statement. If null an auto generated name will be created."},"reference":{"type":"string","example":"BAT#8434","description":"Statement reference given by bank"}}},"App_Http_Requests_IncomeReconciliation_UpdateBankStatementRequest":{"type":"object","properties":{"date":{"type":"string","example":"2026-05-08","description":"Statement date","format":"date"},"name":{"type":"string","example":"Aviva Statement #8434","description":"Optional title to name the bank statement. If null a auto generated name will be created."},"reference":{"type":"string","example":"NAT#8434","description":"Statement reference given by bank"}}},"App_Http_Requests_IncomeReconciliation_StoreChargeRequest":{"type":"object","required":["chargeable_type","chargeable_uuid","seller_uuid","payment_origin","type","category","recurring","start_date","tax_exempt","exclude_from_rmar","advice_type","service_type"],"properties":{"chargeable_type":{"type":"string","example":"client","description":"Model type that can have charges added to them.","enum":["client","plan"]},"chargeable_uuid":{"type":"string","example":"d697c24e-e65b-489e-9c74-7fc7983f75c2","description":"UUID of chargeable model.","format":"uuid"},"seller_uuid":{"type":"string","example":"801ca3ef-8d71-41ec-87f4-a24844b2f961","description":"Employee that will be earning the revenue for this charge","format":"uuid"},"payment_origin":{"type":"string","example":"client","description":"|\n\nWho is expected to pay this.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|provider|Provider|\n|unknown|Unknown|","enum":["client","provider","unknown"]},"type":{"type":"string","example":"fee","description":"|\n\nExpectation type.\n\n| Value | Description |\n| ----- | ----------- |\n|fee|Fee|\n|commission|Commission|","enum":["fee","commission"]},"category":{"type":"string","example":"adhoc","description":"|\n\nExpectation category.\n\n| Value | Description |\n| ----- | ----------- |\n|adhoc|Adhoc|\n|administration|Administration|\n|adjustment|Adjustment|\n|bond_renewal|Bond Renewal|\n|clawback|Clawback|\n|dss_rebate|Dss Rebate|\n|fund|Fund|\n|indemnity|Indemnity|\n|initial_fee|Initial Fee|\n|level|Level|\n|non_indemnity|Non Indemnity|\n|one_off|One Off|\n|ongoing_fee|Ongoing Fee|\n|other_fee|Other Fee|\n|procuration_fee|Procuration Fee|\n|protected_rights|Protected Rights|\n|renewal|Renewal|\n|switch|Switch|\n|unknown|Unknown|","enum":["adhoc","administration","adjustment","bond_renewal","clawback","dss_rebate","fund","indemnity","initial_fee","level","non_indemnity","one_off","ongoing_fee","other_fee","procuration_fee","protected_rights","renewal","switch","unknown"]},"recurring":{"type":"boolean","example":true,"description":"Determines whether the charge recurs at a set frequency. False for a one off statement transactions"},"frequency":{"type":"string","example":"daily","description":"|\n\nCharge frequency from the given start date.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually"]},"start_date":{"type":"string","example":"2026-02-08","description":"Date the recurring charge starts from.","format":"date"},"end_date":{"type":"string","example":"2027-03-08","description":"Date the recurring statement transactions will stop. Leave blank for indefinitely or until charge schedule is deleted.","format":"date"},"amount":{"type":"integer","example":10000,"description":"The fixed amount value as an integer in pennies. Required when not providing a percentage or when chargeable_type is client."},"percentage":{"type":"number","example":11.0,"description":"Percentage of plans value as a charge. Required when not providing a fixed amount. Cannot use percentage for a client chargeable_type.","format":"float","minimum":0.0,"maximum":100.0},"percentage_frequency":{"type":"string","example":"daily","description":"|\n\nFrequency that describes what the percentage is calculated from.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually"]},"tax_exempt":{"type":"boolean","example":true,"description":"Denotes whether the charge is exempt from tax."},"tax":{"type":"number","example":17.5,"description":"Percentage tax to be added on to net amount of charge. Will use fims default tax rate if not provided and charge is not tax exempt.","format":"float","minimum":0.0,"maximum":100.0},"exclude_from_rmar":{"type":"boolean","example":false,"description":"Whether or not to exclude this charge and its expectations from RMAR reporting."},"advice_type":{"type":"string","example":"independent","description":"|\n\nAdvice type for the charge.\n\n| Value | Description |\n| ----- | ----------- |\n|independent|Independent|\n|restricted|Restricted|","enum":["independent","restricted"]},"service_type":{"type":"string","example":"initial","description":"|\n\nService type for the charge. Recurring charges must be \"ongoing\"\n\n| Value | Description |\n| ----- | ----------- |\n|initial|Initial|\n|one_off|One Off|\n|ongoing|Ongoing|","enum":["initial","one_off","ongoing"]},"rmar_type":{"type":"string","example":"adviser_charge","description":"|\n\nRMAR type for the charge. Can only be set for adjustments and unknown charge categories. All other categories are automatically calculated. Recurring charges must be \"ongoing\"\n\n| Value | Description |\n| ----- | ----------- |\n|adviser_charge|Adviser Charge|\n|clawback|Clawback|\n|commission|Commission|\n|other_fee|Other Fee|\n|unknown|Unknown|","enum":["adviser_charge","clawback","commission","other_fee","unknown"]},"premium_uuid":{"type":"string","example":"585f4bad-1a35-436c-84d5-e28aaf52d023","description":"UUID of premium a percentage charge is based from.","format":"uuid"},"advice_area":{"type":"object","description":"RMAR advice area values. Required for charges made directly on a client. All amounts are in pennies and must total the charge net amount.","example":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"properties":{"deposit":{"type":"integer","example":0,"description":"Amount for deposit advice area."},"non_regulated":{"type":"integer","example":0,"description":"Amount for non regulated advice area."},"non_rmar":{"type":"integer","example":0,"description":"Amount for non RMAR advice area."},"non_investment_insurance":{"type":"integer","example":0,"description":"Amount for non investment insurance advice area."},"regulated_mortgage":{"type":"integer","example":0,"description":"Amount for regulated mortgage advice area."},"retail_investment":{"type":"integer","example":0,"description":"Amount for retail investment advice area."},"other_fca_regulated":{"type":"integer","example":0,"description":"Amount for other FCA regulated advice area."},"unknown":{"type":"integer","example":0,"description":"Amount for unknown advice area."}}},"notes":{"type":"string","example":"Note contents relevant to the charge.","description":"Notes to add on to the charge."}}},"App_Http_Requests_IncomeReconciliation_UpdateChargeRequest":{"type":"object","properties":{"seller_uuid":{"type":"string","example":"9e6b0385-13c1-4ece-b08d-6b7888e2e56e","description":"Employee that will be earning the revenue for this charge","format":"uuid"},"payment_origin":{"type":"string","example":"client","description":"|\n\nWho is expected to pay this charge.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|provider|Provider|\n|unknown|Unknown|","enum":["client","provider","unknown"]},"type":{"type":"string","example":"fee","description":"|\n\nExpectation type.\n\n| Value | Description |\n| ----- | ----------- |\n|fee|Fee|\n|commission|Commission|","enum":["fee","commission"]},"category":{"type":"string","example":"commission","description":"Expectation category."},"recurring":{"type":"boolean","example":true,"description":"Whether or not this charge recurring on a frequent basis"},"frequency":{"type":"string","example":"daily","description":"|\n\nExpected charge frequency from the given start date.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually"]},"start_date":{"type":"string","example":"2026-02-08","description":"Date the recurring charge starts from.","format":"date"},"end_date":{"type":"string","example":"2027-03-08","description":"Date the recurring statement transactions will stop. Leave blank for indefinitely or until charge schedule is deleted.","format":"date"},"amount":{"type":"integer","example":10000,"description":"The fixed amount value as an integer in pennies. Required when not providing a percentage or when chargeable_type is client."},"percentage":{"type":"number","example":10.0,"description":"Percentage of plans value as a charge. Required when not providing a fixed amount. Cannot use percentage for a client chargeable_type.","format":"float","minimum":0.0,"maximum":100.0},"percentage_frequency":{"type":"string","example":"daily","description":"|\n\nFrequency that describes what the percentage is calculated from.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually"]},"tax_exempt":{"type":"boolean","example":true,"description":"Denotes whether the charge is exempt from tax."},"tax":{"type":"number","example":17.5,"description":"Percentage tax to be added on to net amount of charge. Will use firms default tax rate if not provided and charge is not tax exempt.","format":"float","minimum":0.0,"maximum":100.0},"exclude_from_rmar":{"type":"boolean","example":false,"description":"Whether or not to exclude this charge and its expectations from RMAR reporting."},"advice_type":{"type":"string","example":"independent","description":"|\n\nAdvice type for the charge.\n\n| Value | Description |\n| ----- | ----------- |\n|independent|Independent|\n|restricted|Restricted|","enum":["independent","restricted"]},"service_type":{"type":"string","example":"initial","description":"|\n\nService type for the charge. Recurring charges must be \"ongoing\"\n\n| Value | Description |\n| ----- | ----------- |\n|initial|Initial|\n|one_off|One Off|\n|ongoing|Ongoing|","enum":["initial","one_off","ongoing"]},"rmar_type":{"type":"string","example":"adviser_charge","description":"|\n\nRMAR type for the charge. Can only be set for adjustments and unknown charge categories. All other categories are automatically calculated. Recurring charges must be \"ongoing\"\n\n| Value | Description |\n| ----- | ----------- |\n|adviser_charge|Adviser Charge|\n|clawback|Clawback|\n|commission|Commission|\n|other_fee|Other Fee|\n|unknown|Unknown|","enum":["adviser_charge","clawback","commission","other_fee","unknown"]},"advice_area":{"type":"object","description":"RMAR advice area values. All advice types are required when updating amounts or advice area amounts for charges made directly on a client. All amounts are in pennies and must total the charge net amount.","example":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"properties":{"deposit":{"type":"integer","example":0,"description":"Amount for deposit advice area."},"non_regulated":{"type":"integer","example":0,"description":"Amount for non regulated advice area."},"non_rmar":{"type":"integer","example":0,"description":"Amount for non RMAR advice area."},"non_investment_insurance":{"type":"integer","example":0,"description":"Amount for non investment insurance advice area."},"regulated_mortgage":{"type":"integer","example":0,"description":"Amount for regulated mortgage advice area."},"retail_investment":{"type":"integer","example":0,"description":"Amount for retail investment advice area."},"other_fca_regulated":{"type":"integer","example":0,"description":"Amount for other FCA regulated advice area."},"unknown":{"type":"integer","example":0,"description":"Amount for unknown advice area."}}}}},"App_Http_Requests_IncomeReconciliation_CalculateExpectationRequest":{"type":"object","required":["chargeable_type","chargeable_uuid","amount"],"properties":{"chargeable_type":{"type":"string","example":"client","description":"Chargeable model type to run calculation on. Valid types are: client, plan","enum":["client","plan"]},"chargeable_uuid":{"type":"string","example":"85f17810-5606-42ff-a286-1fb34be14406","description":"Chargeable model UUID to run calculation on.","format":"uuid"},"amount":{"type":"integer","example":12500,"description":"Expected net amount to calculate on in pennies."},"ongoing":{"type":"boolean","example":false,"description":"Whether to run the calculation based on ongoing charges. Leave as false for initial charges. Defaults to false."},"tax_exempt":{"type":"boolean","example":false,"description":"Denotes whether the net amount given is tax exempt or not. Defaults to true."},"tax":{"type":"number","example":17.5,"description":"Custom tax rate to apply to the net amount. Defaults to firm setting or defaults to Plannr setting of 20%.","format":"float","minimum":0.0,"maximum":100.0},"seller_uuid":{"type":"string","example":"87a53e8d-38b7-4184-8fe0-26a62012f7b1","description":"Select a different adviser to run the calculation again. If not provided a default based on the chargeable model will be selected.","format":"uuid"}}},"App_Http_Requests_IncomeReconciliation_UpdateExpectationRequest":{"type":"object","required":["seller_uuid","exclude_from_rmar","advice_type","service_type"],"properties":{"seller_uuid":{"type":"string","example":"528f337c-1a9f-4485-9285-ed93f855dfe2","description":"Employee that will be earning the revenue for this expectation","format":"uuid"},"payment_origin":{"type":"string","example":"client","description":"|\n\nWho is expected to pay this charge.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|provider|Provider|\n|unknown|Unknown|","enum":["client","provider","unknown"]},"type":{"type":"string","example":"fee","description":"|\n\nExpectation type.\n\n| Value | Description |\n| ----- | ----------- |\n|fee|Fee|\n|commission|Commission|","enum":["fee","commission"]},"category":{"type":"string","example":"adhoc","description":"|\n\nExpectation category.\n\n| Value | Description |\n| ----- | ----------- |\n|adhoc|Adhoc|\n|administration|Administration|\n|adjustment|Adjustment|\n|bond_renewal|Bond Renewal|\n|clawback|Clawback|\n|dss_rebate|Dss Rebate|\n|fund|Fund|\n|indemnity|Indemnity|\n|initial_fee|Initial Fee|\n|level|Level|\n|non_indemnity|Non Indemnity|\n|one_off|One Off|\n|ongoing_fee|Ongoing Fee|\n|other_fee|Other Fee|\n|procuration_fee|Procuration Fee|\n|protected_rights|Protected Rights|\n|renewal|Renewal|\n|switch|Switch|\n|unknown|Unknown|","enum":["adhoc","administration","adjustment","bond_renewal","clawback","dss_rebate","fund","indemnity","initial_fee","level","non_indemnity","one_off","ongoing_fee","other_fee","procuration_fee","protected_rights","renewal","switch","unknown"]},"expected_payment_date":{"type":"string","example":"2022-03-15","description":"Date you are expecting the charge to have been paid by.","format":"date"},"amount":{"type":"integer","example":10000,"description":"The fixed amount value as an integer in pennies. Required when not providing a percentage or when chargeable_type is client."},"percentage":{"type":"number","example":20.0,"description":"Percentage of plans value as a charge. Required when not providing a fixed amount. Cannot use percentage for a client chargeable_type.","format":"float","minimum":0.0,"maximum":100.0},"tax_exempt":{"type":"boolean","example":true,"description":"Denotes whether the charge is exempt from tax."},"exclude_from_rmar":{"type":"boolean","example":false,"description":"Whether or not to exclude this charge and its expectations from RMAR reporting."},"advice_type":{"type":"string","example":"independent","description":"|\n\nAdvice type for the expectation.\n\n| Value | Description |\n| ----- | ----------- |\n|independent|Independent|\n|restricted|Restricted|","enum":["independent","restricted"]},"service_type":{"type":"string","example":"initial","description":"|\n\nService type for the expectation. Recurring charges must be \"ongoing\"\n\n| Value | Description |\n| ----- | ----------- |\n|initial|Initial|\n|one_off|One Off|\n|ongoing|Ongoing|","enum":["initial","one_off","ongoing"]},"rmar_type":{"type":"string","example":"adviser_charge","description":"|\n\nRMAR type for the expectation. Can only be set for adjustments and unknown charge categories. All other categories are automatically calculated. Recurring charges must be \"ongoing\"\n\n| Value | Description |\n| ----- | ----------- |\n|adviser_charge|Adviser Charge|\n|clawback|Clawback|\n|commission|Commission|\n|other_fee|Other Fee|\n|unknown|Unknown|","enum":["adviser_charge","clawback","commission","other_fee","unknown"]},"advice_area":{"type":"object","description":"RMAR advice area values. Required for expectations directly on a client. All amounts are net amounts in pennies. Must total the expectation net amount.","example":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"properties":{"deposit":{"type":"integer","example":0,"description":"Amount for deposit advice area."},"non_regulated":{"type":"integer","example":0,"description":"Amount for non regulated advice area."},"non_rmar":{"type":"integer","example":0,"description":"Amount for non RMAR advice area."},"non_investment_insurance":{"type":"integer","example":0,"description":"Amount for non investment insurance advice area."},"regulated_mortgage":{"type":"integer","example":0,"description":"Amount for regulated mortgage advice area."},"retail_investment":{"type":"integer","example":0,"description":"Amount for retail investment advice area."},"other_fca_regulated":{"type":"integer","example":0,"description":"Amount for other FCA regulated advice area."},"unknown":{"type":"integer","example":0,"description":"Amount for unknown advice area."}}}}},"App_Http_Requests_IncomeReconciliation_StoreStatementTransactionRequest":{"type":"object","required":["provider_statement_uuid","statement_transactions"],"properties":{"statement_uuid":{"type":"string","example":"fa1ad2b3-d2c0-406a-930f-f1d8fe870f93","description":"Required if adding client paid transactions that do not belong in a provider statement. You should be using provider_statement_uuid in most cases. Statement must also be unlocked.","format":"uuid"},"provider_statement_uuid":{"type":"string","example":"c4227e79-bd3c-4bce-a949-c21696821566","description":"Provider statement UUID to store these transactions in.","format":"uuid"},"statement_transactions":{"type":"array","example":[],"description":"An array of statement_transactions. If expected payments date is not provided it will use the provider statement date. All amounts must be in pennies. Can also provide extra metadata which can be the rest of the columns of the provider statement.","items":{"type":"object","example":[{"client_name":"Gareth Thompson","policy_number":"AVIVA_0001","date":"2026-05-06","gross_amount":15000,"net_amount":15000,"transaction_reference":"UoiW0ttr","agency_number":"smwK5bRn","product_reference":"XutfpH7z","category":"ongoing_fee","adviser_name":"Bill Gates","sender_id_sib_number":"Sender ID/SIB number","reason":"Provider Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value"},{"client_first_name":"Barry","client_last_name":"Allen","policy_number":"AVIVA_0002","date":"2026-05-06","gross_amount":8999,"category":"renewal","adviser_first_name":"Bruce","adviser_last_name":"Wayne"}],"properties":{"policy_number":{"type":"string","example":"AVIVA_0001","description":"Policy number associated with the transaction."},"gross_amount":{"type":"integer","example":15000,"description":"Gross amount of the transaction in pennies."},"category":{"type":"string","example":"adhoc","description":"|\n\nCategory of the charge.\n\n| Value | Description |\n| ----- | ----------- |\n|adhoc|Adhoc|\n|administration|Administration|\n|adjustment|Adjustment|\n|bond_renewal|Bond Renewal|\n|clawback|Clawback|\n|dss_rebate|Dss Rebate|\n|fund|Fund|\n|indemnity|Indemnity|\n|initial_fee|Initial Fee|\n|level|Level|\n|non_indemnity|Non Indemnity|\n|one_off|One Off|\n|ongoing_fee|Ongoing Fee|\n|other_fee|Other Fee|\n|procuration_fee|Procuration Fee|\n|protected_rights|Protected Rights|\n|renewal|Renewal|\n|switch|Switch|\n|unknown|Unknown|","enum":["adhoc","administration","adjustment","bond_renewal","clawback","dss_rebate","fund","indemnity","initial_fee","level","non_indemnity","one_off","ongoing_fee","other_fee","procuration_fee","protected_rights","renewal","switch","unknown"]},"client_name":{"type":"string","example":"Gareth Thompson","description":"Name of the client associated with the transaction."},"date":{"type":"string","example":"2026-05-06","description":"Date of the transaction. If not provided the provider statement date will be used.","format":"date"},"net_amount":{"type":"integer","example":15000,"description":"Net amount of the transaction in pennies."},"transaction_reference":{"type":"string","example":"TRX123456","description":"Transaction reference provided by the provider."},"agency_number":{"type":"string","example":"AGENCY123","description":"Agency number associated with the transaction."},"product_reference":{"type":"string","example":"PROD456","description":"Product reference associated with the transaction."},"adviser_name":{"type":"string","example":"Bill Gates","description":"Name of the adviser associated with the transaction."},"sender_id_sib_number":{"type":"string","example":"Sender ID/SIB number","description":"Sender ID or SIB number associated with the transaction."},"reason":{"type":"string","example":"Provider Reason","description":"Reason for the transaction provided by the provider."},"scheme_name":{"type":"string","example":"Scheme name","description":"Scheme name associated with the transaction."},"scheme_number":{"type":"string","example":"Scheme number","description":"Scheme number associated with the transaction."},"customer_number":{"type":"string","example":"Customer number","description":"Customer number associated with the transaction."},"policy_market_value":{"type":"string","example":"Policy market value","description":"Market value of the policy associated with the transaction."},"metadata":{"type":"object","description":"Extra metadata which can be the rest of the columns of the provider statement.","additionalProperties":true}}}}}},"App_Http_Requests_IncomeReconciliation_UpdateStatementTransactionRequest":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson","description":"The client name this payment would be for."},"date":{"type":"string","example":"2026-05-08","description":"Provider statement transaction date","format":"date"},"policy_number":{"type":"string","example":"AVIVA00001","description":"Provider reference of the plan the statement transactions is for."},"category":{"type":"string","example":"adhoc","description":"|\n\nProvider statement transaction category.\n\n| Value | Description |\n| ----- | ----------- |\n|adhoc|Adhoc|\n|administration|Administration|\n|adjustment|Adjustment|\n|bond_renewal|Bond Renewal|\n|clawback|Clawback|\n|dss_rebate|Dss Rebate|\n|fund|Fund|\n|indemnity|Indemnity|\n|initial_fee|Initial Fee|\n|level|Level|\n|non_indemnity|Non Indemnity|\n|one_off|One Off|\n|ongoing_fee|Ongoing Fee|\n|other_fee|Other Fee|\n|procuration_fee|Procuration Fee|\n|protected_rights|Protected Rights|\n|renewal|Renewal|\n|switch|Switch|\n|unknown|Unknown|","enum":["adhoc","administration","adjustment","bond_renewal","clawback","dss_rebate","fund","indemnity","initial_fee","level","non_indemnity","one_off","ongoing_fee","other_fee","procuration_fee","protected_rights","renewal","switch","unknown"]},"gross_amount":{"type":"integer","example":15099,"description":"Transaction gross amount in lowest denomination."},"net_amount":{"type":"integer","example":15099,"description":"Transaction net amount in lowest denomination."},"adviser_name":{"type":"string","example":"Bill Gates","description":"The adviser name if given on the provider statement"},"transaction_reference":{"type":"string","example":"s1eX4eaQcd","description":"Unique statement transactions reference provided by the provider."},"agency_number":{"type":"string","example":"7HHZ5KecBW","description":"Agency number of the transaction if given on the provider statement."},"product_reference":{"type":"string","example":"CqiDyOyP37","description":"Product reference of the transaction if given on the provider statement."},"sender_id_sib_number":{"type":"string","example":"Sender ID/SIB number","description":"Sender ID/SIB number"},"reason":{"type":"string","example":"Reason","description":"Reason"},"scheme_name":{"type":"string","example":"Scheme name","description":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number","description":"Scheme number"},"customer_number":{"type":"string","example":"Customer number","description":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value","description":"Policy market value"},"payment_origin":{"type":"string","example":"client","description":"|\n\nWhere this statement transactions came from.\n\n| Value | Description |\n| ----- | ----------- |\n|client|Client|\n|provider|Provider|\n|unknown|Unknown|","enum":["client","provider","unknown"]}}},"App_Http_Requests_IncomeReconciliation_StoreBankTransactionRequest":{"type":"object","required":["bank_statement_uuid","bank_transactions"],"properties":{"bank_statement_uuid":{"type":"string","example":"932f74a9-7d93-471a-b2ca-83ea28d834cb","description":"Bank statement UUID to store these transactions in.","format":"uuid"},"bank_transactions":{"type":"array","example":[],"description":"An array of bank transactions on a bank statement. All bank transactions amounts must be in pennies.","items":{"type":"object","example":[{"date":"2022-07-15","amount":12345,"reference":"AvivaRef#34"},{"date":"2022-07-14","amount":19855,"reference":"VIT_LTD"}],"properties":{"date":{"type":"string","example":"2022-07-15","description":"The date of the bank transaction.","format":"date","nullable":true},"amount":{"type":"integer","example":19855,"description":"The amount of the bank transaction in pennies."},"reference":{"type":"string","example":"AvivaRef#34","description":"The reference of the bank transaction.","maxLength":255}}}}}},"App_Http_Requests_IncomeReconciliation_UpdateBankTransactionRequest":{"type":"object","properties":{"date":{"type":"string","example":"2026-05-08","description":"Transaction date","format":"date"},"amount":{"type":"integer","example":55099,"description":"Transaction amount in pennies."},"reference":{"type":"string","example":"OGiqft4yKd","description":"Transaction reference as it appears on your bank statement."}}},"App_Http_Requests_IncomeReconciliation_ReconcileExpectationsRequest":{"type":"object","required":["expectation_uuid"],"properties":{"expectation_uuid":{"type":"string","example":"dce483a7-c9da-4492-9c45-e9cd8afd7a7b","description":"The expectation to reconcile against statement transactions.","format":"uuid"},"statement_transactions":{"type":"array","example":["250117ee-c60d-4ee6-a03c-8433a9056927","c9f6166f-b7cb-4b58-987f-a8a94a78c952","daa97c0b-033d-42e1-bfa6-d02a71e4ff6f"],"description":"The list of statement transactions to reconcile against expectations. Required if provider_statement_uuid is not present.","items":{"type":"string","example":"f3c89eb1-761e-4568-8545-d9bc4c3c201c","format":"uuid"}},"create_linked_policy_numbers":{"type":"boolean","example":true,"description":"Create linked policy numbers from the policy number of the statement transactions for the plan belonging to the expectation."}}},"App_Http_Requests_IncomeReconciliation_BalanceExpectationsRequest":{"type":"object","properties":{"expectation_uuids":{"type":"array","example":["33209796-c495-4469-b706-7758e3a3c588","c9e17972-e4b7-4d69-a341-ae52ab87b516","5465b0e3-17d6-4163-95cd-17c586b529c6"],"description":"Array of expectation UUIDs to balance.","items":{"type":"string","example":"6dc00264-9f08-4da4-86ac-c9ec9eb92825","format":"uuid"}},"statement_transaction_uuids":{"type":"array","example":["f05a7eb6-bf7d-4abd-9aaa-b51e6e79a222","8cf207e1-2d89-456c-b79b-b221c0bfcf8d","1727a7bf-0b99-4320-9704-92767ae381bb"],"description":"Array of statement transactions UUIDs which will balance all expectations which are linked to transactions.","items":{"type":"string","example":"5b4e1c05-899a-4e97-a645-8e08349a2724","format":"uuid"}}}},"App_Http_Requests_IncomeReconciliation_UnbalanceExpectationRequest":{"type":"object","required":["expectation_uuid"],"properties":{"expectation_uuid":{"type":"string","example":"e3cac17d-e3ce-4573-af72-9e7847bfab34","description":"Expectation UUID to unbalance.","format":"uuid"}}},"App_Http_Requests_IncomeReconciliation_ReconcileBankTransactionsRequest":{"type":"object","required":["bank_transactions"],"properties":{"provider_statement_uuid":{"type":"string","example":"ee4e7d75-f01a-4069-9625-f00423ca4e99","description":"The UUID of the provider statement. Required if you do not provide statement_transactions.","format":"uuid"},"statement_transactions":{"type":"array","example":["7d037ccb-f690-49e1-8462-6a7777b38d07","7aee8966-beb6-4070-99d4-540c65f956b2","b4ee97cf-521f-4a1c-9dfe-cf7476dacf05"],"description":"The list of statement transactions to reconcile against expectations. Required if provider_statement_uuid is not present.","items":{"type":"string","example":"453bd0b1-b0f3-4a6e-9b1a-bc0650d0cefe","format":"uuid"}},"bank_transactions":{"type":"array","example":["7f195f07-de2d-4cc3-8d9d-d9caa17a096e","9f3dacf2-cc23-4f8f-960d-55dfa4cdd42c","3cae1274-ae15-4af2-91f5-5c3d6a078e38"],"description":"The list of bank payments to reconcile against statement transactions.","items":{"type":"string","example":"4826e0d8-5717-4682-95e6-5eedf9c19b44","format":"uuid"}}}},"App_Http_Requests_IncomeReconciliation_BulkCreateExpectationsRequest":{"type":"object","required":["statement_transactions"],"properties":{"statement_transactions":{"type":"array","example":["b16d4165-234d-4797-bd8c-da4537c62a0f","a5c14035-ec76-4e24-a556-05ef27dbeab0","6fb7027d-bdd2-4276-82ee-5b0459983b72"],"description":"Array of unreconciled statement transactions to bulk create matching expectations.","items":{"type":"string","example":"fb146008-9dcc-4129-b3a4-ee405071bdad","format":"uuid"}}}},"App_Http_Requests_IncomeReconciliation_AutoReconcileStatementTransactionsRequest":{"type":"object","required":["statement_transaction_uuids","provider_statement_uuids"],"properties":{"statement_transaction_uuids":{"type":"array","example":["0553b740-eb53-4b33-b090-787939c1cae6","dab5299d-ffe9-46b0-8ec0-9f3fa30c2894","cee48886-79ce-4ce8-b7c2-dccdeaa7e58d"],"description":"Statement transaction UUIDs to auto reconcile to expectations.","items":{"type":"string","example":"b2278bfe-bb8c-4d26-b95e-1876fdc0b4a8","format":"uuid"}},"provider_statement_uuids":{"type":"array","example":["4cba3e73-7356-49c2-bc9a-786d8b289517","0d57cf32-1d9d-42a5-aaed-c17c8416f135","1bc90455-ed1f-4cc0-a446-b9af725fa736"],"description":"Provider statement UUIDs to auto reconcile to expectations.","items":{"type":"string","example":"6b0066f1-aeac-4c1e-b381-50fd9a06c7e0","format":"uuid"}}}},"App_Http_Requests_IncomeReconciliation_StoreChargeSplitRequest":{"type":"object","required":["splitable_type","splitable_uuid","account_uuid","charge_split_schema_uuid","percentage","transfer_fci","initial","ongoing"],"properties":{"splitable_type":{"type":"string","example":"client","description":"The model type the charge split is being added to.","enum":["client","plan","charge"]},"splitable_uuid":{"type":"string","example":"efff928a-1ca1-46d5-96ad-124d4d279af1","description":"The model UUID belonging to the splitable_type the charge split is being added to","format":"uuid"},"account_uuid":{"type":"string","example":"0a7eddde-d25f-4ccc-9faf-0c0d375dc0b2","description":"The account UUID of who will be receiving this charge split","format":"uuid"},"charge_split_schema_uuid":{"type":"string","example":"b0e29218-f381-4e7d-ace8-0a682ed3bfb0","description":"The charge split schema that defines the parameters of this charge split","format":"uuid"},"percentage":{"type":"number","example":45.8,"description":"Percentage of charge that the introducer will receive. Must be within the provided charge split schema min and max percentage bounds","format":"float","minimum":0.0,"maximum":100.0},"transfer_fci":{"type":"boolean","example":true,"description":"Whether the account will receive FCI recognition for this charge split. Provided charge split schema must allow option to be changed"},"initial":{"type":"boolean","example":true,"description":"Whether this charge split will be applied to initial charges. Provided charge split schema must allow option to be changed"},"ongoing":{"type":"boolean","example":true,"description":"Whether this charge split will be applied to ongoing charges. Provided charge split schema must allow option to be changed"},"apply_to_plans":{"type":"boolean","example":true,"description":"When adding a charge split against a client, you can choose whether to automatically apply to the client's plans too. Must be null or false for a plan splitable_type"}}},"App_Http_Requests_IncomeReconciliation_UpdateChargeSplitRequest":{"type":"object","properties":{"percentage":{"type":"number","example":11.7,"description":"Percentage of charge that the introducer will receive. Must be within the original charge split schema min and max percentage bounds","format":"float","minimum":0.0,"maximum":100.0},"transfer_fci":{"type":"boolean","example":true,"description":"Whether the account will receive FCI recognition for this charge split"},"initial":{"type":"boolean","example":true,"description":"Whether this charge split will be applied to initial charges"},"ongoing":{"type":"boolean","example":true,"description":"Whether this charge split will be applied to ongoing charges"},"apply_to_plans":{"type":"boolean","example":true,"description":"When adding a charge split against a client, you can choose whether to automatically apply to the client's plans too. Must be null or false for a plan splitable_type"}}},"App_Http_Requests_IncomeReconciliation_StoreAdviserSplitRequest":{"type":"object","required":["name","firm_percentage","adviser_percentage","type"],"properties":{"name":{"type":"string","example":"Trainee Rate","description":"The name of the adviser split"},"firm_percentage":{"type":"number","example":30.0,"description":"The percentage held by the firm on a charge","format":"float"},"adviser_percentage":{"type":"number","example":70.0,"description":"The percentage held by the selling adviser on a charge","format":"float"},"type":{"type":"string","example":"plan","description":"Whether or not this adviser split will be assigned directly to an adviser, or at a plan level to override the selling adviser's adviser split.","enum":["plan","adviser"]}}},"App_Http_Requests_IncomeReconciliation_UpdateAdviserSplitRequest":{"type":"object","properties":{"name":{"type":"string","example":"Trainee Rate","description":"The name of the adviser split"},"firm_percentage":{"type":"number","example":20.0,"description":"The percentage held by the firm on a charge","format":"float","minimum":0.0,"maximum":100.0},"adviser_percentage":{"type":"number","example":15.5,"description":"The percentage held by the selling adviser on a charge","format":"float","minimum":0.0,"maximum":100.0}}},"App_Http_Requests_IncomeReconciliation_StoreChargeSplitSchemaRequest":{"type":"object","required":["name","min_percentage","max_percentage","default_percentage","percentage_paid_by_firm","percentage_paid_by_adviser","can_change_transfer_fci","default_transfer_fci","can_change_initial","default_initial","can_change_ongoing","default_ongoing","valid_for_advisers","valid_for_clients","valid_for_introducers","visible_to_advisers"],"properties":{"name":{"type":"string","example":"Basic Introducer Rate","description":"Introducer split name"},"min_percentage":{"type":"number","example":20.0,"description":"Minimum percentage of overall charge introducer can be entitled to","format":"float","minimum":0.0,"maximum":100.0},"max_percentage":{"type":"number","example":40.0,"description":"Maximum percentage of overall charge introducer can be entitled to","format":"float","minimum":0.0,"maximum":100.0},"default_percentage":{"type":"number","example":27.5,"description":"Default percentage of overall charge introducer can be entitled to. Must be between minimum and maximum","format":"float","minimum":0.0,"maximum":100.0},"percentage_paid_by_firm":{"type":"number","example":18.0,"description":"Percentage of the introducer's cut of the expected amount to be paid by the firm","format":"float","minimum":0.0,"maximum":100.0},"percentage_paid_by_adviser":{"type":"number","example":17.62,"description":"Percentage of the introducer's cut of the expected amount to be paid by the selling adviser","format":"float","minimum":0.0,"maximum":100.0},"can_change_transfer_fci":{"type":"boolean","example":true,"description":"Whether the value for FCI contributions can be changed. Will only apply to advisers"},"default_transfer_fci":{"type":"boolean","example":true,"description":"Default value to whether the introducer will be recognised for FCI contributions. Will only apply to advisers"},"can_change_initial":{"type":"boolean","example":true,"description":"Whether the value for initial charges can be changed"},"default_initial":{"type":"boolean","example":true,"description":"Default value to whether this charge split schema will be applied to initial charges"},"can_change_ongoing":{"type":"boolean","example":true,"description":"Whether the value for ongoing charges can be changed"},"default_ongoing":{"type":"boolean","example":true,"description":"Default value to whether this charge split schema will be applied to ongoing charges"},"valid_for_advisers":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for adviser accounts"},"valid_for_clients":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for client accounts"},"valid_for_introducers":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for introducer accounts"},"visible_to_advisers":{"type":"boolean","example":true,"description":"Whether this charge split schema is visible to advisers to use"}}},"App_Http_Requests_IncomeReconciliation_UpdateChargeSplitSchemaRequest":{"type":"object","properties":{"name":{"type":"string","example":"Basic Introducer Rate","description":"Introducer split name"},"min_percentage":{"type":"number","example":20.0,"description":"Minimum percentage of overall charge introducer can be entitled to. Required with max_percentage and default_percentage","format":"float","minimum":0.0,"maximum":100.0},"max_percentage":{"type":"number","example":47.5,"description":"Maximum percentage of overall charge introducer can be entitled to. Required with max_percentage and default_percentage","format":"float","minimum":0.0,"maximum":100.0},"default_percentage":{"type":"number","example":32.0,"description":"Default percentage of overall charge introducer can be entitled to. Must be between minimum and maximum. Required with min_percentage and max_percentage","format":"float","minimum":0.0,"maximum":100.0},"percentage_paid_by_firm":{"type":"number","example":20.0,"description":"Percentage of the introducer's cut of the expected amount to be paid by the firm. Required with percentage_paid_by_adviser","format":"float","minimum":0.0,"maximum":100.0},"percentage_paid_by_adviser":{"type":"number","example":20.0,"description":"Percentage of the introducer's cut of the expected amount to be paid by the selling adviser. Required with percentage_paid_by_firm","format":"float","minimum":0.0,"maximum":100.0},"can_change_transfer_fci":{"type":"boolean","example":true,"description":"Whether the value for FCI contributions can be changed. Will only apply to advisers"},"default_transfer_fci":{"type":"boolean","example":true,"description":"Default value to whether the introducer will be recognised for FCI contributions. Will only apply to advisers"},"can_change_initial":{"type":"boolean","example":true,"description":"Whether the value for initial charges can be changed"},"default_initial":{"type":"boolean","example":true,"description":"Default value to whether this charge split schema will be applied to initial charges"},"can_change_ongoing":{"type":"boolean","example":true,"description":"Whether the value for ongoing charges can be changed"},"default_ongoing":{"type":"boolean","example":true,"description":"Default value to whether this charge split schema will be applied to ongoing charges"},"valid_for_advisers":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for adviser accounts"},"valid_for_clients":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for client accounts"},"valid_for_introducers":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for introducer accounts"},"visible_to_advisers":{"type":"boolean","example":true,"description":"Whether this charge split schema is visible to advisers to use"}}},"App_Http_Requests_StoreNewBusinessEventRequest":{"type":"object","required":["contribution_type","adviser_uuid","advice_type","conducted_by","source_of_funds","status"],"properties":{"plan_uuid":{"type":"string","example":"c47a5e64-96e6-4ed5-89ab-df0a4b2fcd18","description":"Plan UUID. Must be a plan belonging to the firm. Required if client_uuid is not provided","format":"uuid"},"client_uuid":{"type":"string","example":"990af8bf-ed29-437d-8ccc-9176a37151bc","description":"Client UUID. Must be a client belonging to the firm. Comma seperated list of uuids. Required if plan_uuid is not provided","format":"uuid"},"contribution_type":{"type":"string","example":"initial","description":"|\n\nType of contribution.\n\n| Value | Description |\n| ----- | ----------- |\n|initial|Initial|\n|increment|Increment|\n|decrement|Decrement|\n|advice_point|Advice Point|\n|pension_transfer|Pension Transfer|\n|switch|Switch|","enum":["initial","increment","decrement","advice_point","pension_transfer","switch"]},"contribution_type_notes":{"type":"string","example":"Notes for contribution type","description":"Notes for contribution type."},"adviser_uuid":{"type":"string","example":"f6c68e2d-5d68-4484-982e-54f11d6de45b","description":"Adviser UUID. Must be employee of the firm","format":"uuid"},"advice_type":{"type":"string","example":"advised","description":"|\n\nType of advice.\n\n| Value | Description |\n| ----- | ----------- |\n|advised|Advised|\n|execution_only|Execution Only|\n|insistent_investor|Insistent Investor|\n|existing_provision|Existing Provision|\n|direct_offer|Direct Offer|\n|client_instruction|Client Instruction|","enum":["advised","execution_only","insistent_investor","existing_provision","direct_offer","client_instruction"]},"conducted_by":{"type":"string","example":"correspondence_only","description":"|\n\nHow the advice was conducted.\n\n| Value | Description |\n| ----- | ----------- |\n|correspondence_only|Correspondence Only|\n|email|Email|\n|face_to_face|Face To Face|\n|internet|Internet|\n|other|Other|\n|printed_media_campaign|Printed Media Campaign|\n|unknown|Unknown|\n|telephone|Telephone|","enum":["correspondence_only","email","face_to_face","internet","other","printed_media_campaign","unknown","telephone"]},"source_of_funds":{"type":"string","example":"gift","description":"|\n\nSource of funds.\n\n| Value | Description |\n| ----- | ----------- |\n|gift|Gift|\n|inheritance|Inheritance|\n|isa_transfer|ISA Transfer|\n|pension_transfer|Pension Transfer|\n|salary|Salary|\n|savings|Savings|\n|other|Other|","enum":["gift","inheritance","isa_transfer","pension_transfer","salary","savings","other"]},"source_of_funds_note":{"type":"string","example":"Other source of funds","description":"Note for other source of funds. Required if source_of_funds is \"other\""},"premium_amount":{"type":"integer","example":10000,"description":"Premium amount in pence. 10000 = £100.00"},"premium_currency":{"type":"string","example":"GBP","description":"|\n\nPremium currency. Defaults to \"GBP\".\n\n| Value | Description |\n| ----- | ----------- |\n|GBP|G B P|","enum":["GBP"]},"premium_frequency":{"type":"string","example":"daily","description":"|\n\nPremium frequency.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"start_date":{"type":"string","example":"2021-01-01","description":"Start date of premium. Required if status is \"accepted\"","format":"date"},"proposal_date":{"type":"string","example":"2020-10-12","description":"Proposal date of the New Business Event","format":"date"},"case_uuid":{"type":"string","example":"88f7aa0c-a14f-4a35-ade3-c023fef654a6","description":"Case UUID to link this to a existing case","format":"uuid"},"is_vulnerable_client":{"type":"string","example":"yes","description":"|\n\nIs this a vulnerable client. Defaults to \"no\".\n\n| Value | Description |\n| ----- | ----------- |\n|yes|Yes|\n|no|No|\n|possibly|Possibly|","enum":["yes","no","possibly"]},"is_replacing_existing_plan":{"type":"boolean","example":true,"description":"Is this replacing an existing plan"},"existing_plan_uuid":{"type":"string","example":"aaeb65ca-6cbb-4bb9-91d6-72a6c241195e","description":"Existing Plan UUID. Must be a plan belonging to the firm.","format":"uuid"},"existing_plan_details":{"type":"string","example":"Existing plan details","description":"Details of existing plan. Required if is_replacing_existing_plan is true and existing_plan_uuid is empty"},"opted_out_of_pension_scheme_for_plan":{"type":"boolean","example":true,"description":"Did the client opt out of an employer sponsored pension scheme to take out this plan. Required if related to a plan and is a pension plan"},"opted_out_at":{"type":"string","example":"2026-05-08","description":"The datetime when the pension scheme was opted out of. Required if opted_out_of_pension_scheme_for_plan is true","format":"date"},"opted_out_notes":{"type":"string","example":"Opted out of pension scheme","description":"Notes for opting out of pension scheme. Required if opted_out_of_pension_scheme_for_plan is true"},"status":{"type":"string","example":"accepted","description":"|\n\nStatus of the New Business Event.\n\n| Value | Description |\n| ----- | ----------- |\n|accepted|Accepted|\n|proposed|Proposed|\n|rejected|Rejected|\n|deferred|Deferred|\n|NPW|NPW|","enum":["accepted","proposed","rejected","deferred","NPW"]}}},"App_Http_Requests_UpdateNewBusinessEventRequest":{"type":"object","required":["contribution_type","adviser_uuid","advice_type","conducted_by","source_of_funds","status"],"properties":{"plan_uuid":{"type":"string","example":"fa2332a1-24c7-4f5b-8f49-a78b3c3c6bc3","description":"Plan UUID. Must be a plan belonging to the firm. Only works if the new business event is not already joined to a plan","format":"uuid"},"contribution_type":{"type":"string","example":"initial","description":"|\n\nType of contribution\n\n| Value | Description |\n| ----- | ----------- |\n|initial|Initial|\n|increment|Increment|\n|decrement|Decrement|\n|advice_point|Advice Point|\n|pension_transfer|Pension Transfer|\n|switch|Switch|","enum":["initial","increment","decrement","advice_point","pension_transfer","switch"]},"contribution_type_notes":{"type":"string","example":"Other contribution type","description":"Note for other contribution type"},"adviser_uuid":{"type":"string","example":"d6a11fbb-69dd-432e-b20a-7c95fa3366de","description":"Adviser UUID. Must be employee of the firm","format":"uuid"},"advice_type":{"type":"string","example":"advised","description":"|\n\nType of advice.\n\n| Value | Description |\n| ----- | ----------- |\n|advised|Advised|\n|execution_only|Execution Only|\n|insistent_investor|Insistent Investor|\n|existing_provision|Existing Provision|\n|direct_offer|Direct Offer|\n|client_instruction|Client Instruction|","enum":["advised","execution_only","insistent_investor","existing_provision","direct_offer","client_instruction"]},"conducted_by":{"type":"string","example":"correspondence_only","description":"|\n\nHow the advice was conducted.\n\n| Value | Description |\n| ----- | ----------- |\n|correspondence_only|Correspondence Only|\n|email|Email|\n|face_to_face|Face To Face|\n|internet|Internet|\n|other|Other|\n|printed_media_campaign|Printed Media Campaign|\n|unknown|Unknown|\n|telephone|Telephone|","enum":["correspondence_only","email","face_to_face","internet","other","printed_media_campaign","unknown","telephone"]},"source_of_funds":{"type":"string","example":"gift","description":"|\n\nSource of funds.\n\n| Value | Description |\n| ----- | ----------- |\n|gift|Gift|\n|inheritance|Inheritance|\n|isa_transfer|ISA Transfer|\n|pension_transfer|Pension Transfer|\n|salary|Salary|\n|savings|Savings|\n|other|Other|","enum":["gift","inheritance","isa_transfer","pension_transfer","salary","savings","other"]},"source_of_funds_note":{"type":"string","example":"Other source of funds","description":"Note for other source of funds. Required if source_of_funds is \"other\""},"premium_amount":{"type":"integer","example":10000,"description":"Premium amount in pence. 10000 = £100.00"},"premium_currency":{"type":"string","example":"GBP","description":"|\n\nPremium currency. Defaults to \"GBP\".\n\n| Value | Description |\n| ----- | ----------- |\n|GBP|G B P|","enum":["GBP"]},"premium_frequency":{"type":"string","example":"daily","description":"|\n\nPremium frequency.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"start_date":{"type":"string","example":"2021-01-01","description":"Start date of premium. Required if status is \"accepted\"","format":"date"},"proposal_date":{"type":"string","example":"2020-10-12","description":"Proposal date of the New Business Event","format":"date"},"case_uuid":{"type":"string","example":"8e20bbf5-d463-47fc-80d4-8473c66ced59","description":"Case UUID to link this to a existing case","format":"uuid"},"is_vulnerable_client":{"type":"string","example":"yes","description":"|\n\nIs this a vulnerable client. Defaults to \"no\".\n\n| Value | Description |\n| ----- | ----------- |\n|yes|Yes|\n|no|No|\n|possibly|Possibly|","enum":["yes","no","possibly"]},"is_replacing_existing_plan":{"type":"boolean","example":true,"description":"Is this replacing an existing plan"},"existing_plan_uuid":{"type":"string","example":"4b428230-19d8-4c65-a447-640dc4ba1200","description":"Existing Plan UUID. Must be a plan belonging to the firm.","format":"uuid"},"existing_plan_details":{"type":"string","example":"Existing plan details","description":"Details of existing plan. Required if is_replacing_existing_plan is true and existing_plan_uuid is empty"},"opted_out_of_pension_scheme_for_plan":{"type":"boolean","example":true,"description":"Did the client opt out of an employer sponsored pension scheme to take out this plan. Required if related to a plan and is a pension plan"},"opted_out_at":{"type":"string","example":"2026-05-08","description":"The datetime when the pension scheme was opted out of. Required if opted_out_of_pension_scheme_for_plan is true","format":"date"},"opted_out_notes":{"type":"string","example":"Opted out of pension scheme","description":"Notes for opting out of pension scheme. Required if opted_out_of_pension_scheme_for_plan is true"},"status":{"type":"string","example":"accepted","description":"|\n\nStatus of the New Business Event.\n\n| Value | Description |\n| ----- | ----------- |\n|accepted|Accepted|\n|proposed|Proposed|\n|rejected|Rejected|\n|deferred|Deferred|\n|NPW|NPW|","enum":["accepted","proposed","rejected","deferred","NPW"]}}},"App_Http_Requests_Addons_SubscribeToAddonRequest":{"type":"object","required":["addon_id","enabled"],"properties":{"addon_id":{"type":"string","example":"transact_valuation_feed","description":"Unique identifier of the addon to subscribe to"},"config":{"type":"object","description":"Configuration parameters dependant on type of addon","example":{"api_key":"apikey123"},"additionalProperties":true},"enabled":{"type":"boolean","example":true,"description":"If the addon should start enabled"}}},"App_Http_Requests_Addons_UpdateAddonSubscriptionConfigRequest":{"type":"object","properties":{"config":{"type":"object","description":"Configuration parameters dependant on type of addon.","example":{"api_key":"example-api-key"},"additionalProperties":true}}},"App_Http_Requests_Reports_StoreReportRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Client Export 22nd July","description":"Name of the report"},"report_type_id":{"type":"string","example":"actual_vs_estimate_report","description":"Type of report to generate, available types are actual_vs_estimate_report, adviser_income_detailed, aged_debt_report, cases_export, charges_export, client_expenditure_export, client_export, conversion_pipeline, employee_export, form_submission_export, group_scheme_members_export, holding_export, income_reconciliation_export, new_business_export, new_business_summary_report, note_export, plan_export, premium_export, revenue_analysis_based_on_receipts, rmar, staff_member_export, task_export, time_entries, valuation_report","enum":["actual_vs_estimate_report","adviser_income_detailed","aged_debt_report","cases_export","charges_export","client_expenditure_export","client_export","conversion_pipeline","employee_export","form_submission_export","group_scheme_members_export","holding_export","income_reconciliation_export","new_business_export","new_business_summary_report","note_export","plan_export","premium_export","revenue_analysis_based_on_receipts","rmar","staff_member_export","task_export","time_entries","valuation_report"]},"report_template_uuid":{"type":"string","example":"67cadf8a-25d5-44c5-b261-85f87cd0a96c","description":"Report template uuid to generate a report from, required if no report id is passed","format":"uuid"},"report_query":{"type":"object","description":"Extra query parameters that can be used to manipulate the report output, only works for new reports, for templates the data stored on the template will be used","example":{"start_date":"2026-05-08T14:41:56+01:00"},"additionalProperties":true},"save_as_template":{"type":"boolean","example":true,"description":"setting this to true will save this request as a template that can be reused, if no value is given this defaults to false, does not store a new template if a template if a template is passed"},"template_name":{"type":"string","example":"my-template","description":"The name of the template to generate. Required if save_as_template is true."}}},"App_Http_Requests_StoreReportTemplateRequest":{"type":"object","required":["name","report_type_id"],"properties":{"name":{"type":"string","example":"Task report for clients over the age 60","description":"Name of the report template"},"report_type_id":{"type":"string","example":"rmar","description":"Valid report type id, this template will generate reports of this type"},"report_query":{"type":"object","description":"Extra query information that may be either required or optional depending on the report type","example":{"start_age":60},"additionalProperties":true}}},"App_Http_Requests_UpdateReportTemplateRequest":{"type":"object","properties":{"name":{"type":"string","example":"Task report for clients over the age 60","description":"Name of the report template"},"report_query":{"type":"object","description":"Extra query information that may be either required or optional depending on the report type","example":{"start_age":60},"additionalProperties":true}}},"App_Http_Requests_CustomFields_StoreCustomFieldRequest":{"type":"object","required":["type","name","is_required","model_type"],"properties":{"type":{"type":"string","example":"string","description":"|\n\nThe custom field type. Available options: string, number, selection, boolean, datetime and longtext\n\n| Value | Description |\n| ----- | ----------- |\n|string|String|\n|number|Number|\n|selection|Selection|\n|boolean|Boolean|\n|datetime|Datetime|\n|longtext|Longtext|","enum":["string","number","selection","boolean","datetime","longtext"]},"name":{"type":"string","example":"Favourite Drink","description":"The name of the custom field. Must be unique for the model_type."},"is_required":{"type":"boolean","example":true,"description":"Denotes if the custom field is required. If required, it must be specified when creating/updating a model."},"model_type":{"type":"string","example":"client","description":"The type of model the custom field applies for. Available options: client, board_task, case, plan, task","enum":["client","board_task","case","plan","task"]},"help_text":{"type":"string","example":"This is the client's favourite drink. You should make it for them before they arrive for meetings.","description":"Optional help text to aide the custom field. Will be displayed on Plannr."},"selection_options":{"type":"array","example":["Tea","Coffee","Water"],"description":"If the type is \"selection\" this array must be provided. This is the array of available options for the selection box."},"is_visible_to_clients":{"type":"boolean","example":true,"description":"Denotes if the custom field is visible and editable to clients and their fact finds."},"conditions":{"type":"array","example":[],"description":"Conditions that must be met for this custom field to apply. Each condition has an attribute and an array of acceptable values.","items":{"type":"object","example":{"attribute":"client_type","values":[]},"properties":{"attribute":{"type":"string","example":"client_type","description":"|\n\nThe condition attribute. Must be valid for the chosen model_type.\n\n| Value | Description |\n| ----- | ----------- |\n|client_type|CLIENT_TYPE|\n|client_status|CLIENT_STATUS|\n|case_type|CASE_TYPE|\n|case_status|CASE_STATUS|\n|task_status|TASK_STATUS|\n|plan_type|PLAN_TYPE|\n|plan_sub_type|PLAN_SUB_TYPE|\n|plan_status|PLAN_STATUS|","enum":["client_type","client_status","case_type","case_status","task_status","plan_type","plan_sub_type","plan_status"]},"values":{"type":"array","example":[],"description":"Array of acceptable values for the condition attribute (UUIDs for relationships, enum values for enums)."}}}},"conditions_operator":{"type":"string","example":"all","description":"The logical operator for combining conditions. \"all\" (AND) or \"any\" (OR). Defaults to \"all\"."}}},"App_Http_Requests_CustomFields_UpdateCustomFieldRequest":{"type":"object","properties":{"type":{"type":"string","example":"string","description":"|\n\nThe custom field type. Available options: string, number, selection, boolean, datetime and longtext\n\n| Value | Description |\n| ----- | ----------- |\n|string|String|\n|number|Number|\n|selection|Selection|\n|boolean|Boolean|\n|datetime|Datetime|\n|longtext|Longtext|","enum":["string","number","selection","boolean","datetime","longtext"]},"name":{"type":"string","example":"Favourite Drink","description":"The name of the custom field. Must be unique for the model_type."},"is_required":{"type":"boolean","example":true,"description":"Denotes if the custom field is required. If required, it must be specified when creating/updating a model."},"is_visible_to_clients":{"type":"boolean","example":true,"description":"Denotes if the custom field is visible and editable to clients and their fact finds."},"model_type":{"type":"string","example":"client","description":"The type of model the custom field applies for. Available options: client, board_task, case, plan, task","enum":["client","board_task","case","plan","task"]},"help_text":{"type":"string","example":"This is the client's favourite drink. You should make it for them before they arrive for meetings.","description":"Optional help text to aide the custom field. Will be displayed on Plannr."},"selection_options":{"type":"array","example":["Tea","Coffee","Water"],"description":"If the type is \"selection\" this array must be provided. This is the array of available options for the selection box."},"position":{"type":"integer","example":5,"description":"The position of the custom field. Will be placed last if left blank."},"conditions":{"type":"array","example":[],"description":"Conditions that must be met for this custom field to apply. Pass null or empty array to clear conditions.","items":{"type":"object","example":{"attribute":"client_type","values":[]},"properties":{"attribute":{"type":"string","example":"client_type","description":"|\n\nThe condition attribute. Must be valid for the custom field's model type.\n\n| Value | Description |\n| ----- | ----------- |\n|client_type|CLIENT_TYPE|\n|client_status|CLIENT_STATUS|\n|case_type|CASE_TYPE|\n|case_status|CASE_STATUS|\n|task_status|TASK_STATUS|\n|plan_type|PLAN_TYPE|\n|plan_sub_type|PLAN_SUB_TYPE|\n|plan_status|PLAN_STATUS|","enum":["client_type","client_status","case_type","case_status","task_status","plan_type","plan_sub_type","plan_status"]},"values":{"type":"array","example":[],"description":"Array of acceptable values for the condition attribute."}}}},"conditions_operator":{"type":"string","example":"all","description":"The logical operator for combining conditions. \"all\" (AND) or \"any\" (OR). Defaults to \"all\"."}}},"App_Http_Requests_StoreCustomDefaultFoldersRequest":{"type":"object","required":["model","is_active"],"properties":{"description":{"type":"string","example":"Default folder structure for standard clients","description":"A description of the default folder structure"},"model":{"type":"string","example":"client","description":"What model this default folder structure is for. Can be either client or case"},"structure":{"type":"array","example":[{"name":"Documents","children":[{"name":"Contracts","children":[]},{"name":"Emails","children":[]}]},{"name":"Notes","children":[]}],"description":"The folder structure definition for the default folder structure.","items":{"$ref":"#/components/schemas/DefaultFoldersStructure"}},"is_active":{"type":"boolean","example":true,"description":"Whether this default folder structure is active or not. Only one default folder structure for the same model and parameter can be active at a time."},"parameter":{"type":"string","example":"individual","description":"The parameter for the default folder structure. If the model is client, this can be either individual, trust, business or shared. If the type is case, this can be any of the case types that are available in the firm. Leaving it null will make the custom default folders apply to all clients/cases."},"for_existing":{"type":"boolean","example":true,"description":"Whether this default folder structure is applied to existing clients or not. If this is false, the default folder structure will only be applied to new clients. Required if the model is client"}}},"App_Http_Requests_UpdateCustomDefaultFoldersRequest":{"type":"object","properties":{"description":{"type":"string","example":"Default folder structure for standard clients","description":"A description of the default folder structure"},"model":{"type":"string","example":"client","description":"What model this default folder structure is for. Can be either client or case"},"structure":{"type":"array","example":[{"name":"Documents","children":[{"name":"Contracts","children":[]},{"name":"Emails","children":[]}]},{"name":"Notes","children":[]}],"description":"The folder structure definition for the default folder structure.","items":{"$ref":"#/components/schemas/DefaultFoldersStructure"}},"is_active":{"type":"boolean","example":true,"description":"Whether this default folder structure is active or not. Only one default folder structure for the same model and parameter can be active at a time."},"parameter":{"type":"string","example":"individual","description":"The parameter for the default folder structure. If the model is client, this can be either individual, trust, business or shared. If the type is case, this can be any of the case types that are available in the firm."},"for_existing":{"type":"boolean","example":true,"description":"Whether this default folder structure is applied to existing clients or not. If this is false, the default folder structure will only be applied to new clients."}}},"App_Http_Requests_Addons_Seccl_StoreAdviserSecclNodeAssociationRequest":{"type":"object","required":["associations"],"properties":{"associations":{"type":"array","example":[],"description":"Associations to be created. Each association should have adviser_uuid and SECCL node_ids.","items":{"type":"object","example":{"adviser_uuid":"c33a9081-e6bb-4eab-afd9-8872109058fb","node_ids":["1234","321"]},"properties":{"adviser_uuid":{"type":"string","example":"c33a9081-e6bb-4eab-afd9-8872109058fb","description":"Adviser UUID","format":"uuid"},"node_ids":{"type":"array","example":["1234","321"],"description":"SECCL Node IDs"}}}}}},"App_Http_Requests_Addons_Seccl_CreateSecclClientRequest":{"type":"object","required":["client_type","first_name","surname","nationality","nationalities.*.code","nationalities.*.identifiers.*.name","nationalities.*.identifiers.*.available","date_of_birth","address_1","country","postcode","vulnerability.is_vulnerable","employers.*.company_name","employers.*.company_reg_no"],"properties":{"client_type":{"type":"string","example":"Individual","description":"|\n\nThe type of client.\n\n| Value | Description |\n| ----- | ----------- |\n|Individual|INDIVIDUAL|\n|Individual Minor|INDIVIDUAL_MINOR|","enum":["Individual","Individual Minor"]},"node_id":{"type":"string","example":"2","description":"The Seccl node ID. Required for adult clients."},"parent_id":{"type":"string","example":"02GG28B","description":"The parent client identifier. Required for minor clients. Accepts either a Seccl client ID or a Plannr account UUID."},"title":{"type":"string","example":"Dr","description":"|\n\nThe client's title. Required for adult clients.\n\n| Value | Description |\n| ----- | ----------- |\n|Dr|Dr|\n|Professor|Professor|\n|Mrs|Mrs|\n|Miss|Miss|\n|Mr|Mr|\n|Ms|Ms|\n|Mx|Mx|","enum":["Dr","Professor","Mrs","Miss","Mr","Ms","Mx"]},"first_name":{"type":"string","example":"Jane","description":"The client's first name."},"surname":{"type":"string","example":"Smith","description":"The client's surname."},"email":{"type":"string","example":"jane.smith@example.com","description":"The client's email. Required for adult clients.","format":"email"},"nationality":{"type":"string","example":"GB","description":"The client's primary nationality (2-letter ISO code)."},"nationalities":{"type":"array","example":[{"code":"GB","identifiers":[{"name":"NINO","available":true,"value":"AB123456C"}]}],"description":"Array of nationalities with optional identifiers. Exactly one nationality must include identifiers, and exactly one identifier must be marked as available."},"nationalities.*.code":{"type":"string","example":"GB","description":"The 2-letter ISO country code."},"nationalities.*.identifiers":{"type":"array","example":[{"name":"NINO","available":true,"value":"AB123456C"}],"description":"Array of tax identifiers for this nationality."},"nationalities.*.identifiers.*.name":{"type":"string","example":"NINO","description":"The identifier name (e.g., NINO, TIN, SSN, CONCAT)."},"nationalities.*.identifiers.*.available":{"type":"boolean","example":true,"description":"Whether this identifier is available for the client."},"nationalities.*.identifiers.*.value":{"type":"string","example":"AB123456C","description":"The identifier value. Required when available is true, must not be present when available is false or name is CONCAT."},"national_insurance_no":{"type":"string","example":"AB123456C","description":"The client's national insurance number."},"date_of_birth":{"type":"string","example":"1987-05-15","description":"The client's date of birth.","format":"date"},"flat_number":{"type":"string","example":"12","description":"The client's flat number."},"building_name":{"type":"string","example":"Suite E","description":"The client's building name."},"building_number":{"type":"string","example":"10","description":"The client's building number."},"address_1":{"type":"string","example":"Waterberry Drive","description":"The client's address line 1."},"address_2":{"type":"string","example":"Waterlooville","description":"The client's address line 2."},"country":{"type":"string","example":"GB","description":"The client's country."},"postcode":{"type":"string","example":"PO7 7YH","description":"The client's postcode."},"account_uuid":{"type":"string","example":"7356b97f-6a4c-444f-831e-3e0bb884da5c","description":"The UUID of an existing Plannr account to link to the newly created Seccl client. When provided, the Seccl client ID will be set as an external reference on that account before syncing.","format":"uuid"},"tax_domicile":{"type":"string","example":"GB","description":"The client's tax domicile (2-letter ISO code, currently only GB supported)."},"marital_status":{"type":"string","example":"Single","description":"|\n\nThe client's marital status.\n\n| Value | Description |\n| ----- | ----------- |\n|Single|Single|\n|Married|Married|\n|Divorced|Divorced|\n|Widowed|Widowed|","enum":["Single","Married","Divorced","Widowed"]},"retirement_age":{"type":"integer","example":65,"description":"The client's expected retirement age.","minimum":0,"maximum":120},"vulnerability":{"type":"array","example":{"is_vulnerable":true,"reason":["Health"],"is_support_temporary":false},"description":"Vulnerability information for the client."},"vulnerability.is_vulnerable":{"type":"boolean","example":true,"description":"Whether the client is vulnerable."},"vulnerability.reason":{"type":"array","example":["Health"],"description":"Array of vulnerability reasons (max 4). Required when is_vulnerable is true."},"vulnerability.reason.*":{"type":"string","example":"Health","description":"|\n\nA vulnerability reason.\n\n| Value | Description |\n| ----- | ----------- |\n|Health|HEALTH|\n|Life event|LIFE_EVENT|\n|Resilience|RESILIENCE|\n|Capability|CAPABILITY|","enum":["Health","Life event","Resilience","Capability"]},"vulnerability.is_support_temporary":{"type":"boolean","example":false,"description":"Whether the support required is temporary. Required when is_vulnerable is true."},"bank_details":{"type":"array","example":{"account_number":"12345678","sort_code":"123456"},"description":"Bank account details for the client."},"bank_details.account_number":{"type":"string","example":"12345678","description":"The bank account number. Required if requires_debit_mandate is true.","minLength":8,"maxLength":8},"bank_details.sort_code":{"type":"string","example":"123456","description":"The bank sort code. Required if requires_debit_mandate is true.","minLength":6,"maxLength":6},"requires_debit_mandate":{"type":"boolean","example":false,"description":"Whether a debit mandate is required for this client."},"employment_status":{"type":"string","example":"Employed","description":"|\n\nThe client's employment status.\n\n| Value | Description |\n| ----- | ----------- |\n|Employed|Employed|\n|Retired|Retired|\n|Self Employed|Self Employed|\n|Care Under 16s|Care Under 16S|\n|Care Over 16|Care Over 16|\n|Education|Education|\n|Unemployed|Unemployed|\n|Other|Other|","enum":["Employed","Retired","Self Employed","Care Under 16s","Care Over 16","Education","Unemployed","Other"]},"employers":{"type":"array","example":[{"company_name":"Acme Ltd","company_reg_no":"12345678"}],"description":"Array of employer information (max 1)."},"employers.*.company_name":{"type":"string","example":"Acme Ltd","description":"The employer's company name."},"employers.*.company_reg_no":{"type":"string","example":"12345678","description":"The employer's company registration number."},"employers.*.address_detail":{"type":"array","example":{"address_1":"123 Business Park","country":"GB","post_code":"AB1 2CD"},"description":"The employer's address."},"employers.*.address_detail.flat_number":{"type":"string","example":"1","description":"The employer address flat number."},"employers.*.address_detail.building_name":{"type":"string","example":"Tower A","description":"The employer address building name."},"employers.*.address_detail.building_number":{"type":"string","example":"100","description":"The employer address building number."},"employers.*.address_detail.address_1":{"type":"string","example":"123 Business Park","description":"The employer address line 1."},"employers.*.address_detail.address_2":{"type":"string","example":"Industrial Estate","description":"The employer address line 2."},"employers.*.address_detail.country":{"type":"string","example":"GB","description":"The employer address country."},"employers.*.address_detail.post_code":{"type":"string","example":"AB1 2CD","description":"The employer address postcode."},"employers.*.bank_details":{"type":"array","example":{"sort_code":"123456","account_number":"12345678"},"description":"The employer's bank details."},"employers.*.bank_details.sort_code":{"type":"string","example":"123456","description":"The employer bank sort code.","minLength":6,"maxLength":6},"employers.*.bank_details.account_number":{"type":"string","example":"12345678","description":"The employer bank account number.","minLength":8,"maxLength":8},"aml":{"type":"boolean","example":true,"description":"AML acceptance confirmation. Required and must be accepted for adult clients."}}},"App_Http_Requests_Addons_Seccl_UpdateSecclClientRequest":{"type":"object","properties":{"application_uuid":{"type":"string","example":"61aa4ca4-e180-41cd-a16f-3bbaf377d4c3","description":"The Seccl application","format":"uuid"},"title":{"type":"string","example":"Mr","description":"The client's title."},"first_name":{"type":"string","example":"Gareth","description":"The client's first name."},"surname":{"type":"string","example":"Thompson","description":"The client's surname."},"flat_number":{"type":"string","example":"12","description":"The client's flat number of their address."},"building_name":{"type":"string","example":"Suite E","description":"The client's building name of their address."},"building_number":{"type":"string","example":"12","description":"The client's building number of their address."},"address_1":{"type":"string","example":"Waterberry Drive","description":"The client's address 1 of their address."},"address_2":{"type":"string","example":"Waterlooville","description":"The client's address 2 of their address."},"country":{"type":"string","example":"GB","description":"The client's country of their address."},"postcode":{"type":"string","example":"PO77YH","description":"The client's post code of their address."},"email":{"type":"string","example":"gareth.thompson@plannrcrm.com","description":"The client's email."},"mobile":{"type":"string","example":"07890000000","description":"The client's mobile."},"nationality":{"type":"string","example":"GB","description":"The client's nationality."},"national_insurance_no":{"type":"string","example":"AB123456C","description":"The client's national insurance number."},"date_of_birth":{"type":"string","example":"1987-05-15","description":"The client's date of birth.","format":"date"},"tax_domicile":{"type":"string","example":"GB","description":"The client's tax domicile."},"marketing_consent":{"type":"boolean","example":true,"description":"Boolean to denote whether the client accepts the marketing communication preferences."},"bank_details":{"type":"array","example":{"account_number":"12345678","sort_code":"123456"},"description":"The client's bank details."},"marital_status":{"type":"string","example":"Single","description":"The client's marital status."},"retirement_age":{"type":"integer","example":67,"description":"The client's retirement age."},"vulnerability":{"type":"array","example":{"is_vulnerable":false,"reason":["Health","Resilience","Capability","Life event"],"is_support_temporary":false,"is_vulnerable_set_date":"2024-01-01"},"description":"The client's vulnerability information."},"requires_debit_mandate":{"type":"boolean","example":false,"description":"Whether the client requires a debit mandate."},"employment_status":{"type":"string","example":"Employed","description":"The client's employment status."},"employers":{"type":"array","example":[{"company_name":"Acme Corp","company_reg_no":"12345678","address_detail":{"flat_number":"12","building_name":"Suite E","building_number":"12","address_1":"Waterberry Drive","address_2":"Waterlooville","country":"GB","post_code":"PO77YH"},"bank_details":{"sort_code":"123456","account_number":"12345678","verification_status":"verified","debit_payment_mandate":true,"debit_payment_mandate_agreement_date":"2024-01-01"}}],"description":"Array of the client's employers."},"nationalities":{"type":"array","example":[{"code":"RO"},{"code":"GB","identifiers":[{"name":"National Insurance Number","available":true,"value":"AB000001D"}]}],"description":"The client's nationalities. Exactly one entry must contain an identifiers array, with exactly one identifier marked available. If available is true and name is not CONCAT, value is required. If name is CONCAT, value must be absent."},"platform_terms_agreed":{"type":"boolean","example":true,"description":"Boolean to denote whether the client accepts the platform terms and conditions."}}},"App_Http_Requests_Addons_SmartSearch_RunSmartSearchUKAMLCheckRequest":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","description":"The attributes to be sent","example":{"bank":{"account_type":"direct_debit","sortcode":"12-34-56","account_number":"12345678","roll_number":"CXJ-K6 897/98X"},"addresses":[],"documents":[]},"properties":{"bank":{"type":"object","description":"The array of bank parameters","example":{"account_type":"direct_debit","sortcode":"12-34-56","account_number":"12345678","roll_number":"CXJ-K6 897/98X"},"properties":{"account_type":{"type":"string","example":"direct_debit","description":"Bank account type"},"sortcode":{"type":"string","example":"12-34-56","description":"Bank account sort code"},"account_number":{"type":"string","example":"12345678","description":"Bank account number"},"roll_number":{"type":"string","example":"CXJ-K6 897/98X","description":"Bank account roll number"}}},"addresses":{"type":"array","example":[],"description":"The array of addresses","items":{"type":"object","example":{"flat":"Flat 2","building":"5","street_1":"The Briars","street_2":"Waterberry Drive","town":"Waterlooville","region":"Hampshire","postcode":"PO7 7YH","duration":3},"properties":{"flat":{"type":"string","example":"Flat 2","description":"Address flat name"},"building":{"type":"string","example":"5","description":"Address building name or number"},"street_1":{"type":"string","example":"The Briars","description":"First line of the address"},"street_2":{"type":"string","example":"Waterberry Drive","description":"Second line of the address"},"town":{"type":"string","example":"Waterlooville","description":"Town or city of the address"},"region":{"type":"string","example":"Hampshire","description":"Region of the address"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode of the address"},"duration":{"type":"integer","example":3,"description":"Length of time the individual has lived at this address in months"}}}},"documents":{"type":"array","example":[],"description":"The array of document parameters","items":{"type":"object","example":{"national_insurance":"JM 12 34 56 A.","passport":{"country":"GBR","expiry":"2020-12-20","mrz_line_2":"3785333651GBR6210283M1601013\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c02"},"driving_licence":{"number":"JUDD9507139NP9LN"}},"properties":{"national_insurance":{"type":"string","example":"JM 12 34 56 A.","description":"National insurance number"},"passport":{"type":"object","description":"The array of passport parameters","example":{"country":"GBR","expiry":"2020-12-20","mrz_line_2":"3785333651GBR6210283M1601013\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c02"},"properties":{"country":{"type":"string","example":"GBR","description":"Passport country code"},"expiry":{"type":"string","example":"2020-12-20","description":"Passport expiry date","format":"date"},"mrz_line_2":{"type":"string","example":"3785333651GBR6210283M1601013\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c02","description":"Passport number"}}},"driving_licence":{"type":"object","description":"The array of driving licence parameters","example":{"number":"JUDD9507139NP9LN"},"properties":{"number":{"type":"string","example":"JUDD9507139NP9LN","description":"Driving Licence number"}}}}}}}}}},"App_Http_Requests_Addons_CreateBeIQInvitationRequest":{"type":"object","required":["client_account_uuid","employee_account_uuid"],"properties":{"client_account_uuid":{"type":"string","example":"2d554b1f-fdfc-4422-8b90-26ddec516c6a","description":"The client which you would like to send an invitation to.","format":"uuid"},"employee_account_uuid":{"type":"string","example":"3d6eabb2-eb58-4830-8592-457f39282fca","description":"The employee to associate the client to in Be-IQ. This is only required for the first invitation sent.","format":"uuid"}}},"App_Http_Requests_Addons_Transact_TransactAccountOpeningRequest":{"type":"object","required":["adviser_id","investors","bank_account"],"properties":{"adviser_id":{"type":"string","example":"123456789","description":"The Transact adviser ID to open the account under."},"investors":{"type":"array","example":[],"description":"A list of investors to open accounts for.","items":{"type":"object","example":{"title":"mr","surname":"Miggins","given_names":"Ian","date_of_birth":"1981-05-08","gender":"male","email_address":"text@example.com","nino":"123456789","nationalities":["GB"],"tax_residencies":[],"investor_category":"RETAIL","mobile_number":{"country":"GB","number":"07700900000"},"residential_address":{"line1":"1 Washington Street","line2":"Worcester","post_code":"WR1 1NL","country":"GB"},"postal_address":{"line1":"1 Washington Street","line2":"Worcester","post_code":"WR1 1NL","country":"GB"}},"properties":{"title":{"type":"string","example":"mr","description":"|\n\nInvestor title\n\n| Value | Description |\n| ----- | ----------- |\n|mr|Mr|\n|mrs|Mrs|\n|ms|Ms|\n|miss|Miss|\n|admiral|Admiral|\n|air_commodore|Air Commodore|\n|air_vice_marshall|Air Vice Marshall|\n|archdeacon|Archdeacon|\n|baron|Baron|\n|baroness|Baroness|\n|bishop|Bishop|\n|brigadier|Brigadier|\n|canon|Canon|\n|captain|Captain|\n|colonel|Colonel|\n|commander|Commander|\n|commodore|Commodore|\n|corporal|Corporal|\n|count|Count|\n|countess|Countess|\n|dame|Dame|\n|deacon|Deacon|\n|deaconess|Deaconess|\n|dr|Dr|\n|duchess|Duchess|\n|father|Father|\n|flight_lieutenant|Flight Lieutenant|\n|group_captain|Group Captain|\n|judge|Judge|\n|lady|Lady|\n|lance_corporal|Lance Corporal|\n|lieutenant|Lieutenant|\n|lieutenant_colonel|Lieutenant Colonel|\n|lieutenant_commander|Lieutenant Commander|\n|lord|Lord|\n|madam|Madam|\n|major|Major|\n|major_general|Major General|\n|master|Master|\n|monsignor|Monsignor|\n|mx|Mx|\n|other|Other|\n|pastor|Pastor|\n|prince|Prince|\n|princess|Princess|\n|private|Private|\n|professor|Professor|\n|rabbi|Rabbi|\n|rear_admiral|Rear Admiral|\n|reverend|Reverend|\n|reverend_doctor|Reverend Doctor|\n|right_honourable|Right Honourable|\n|right_honourable_lord|Right Honourable Lord|\n|right_reverend|Right Reverend|\n|second_lieutenant|Second Lieutenant|\n|sergeant|Sergeant|\n|sheriff|Sheriff|\n|sir|Sir|\n|sister|Sister|\n|squadron_leader|Squadron Leader|\n|staff_sergeant|Staff Sergeant|\n|surgeon_captain|Surgeon Captain|\n|the_earl_of|The Earl of|\n|the_honourable|The Honourable|\n|the_reverend_canon|The Reverend Canon|\n|trooper|Trooper|\n|unspecified|Unspecified|\n|venerable|Venerable|\n|very_reverend|Very Reverend|\n|viscount|Viscount|\n|viscountess|Viscountess|\n|wing_commander|Wing Commander|","enum":["mr","mrs","ms","miss","admiral","air_commodore","air_vice_marshall","archdeacon","baron","baroness","bishop","brigadier","canon","captain","colonel","commander","commodore","corporal","count","countess","dame","deacon","deaconess","dr","duchess","father","flight_lieutenant","group_captain","judge","lady","lance_corporal","lieutenant","lieutenant_colonel","lieutenant_commander","lord","madam","major","major_general","master","monsignor","mx","other","pastor","prince","princess","private","professor","rabbi","rear_admiral","reverend","reverend_doctor","right_honourable","right_honourable_lord","right_reverend","second_lieutenant","sergeant","sheriff","sir","sister","squadron_leader","staff_sergeant","surgeon_captain","the_earl_of","the_honourable","the_reverend_canon","trooper","unspecified","venerable","very_reverend","viscount","viscountess","wing_commander"]},"surname":{"type":"string","example":"Miggins","description":"Investor surname"},"given_names":{"type":"string","example":"Ian","description":"Investor given names"},"date_of_birth":{"type":"string","example":"1981-05-08","description":"Investor date of birth - YYYY-MM-DD","format":"date"},"gender":{"type":"string","example":"male","description":"|\n\nInvestor gender\n\n| Value | Description |\n| ----- | ----------- |\n|male|male|\n|female|female|\n|non-binary|non-binary|\n|transgender|transgender|\n|intersex|intersex|\n|other|other|\n|unknown|unknown|","enum":["male","female","non-binary","transgender","intersex","other","unknown"]},"email_address":{"type":"string","example":"text@example.com","description":"Investor email address"},"nino":{"type":"string","example":"123456789","description":"Investor National Insurance number"},"nationalities":{"type":"array","example":["GB"],"description":"Investor nationalities, ISO 3166-1 alpha-2 codes"},"tax_residencies":{"type":"array","example":[],"description":"The array of tax residencies","items":{"type":"object","example":{"country":"GB","tax_id":"123456789"},"properties":{"country":{"type":"string","example":"GB","description":"Tax residency country code"},"tax_id":{"type":"string","example":"123456789","description":"Tax residency tax ID"}}}},"investor_category":{"type":"string","example":"RETAIL","description":"Investor category","enum":["RETAIL","PROFESSIONAL"]},"mobile_number":{"type":"object","description":"Investor mobile number","example":{"country":"GB","number":"07700900000"},"properties":{"country":{"type":"string","example":"GB","description":"Mobile number country, ISO 3166-1 alpha-2"},"number":{"type":"string","example":"07700900000","description":"Mobile number"}}},"residential_address":{"type":"object","description":"Investor residential address","example":{"line1":"1 Washington Street","line2":"Worcester","post_code":"WR1 1NL","country":"GB"},"properties":{"line1":{"type":"string","example":"1 Washington Street","description":"Residential address line 1"},"line2":{"type":"string","example":"Worcester","description":"Residential address line 2"},"post_code":{"type":"string","example":"WR1 1NL","description":"Residential address postcode"},"country":{"type":"string","example":"GB","description":"Residential address country, ISO 3166-1 alpha-2"}}},"postal_address":{"type":"object","description":"Investor postal address","example":{"line1":"1 Washington Street","line2":"Worcester","post_code":"WR1 1NL","country":"GB"},"properties":{"line1":{"type":"string","example":"1 Washington Street","description":"Investor postal address line 1"},"line2":{"type":"string","example":"Worcester","description":"Investor postal address line 2"},"post_code":{"type":"string","example":"WR1 1NL","description":"Investor postal address postcode"},"country":{"type":"string","example":"GB","description":"Investor postal address country, ISO 3166-1 alpha-2"}}}}}},"bank_account":{"type":"object","description":"Bank account details","example":{"sort_code":"123456","account_number":"12345678","account_name_or_roll_number":"Ian Miggins","is_building_society":true},"properties":{"sort_code":{"type":"string","example":"123456","description":"Bank account sort code - 6 digits, no hyphens or spaces."},"account_number":{"type":"string","example":"12345678","description":"Bank account number - max 8 characters."},"account_name_or_roll_number":{"type":"string","example":"Ian Miggins","description":"Bank account name or roll number - max 32 characters."},"is_building_society":{"type":"boolean","example":true,"description":"Is this a building society account?"}}}}},"App_Http_Requests_MortgageBrain_StoreMortgageSearchRequest":{"type":"object","required":["applicants","proceed"],"properties":{"applicants":{"type":"array","example":[],"description":"The applicants for the mortgage search. Must be at least one and no more than two.","items":{"type":"object","example":{"account_uuid":"c78e31f2-c5a2-4556-9598-2ad0374ea7b8","title":"mr","date_of_birth":"1999-01-01","birth_gender":"male","salutation":"John","retirement_age":65,"employment_status":"employed","annual_salary_amount":3000000},"properties":{"account_uuid":{"type":"string","example":"c78e31f2-c5a2-4556-9598-2ad0374ea7b8","description":"The UUID of the applicant","format":"uuid"},"title":{"type":"string","example":"mr","description":"|\n\nThe title of the applicant\n\n| Value | Description |\n| ----- | ----------- |\n|mr|MR|\n|mrs|MRS|\n|miss|MISS|\n|ms|MS|\n|mx|MX|\n|dr|DR|\n|dame|DAME|\n|father|FATHER|\n|madam|MADAM|\n|lord|LORD|\n|sir|SIR|\n|prof|PROF|","enum":["mr","mrs","miss","ms","mx","dr","dame","father","madam","lord","sir","prof"]},"date_of_birth":{"type":"string","example":"1999-01-01","description":"The date of birth of the applicant","format":"date","nullable":true},"birth_gender":{"type":"string","example":"male","description":"|\n\nThe birth gender of the applicant\n\n| Value | Description |\n| ----- | ----------- |\n|male|MALE|\n|female|FEMALE|","enum":["male","female"],"nullable":true},"salutation":{"type":"string","example":"John","description":"The salutation of the applicant","nullable":true},"retirement_age":{"type":"integer","example":65,"description":"The retirement age of the applicant","nullable":true},"employment_status":{"type":"string","example":"employed","description":"|\n\nThe employment status of the applicant\n\n| Value | Description |\n| ----- | ----------- |\n|employed|EMPLOYED|\n|self_employed|SELF_EMPLOYED|\n|retired|RETIRED|","enum":["employed","self_employed","retired"],"nullable":true},"annual_salary_amount":{"type":"integer","example":3000000,"description":"The annual salary amount of the applicant. Price must be in pennies.","nullable":true}}}},"case_uuids":{"type":"array","example":["f229d62f-8d88-43cf-815a-6df2522e170f","b7797ed1-3c8e-482b-882d-76c08d8f9387","d81ecf00-4754-4852-92b8-ef487d0a9e04"],"description":"An optional array of case UUIDs to associate to the mortgage search","items":{"type":"string","example":"6f352584-5bb4-4868-8c20-96bad4f941eb","format":"uuid"},"nullable":true},"oauth_connection_uuid":{"type":"string","example":"c6f37d91-1f95-4ff2-b3dc-ebacc2a979ba","description":"An optional OAuth2 connection UUID to overwrite the default behaviour (which is to pick the first Mortgage Brain OAuth2 connection)","format":"uuid","nullable":true},"proceed":{"type":"boolean","example":true,"description":"This parameter can be used to indicate whether to proceed with creating the mortgage search or not. If false, a 202 response will be returned without creating the search. This can be used to validate the data before continuing."}}},"App_Http_Requests_OAuth2_UpdateOAuthConnectionRequest":{"type":"object","properties":{"label":{"type":"string","example":"My Fundment Account 1","description":"The label of the OAuth2 connection"}}},"App_Http_Requests_V2_Risks_StoreRiskRequest":{"type":"object","required":["account_uuid","completed_at","completed_by"],"properties":{"account_uuid":{"type":"string","example":"a155d8fb-3d5a-4149-9dbb-0b31aaf6af68","description":"The UUID of the accounts who should own the risk. These must only be client accounts.","format":"uuid"},"level":{"type":"integer","example":52,"description":"The risk level of the clients risk assessment. Number between 1 and 1,000. Cannot be set with level_string","minimum":1,"maximum":1000,"nullable":true},"level_string":{"type":"string","example":"Moderately Aggressive","description":"The risk level of the client as a string/text. Cannot be set with level.","maxLength":255,"nullable":true},"completed_at":{"type":"string","example":"2025-05-08","description":"Date of risk assessment completion.","format":"date"},"completed_by":{"type":"string","example":"5d32345d-dc6b-48a3-8b7f-875e4a0f3cb0","description":"Uuid of the employee that completed the risk assessment","format":"uuid"},"risk_assessment_provider":{"type":"string","example":"Defaqto","description":"Name of provider for the risk assessment","maxLength":255,"nullable":true},"time_horizon":{"type":"string","example":"For the next 5 years","description":"Time horizon: how long the risk assessment will last for the client.","maxLength":255,"nullable":true}}},"App_Http_Requests_V2_Risks_UpdateRiskRequest":{"type":"object","properties":{"account_uuid":{"type":"string","example":"d7e78fa8-db24-4816-838b-6129e17eaf48","description":"The UUID of the accounts who should own the risk. These must only be client accounts.","format":"uuid"},"level":{"type":"integer","example":7,"description":"The risk level of the clients risk assessment. Number between 1 and 1,000. Cannot be set with level_string","minimum":1,"maximum":1000,"nullable":true},"level_string":{"type":"string","example":"Moderately Aggressive","description":"The risk level of the client as a string/text. Cannot be set with level.","maxLength":255,"nullable":true},"completed_at":{"type":"string","example":"2025-05-08","description":"Date of risk assessment completion.","format":"date"},"completed_by":{"type":"string","example":"72c66a0e-0e6e-4083-a295-f881dc8113ac","description":"Uuid of the employee that completed the risk assessment","format":"uuid"},"risk_assessment_provider":{"type":"string","example":"Defaqto","description":"Name of provider for the risk assessment","maxLength":255,"nullable":true},"time_horizon":{"type":"string","example":"For the next 5 years","description":"Time horizon: how long the risk assessment will last for the client.","maxLength":255,"nullable":true}}},"App_Http_Requests_V2_Addresses_StoreAddressRequest":{"type":"object","required":["account_uuids"],"properties":{"account_uuids":{"type":"array","example":["49cdf657-2eb5-4f0d-a3f3-7e82a7d23d33","167b71cd-cb19-4467-8a11-d86fe8f9a38c","25e3f62f-3dd6-4045-9714-aeca76894ac6"],"description":"The UUIDs of the accounts who should own the address. These must only be client accounts.","items":{"type":"string","example":"4a217357-3c3e-4846-b40e-e4e9296e8574","format":"uuid"}},"primary_account_uuids":{"type":"array","example":["ba983d50-6c7e-414d-b02e-2fa477d8b7f4","95a92abe-e676-4f26-ae81-346b4e37f0c2","561c8b24-c561-4260-906a-ac4b6cc4696c"],"description":"The UUIDs of the accounts who should have the address as their primary address.","items":{"type":"string","example":"27867ab3-d606-4d0f-af88-05b2a3fa1765","format":"uuid"}},"is_primary":{"type":"boolean","example":true,"description":"When provided and set to true, it will make the created address the primary address for all of the account UUIDs provided."},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"move_in_date":{"type":"string","example":"2024-06-20","description":"Move in date"},"moved_in_month":{"type":"integer","example":6,"description":"The month the client moved into this address."},"moved_in_year":{"type":"integer","example":2022,"description":"The year the client moved into this address."},"moved_out_month":{"type":"integer","example":1,"description":"The month the client moved out of this address."},"moved_out_year":{"type":"integer","example":2024,"description":"The year the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","description":"|\n\nThe client's residential status when living at the address.\n\n| Value | Description |\n| ----- | ----------- |\n|homeowner|Homeowner|\n|renting|Renting|\n|living_with_parents|Living With Parents|\n|other|Other|","enum":["homeowner","renting","living_with_parents","other"]},"residential_status_other":{"type":"string","example":"Non-tenant occupier","description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."}}},"App_Http_Requests_V2_Addresses_UpdateAddressRequest":{"type":"object","properties":{"account_uuids":{"type":"array","example":["68266b68-41a5-4c9b-89df-faf742812d9d","b6a04c06-4ed4-4164-9008-ca0bb839db61","1dfd6038-5bbe-4cf6-8972-d9c904962573"],"description":"The UUIDs of the accounts who should own the address. These must only be client accounts.","items":{"type":"string","example":"48cd2bbe-cc80-47cc-9168-a7fb37d02bf6","format":"uuid"}},"primary_account_uuids":{"type":"array","example":["7c687f43-7ddf-4429-a700-a7ea512b9457","8b595997-13cf-40a7-8f85-8088a1bdb289","2da7b650-e7b5-4c3f-b0e0-110b38faf443"],"description":"The UUIDs of the accounts who should have the address as their primary address.","items":{"type":"string","example":"636921f8-d56d-448b-a55d-ec2d42a1a2d4","format":"uuid"}},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"move_in_date":{"type":"string","example":"2024-06-20","description":"Move in date"},"moved_in_month":{"type":"integer","example":6,"description":"The month the client moved into this address."},"moved_in_year":{"type":"integer","example":2022,"description":"The year the client moved into this address."},"moved_out_month":{"type":"integer","example":1,"description":"The month the client moved out of this address."},"moved_out_year":{"type":"integer","example":2024,"description":"The year the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","description":"|\n\nThe client's residential status when living at the address.\n\n| Value | Description |\n| ----- | ----------- |\n|homeowner|Homeowner|\n|renting|Renting|\n|living_with_parents|Living With Parents|\n|other|Other|","enum":["homeowner","renting","living_with_parents","other"]},"residential_status_other":{"type":"string","example":"Non-tenant occupier","description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."}}},"App_Http_Requests_V2_StoreContactDetailRequest":{"type":"object","required":["type","name","value","account_uuids"],"properties":{"type":{"type":"string","example":"email","description":"|\n\nContact Detail type.\n\n| Value | Description |\n| ----- | ----------- |\n|email|Email|\n|phone_number|Phone Number|","enum":["email","phone_number"]},"is_primary":{"type":"boolean","example":true,"description":"Make this contact type the primary contact. Will make all other contact details of the same type no longer primary."},"name":{"type":"string","example":"Work phone number","description":"Description of contact detail","maxLength":255},"value":{"example":["+44751488454","0751488454",{"country":"AU","number":"+61 2 3456 7890"},"someone@example.com"],"description":"Contact Detail value can be provided in various formats. Phone number or email address depending on the type.","oneOf":[{"type":"string","example":"+44751488454","description":"Phone number in international format","format":"international phone"},{"type":"string","example":"0751488454","description":"Phone number in UK standard format","format":"UK phone"},{"type":"object","description":"Telephone number object - with country code and number","example":{"country":"AU","number":"+61 2 3456 7890"},"properties":{"country":{"type":"string","example":"AU","description":"country code in ISO 3166-1 alpha-2 format"},"number":{"type":"string","example":"+61 2 3456 7890","description":"Phone number including area code"}},"required":["country","number"]},{"type":"string","example":"someone@example.com","description":"Email address","format":"email"}]},"account_uuids":{"type":"array","example":["6666fd63-f15a-4107-bfeb-7f957cb49e91","4226eec9-839f-416c-95fb-927a83009e58","022945bf-fd15-4979-8471-915756eb823d"],"description":"The UUIDs of the accounts who should own the contact detail. These must only be client accounts.","items":{"type":"string","example":"ec2543ee-64ef-4027-b7e3-b5999442b4dc","format":"uuid"}},"primary_account_uuids":{"type":"array","example":["8d79eba7-27b1-48df-b99a-32557d8e9573","abb6e38b-e6f1-418e-8914-680e7c494bc9","f65b5406-ce35-4240-9756-2129aced3100"],"description":"The UUIDs of the accounts who should have the contact detail as their primary contact detail.","items":{"type":"string","example":"89200bbd-e195-42d8-b547-75c7cb5f257a","format":"uuid"}}}},"App_Http_Requests_V2_UpdateContactDetailRequest":{"type":"object","required":["name","value","account_uuids"],"properties":{"name":{"type":"string","example":"Work phone number","description":"Description of contact detail","maxLength":255},"value":{"example":["+44751488454","0751488454",{"country":"AU","number":"+61 2 3456 7890"},"someone@example.com"],"description":"Contact Detail value can be provided in various formats. Phone number or email address depending on the type.","oneOf":[{"type":"string","example":"+44751488454","description":"Phone number in international format","format":"international phone"},{"type":"string","example":"0751488454","description":"Phone number in UK standard format","format":"UK phone"},{"type":"object","description":"Telephone number object - with country code and number","example":{"country":"AU","number":"+61 2 3456 7890"},"properties":{"country":{"type":"string","example":"AU","description":"country code in ISO 3166-1 alpha-2 format"},"number":{"type":"string","example":"+61 2 3456 7890","description":"Phone number including area code"}},"required":["country","number"]},{"type":"string","example":"someone@example.com","description":"Email address","format":"email"}]},"account_uuids":{"type":"array","example":["385f565a-6f18-47cd-a57d-7a8e400699c0","4fc86d32-4ab7-4287-9f00-d56898dadff5","eb15b064-e590-4d52-8c90-0ffb0d8d71b1"],"description":"The UUIDs of the accounts who should own the contact detail. These must only be client accounts.","items":{"type":"string","example":"8f451b53-0ffa-4ae2-a1d4-eaa1e93493c6","format":"uuid"}},"primary_account_uuids":{"type":"array","example":["0663be02-7ccc-4be8-bc15-f59c9246c22f","2455bb8b-4fd3-4842-b67d-4644c4377f02","e74f9db2-6107-4661-a53e-140b382115ac"],"description":"The UUIDs of the accounts who should have the contact detail as their primary contact detail.","items":{"type":"string","example":"114c06ed-2ace-453a-b8ca-df0d7b753f7f","format":"uuid"}}}},"App_Http_Requests_V2_Dependants_StoreDependantRequest":{"type":"object","required":["account_uuids","first_name","last_name","relationship"],"properties":{"account_uuids":{"type":"array","example":["f6b2d9e8-8329-4eff-950d-c1ac4ad73d64","7ad44722-fc4b-4061-a2eb-01950abb7b22","c419b8e5-a5b7-49fc-9454-93581ce9df52"],"description":"The UUIDs of the accounts who should own the dependant. These must only be client accounts.","items":{"type":"string","example":"8d0b3264-d8fb-4f33-892a-2b427fd3d903","format":"uuid"}},"first_name":{"type":"string","example":"Christopher","description":"The first name of the dependant.","maxLength":255},"last_name":{"type":"string","example":"Nolan","description":"The last name of the dependant.","maxLength":255},"known_as":{"type":"string","example":"Chris","description":"An optional nickname for the dependant.","maxLength":255,"nullable":true},"relationship":{"type":"string","example":"Brother","description":"The relationship of the dependant.","maxLength":255},"date_of_birth":{"type":"string","example":"2006-05-08","description":"The date of birth of the dependant. Must be in Y-m-d format. Example: 1990-12-25.","format":"date","nullable":true},"is_financially_dependant":{"type":"boolean","example":true,"description":"Denotes if the dependant is financially dependant on the client."},"notes":{"type":"string","example":"Example notes","description":"Optional notes for the dependant.","maxLength":5000,"nullable":true}}},"App_Http_Requests_V2_Dependants_UpdateDependantRequest":{"type":"object","required":["account_uuids","first_name","last_name","relationship"],"properties":{"account_uuids":{"type":"array","example":["28966af4-6083-4a61-9209-6de5274836a9","cb33b1d8-f22d-44d4-a00c-fa6c238a5ecf","dd36641f-64f6-4628-ae86-27755fdbbbd3"],"description":"The UUIDs of the accounts who should own the dependant. These must only be client accounts.","items":{"type":"string","example":"332e71de-6941-450b-8389-a477bbe5456a","format":"uuid"}},"first_name":{"type":"string","example":"Christopher","description":"The first name of the dependant.","maxLength":255},"last_name":{"type":"string","example":"Nolan","description":"The last name of the dependant.","maxLength":255},"known_as":{"type":"string","example":"Chris","description":"An optional nickname for the dependant.","maxLength":255,"nullable":true},"relationship":{"type":"string","example":"Brother","description":"The relationship of the dependant.","maxLength":255},"date_of_birth":{"type":"string","example":"2006-05-08","description":"The date of birth of the dependant. Must be in Y-m-d format. Example: 1990-12-25.","format":"date","nullable":true},"is_financially_dependant":{"type":"boolean","example":true,"description":"Denotes if the dependant is financially dependant on the client."},"notes":{"type":"string","example":"Example notes","description":"Optional notes for the dependant.","maxLength":5000,"nullable":true}}},"App_Http_Requests_Plans_StoreLinkedPolicyNumberRequest":{"type":"object","required":["linked_policy_number"],"properties":{"linked_policy_number":{"type":"string","example":"ABC123-X","description":"The linked policy number for the plan."}}},"App_Http_Requests_Plans_UpdateLinkedPolicyNumberRequest":{"type":"object","required":["linked_policy_number"],"properties":{"linked_policy_number":{"type":"string","example":"ABC123-X","description":"The linked policy number for the plan."}}},"App_Http_Requests_V2_Goals_StoreGoalRequest":{"type":"object","required":["account_uuids","name","target_amount"],"properties":{"account_uuids":{"type":"array","example":["9373cd9a-44ab-4664-a060-d9e9e729ca7a","7395d46c-974c-449a-ade5-fb0d8baccfaa","2d375379-7d48-4d59-9ad7-d870521a2c85"],"description":"The UUIDs of the accounts who should own the goal. These must only be client accounts.","items":{"type":"string","example":"bad35b8f-c0f3-4363-9b12-7f02060d79fe","format":"uuid"}},"name":{"type":"string","example":"Reduced Mileage","description":"The goal's name.","maxLength":255},"description":{"type":"string","example":"Reduce the amount of gas spent yearly.","description":"The goal's description.","maxLength":5000,"nullable":true},"target_amount":{"type":"integer","example":5000,"description":"The goal's target amount.","minimum":0},"progress":{"type":"integer","example":68,"description":"The goal's progress as a percentage.","minimum":0,"maximum":100},"timeframe":{"type":"string","example":"Within the year.","description":"The goal's timeframe.","maxLength":255,"nullable":true},"complete_goal_by":{"type":"string","example":"2027-05-08","description":"The goal's deadline as a specific date.","format":"date"},"priority":{"type":"integer","example":4,"description":"The goal's priority on a scale from 1 to 5.","minimum":1,"maximum":5},"show_on_circles":{"type":"boolean","example":false,"description":"Determines if goal should be shown on a circle."},"visible_to_circles_uuids":{"type":"array","example":["876e1e9e-12a9-49c2-89be-c753b2ab678e","e319ae80-9726-4fcd-b7ba-ba199c87b251","f6897799-8275-47a3-9784-6df738206de8"],"description":"Circles UUIDs that can view the goal when filtering goals by circles. Leaving blank means the goal will be visible for all circles which contains the goal owners.","items":{"type":"string","example":"262d8025-a73c-4b4e-9bf7-82b79a7e144c","format":"uuid"}}}},"App_Http_Requests_V2_Goals_UpdateGoalRequest":{"type":"object","properties":{"account_uuids":{"type":"array","example":["a26706a8-98a4-4fa1-bb62-811f819998bd","38debaa6-256f-49ea-a90c-8e546db899e3","9604dfd1-0ffa-40d7-82c6-5add40749d25"],"description":"The UUIDs of the accounts who should own the goal. These must only be client accounts.","items":{"type":"string","example":"95a0e7b0-5cd0-4c2b-8e8d-c50d9aad0454","format":"uuid"}},"name":{"type":"string","example":"Reduced Mileage","description":"The goal's name.","maxLength":255},"description":{"type":"string","example":"Reduce the amount of gas spent yearly.","description":"The goal's description.","maxLength":5000},"target_amount":{"type":"integer","example":500,"description":"The goal's target amount.","minimum":0},"progress":{"type":"integer","example":68,"description":"The goal's progress as a percentage.","minimum":0,"maximum":100},"timeframe":{"type":"string","example":"Within the year.","description":"The goal's timeframe.","maxLength":255,"nullable":true},"complete_goal_by":{"type":"string","example":"2027-05-08","description":"The goal's deadline as a specific date.","format":"date"},"priority":{"type":"integer","example":4,"description":"The goal's priority on a scale from 1 to 5.","minimum":1,"maximum":5},"shown_on_circles":{"type":"boolean","example":false,"description":"Determines if goal should be shown on a circle."},"visible_to_circles_uuids":{"type":"array","example":["9ce7ab2d-1b0e-4cde-add3-3dc2a43501c9","cc1a4770-4235-4ddb-82af-00660c2e7c0b","ff3d1bc3-64cf-43c5-91eb-554c835db02d"],"description":"Circles UUIDs that can view the goal when filtering goals by circles. Leaving blank means the goal will be visible for all circles which contains the goal owners.","items":{"type":"string","example":"de0fc980-d931-48b0-a67c-b2e08a420613","format":"uuid"}}}},"App_Http_Requests_V2_Income_StoreIncomeRequest":{"type":"object","required":["account_uuid","name","type","amount","amount_type","frequency"],"properties":{"account_uuid":{"type":"string","example":"5d623bb8-5b39-40b8-9c36-aeb82a26cee7","description":"Client account UUID of who this income belongs to.","format":"uuid"},"name":{"type":"string","example":"My Salary","description":"The name of the income.","maxLength":255},"type":{"type":"string","example":"salary","description":"|\n\nThe type of income.\n\n| Value | Description |\n| ----- | ----------- |\n|salary|Salary|\n|dividend|Dividend|\n|bonus|Bonus|\n|benefit|Benefit|\n|other|Other|\n|investment|Investment|\n|rental|Rental|\n|pension|Pension|\n|capital_gains|Capital Gains|\n|business_loan|Business Loan|\n|investor_funding|Investor Funding|\n|grant|Grant|\n|charity|Charity|\n|crowdfunding|Crowdfunding|\n|gross_profit|Gross Profit|\n|operating_profit|Operating Profit|\n|operating_revenue|Operating Revenue|\n|non_operating_revenue|Non Operating Revenue|\n|net_profit|Net Profit|","enum":["salary","dividend","bonus","benefit","other","investment","rental","pension","capital_gains","business_loan","investor_funding","grant","charity","crowdfunding","gross_profit","operating_profit","operating_revenue","non_operating_revenue","net_profit"]},"type_other":{"type":"string","example":"My Other Income","description":"The type of income when the type is set to \"other\".","maxLength":255,"nullable":true},"amount":{"type":"integer","example":5000000,"description":"The amount of the income in pennies. For example, £50,000 would be 5000000."},"amount_type":{"type":"string","example":"net","description":"|\n\nThe type of the amount.\n\n| Value | Description |\n| ----- | ----------- |\n|net|Net|\n|gross|Gross|","enum":["net","gross"]},"start_date":{"type":"string","example":"2025-05-08","description":"The start date of the income.","format":"date","nullable":true},"end_date":{"type":"string","example":"2026-05-08","description":"The end date of the income.","format":"date","nullable":true},"frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency of the income.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"is_taxable":{"type":"boolean","example":true,"description":"Denotes if the income is taxable or not."},"employment_uuid":{"type":"string","example":"ed91b94b-3ce2-4707-9d35-1a301efe1955","description":"Employment to link to this salary, dividend, bonus, benefit, other type incomes.","format":"uuid"}}},"App_Http_Requests_V2_Income_UpdateIncomeRequest":{"type":"object","required":["name","type","amount","amount_type","frequency"],"properties":{"name":{"type":"string","example":"My Salary","description":"The name of the income.","maxLength":255},"type":{"type":"string","example":"salary","description":"|\n\nThe type of income.\n\n| Value | Description |\n| ----- | ----------- |\n|salary|Salary|\n|dividend|Dividend|\n|bonus|Bonus|\n|benefit|Benefit|\n|other|Other|\n|investment|Investment|\n|rental|Rental|\n|pension|Pension|\n|capital_gains|Capital Gains|\n|business_loan|Business Loan|\n|investor_funding|Investor Funding|\n|grant|Grant|\n|charity|Charity|\n|crowdfunding|Crowdfunding|\n|gross_profit|Gross Profit|\n|operating_profit|Operating Profit|\n|operating_revenue|Operating Revenue|\n|non_operating_revenue|Non Operating Revenue|\n|net_profit|Net Profit|","enum":["salary","dividend","bonus","benefit","other","investment","rental","pension","capital_gains","business_loan","investor_funding","grant","charity","crowdfunding","gross_profit","operating_profit","operating_revenue","non_operating_revenue","net_profit"]},"type_other":{"type":"string","example":"My Other Income","description":"The type of income when the type is set to \"other\".","maxLength":255,"nullable":true},"amount":{"type":"integer","example":5000000,"description":"The amount of the income in pennies. For example, £50,000 would be 5000000."},"amount_type":{"type":"string","example":"net","description":"|\n\nThe type of the amount.\n\n| Value | Description |\n| ----- | ----------- |\n|net|Net|\n|gross|Gross|","enum":["net","gross"]},"start_date":{"type":"string","example":"2025-05-08","description":"The start date of the income.","format":"date","nullable":true},"end_date":{"type":"string","example":"2026-05-08","description":"The end date of the income.","format":"date","nullable":true},"frequency":{"type":"string","example":"daily","description":"|\n\nThe frequency of the income.\n\n| Value | Description |\n| ----- | ----------- |\n|daily|Daily|\n|weekly|Weekly|\n|fortnightly|Fortnightly|\n|four_weekly|Four Weekly|\n|monthly|Monthly|\n|bimonthly|Bimonthly|\n|quarterly|Quarterly|\n|biannually|Biannually|\n|annually|Annually|\n|adhoc|Adhoc|\n|one_off|One Off|","enum":["daily","weekly","fortnightly","four_weekly","monthly","bimonthly","quarterly","biannually","annually","adhoc","one_off"]},"is_taxable":{"type":"boolean","example":true,"description":"Denotes if the income is taxable or not."},"employment_uuid":{"type":"string","example":"32875c9f-a59a-4802-a620-5eb87f23fc72","description":"Employment to link to this salary, dividend, bonus, benefit, other type incomes.","format":"uuid"}}},"App_Http_Requests_V2_Employment_StoreEmploymentRequest":{"type":"object","required":["account_uuid","status"],"properties":{"account_uuid":{"type":"string","example":"4f0d2719-f097-46cc-b4d6-d49ba505c81d","description":"The uuid of the account to link Employment to.","format":"uuid"},"accountant_company_name":{"type":"string","example":"My Company","description":"The name of the accountant company.","maxLength":255,"nullable":true},"accountant_email":{"type":"string","example":"accountant@email.com","description":"The email of the accountant.","maxLength":255,"nullable":true},"accountant_telephone_number":{"type":"string","example":"0123456789","description":"The telephone number of the accountant.","nullable":true},"accountant_address":{"type":"string","example":"1 My Street, My Town, My Country","description":"The address of the accountant.","maxLength":255,"nullable":true},"business_name":{"type":"string","example":"My Business","description":"The name of the business.","maxLength":255,"nullable":true},"business_value":{"type":"integer","example":5000000,"description":"The value of the business in pennies.","nullable":true},"business_year_end":{"type":"string","example":"2019-01-01","description":"The year end of the business.","maxLength":255,"nullable":true},"directors":{"type":"string","example":"John Doe","description":"The directors of the business.","maxLength":255,"nullable":true},"employer":{"type":"string","example":"Plannr Technologies Ltd","description":"The name of the employer/business.","maxLength":255,"nullable":true},"email_address":{"type":"string","example":"gareth@plannrcrm.com","description":"The email address of the employer. Will be added as a contact detail.","maxLength":255,"nullable":true},"ended_at":{"type":"string","example":"2022-05-08","description":"An optional end date of the employment.","format":"date"},"is_business_owner":{"type":"boolean","example":true,"description":"Denotes if the employment owner is the business owner."},"job_title":{"type":"string","example":"Senior Developer","description":"Job title if no suitable occupation code is found.","maxLength":255,"nullable":true},"last_salary_increase":{"type":"string","example":"2019-01-01","description":"The date of the last salary increase.","format":"date","nullable":true},"occupation_code":{"type":"string","example":"FAC02774","description":"The Origo occupation code for the given employment. You can use the /api/v1/static/occupations endpoint to get a list of occupations.","nullable":true},"percentage_of_business_owned":{"type":"integer","example":50,"description":"The percentage of the business owned.","minimum":0,"maximum":100,"nullable":true},"phone_number":{"type":"string","example":"+443330509960","description":"The phone number of the employer. In E.164 format. Will be added as a contact detail.","nullable":true},"primary":{"type":"boolean","example":true,"description":"Make this employment the primary employment.  Will make all other employments no longer primary."},"profit":{"type":"integer","example":5000000,"description":"The profit of the business in pennies.","minimum":0,"nullable":true},"shareholding_in_business":{"type":"number","example":50.5,"description":"The shareholding in the business in percentage.","format":"float","minimum":0.0,"maximum":100.0,"nullable":true},"started_at":{"type":"string","example":"2021-05-08","description":"An optional start date of the employment.","format":"date"},"status":{"type":"string","example":"employed","description":"|\n\nThe employment status for the given employment.\n\n| Value | Description |\n| ----- | ----------- |\n|employed|Employed|\n|self_employed|Self Employed|\n|student|Student|\n|unemployed|Unemployed|\n|house_person|House Person|\n|retired|Retired|\n|other|Other|","enum":["employed","self_employed","student","unemployed","house_person","retired","other"]},"turnover_history":{"type":"array","example":[],"description":"An array of turnover history items.","items":{"$ref":"#/components/schemas/TurnoverHistoryItem"},"nullable":true},"address":{"$ref":"#/components/schemas/BasicAddress"}}},"App_Http_Requests_V2_Employment_UpdateEmploymentRequest":{"type":"object","required":["status"],"properties":{"accountant_company_name":{"type":"string","example":"My Company","description":"The name of the accountant company.","maxLength":255,"nullable":true},"accountant_email":{"type":"string","example":"accountant@email.com","description":"The email of the accountant.","maxLength":255,"nullable":true},"accountant_telephone_number":{"type":"string","example":"0123456789","description":"The telephone number of the accountant.","nullable":true},"accountant_address":{"type":"string","example":"1 My Street, My Town, My Country","description":"The address of the accountant.","maxLength":255,"nullable":true},"business_name":{"type":"string","example":"My Business","description":"The name of the business.","maxLength":255,"nullable":true},"business_value":{"type":"integer","example":5000000,"description":"The value of the business in pennies.","nullable":true},"business_year_end":{"type":"string","example":"2019-01-01","description":"The year end of the business.","maxLength":255,"nullable":true},"directors":{"type":"string","example":"John Doe","description":"The directors of the business.","maxLength":255,"nullable":true},"employer":{"type":"string","example":"Plannr Technologies Ltd","description":"The name of the employer/business.","maxLength":255,"nullable":true},"email_address":{"type":"string","example":"gareth@plannrcrm.com","description":"The email address of the employer. Will be added as a contact detail.","maxLength":255,"nullable":true},"ended_at":{"type":"string","example":"2022-05-08","description":"An optional end date of the employment.","format":"date"},"is_business_owner":{"type":"boolean","example":true,"description":"Denotes if the employment owner is the business owner."},"job_title":{"type":"string","example":"Senior Developer","description":"Job title if no suitable occupation code is found.","maxLength":255,"nullable":true},"last_salary_increase":{"type":"string","example":"2019-01-01","description":"The date of the last salary increase.","format":"date","nullable":true},"occupation_code":{"type":"string","example":"FAC02774","description":"The Origo occupation code for the given employment. You can use the /api/v1/static/occupations endpoint to get a list of occupations.","nullable":true},"percentage_of_business_owned":{"type":"integer","example":50,"description":"The percentage of the business owned.","minimum":0,"maximum":100,"nullable":true},"phone_number":{"type":"string","example":"+443330509960","description":"The phone number of the employer. In E.164 format. Will be added as a contact detail.","nullable":true},"primary":{"type":"boolean","example":true,"description":"Make this employment the primary employment.  Will make all other employments no longer primary."},"profit":{"type":"integer","example":5000000,"description":"The profit of the business in pennies.","minimum":0,"nullable":true},"shareholding_in_business":{"type":"number","example":50.5,"description":"The shareholding in the business in percentage.","format":"float","minimum":0.0,"maximum":100.0,"nullable":true},"started_at":{"type":"string","example":"2021-05-08","description":"An optional start date of the employment.","format":"date"},"status":{"type":"string","example":"employed","description":"|\n\nThe employment status for the given employment.\n\n| Value | Description |\n| ----- | ----------- |\n|employed|Employed|\n|self_employed|Self Employed|\n|student|Student|\n|unemployed|Unemployed|\n|house_person|House Person|\n|retired|Retired|\n|other|Other|","enum":["employed","self_employed","student","unemployed","house_person","retired","other"]},"turnover_history":{"type":"array","example":[],"description":"An array of turnover history items.","items":{"$ref":"#/components/schemas/TurnoverHistoryItem"},"nullable":true},"address":{"$ref":"#/components/schemas/BasicAddress"}}},"App_Http_Requests_StoreShareholderRequest":{"type":"object","required":["business_uuid","full_name","percentage","shares_owned","voting_rights","role","appointed_at"],"properties":{"business_uuid":{"type":"string","example":"91f04547-fff6-491b-951c-eee04ea44af5","description":"The UUID of the business this shareholder is associated with.","format":"uuid"},"full_name":{"type":"string","example":"John Doe","description":"The shareholder's full name."},"percentage":{"type":"number","example":11.7,"description":"The percentage of ownership this shareholder has.","format":"float","minimum":0.0,"maximum":100.0},"shares_owned":{"type":"integer","example":100,"description":"The number of shares this shareholder owns."},"voting_rights":{"type":"string","example":"All","description":"The voting rights this shareholder has."},"role":{"type":"string","example":"Senior Partner","description":"The role of this shareholder."},"appointed_at":{"type":"string","example":"2022-03-17","description":"The date this shareholder was appointed.","format":"date"},"address":{"$ref":"#/components/schemas/BasicAddress"}}},"App_Http_Requests_UpdateShareholderRequest":{"type":"object","required":["business_uuid"],"properties":{"business_uuid":{"type":"string","example":"4014f901-0b44-45ae-a41e-e7f67c8ed537","description":"The UUID of the business this shareholder should associate with. Leave null to clear the association with the current business.","format":"uuid"},"full_name":{"type":"string","example":"Jane Doe","description":"The updated name of the shareholder."},"role":{"type":"string","example":"Senior Investor","description":"The updated role of the shareholder."},"appointed_at":{"type":"string","example":"2022-03-17","description":"The updated appointed date of the shareholder.","format":"date"},"address":{"$ref":"#/components/schemas/BasicAddress"},"percentage":{"type":"number","example":25.5,"description":"The updated percentage of the shareholder.","format":"float","minimum":0.0,"maximum":100.0},"shares_owned":{"type":"integer","example":100,"description":"The updated number of shares owned by the shareholder."},"voting_rights":{"type":"string","example":"All","description":"The updated voting rights of the shareholder."}}},"App_Http_Requests_V2_BankAccount_StoreBankAccountRequest":{"type":"object","required":["account_uuids","account_name","account_holders","account_number","sort_code"],"properties":{"account_uuids":{"type":"array","example":["292ef475-f669-4549-bd36-27ba2e69dda7","927cb195-a70e-472d-9832-52f796a82331","5eb5ad71-af5d-4617-a6c2-91f2d7c69229"],"description":"The UUIDs of the accounts who should own the bank account. These must only be client accounts.","items":{"type":"string","example":"d3c190d6-a470-4f6f-a570-90034c01ce0f","format":"uuid"}},"account_name":{"type":"string","example":"My Savings Account","description":"The friendly name for the bank account.","maxLength":255},"account_holders":{"type":"string","example":"Mr John A Smith \u0026 Mrs Jane Smith","description":"The name of the bank account holder(s) as it appears on statements","maxLength":255},"account_number":{"type":"string","example":"01234567","description":"The bank account number."},"sort_code":{"type":"string","example":"012345","description":"The bank account sort code"}}},"App_Http_Requests_V2_BankAccount_UpdateBankAccountRequest":{"type":"object","required":["account_uuids","account_name","account_holders","account_number","sort_code"],"properties":{"account_uuids":{"type":"array","example":["97ffd12c-9438-4acf-8dda-2cc729587836","b5b484c1-b879-4efa-bfc8-ff8e39e856cd","05f9061b-8f37-4f11-954b-748db8058926"],"description":"The UUIDs of the accounts who should own the bank account. These must only be client accounts.","items":{"type":"string","example":"f62049c1-8d47-40cb-9584-9a580e0941dd","format":"uuid"}},"account_name":{"type":"string","example":"My Savings Account","description":"The friendly name for the bank account.","maxLength":255},"account_holders":{"type":"string","example":"Mr John A Smith","description":"The name of the bank account holder(s) as it appears on statements","maxLength":255},"account_number":{"type":"string","example":"01234567","description":"The bank account number."},"sort_code":{"type":"string","example":"012345","description":"The bank account sort code"}}},"App_Http_Controllers_V2_IndexFluxRequest":{"type":"object","required":["model_type","model_uuid","start_date","end_date"],"properties":{"model_type":{"type":"string","example":"account","description":"The model type. Can be: account, plan, or circle."},"model_uuid":{"type":"string","example":"6145a700-42a7-42e9-8c6c-69cdcf514c26","description":"The model UUID","format":"uuid"},"start_date":{"type":"string","example":"2026-04-29","description":"Filter them down by choosing the start date. This will return all fluxes between the start and end date.","format":"date"},"end_date":{"type":"string","example":"2026-05-06","description":"Filter them down by choosing the end date.","format":"date"},"filter.include_inactive":{"type":"boolean","example":false,"description":"Include transactions from inactive plans. When true, only transactions that occurred before the plan became inactive are included."},"filter.transaction_types":{"type":"string","example":"adjustment","description":"|\n\nFilter by transaction types. Accepts an array or comma-separated string.\n\n| Value | Description |\n| ----- | ----------- |\n|adjustment|Adjustment|\n|adviser_fee|Adviser Fee|\n|contribution|Contribution|\n|corporate_action|Corporate Action|\n|distribution|Distribution|\n|fee|Fee|\n|income|Income|\n|payment|Payment|\n|provider_fee|Provider Fee|\n|rebate|Rebate|\n|trade|Trade|\n|transfer|Transfer|\n|withdrawal|Withdrawal|\n|other|Other|","enum":["adjustment","adviser_fee","contribution","corporate_action","distribution","fee","income","payment","provider_fee","rebate","trade","transfer","withdrawal","other"]},"filter.include_premiums":{"type":"boolean","example":false,"description":"Include premiums from eligible plans (investments, annuities, cash accounts, pensions, mortgages) in the inflows calculation. Pension group schemes and group scheme members are excluded. Premiums are calculated based on occurrences within the date range."}}},"App_Http_Requests_V2_MortgageSearches_UpdateMortgageSearch":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"My Mortgage Search","description":"The name of the mortgage search","maxLength":255}}},"App_Http_Requests_StoreWebhookSubscriptionRequest":{"type":"object","required":["url","events"],"properties":{"url":{"type":"string","example":"https://api.example.com/webhooks","description":"The URL of the webhook you would like Plannr to send events to.","format":"uri"},"events":{"type":"array","example":["account.deleted","circle.created"],"description":"The events the webhook subscription is subscribed to.","items":{"type":"string","example":"account.created","enum":["account.created","account.updated","account.deleted","account.annual-review-date-occurred","circle.created","circle.updated","circle.deleted","plan.created","plan.updated","plan.deleted","case.created","case.updated","case.deleted","task.created","task.updated","task.deleted","task.completed","fact-find.completed","fact-find.completed-v3","form-submission.completed","bank-account.created","bank-account.updated","bank-account.deleted","bank-statement.created","bank-statement.updated","bank-statement.deleted","bank-transaction.created","bank-transaction.updated","bank-transaction.deleted","provider-statement.created","provider-statement.updated","provider-statement.deleted","transaction.created","transaction.updated","transaction.deleted","transaction.reconciled","transaction.unreconciled","statement.lock-status"]}}}},"App_Http_Requests_UpdateWebhookSubscriptionRequest":{"type":"object","required":["events"],"properties":{"events":{"type":"array","example":["account.deleted","circle.created"],"description":"The events the webhook subscription is subscribed to.","items":{"type":"string","example":"account.created","enum":["account.created","account.updated","account.deleted","account.annual-review-date-occurred","circle.created","circle.updated","circle.deleted","plan.created","plan.updated","plan.deleted","case.created","case.updated","case.deleted","task.created","task.updated","task.deleted","task.completed","fact-find.completed","fact-find.completed-v3","form-submission.completed","bank-account.created","bank-account.updated","bank-account.deleted","bank-statement.created","bank-statement.updated","bank-statement.deleted","bank-transaction.created","bank-transaction.updated","bank-transaction.deleted","provider-statement.created","provider-statement.updated","provider-statement.deleted","transaction.created","transaction.updated","transaction.deleted","transaction.reconciled","transaction.unreconciled","statement.lock-status"]}}}},"App_Http_Requests_V2_Valuations_StoreBulkValuationsRequest":{"type":"object","required":["plan_uuid","valuations"],"properties":{"plan_uuid":{"type":"string","example":"17b325c7-b389-4f98-a601-f5267b7dfbae","description":"The UUID of the plan to store the valuations on.","format":"uuid"},"sub_account_uuid":{"type":"string","example":"b81b7dfb-45b1-4e6a-bc9b-d1a5b12adbcf","description":"The UUID of the plan's sub account to store the valuations on.","format":"uuid"},"valuations":{"type":"array","example":[],"description":"The valuations to store. You can provide up to 1,000 valuations per request.","items":{"type":"object","example":{"valued_at":"2025-01-01","value":100000,"bulk_reference_uuid":"d407d017-13d9-49d6-a123-29ed1ae7a78d"},"properties":{"valued_at":{"type":"string","example":"2025-01-01","description":"The date the valuation was made.","format":"date"},"value":{"type":"integer","example":100000,"description":"The value represented in pennies. "},"bulk_reference_uuid":{"type":"string","example":"d407d017-13d9-49d6-a123-29ed1ae7a78d","description":"Optional field to provide a unique UUIDv4 for your reference.","format":"uuid"}}}}}},"App_Http_Resources_CheckResource":{"type":"object","properties":{"uuid":{"type":"string","example":"60451a88-43c1-4ff0-8a1b-b9c7d859c043","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"last_webhook_at":{"type":"string","example":"2026-05-01T14:41:54+01:00","description":"If via an integration, when was data last pulled through?"},"originally_ran_at":{"type":"string","example":"2026-05-01T14:41:54+01:00","description":"The date that the check was originally ran"},"provider":{"type":"string","example":"SmartSearch","description":"The name of the provider that ran the check."},"type":{"type":"string","example":"fraud","description":"The type of check, possible values are aml, smartdoc and fraud"},"provider_reference":{"type":"string","example":"10009815","description":"The provider's unique identifier for the check."},"status":{"type":"string","example":"completed","description":"The check's status at the current time, possible values are abandoned, active, archive, complete, expired, failed, lock, pending and processing"},"outcome":{"type":"string","example":"refer","description":"The check's outcome at the current time, possible values are pass, refer, fail, high_risk, medium_risk and low_risk"},"via_integration":{"type":"boolean","example":false,"description":"Did this check originate via an integration or was it manually added."},"last_error":{"type":"string","example":"SmartSearch could not process the request. Please contact support.","description":"The last error received on a failed check"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"ca318b44-7c4c-47df-9aac-e97e1d15100e"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account this check belongs to"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"1bdb0be3-3242-4e88-b4b8-7861cde0602e"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm this check belongs to"},"folder":{"type":"object","properties":{"uuid":{"type":"string","example":"80f1028f-6aa9-4fc9-891e-4a8946d9b633"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}},"description":"Folder this check has stored files in"}},"example":{"uuid":"60451a88-43c1-4ff0-8a1b-b9c7d859c043","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","last_webhook_at":"2026-05-01T14:41:54+01:00","originally_ran_at":"2026-05-01T14:41:54+01:00","provider":"SmartSearch","type":"fraud","provider_reference":"10009815","status":"completed","outcome":"refer","via_integration":false,"last_error":"SmartSearch could not process the request. Please contact support.","account":{"uuid":"ca318b44-7c4c-47df-9aac-e97e1d15100e","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"firm":{"uuid":"1bdb0be3-3242-4e88-b4b8-7861cde0602e","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"folder":{"uuid":"80f1028f-6aa9-4fc9-891e-4a8946d9b633","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}}},"App_Http_Resources_AccountResource":{"type":"object","properties":{"uuid":{"type":"string","example":"fa354e52-bf50-4714-b6a1-b5eb571f0f86","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"type":{"type":"string","example":"client","description":"Account type"},"role":{"type":"string","example":"client","description":"Account role"},"first_name":{"type":"string","example":"Gareth","description":"First name"},"last_name":{"type":"string","example":"Thompson","description":"Last name"},"name":{"type":"string","example":"Gareth Thompson","description":"Name"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use primary_email instead). The email of the account."},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson","description":"URL for initial avatar image"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"e7c26735-62f2-45e9-8e00-b5bcaa239e34"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm"},"primary_phone_number":{"type":"object","properties":{"uuid":{"type":"string","example":"42f5dcf5-8eea-4179-8cf9-8f7ed692bf5f"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"Primary phone number"},"primary_email":{"type":"object","properties":{"uuid":{"type":"string","example":"c3c99d0e-cb37-468e-a409-bc77a96c37db"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"Primary email"},"current_time_entry":{"type":"object","properties":{"uuid":{"type":"string","example":"d85b0768-be01-47ed-823a-3e9393283f65"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Research"},"description":{"type":"string","example":"This is a description."},"trackable_type":{"type":"string","example":"Client"},"trackable":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"start_date":{"type":"string","example":"2026-05-08T13:51:54+01:00"},"end_date":{"type":"string","example":"2026-05-08T14:19:54+01:00"},"is_active":{"type":"boolean","example":true},"total_time_in_minutes":{"type":"integer","example":28},"computed_time_elapsed_in_seconds":{"type":"integer","example":1680},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}},"description":"Current time entry"},"assigned_adviser":{"type":"object","properties":{"uuid":{"type":"string","example":"41e18e01-f9c1-40bd-b0ad-5dc47e72d434"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Assigned adviser"},"assigned_administrator":{"type":"object","properties":{"uuid":{"type":"string","example":"dfb02c89-6b84-4e54-9bba-f7d3389e5511"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Assigned administrator"},"assigned_paraplanner":{"type":"object","properties":{"uuid":{"type":"string","example":"2667b22c-b862-4270-a1e2-7f07c6a735f8"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Assigned paraplanner"},"introduced_by":{"type":"object","properties":{"uuid":{"type":"string","example":"33a7a099-ce03-4487-8829-5e726d88e166"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Introduced by"},"business_unit":{"type":"object","properties":{"uuid":{"type":"string","example":"138c3965-be28-42cc-a728-d1445c87a5eb"},"name":{"type":"string","example":"Wealth Management"},"has_alternative_branding":{"type":"boolean","example":false},"brand_colours":{"type":"array","example":[]},"members_count":{"type":"integer","example":3},"members":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"groups_count":{"type":"integer","example":2},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}},"description":"The business unit this account belongs to"},"groups":{"type":"array","example":[{"uuid":"3ea10e22-eafa-47ee-9585-128c96a50271","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"7b4025ff-eb23-4c81-8398-631254f3f253","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}],"description":"Groups","items":{"type":"object","properties":{"uuid":{"type":"string","example":"3ea10e22-eafa-47ee-9585-128c96a50271"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"participants_count":{"type":"string","example":"3"},"participants":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"7b4025ff-eb23-4c81-8398-631254f3f253"},"description":{"type":"string","example":"UUID of the account"}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Role of the account"}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name of the account"}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name of the account"}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name of the account"}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"Email of the account"}}}}},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}}}},"tags":{"type":"array","example":[{"uuid":"3046c766-bc9d-4f56-b584-3ab2fde052a5","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"description":"Tags","items":{"type":"object","properties":{"uuid":{"type":"string","example":"3046c766-bc9d-4f56-b584-3ab2fde052a5"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}},"owners":{"type":"array","example":[{"uuid":"bd2f2ae5-7758-4c28-a0f1-f5daf3d402ec","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"Accounts that own this account","items":{"type":"object","properties":{"uuid":{"type":"string","example":"bd2f2ae5-7758-4c28-a0f1-f5daf3d402ec"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"First contact date"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Next review date"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Previous review date"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Anniversary review date"},"with_login":{"type":"boolean","example":true,"description":"Denotes whether the account has a login to Plannr"},"has_joint_account":{"type":"boolean","example":true,"description":"Denotes whether this account belongs to a joint account too"},"can_be_deleted":{"type":"string","example":"false","description":"Denotes if the account can be deleted"},"joint_account_circle":{"type":"object","properties":{"uuid":{"type":"string","example":"2151cd1f-68bb-4b74-b75f-141bb2988dd4"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Jones Family"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=jones+family"},"bg_colour":{"type":"string","example":"#35f4e1"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"joint_account_uuid":{"type":"string","example":"62fc4bc0-15d2-49cb-9792-85f67545fb92"},"login_access_level":{"type":"string","example":"write"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles."},"circles":{"type":"array","example":[{"uuid":"caad4285-b894-43ba-909f-81df6c15de04","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":"App\\Http\\Resources\\AccountResource","groups":"App\\Http\\Resources\\GroupResource","joint_account_uuid":"84913be4-e6f0-46bd-88c8-0ac1036f4ca4","login_access_level":"write","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"The circles the account belongs to","items":{"type":"object","properties":{"uuid":{"type":"string","example":"caad4285-b894-43ba-909f-81df6c15de04"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Jones Family"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=jones+family"},"bg_colour":{"type":"string","example":"#35f4e1"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"joint_account_uuid":{"type":"string","example":"84913be4-e6f0-46bd-88c8-0ac1036f4ca4"},"login_access_level":{"type":"string","example":"write"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"ownership_percentage":{"type":"integer","example":100,"description":"Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -\u003e Accounts)"},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54","description":"Last interaction date"},"referral_code":{"type":"string","example":"ABC12345","description":"Unique referral code for the employee account (employees only)"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}},"description":"Permission map where keys are permission names and values are target arrays"},"custom_fields":{"type":"array","example":[{"uuid":"f3bab1c5-a562-42dc-a17a-35fedae5fab0","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"description":"Any custom fields on the model.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"f3bab1c5-a562-42dc-a17a-35fedae5fab0"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}},"external_references":{"type":"array","example":[{"uuid":"8314cb0a-157a-44d6-8f8b-4932527e2b79","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","third_party":"nucleus","reference":"AB123456"}],"description":"The external references that have been added to the client.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"8314cb0a-157a-44d6-8f8b-4932527e2b79"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}}},"example":{"uuid":"fa354e52-bf50-4714-b6a1-b5eb571f0f86","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":{"uuid":"e7c26735-62f2-45e9-8e00-b5bcaa239e34","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"primary_phone_number":{"uuid":"42f5dcf5-8eea-4179-8cf9-8f7ed692bf5f","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"primary_email":{"uuid":"c3c99d0e-cb37-468e-a409-bc77a96c37db","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"current_time_entry":{"uuid":"d85b0768-be01-47ed-823a-3e9393283f65","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Research","description":"This is a description.","trackable_type":"Client","trackable":"App\\Http\\Resources\\MinimalAccountResource","start_date":"2026-05-08T13:51:54+01:00","end_date":"2026-05-08T14:19:54+01:00","is_active":true,"total_time_in_minutes":28,"computed_time_elapsed_in_seconds":1680,"account":"App\\Http\\Resources\\MinimalAccountResource"},"assigned_adviser":{"uuid":"41e18e01-f9c1-40bd-b0ad-5dc47e72d434","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"assigned_administrator":{"uuid":"dfb02c89-6b84-4e54-9bba-f7d3389e5511","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"assigned_paraplanner":{"uuid":"2667b22c-b862-4270-a1e2-7f07c6a735f8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"introduced_by":{"uuid":"33a7a099-ce03-4487-8829-5e726d88e166","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"business_unit":{"uuid":"138c3965-be28-42cc-a728-d1445c87a5eb","name":"Wealth Management","has_alternative_branding":false,"brand_colours":[],"members_count":3,"members":"App\\Http\\Resources\\AccountResource","groups_count":2,"groups":"App\\Http\\Resources\\GroupResource","firm":"App\\Http\\Resources\\FirmResource","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"},"groups":[{"uuid":"3ea10e22-eafa-47ee-9585-128c96a50271","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"7b4025ff-eb23-4c81-8398-631254f3f253","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}],"tags":[{"uuid":"3046c766-bc9d-4f56-b584-3ab2fde052a5","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"owners":[{"uuid":"bd2f2ae5-7758-4c28-a0f1-f5daf3d402ec","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":{"uuid":"2151cd1f-68bb-4b74-b75f-141bb2988dd4","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":"App\\Http\\Resources\\AccountResource","groups":"App\\Http\\Resources\\GroupResource","joint_account_uuid":"62fc4bc0-15d2-49cb-9792-85f67545fb92","login_access_level":"write","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"circles":[{"uuid":"caad4285-b894-43ba-909f-81df6c15de04","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":"App\\Http\\Resources\\AccountResource","groups":"App\\Http\\Resources\\GroupResource","joint_account_uuid":"84913be4-e6f0-46bd-88c8-0ac1036f4ca4","login_access_level":"write","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":[{"uuid":"f3bab1c5-a562-42dc-a17a-35fedae5fab0","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"external_references":[{"uuid":"8314cb0a-157a-44d6-8f8b-4932527e2b79","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","third_party":"nucleus","reference":"AB123456"}]}},"App_Http_Resources_V2_ActionsResource":{"type":"object","properties":{"uuid":{"type":"string","example":"e1bce7a1-175e-4f3f-bb42-297575576745"},"title":{"type":"string","example":"Signature Request"},"description":{"type":"string","example":"Invited to complete the action item"},"type":{"type":"string","example":"fact_find_request"},"is_completed":{"type":"string","example":"true"},"resource":{"type":"object","properties":{"uuid":{"type":"string","example":"bcb63a02-c3e3-45a4-a225-9cf57331a600"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"status":{"type":"string","example":"complete"},"completed_at":{"type":"string","example":"2026-05-03T14:41:56+01:00"},"invitation_text":{"type":"string","example":"Please complete this fact find!"},"schema":{"type":"string","example":"App\\Http\\Resources\\FactFind\\FactFindSchemaResource"},"latest_file":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"invitation_url":{"type":"string","example":"https://api.plannrcrm.com/fact-find/2ceadbc3-b4af-44eb-a933-43630daffc9b/6ef22368-d4e4-4117-85d0-74f5334711ac"},"fact_find_passes":{"type":"string","example":"App\\Http\\Resources\\FactFindPassResource"}}},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"}},"example":[{"uuid":"e1bce7a1-175e-4f3f-bb42-297575576745","title":"Signature Request","description":"Invited to complete the action item","type":"fact_find_request","is_completed":"true","resource":{"uuid":"bcb63a02-c3e3-45a4-a225-9cf57331a600","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","status":"complete","completed_at":"2026-05-03T14:41:56+01:00","invitation_text":"Please complete this fact find!","schema":"App\\Http\\Resources\\FactFind\\FactFindSchemaResource","latest_file":"App\\Http\\Resources\\FileResource","account":"App\\Http\\Resources\\MinimalAccountResource","invitation_url":"https://api.plannrcrm.com/fact-find/2ceadbc3-b4af-44eb-a933-43630daffc9b/6ef22368-d4e4-4117-85d0-74f5334711ac","fact_find_passes":"App\\Http\\Resources\\FactFindPassResource"},"created_at":"2026-05-08T14:41:56+01:00"}]},"App_Http_Resources_Addons_AddonSubscriptionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"a92a8433-a987-416f-922a-cb33c948dad0","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"enabled":{"type":"string","example":"true","description":"Determines if the addon is enabled"},"addon":{"type":"object","properties":{"id":{"type":"string","example":"transact_valuation_feed"},"name":{"type":"string","example":"Transact Valuation Feed"},"description":{"type":"string","example":"Provides an automatic holding and valuation feed via a transact integration"},"setup_instructions":{"type":"string","example":"Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/"},"category":{"type":"string","example":"valuation_feed_integration"},"params":{"type":"object","properties":{"access_code":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Transact Number"},"example":{"type":"string","example":"555-123-456"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"pin":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"TRDS Password (Not Your Transact Password)"},"example":{"type":"string","example":"secret-password-123"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"second_access_code":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Second Transact Number"},"example":{"type":"string","example":"555-123-456"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"second_pin":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Second TRDS Password (Not Your Transact Password)"},"example":{"type":"string","example":"secret-password-123"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"third_access_code":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Third Transact Number"},"example":{"type":"string","example":"555-123-456"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"third_pin":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Third TRDS Password (Not Your Transact Password)"},"example":{"type":"string","example":"secret-password-123"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}}}},"banner_url":{"type":"string","example":"https://plannrcrm.com/banner.png"},"icon_url":{"type":"string","example":"https://plannrcrm.com/icon.png"},"price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"can_be_subscribed_to":{"type":"boolean","example":true},"is_visible":{"type":"boolean","example":true},"free_trial_days":{"type":"integer","example":30},"should_poll_for_subscription_changes":{"type":"boolean","example":true}},"description":"Details about the addon subscribed to"},"trial_ends_at":{"type":"string","example":"2026-05-22","description":"If the addon is a paid addon, this is the date the free trial will end for the addon subscription."},"trial_ends_in_days":{"type":"integer","example":14,"description":"If the addon is a paid addon, this is the number of days left in the free trial for the addon subscription."},"payment_confirmed_at":{"type":"string","example":"2026-05-26","description":"If the addon is a paid addon, this is the date the payment was confirmed for the addon subscription."}},"example":{"uuid":"a92a8433-a987-416f-922a-cb33c948dad0","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","enabled":"true","addon":{"id":"transact_valuation_feed","name":"Transact Valuation Feed","description":"Provides an automatic holding and valuation feed via a transact integration","setup_instructions":"Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/","category":"valuation_feed_integration","params":{"access_code":{"type":"text","description":"Transact Number","example":"555-123-456","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"pin":{"type":"text","description":"TRDS Password (Not Your Transact Password)","example":"secret-password-123","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"second_access_code":{"type":"text","description":"Second Transact Number","example":"555-123-456","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"second_pin":{"type":"text","description":"Second TRDS Password (Not Your Transact Password)","example":"secret-password-123","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"third_access_code":{"type":"text","description":"Third Transact Number","example":"555-123-456","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"third_pin":{"type":"text","description":"Third TRDS Password (Not Your Transact Password)","example":"secret-password-123","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]}},"banner_url":"https://plannrcrm.com/banner.png","icon_url":"https://plannrcrm.com/icon.png","price":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"can_be_subscribed_to":true,"is_visible":true,"free_trial_days":30,"should_poll_for_subscription_changes":true},"trial_ends_at":"2026-05-22","trial_ends_in_days":14,"payment_confirmed_at":"2026-05-26"}},"App_Http_Resources_Addons_AddonResource":{"type":"object","properties":{"id":{"type":"string","example":"transact_valuation_feed"},"name":{"type":"string","example":"Transact Valuation Feed"},"description":{"type":"string","example":"Provides an automatic holding and valuation feed via a transact integration"},"setup_instructions":{"type":"string","example":"Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/"},"category":{"type":"string","example":"valuation_feed_integration"},"params":{"type":"object","properties":{"access_code":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Transact Number"},"example":{"type":"string","example":"555-123-456"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"pin":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"TRDS Password (Not Your Transact Password)"},"example":{"type":"string","example":"secret-password-123"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"second_access_code":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Second Transact Number"},"example":{"type":"string","example":"555-123-456"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"second_pin":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Second TRDS Password (Not Your Transact Password)"},"example":{"type":"string","example":"secret-password-123"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"third_access_code":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Third Transact Number"},"example":{"type":"string","example":"555-123-456"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}},"third_pin":{"type":"object","properties":{"type":{"type":"string","example":"text"},"description":{"type":"string","example":"Third TRDS Password (Not Your Transact Password)"},"example":{"type":"string","example":"secret-password-123"},"options":{"type":"array","example":[]},"required":{"type":"boolean","example":false},"inputs":{"type":"array","example":[]},"list_type":{"type":"string","example":null,"nullable":true},"attributes":{"type":"array","example":[]}}}}},"banner_url":{"type":"string","example":"https://plannrcrm.com/banner.png"},"icon_url":{"type":"string","example":"https://plannrcrm.com/icon.png"},"price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"can_be_subscribed_to":{"type":"boolean","example":true},"is_visible":{"type":"boolean","example":true},"free_trial_days":{"type":"integer","example":30},"should_poll_for_subscription_changes":{"type":"boolean","example":true}},"example":[{"id":"transact_valuation_feed","name":"Transact Valuation Feed","description":"Provides an automatic holding and valuation feed via a transact integration","setup_instructions":"Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/","category":"valuation_feed_integration","params":{"access_code":{"type":"text","description":"Transact Number","example":"555-123-456","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"pin":{"type":"text","description":"TRDS Password (Not Your Transact Password)","example":"secret-password-123","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"second_access_code":{"type":"text","description":"Second Transact Number","example":"555-123-456","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"second_pin":{"type":"text","description":"Second TRDS Password (Not Your Transact Password)","example":"secret-password-123","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"third_access_code":{"type":"text","description":"Third Transact Number","example":"555-123-456","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]},"third_pin":{"type":"text","description":"Third TRDS Password (Not Your Transact Password)","example":"secret-password-123","options":[],"required":false,"inputs":[],"list_type":null,"attributes":[]}},"banner_url":"https://plannrcrm.com/banner.png","icon_url":"https://plannrcrm.com/icon.png","price":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"can_be_subscribed_to":true,"is_visible":true,"free_trial_days":30,"should_poll_for_subscription_changes":true}]},"App_Http_Resources_Addons_SecclNodeResource":{"type":"object","properties":{"id":{"type":"string","example":"123","description":"Node ID from Seccl"},"name":{"type":"string","example":"Test Node","description":"Node name from Seccl"},"nodeType":{"type":"string","example":"Test Type","description":"Node type from Seccl"},"parentNodeId":{"type":"string","example":"0","description":"Parent node ID from Seccl"}},"example":{"id":"123","name":"Test Node","nodeType":"Test Type","parentNodeId":"0"}},"App_Http_Resources_LookupResource":{"type":"object","properties":{"uuid":{"type":"string","example":"bf82a15f-0d37-466d-bfb4-77d4d1918de3"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"provider_statement_mapping"},"lookupable_type":{"type":"string","example":"provider"},"lookupable_uuid":{"type":"string","example":"0d2b62be-a70e-406f-acc4-519fcbbe666f"},"lookupable_value":{"type":"string","example":"J Bloggs Plan"},"lookup_value":{"type":"string","example":"zAbWeFVJ:Bloggs J"},"returnable_type":{"type":"string","example":"plan"},"returnable_uuid":{"type":"string","example":"db40a283-6977-4c6f-9f99-da3c2b1aa035"},"returnable_value":{"type":"string","example":"example"},"return_string":{"type":"string","example":"Consectetur officia labore"},"return_json":{"type":"object","properties":{"key_1":{"type":"string","example":"value_1"},"key_2":{"type":"string","example":"value_2"}}},"return_float":{"type":"number","example":70.35}},"example":[{"uuid":"bf82a15f-0d37-466d-bfb4-77d4d1918de3","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"provider_statement_mapping","lookupable_type":"provider","lookupable_uuid":"0d2b62be-a70e-406f-acc4-519fcbbe666f","lookupable_value":"J Bloggs Plan","lookup_value":"zAbWeFVJ:Bloggs J","returnable_type":"plan","returnable_uuid":"db40a283-6977-4c6f-9f99-da3c2b1aa035","returnable_value":"example","return_string":"Consectetur officia labore","return_json":{"key_1":"value_1","key_2":"value_2"},"return_float":70.35}]},"App_Http_Resources_Addons_SecclAssetResource":{"type":"object","properties":{"id":{"type":"string","example":"031DF6J","description":"The unique identifier of the client"},"isin":{"type":"string","example":"GB00B1XZS820","description":"The ISIN of the asset"},"short_name":{"type":"string","example":"VANGUARD LIFESTRATEGY 80% EQUI ACC","description":"The short name of the asset"},"long_name":{"type":"string","example":"Vanguard Investments UK Ltd LifeStrategy 80% Equity Acc","description":"The long name of the asset"},"currency":{"type":"string","example":"GBP","description":"The currency of the asset"},"status":{"type":"string","example":"Active","description":"The status of the asset"},"available_to_node_id":{"type":"array","example":["0"],"description":"The node ID the asset is available to","items":{"type":"string"}},"node_id":{"type":"array","example":["1","2"],"description":"The node IDs the asset is associated with","items":{"type":"string"}},"mid":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"23454"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£234.54"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The mid price of the asset"}},"example":{"id":"031DF6J","isin":"GB00B1XZS820","short_name":"VANGUARD LIFESTRATEGY 80% EQUI ACC","long_name":"Vanguard Investments UK Ltd LifeStrategy 80% Equity Acc","currency":"GBP","status":"Active","available_to_node_id":["0"],"node_id":["1","2"],"mid":{"amount":{"example":"23454","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£234.54","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}},"App_Http_Resources_Addons_SecclClientResource":{"type":"object","properties":{"id":{"type":"string","example":"031DF6J","description":"The unique identifier of the client"},"node_id":{"type":"string","example":"1","description":"The node ID"},"client_type":{"type":"string","example":"Individual","description":"The type of client"},"title":{"type":"string","example":"Ms","description":"The title of the client"},"first_name":{"type":"string","example":"Isabella","description":"The first name of the client"},"surname":{"type":"string","example":"Richardson","description":"The surname of the client"},"address_detail":{"type":"object","properties":{"flat_number":{"type":"string","example":"1"},"building_name":{"type":"string","example":"The White House"},"building_number":{"type":"string","example":"1"},"address_1":{"type":"string","example":"Downing Street"},"address_2":{"type":"string","example":"Westminster"},"country":{"type":"string","example":"United Kingdom"},"postcode":{"type":"string","example":"SW1A 2AA"}},"description":"The address details of the client"},"email":{"type":"string","example":"test@example.com","description":"The email address of the client"},"mobile":{"type":"object","properties":{"number":{"type":"string","example":"07777000000"},"locale":{"type":"string","example":"en-GB"},"isMobile":{"type":"boolean","example":true}},"description":"The primary mobile number of the client"},"nationality":{"type":"string","example":"GB","description":"The primary nationality of the client"},"national_insurance_no":{"type":"string","example":"AB123456C","description":"The national insurance number of the client"},"date_of_birth":{"type":"string","example":"1980-01-01","description":"The date of birth of the client"},"tax_domicile":{"type":"string","example":"GB","description":"The tax domicile of the client"},"terms_accepted":{"type":"boolean","example":true,"description":"The terms accepted status of the client"},"status":{"type":"string","example":"Active","description":"The status of the client"},"bank_details":{"type":"object","properties":{"account_number":{"type":"string","example":"12345678"},"sort_code":{"type":"string","example":"12-34-56"},"accepted_debit_mandate":{"type":"boolean","example":true},"accepted_debit_mandate_at":{"type":"string","example":"2025-01-01T00:00:00.000Z"}},"description":"The bank details of the client"},"vulnerability":{"type":"object","properties":{"isVulnerable":{"type":"boolean","example":true},"reason":{"type":"array","example":["Mental Health"],"items":{"type":"string"}},"isSupportTemporary":{"type":"boolean","example":true}},"description":"The vulnerability details of the client"},"aml_passed":{"type":"boolean","example":true,"description":"Whether the client has passed AML checks"},"requires_debit_mandate":{"type":"boolean","example":true,"description":"Does this client require a debit mandate"},"employment_status":{"type":"string","example":"Employed","description":"The employment status of the client"},"employers":{"type":"array","example":[{"companyName":"Acme Corp","companyRegNo":"12345678","addressDetail":{"flat_number":null,"building_name":null,"building_number":"123","address_1":"123 Business Rd","address_2":"Business City","country":"GB","postcode":"BC1 2AB"},"bankDetails":{"sortCode":"12-34-56","accountNumber":"12345678"}}],"description":"The employers of the client","items":{"type":"object","properties":{"companyName":{"type":"string","example":"Acme Corp"},"companyRegNo":{"type":"string","example":"12345678"},"addressDetail":{"type":"object","properties":{"flat_number":{"type":"string","example":null,"nullable":true},"building_name":{"type":"string","example":null,"nullable":true},"building_number":{"type":"string","example":"123"},"address_1":{"type":"string","example":"123 Business Rd"},"address_2":{"type":"string","example":"Business City"},"country":{"type":"string","example":"GB"},"postcode":{"type":"string","example":"BC1 2AB"}}},"bankDetails":{"type":"object","properties":{"sortCode":{"type":"string","example":"12-34-56"},"accountNumber":{"type":"string","example":"12345678"}}}}}},"marital_status":{"type":"string","example":"Single","description":"The marital status of the client"},"retirement_age":{"type":"integer","example":65,"description":"The retirement age of the client"},"can_open_accounts_for":{"type":"array","example":["JISA"],"description":"The wrapper types the client can open accounts for","items":{"type":"string"}},"plannr_account":{"type":"object","properties":{"uuid":{"type":"string","example":"328d2fe9-3551-406d-81b6-7a6d9c9c37c1"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The Plannr account associated with the client"},"parent_id":{"type":"string","example":"031DF6J","description":"The parent ID of the client"}},"example":{"id":"031DF6J","node_id":"1","client_type":"Individual","title":"Ms","first_name":"Isabella","surname":"Richardson","address_detail":{"flat_number":"1","building_name":"The White House","building_number":"1","address_1":"Downing Street","address_2":"Westminster","country":"United Kingdom","postcode":"SW1A 2AA"},"email":"test@example.com","mobile":{"number":"07777000000","locale":"en-GB","isMobile":true},"nationality":"GB","national_insurance_no":"AB123456C","date_of_birth":"1980-01-01","tax_domicile":"GB","terms_accepted":true,"status":"Active","bank_details":{"account_number":"12345678","sort_code":"12-34-56","accepted_debit_mandate":true,"accepted_debit_mandate_at":"2025-01-01T00:00:00.000Z"},"vulnerability":{"isVulnerable":true,"reason":["Mental Health"],"isSupportTemporary":true},"aml_passed":true,"requires_debit_mandate":true,"employment_status":"Employed","employers":[{"companyName":"Acme Corp","companyRegNo":"12345678","addressDetail":{"flat_number":null,"building_name":null,"building_number":"123","address_1":"123 Business Rd","address_2":"Business City","country":"GB","postcode":"BC1 2AB"},"bankDetails":{"sortCode":"12-34-56","accountNumber":"12345678"}}],"marital_status":"Single","retirement_age":65,"can_open_accounts_for":["JISA"],"plannr_account":{"uuid":"328d2fe9-3551-406d-81b6-7a6d9c9c37c1","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"parent_id":"031DF6J"}},"App_Http_Resources_Addons_SecclSchemeProductResource":{"type":"object","properties":{"id":{"type":"string","example":"031DF6J","description":"The unique identifier"},"product_name":{"type":"string","example":"Plannr Personal Pension","description":"Name of this product"},"available_to_node_id":{"type":"array","example":["0","1"],"description":"The node ID the asset is available to","items":{"type":"string"}},"platform":{"type":"string","example":"seccl","description":"The platform this product is available on"}},"example":{"id":"031DF6J","product_name":"Plannr Personal Pension","available_to_node_id":["0","1"],"platform":"seccl"}},"App_Http_Resources_Addons_SecclClientProductResource":{"type":"object","properties":{"id":{"type":"string","example":"CP12345","description":"The unique identifier of the client product"},"client_ids":{"type":"array","example":["031DF6J"],"description":"The client IDs associated with this product","items":{"type":"string"}},"node_id":{"type":"string","example":"N12345","description":"The node ID of the client product"},"wrapper_type":{"type":"string","example":"ISA","description":"The wrapper type (ISA, JISA, PENSION, GIA)"},"terms_accepted":{"type":"boolean","example":true,"description":"Whether the product terms have been accepted"},"declaration_accepted_date":{"type":"string","example":"2025-01-01T00:00:00+00:00","description":"When the declaration was accepted (ISA/JISA)"},"accepted_provider_terms":{"type":"boolean","example":true,"description":"Whether provider terms were accepted (PENSION)"}},"example":{"id":"CP12345","client_ids":["031DF6J"],"node_id":"N12345","wrapper_type":"ISA","terms_accepted":true,"declaration_accepted_date":"2025-01-01T00:00:00+00:00","accepted_provider_terms":true}},"App_Http_Resources_AddressResource":{"type":"object","properties":{"uuid":{"type":"string","example":"aa25b658-9f7c-493f-85bc-51804076098a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars","description":"First line of the address"},"address_2":{"type":"string","example":"Waterberry Drive","description":"Second line of the address"},"address_3":{"type":"string","example":"The Innovative Centre","description":"Third line of the address"},"address_4":{"type":"string","example":"Waterlooville","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"move_in_date":{"type":"string","example":"2025-05-08","description":"Address move in date. This field may provide inaccurate data. We recommend using the v2/addresses API which has the moved_in_month and moved_in_year fields instead."},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"211c8691-7c6a-4b6e-84eb-791e7905d046"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Accounts that own this address"}},"example":{"uuid":"aa25b658-9f7c-493f-85bc-51804076098a","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2025-05-08","accounts":{"uuid":"211c8691-7c6a-4b6e-84eb-791e7905d046","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_AddressResource":{"type":"object","properties":{"uuid":{"type":"string","example":"d3f274c5-5050-4908-931c-f6d4e2f2a6a6","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Work Address","description":"The friendly name for the address."},"address_1":{"type":"string","example":"Suite E, 5 The Briars","description":"The first line of the address."},"address_2":{"type":"string","example":"Waterberry Drive","description":"The second line of the address."},"address_3":{"type":"string","example":"The Innovative Centre","description":"The third line of the address."},"address_4":{"type":"string","example":"Waterlooville","description":"The fourth line of the address."},"town_city":{"type":"string","example":"Waterlooville","description":"The town or city."},"county":{"type":"string","example":"Hampshire","description":"The county."},"postcode":{"type":"string","example":"PO7 7YH","description":"The postcode."},"country":{"type":"string","example":"United Kingdom","description":"The country."},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"8688d9aa-11a2-4abb-8436-7a7a5ff91891"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The accounts who own the address. This may not be included when viewing all addresses. Refer to the documentation to include this field."},"primary_accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"5d9fbbbe-f592-4193-bdc3-cc8cc530b79c"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The accounts who own the address and have it as their primary address. This may not be included when viewing all addresses. Refer to the documentation to include this field."},"moved_in_month":{"type":"integer","example":6,"description":"The month the client moved into this address."},"moved_in_year":{"type":"integer","example":2022,"description":"The year the client moved into this address."},"moved_out_month":{"type":"integer","example":1,"description":"The month the client moved out of this address."},"moved_out_year":{"type":"integer","example":2024,"description":"The year the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","description":"The client's residential status when living at the address."},"residential_status_other":{"type":"string","example":"homeowner","description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."},"lived_in_months":{"type":"integer","example":19,"description":"The number of months the client lived in the address."}},"example":{"uuid":"d3f274c5-5050-4908-931c-f6d4e2f2a6a6","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","accounts":{"uuid":"8688d9aa-11a2-4abb-8436-7a7a5ff91891","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"primary_accounts":{"uuid":"5d9fbbbe-f592-4193-bdc3-cc8cc530b79c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"moved_in_month":6,"moved_in_year":2022,"moved_out_month":1,"moved_out_year":2024,"residential_status":"homeowner","residential_status_other":"homeowner","lived_in_months":19}},"App_Http_Resources_AuditResource":{"type":"object","properties":{"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"uuid":{"type":"string","example":"be68a0b9-68e9-48cf-86f0-de2acbc524c7"},"type":{"type":"string","example":"Sub Account"},"old_values":{"type":"object","properties":{"first_name":{"type":"string","example":"John"}}},"new_values":{"type":"object","properties":{"first_name":{"type":"string","example":"Jonathan"}}},"user_agent":{"type":"string","example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"},"ip_address":{"type":"string","example":"127.0.0.1"},"event":{"type":"string","example":"updated"},"url":{"type":"string","example":"https://plannrcrm.com"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"b252eaa1-7691-4093-ad9f-b391f805ef5a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"example":[{"created_at":"2026-05-08T14:41:55+01:00","uuid":"be68a0b9-68e9-48cf-86f0-de2acbc524c7","type":"Sub Account","old_values":{"first_name":"John"},"new_values":{"first_name":"Jonathan"},"user_agent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0","ip_address":"127.0.0.1","event":"updated","url":"https://plannrcrm.com","account":{"uuid":"b252eaa1-7691-4093-ad9f-b391f805ef5a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}]},"App_Http_Resources_Automation_AutomationBlockResource":{"type":"object","properties":{"type":{"type":"string","example":"account.tag"},"name":{"type":"string","example":"Add a tag to a client"},"description":{"type":"string","example":"will add an existing tag or create a new one to the account of the given \"account_uuid\" "},"params":{"type":"object","properties":{"account_uuid":{"type":"object","properties":{"type":{"type":"string","example":"string"},"description":{"type":"string","example":"UUID of the account to store tag against"}}},"tag":{"type":"object","properties":{"type":{"type":"string","example":"string"},"description":{"type":"string","example":"The name of the tag to store against the account"}}}}},"returns":{"type":"object","properties":{"tag":{"type":"object","properties":{"type":{"type":"string","example":"string"},"description":{"type":"string","example":"the name of the tag stored against the account"}}}}},"isCondition":{"type":"string","example":"false"},"icon":{"type":"string","example":"star"}},"example":[{"type":"account.tag","name":"Add a tag to a client","description":"will add an existing tag or create a new one to the account of the given \"account_uuid\" ","params":{"account_uuid":{"type":"string","description":"UUID of the account to store tag against"},"tag":{"type":"string","description":"The name of the tag to store against the account"}},"returns":{"tag":{"type":"string","description":"the name of the tag stored against the account"}},"isCondition":"false","icon":"star"}]},"App_Http_Resources_Automation_AutomationTriggerResource":{"type":"object","properties":{"type":{"type":"string","example":"client.created"},"name":{"type":"string","example":"Run at a specific date"},"description":{"type":"string","example":"Trigger an automation on a specific date"},"returns":{"type":"object","properties":{"client":{"type":"array","example":["title","value","next_review_date","previous_review_date","anniversary_review_date","checked_sanctions_at","lead_source","first_contact_date","gender","date_of_birth","target_retirement_age","smoker_status","residential_status","country_of_residence","marital_status","is_prospect","is_vulnerable","is_uk_resident","is_uk_domicile","expected_retirement_age","state_retirement_age","third_party_offered","current_state_of_health","long_term_care_needed","has_will","will_last_reviewed","has_power_of_attorney","units_of_alcohol_weekly","has_gifted_family","is_anticipating_inheritance","is_in_receipt_of_your_state_pension","has_obtained_a_forecast","date_of_forecast","years_of_national_insurance_contributions","date_of_marriage","is_deceased","deceased_at"],"items":{"type":"string"}}}},"configParams":{"type":"object","properties":{"client":{"type":"array","example":["title","value","next_review_date","previous_review_date","anniversary_review_date","checked_sanctions_at","lead_source","first_contact_date","gender","date_of_birth","target_retirement_age","smoker_status","residential_status","country_of_residence","marital_status","is_prospect","is_vulnerable","is_uk_resident","is_uk_domicile","expected_retirement_age","state_retirement_age","third_party_offered","current_state_of_health","long_term_care_needed","has_will","will_last_reviewed","has_power_of_attorney","units_of_alcohol_weekly","has_gifted_family","is_anticipating_inheritance","is_in_receipt_of_your_state_pension","has_obtained_a_forecast","date_of_forecast","years_of_national_insurance_contributions","date_of_marriage","is_deceased","deceased_at"],"items":{"type":"string"}}}}},"example":[{"type":"client.created","name":"Run at a specific date","description":"Trigger an automation on a specific date","returns":{"client":["title","value","next_review_date","previous_review_date","anniversary_review_date","checked_sanctions_at","lead_source","first_contact_date","gender","date_of_birth","target_retirement_age","smoker_status","residential_status","country_of_residence","marital_status","is_prospect","is_vulnerable","is_uk_resident","is_uk_domicile","expected_retirement_age","state_retirement_age","third_party_offered","current_state_of_health","long_term_care_needed","has_will","will_last_reviewed","has_power_of_attorney","units_of_alcohol_weekly","has_gifted_family","is_anticipating_inheritance","is_in_receipt_of_your_state_pension","has_obtained_a_forecast","date_of_forecast","years_of_national_insurance_contributions","date_of_marriage","is_deceased","deceased_at"]},"configParams":{"client":["title","value","next_review_date","previous_review_date","anniversary_review_date","checked_sanctions_at","lead_source","first_contact_date","gender","date_of_birth","target_retirement_age","smoker_status","residential_status","country_of_residence","marital_status","is_prospect","is_vulnerable","is_uk_resident","is_uk_domicile","expected_retirement_age","state_retirement_age","third_party_offered","current_state_of_health","long_term_care_needed","has_will","will_last_reviewed","has_power_of_attorney","units_of_alcohol_weekly","has_gifted_family","is_anticipating_inheritance","is_in_receipt_of_your_state_pension","has_obtained_a_forecast","date_of_forecast","years_of_national_insurance_contributions","date_of_marriage","is_deceased","deceased_at"]}}]},"App_Http_Resources_Automation_AutomationBlueprintResource":{"type":"object","properties":{"uuid":{"type":"string","example":"c33d5993-d71a-4a09-953b-bfac123cfc1b","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Add new client on webhook","description":"Name of the Automation Blueprint"},"trigger":{"type":"string","example":"client.create","description":"What type of event will trigger this AutomationBlueprint"},"is_active":{"type":"boolean","example":false,"description":"Is the automation currently active? If false will not create new execution instances"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"f21cf285-e916-4748-8e75-bd668aef71e0"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that made this automation blueprints"},"conditions":{"type":"array","example":[],"description":"Conditions for the automation blueprint"},"configuration":{"type":"array","example":[],"description":"Extra configuration options for the trigger of this blueprint"},"steps":{"type":"array","example":[{"uuid":"1358af13-39a1-438f-acbc-341442ffe0d2","created_at":"2026-05-08T14:41:55+01:00","updated":"2026-05-08T14:41:55+01:00","name":"create a new client","type":"client.create","configuration":{"params":{"account_uuid":{"type":"ref","value":"trigger.account.uuid"}}},"condition_state":false,"parent_step_uuid":"1a66082d-bf74-4ace-b311-a46fecc476cb"}],"description":"All blueprint steps attached to this blueprint","items":{"type":"object","properties":{"uuid":{"type":"string","example":"1358af13-39a1-438f-acbc-341442ffe0d2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"create a new client"},"type":{"type":"string","example":"client.create"},"configuration":{"type":"object","properties":{"params":{"type":"object","properties":{"account_uuid":{"type":"object","properties":{"type":{"type":"string","example":"ref"},"value":{"type":"string","example":"trigger.account.uuid"}}}}}}},"condition_state":{"type":"boolean","example":false},"parent_step_uuid":{"type":"string","example":"1a66082d-bf74-4ace-b311-a46fecc476cb"}}}},"steps_count":{"type":"string","example":"1","description":"Amount of blueprints steps on this automation blueprint"},"webhook_targets":{"type":"array","example":[{"uuid":"2ff9bd6f-4c15-4298-b5c7-2756108fcbb2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","url":"https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea"}],"description":"List of webhook target endpoints that can be used to trigger this automation","items":{"type":"object","properties":{"uuid":{"type":"string","example":"2ff9bd6f-4c15-4298-b5c7-2756108fcbb2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"url":{"type":"string","example":"https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea"}}}}},"example":{"uuid":"c33d5993-d71a-4a09-953b-bfac123cfc1b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Add new client on webhook","trigger":"client.create","is_active":false,"account":{"uuid":"f21cf285-e916-4748-8e75-bd668aef71e0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"conditions":[],"configuration":[],"steps":[{"uuid":"1358af13-39a1-438f-acbc-341442ffe0d2","created_at":"2026-05-08T14:41:55+01:00","updated":"2026-05-08T14:41:55+01:00","name":"create a new client","type":"client.create","configuration":{"params":{"account_uuid":{"type":"ref","value":"trigger.account.uuid"}}},"condition_state":false,"parent_step_uuid":"1a66082d-bf74-4ace-b311-a46fecc476cb"}],"steps_count":"1","webhook_targets":[{"uuid":"2ff9bd6f-4c15-4298-b5c7-2756108fcbb2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","url":"https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea"}]}},"App_Http_Resources_Automation_WebhookTargetResource":{"type":"object","properties":{"uuid":{"type":"string","example":"60587b23-75b6-4269-87ef-9feb2643faa9","description":"The UUID of the custom field"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"datetime the webhook trigger was created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"datetime the webhook trigger was updated"},"url":{"type":"string","example":"https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea","description":"the targets endpoint"}},"example":{"uuid":"60587b23-75b6-4269-87ef-9feb2643faa9","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","url":"https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea"}},"App_Http_Resources_Automation_AutomationExecutionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"99b6e029-daed-46fb-95bc-1ee04d0d5526","description":"UUID of automation execution"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when this execution was created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when this execution was updated"},"status":{"type":"string","example":"in_progress","description":"Current status of this automation execution"},"triggered_by":{"type":"string","example":"client.created","description":"Name of what triggered this automation execution"},"steps":{"type":"array","example":[{"uuid":"f94bfed4-3034-4c54-a7e3-9ce956dba455","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","executed_at":"2026-05-08T14:41:55+01:00","status":"completed","info":"\"[{errors : \"the account_uuid field is required\" }]\"","name":"Send SMS"}],"description":"Collection of the steps in this execution","items":{"type":"object","properties":{"uuid":{"type":"string","example":"f94bfed4-3034-4c54-a7e3-9ce956dba455"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"executed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"status":{"type":"string","example":"completed"},"info":{"type":"string","example":"\"[{errors : \"the account_uuid field is required\" }]\""},"name":{"type":"string","example":"Send SMS"}}}},"name":{"type":"string","example":"Send client welcome pack to newly created client","description":"Name of the automation blueprint"},"next_step":{"type":"object","properties":{"uuid":{"type":"string","example":"37f1e928-7573-4af7-9c6e-3037c5f6040f"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"executed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"status":{"type":"string","example":"completed"},"info":{"type":"string","example":"\"[{errors : \"the account_uuid field is required\" }]\""},"name":{"type":"string","example":"Send SMS"}},"description":"The next step set to run"},"previous_step":{"type":"object","properties":{"uuid":{"type":"string","example":"23830d27-c849-4152-8c59-85f6fc2417d4"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"executed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"status":{"type":"string","example":"completed"},"info":{"type":"string","example":"\"[{errors : \"the account_uuid field is required\" }]\""},"name":{"type":"string","example":"Send SMS"}},"description":"The step that was last run"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"38c0e8c1-08ae-4a69-b9f7-d3e647483e34"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account this automation execution ran for (only included when requested)"}},"example":{"uuid":"99b6e029-daed-46fb-95bc-1ee04d0d5526","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","status":"in_progress","triggered_by":"client.created","steps":[{"uuid":"f94bfed4-3034-4c54-a7e3-9ce956dba455","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","executed_at":"2026-05-08T14:41:55+01:00","status":"completed","info":"\"[{errors : \"the account_uuid field is required\" }]\"","name":"Send SMS"}],"name":"Send client welcome pack to newly created client","next_step":{"uuid":"37f1e928-7573-4af7-9c6e-3037c5f6040f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","executed_at":"2026-05-08T14:41:55+01:00","status":"completed","info":"\"[{errors : \"the account_uuid field is required\" }]\"","name":"Send SMS"},"previous_step":{"uuid":"23830d27-c849-4152-8c59-85f6fc2417d4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","executed_at":"2026-05-08T14:41:55+01:00","status":"completed","info":"\"[{errors : \"the account_uuid field is required\" }]\"","name":"Send SMS"},"account":{"uuid":"38c0e8c1-08ae-4a69-b9f7-d3e647483e34","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_BankAccountResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b0135d7b-f1aa-4458-911a-c74abb8b29ba","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"account_name":{"type":"string","example":"Savings Account","description":"The name of the bank account"},"account_holders":{"type":"string","example":"Mr John A Smith","description":"The name of the bank account holder(s) as it appears on statements"},"account_number":{"type":"string","example":"12345678","description":"The bank account number"},"sort_code":{"type":"string","example":"123456","description":"The bank account sort code"},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"d843ce41-70b2-4576-a6f3-4dc9d4ad9b30"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The accounts linked to this bank account"}},"example":{"uuid":"b0135d7b-f1aa-4458-911a-c74abb8b29ba","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","account_name":"Savings Account","account_holders":"Mr John A Smith","account_number":"12345678","sort_code":"123456","accounts":{"uuid":"d843ce41-70b2-4576-a6f3-4dc9d4ad9b30","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_Plans_BeneficiaryResource":{"type":"object","properties":{"uuid":{"type":"string","example":"ea71471f-46d2-458e-bb86-8b70aaead865","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Beneficiary name","description":"Beneficiary name."},"percentage":{"type":"integer","example":50,"description":"Beneficiary percentage."},"cover":{"type":"object","properties":{"uuid":{"type":"string","example":"27d90f6c-7734-4cfa-b12a-5bfb171762d1"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"cover_type":{"type":"string","example":"critical_illness"},"benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"benefit_frequency":{"type":"string","example":"monthly"},"benefit_status":{"type":"string","example":"active"},"excess":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"indexation":{"type":"number","example":1.4},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"Cover this beneficiary is for."}},"example":{"uuid":"ea71471f-46d2-458e-bb86-8b70aaead865","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Beneficiary name","percentage":50,"cover":{"uuid":"27d90f6c-7734-4cfa-b12a-5bfb171762d1","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}}},"App_Http_Resources_Automation_BlueprintStepResource":{"type":"object","properties":{"uuid":{"type":"string","example":"34b709a6-dd82-403d-8f29-49a89c760b21","description":"Uuid of the Blueprint Step"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Datetime the Blueprint Step was created"},"updated":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Datetime the Blueprint Step was updated"},"name":{"type":"string","example":"create a new client","description":"Description of the action that the automation step is taking"},"type":{"type":"string","example":"client.create","description":"Type of action to take on this step"},"configuration":{"type":"object","properties":{"params":{"type":"object","properties":{"account_uuid":{"type":"object","properties":{"type":{"type":"string","example":"ref"},"value":{"type":"string","example":"trigger.account.uuid"}}}}}},"description":"The configuration of this step"},"condition_state":{"type":"boolean","example":false,"description":"If the step is a type of condition, this will be the branch that the step follows on."},"parent_step_uuid":{"type":"string","example":"c502f72a-62da-4097-aa2f-300ca89f4612","description":"Uuid of the parent step, can be null if this is the root step"}},"example":{"uuid":"34b709a6-dd82-403d-8f29-49a89c760b21","created_at":"2026-05-08T14:41:55+01:00","updated":"2026-05-08T14:41:55+01:00","name":"create a new client","type":"client.create","configuration":{"params":{"account_uuid":{"type":"ref","value":"trigger.account.uuid"}}},"condition_state":false,"parent_step_uuid":"c502f72a-62da-4097-aa2f-300ca89f4612"}},"App_Http_Resources_BulkActionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"5a88f05d-a884-4e2e-adb0-e48539020d61","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Task Bulk Action","description":"The name of the bulk action"},"type":{"type":"string","example":"api_bulk_action","description":"The type of the bulk action"},"logs":{"type":"object","properties":{"uuid":{"type":"string","example":"0bed4052-53ba-4337-ba29-549e24fcd3bc"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"title":{"type":"string","example":"Authorization Error"},"description":{"type":"string","example":"Authorization Error"}},"description":"Logs of the bulk action"},"executed_by":{"type":"object","properties":{"uuid":{"type":"string","example":"7e29de10-653c-46d5-af1c-dc92f20f8153"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that executed bulk action"}},"example":{"uuid":"5a88f05d-a884-4e2e-adb0-e48539020d61","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Task Bulk Action","type":"api_bulk_action","logs":{"uuid":"0bed4052-53ba-4337-ba29-549e24fcd3bc","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","title":"Authorization Error","description":"Authorization Error"},"executed_by":{"uuid":"7e29de10-653c-46d5-af1c-dc92f20f8153","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_Metrics_AumMetricResource":{"type":"object","properties":{"metric":{"type":"string","example":"aum"},"data":{"type":"object","properties":{"total":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£12,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"abstract_types":{"type":"object","properties":{"assets":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£12,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"liabilities":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"protection":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"plan_types":{"type":"object","properties":{"annuity":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£12,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"cash_account":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"fixed_asset":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"general_insurance":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"group_protection":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"investment":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"loan_credit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"mortgage":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"pension":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"protection_policy":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"234567"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£2,345.67"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}}}},"date":{"type":"string","example":"2023-06-30"},"requested_at":{"type":"string","example":"2023-07-01 12:30:45"}},"example":[{"metric":"aum","data":{"total":{"amount":{"example":"1234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£12,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"abstract_types":{"assets":{"amount":{"example":"1234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£12,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"liabilities":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"protection":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"plan_types":{"annuity":{"amount":{"example":"1234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£12,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"cash_account":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"fixed_asset":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"general_insurance":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"group_protection":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"investment":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"loan_credit":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"mortgage":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"pension":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"protection_policy":{"amount":{"example":"234567","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£2,345.67","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}},"date":"2023-06-30","requested_at":"2023-07-01 12:30:45"}]},"App_Http_Resources_Metrics_KeyMetricResource":{"type":"object","properties":{"metric":{"type":"string","example":"time_logged"},"data":{"type":"string","example":"123"},"date":{"type":"string","example":"2023-06-30"},"requested_at":{"type":"string","example":"2023-07-01 12:30:45"}},"example":[{"metric":"time_logged","data":"123","date":"2023-06-30","requested_at":"2023-07-01 12:30:45"}]},"App_Http_Resources_BusinessUnitResource":{"type":"object","properties":{"uuid":{"type":"string","example":"9de9d303-96d5-4cf7-ba96-adc224259e39","description":"The UUID of the resource."},"name":{"type":"string","example":"Wealth Management","description":"Name of the business unit."},"has_alternative_branding":{"type":"boolean","example":false,"description":"Whether alternative branding is enabled for this business unit."},"brand_colours":{"type":"array","example":[],"description":"Brand colours for this business unit, merged with firm defaults."},"members_count":{"type":"integer","example":3,"description":"Number of accounts assigned to this business unit"},"members":{"type":"array","example":[{"uuid":"ac2bc640-5af4-4c94-96d9-0d442bb0871a","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"Accounts assigned to this business unit","items":{"type":"object","properties":{"uuid":{"type":"string","example":"ac2bc640-5af4-4c94-96d9-0d442bb0871a"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"groups_count":{"type":"integer","example":2,"description":"Number of groups assigned to this business unit"},"groups":{"type":"array","example":[{"uuid":"8ffac9aa-e3bd-4c1a-9e47-0ed7170b7c46","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"2c801677-4b6e-4f5a-9b41-dcf281a98902","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}],"description":"Groups assigned to this business unit","items":{"type":"object","properties":{"uuid":{"type":"string","example":"8ffac9aa-e3bd-4c1a-9e47-0ed7170b7c46"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"participants_count":{"type":"string","example":"3"},"participants":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"2c801677-4b6e-4f5a-9b41-dcf281a98902"},"description":{"type":"string","example":"UUID of the account"}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Role of the account"}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name of the account"}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name of the account"}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name of the account"}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"Email of the account"}}}}},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}}}},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"76f09d44-23ca-47f4-8b53-1a1e13d2e7e3"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The firm this business unit belongs to."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."}},"example":{"uuid":"9de9d303-96d5-4cf7-ba96-adc224259e39","name":"Wealth Management","has_alternative_branding":false,"brand_colours":[],"members_count":3,"members":[{"uuid":"ac2bc640-5af4-4c94-96d9-0d442bb0871a","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"groups_count":2,"groups":[{"uuid":"8ffac9aa-e3bd-4c1a-9e47-0ed7170b7c46","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"2c801677-4b6e-4f5a-9b41-dcf281a98902","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}],"firm":{"uuid":"76f09d44-23ca-47f4-8b53-1a1e13d2e7e3","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}},"App_Http_Resources_CasesResource":{"type":"object","properties":{"uuid":{"type":"string","example":"ffc3f7a8-23af-41bd-a360-a4ff62dfdca1","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"finance","description":"Name of the case"},"slug":{"type":"string","example":"finance","description":"Slug of the case"},"status":{"type":"object","properties":{"uuid":{"type":"string","example":"ab94b2d4-8a14-4d18-83aa-b3752d75c276"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"To Be Reviewed"},"colour":{"type":"string","example":"#23852B"},"position":{"type":"integer","example":5},"is_type_completed":{"type":"boolean","example":false}},"description":"Case status"},"type":{"type":"object","properties":{"uuid":{"type":"string","example":"f90200d7-0dad-4b4d-9af9-e75c2ce7b3ee"},"name":{"type":"string","example":"Mortgage Plan"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}},"description":"Case type"},"review_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the case should be reviewed"},"assigned_to_uuids":{"type":"array","example":["0c6c1996-c2d1-49a9-a816-4cb268fb1d77"],"description":"UUIDs of accounts that will be assigned to the case when it is created.","items":{"type":"string"}},"group_uuids":{"type":"array","example":["ae89fb08-199d-42f1-8450-c856fb49b82c"],"description":"UUIDs of groups that will be assigned when the case is created.","items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the case was completed"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Expected value of this case"},"status_position":{"type":"integer","example":4,"description":"The case status's position on the status list. Starting from 1.  Only used if you are formatting cases in a kanban layout."},"participants_count":{"type":"integer","example":4,"description":"The number of participants on the case"},"participants":{"type":"object","properties":{"uuid":{"type":"string","example":"4140fe8f-4a54-4719-98d4-1f02ae944f96"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Participants on this case (if included)"},"task_board_uuid":{"type":"string","example":"9a57676f-6ff6-45f8-8650-8a5c18890b15","description":"UUID of the task board"},"plans":{"type":"object","properties":{"uuid":{"type":"string","example":"4ba3c09b-da2f-4947-95f9-b02f262a2578"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:54+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Plans in this case (if included)"},"custom_fields":{"type":"array","example":[{"uuid":"1a6b064f-413e-4a11-98e1-8d1eea21e6aa","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"description":"Any custom fields on the model.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"1a6b064f-413e-4a11-98e1-8d1eea21e6aa"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}}},"example":{"uuid":"ffc3f7a8-23af-41bd-a360-a4ff62dfdca1","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"finance","slug":"finance","status":{"uuid":"ab94b2d4-8a14-4d18-83aa-b3752d75c276","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"To Be Reviewed","colour":"#23852B","position":5,"is_type_completed":false},"type":{"uuid":"f90200d7-0dad-4b4d-9af9-e75c2ce7b3ee","name":"Mortgage Plan","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"},"review_at":"2026-05-08T14:41:54+01:00","assigned_to_uuids":["0c6c1996-c2d1-49a9-a816-4cb268fb1d77"],"group_uuids":["ae89fb08-199d-42f1-8450-c856fb49b82c"],"completed_at":"2026-05-08T14:41:54+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":{"uuid":"4140fe8f-4a54-4719-98d4-1f02ae944f96","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"task_board_uuid":"9a57676f-6ff6-45f8-8650-8a5c18890b15","plans":{"uuid":"4ba3c09b-da2f-4947-95f9-b02f262a2578","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","opened_at":"2026-05-08T14:41:54+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:54+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:54+01:00","original_valued_at":"2026-05-07T14:41:54+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"custom_fields":[{"uuid":"1a6b064f-413e-4a11-98e1-8d1eea21e6aa","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}]}},"App_Http_Resources_CasesStatusResource":{"type":"object","properties":{"uuid":{"type":"string","example":"adc88292-c2b4-4289-944d-06ddd3cb02b8","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"To Be Reviewed","description":"The name of the status."},"colour":{"type":"string","example":"#23852B","description":"The colour of the status."},"position":{"type":"integer","example":5,"description":"The position of the status."},"is_type_completed":{"type":"boolean","example":false,"description":"Indicates if the status is for a completed case type."}},"example":{"uuid":"adc88292-c2b4-4289-944d-06ddd3cb02b8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"To Be Reviewed","colour":"#23852B","position":5,"is_type_completed":false}},"App_Http_Resources_CasesTypeResource":{"type":"object","properties":{"uuid":{"type":"string","example":"edd4f2cd-c103-4bae-86a8-d19665a42b1b","description":"The UUID of the type"},"name":{"type":"string","example":"Mortgage Plan","description":"Name of the type"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."}},"example":{"uuid":"edd4f2cd-c103-4bae-86a8-d19665a42b1b","name":"Mortgage Plan","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}},"App_Http_Resources_CircleResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3e61f992-0d20-434f-be55-a3fe1a447c0a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Jones Family","description":"The Circle name"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=jones+family","description":"URL for initial avatar image"},"bg_colour":{"type":"string","example":"#35f4e1","description":"Hex colour background for avatar"},"accounts":{"type":"array","example":[{"uuid":"8a87f061-0df8-4e90-8e09-26f2b33e7ca0","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"Accounts belonging to the circle","items":{"type":"object","properties":{"uuid":{"type":"string","example":"8a87f061-0df8-4e90-8e09-26f2b33e7ca0"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"groups":{"type":"array","example":[{"uuid":"73aefd20-8003-49df-8898-baeaebfbf8de","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"0f323dba-1ed4-45b9-9492-fbba950f31c9","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}],"description":"Groups the circle belongs to","items":{"type":"object","properties":{"uuid":{"type":"string","example":"73aefd20-8003-49df-8898-baeaebfbf8de"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"participants_count":{"type":"string","example":"3"},"participants":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"0f323dba-1ed4-45b9-9492-fbba950f31c9"},"description":{"type":"string","example":"UUID of the account"}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Role of the account"}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name of the account"}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name of the account"}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name of the account"}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"Email of the account"}}}}},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}}}},"joint_account_uuid":{"type":"string","example":"be0ed009-edb1-49cb-9724-f760c8d53fec","description":"uuid of joint account where circle created from joint account"},"login_access_level":{"type":"string","example":"write","description":"The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write"},"external_references":{"type":"array","example":[{"uuid":"57d5af5e-347e-44ec-94ed-8136472fdf69","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","third_party":"nucleus","reference":"AB123456"}],"description":"The external references that have been added to the client.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"57d5af5e-347e-44ec-94ed-8136472fdf69"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}}},"example":{"uuid":"3e61f992-0d20-434f-be55-a3fe1a447c0a","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":[{"uuid":"8a87f061-0df8-4e90-8e09-26f2b33e7ca0","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"groups":[{"uuid":"73aefd20-8003-49df-8898-baeaebfbf8de","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"0f323dba-1ed4-45b9-9492-fbba950f31c9","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}],"joint_account_uuid":"be0ed009-edb1-49cb-9724-f760c8d53fec","login_access_level":"write","external_references":[{"uuid":"57d5af5e-347e-44ec-94ed-8136472fdf69","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","third_party":"nucleus","reference":"AB123456"}]}},"App_Http_Resources_NoteResource":{"type":"object","properties":{"uuid":{"type":"string","example":"06afdf78-bdab-47b5-8052-8a97cb8fa217"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"contents":{"type":"string","example":"Great work"},"edited":{"type":"boolean","example":true},"author_name":{"type":"string","example":"John Smith"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"98030b5c-606b-4387-8433-c31d7d9c94e3"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"mentioned_accounts":{"type":"array","example":[{"item":"Gareth Thompson","contents":"\u003cspan data-type=\"mention\" data-account-uuid=\"b7b623c3-9ca6-4470-8cf8-a76cc6d9b21a\"\u003e@Gareth Thompson\u003c/span\u003e"}],"items":{"type":"object","properties":{"item":{"type":"string","example":"Gareth Thompson"},"contents":{"type":"string","example":"\u003cspan data-type=\"mention\" data-account-uuid=\"b7b623c3-9ca6-4470-8cf8-a76cc6d9b21a\"\u003e@Gareth Thompson\u003c/span\u003e"}}}},"tags":{"type":"array","example":[{"uuid":"2064e4a6-d461-466a-8341-4fecfff9135d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"2064e4a6-d461-466a-8341-4fecfff9135d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}},"type":{"type":"string","example":"meeting"},"notable_type":{"type":"string","example":"client"},"notable":{"type":"object","properties":{"uuid":{"type":"string","example":"d535b55a-3994-4eb8-ad13-df58f303e9ac"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"external_references":{"type":"array","example":[{"uuid":"03aa3c15-38e4-4d33-acb4-8ab1a6459136","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"03aa3c15-38e4-4d33-acb4-8ab1a6459136"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}}},"example":[{"uuid":"06afdf78-bdab-47b5-8052-8a97cb8fa217","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","contents":"Great work","edited":true,"author_name":"John Smith","account":{"uuid":"98030b5c-606b-4387-8433-c31d7d9c94e3","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"mentioned_accounts":[{"item":"Gareth Thompson","contents":"\u003cspan data-type=\"mention\" data-account-uuid=\"b7b623c3-9ca6-4470-8cf8-a76cc6d9b21a\"\u003e@Gareth Thompson\u003c/span\u003e"}],"tags":[{"uuid":"2064e4a6-d461-466a-8341-4fecfff9135d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"type":"meeting","notable_type":"client","notable":{"uuid":"d535b55a-3994-4eb8-ad13-df58f303e9ac","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"external_references":[{"uuid":"03aa3c15-38e4-4d33-acb4-8ab1a6459136","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}]}]},"App_Http_Resources_ChargeSplitResource":{"type":"object","properties":{"uuid":{"type":"string","example":"8b06abde-2b6f-424f-b320-c478f099a5ea","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"splitable_type":{"type":"string","example":"plan","description":"The model type this charge split belongs to."},"splitable":{"type":"object","properties":{"uuid":{"type":"string","example":"25edc624-16b9-4d28-a6c8-9918fa8ea35b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Model this charge split belongs to e.g. plan"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"9cef0ef8-f88d-4565-bfea-044345934326"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account who will be receiving this charge split"},"charge_split_schema":{"type":"object","properties":{"uuid":{"type":"string","example":"6ee65f77-5b26-4714-bd4f-58bc59ec2ea2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Basic Introducer Rate"},"min_percentage":{"type":"integer","example":10},"max_percentage":{"type":"integer","example":20},"default_percentage":{"type":"integer","example":15},"percentage_paid_by_firm":{"type":"integer","example":25},"percentage_paid_by_adviser":{"type":"integer","example":75},"can_change_transfer_fci":{"type":"boolean","example":true},"default_transfer_fci":{"type":"boolean","example":true},"can_change_initial":{"type":"boolean","example":true},"default_initial":{"type":"boolean","example":true},"can_change_ongoing":{"type":"boolean","example":true},"default_ongoing":{"type":"boolean","example":true},"valid_for_advisers":{"type":"boolean","example":true},"valid_for_clients":{"type":"boolean","example":true},"valid_for_introducers":{"type":"boolean","example":true},"visible_to_advisers":{"type":"boolean","example":true}},"description":"The charge split schema model that defined the parameters of this charge split"},"percentage":{"type":"number","example":12.5,"description":"How much of the expectation the given account is expected to receive"},"percentage_paid_by_firm":{"type":"integer","example":0,"description":"How much of the charge split amount will be paid by the firm"},"percentage_paid_by_adviser":{"type":"integer","example":100,"description":"How much of the charge split amount will be paid by the adviser"},"transfer_fci":{"type":"string","example":"example","description":"Whether the account will receive FCI recognition for this expectation amount"},"initial":{"type":"string","example":"example","description":"Whether the charge split will apply to initial charges"},"ongoing":{"type":"string","example":"example","description":"Whether the charge split will apply to ongoing charges"},"apply_to_plans":{"type":"boolean","example":true,"description":"When adding this charge split to a client, setting this to true will automatically apply the charge split to all of the client's plans"}},"example":{"uuid":"8b06abde-2b6f-424f-b320-c478f099a5ea","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","splitable_type":"plan","splitable":{"uuid":"25edc624-16b9-4d28-a6c8-9918fa8ea35b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"account":{"uuid":"9cef0ef8-f88d-4565-bfea-044345934326","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"charge_split_schema":{"uuid":"6ee65f77-5b26-4714-bd4f-58bc59ec2ea2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Basic Introducer Rate","min_percentage":10,"max_percentage":20,"default_percentage":15,"percentage_paid_by_firm":25,"percentage_paid_by_adviser":75,"can_change_transfer_fci":true,"default_transfer_fci":true,"can_change_initial":true,"default_initial":true,"can_change_ongoing":true,"default_ongoing":true,"valid_for_advisers":true,"valid_for_clients":true,"valid_for_introducers":true,"visible_to_advisers":true},"percentage":12.5,"percentage_paid_by_firm":0,"percentage_paid_by_adviser":100,"transfer_fci":"example","initial":"example","ongoing":"example","apply_to_plans":true}},"App_Http_Resources_Circles_CircleAccountsResource":{"type":"object","properties":{"uuid":{"type":"string","example":"f6ae5440-f9b4-48cf-bce2-4acbb42ccae3"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"linked_clients":{"type":"array","example":[{"uuid":"4b2d5dd2-751c-4e9a-a221-9a6c321eaa4b","name":"Gareth","relationship":"Father"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"4b2d5dd2-751c-4e9a-a221-9a6c321eaa4b"},"name":{"type":"string","example":"Gareth"},"relationship":{"type":"string","example":"Father"}}}},"logins":{"type":"array","example":[{"uuid":"436a99ce-638d-433a-8433-46638a345c41","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2026-08-16T14:41:54+01:00","has_write_permission":false,"has_delete_permission":false,"primary":false,"receives_unread_notifications_email":true,"wealth_enabled":true,"goals_enabled":true,"factfind_enabled":true,"tasks_enabled":true,"welcome_enabled":true,"first_name":"Gareth","last_name":"Thompson","email":"gareth@plannrcrm.com","user_type":"standard","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource","is_impersonated":false}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"436a99ce-638d-433a-8433-46638a345c41"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"expires_at":{"type":"string","example":"2026-08-16T14:41:54+01:00"},"has_write_permission":{"type":"boolean","example":false},"has_delete_permission":{"type":"boolean","example":false},"primary":{"type":"boolean","example":false},"receives_unread_notifications_email":{"type":"boolean","example":true},"wealth_enabled":{"type":"boolean","example":true},"goals_enabled":{"type":"boolean","example":true},"factfind_enabled":{"type":"boolean","example":true},"tasks_enabled":{"type":"boolean","example":true},"welcome_enabled":{"type":"boolean","example":true},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"email":{"type":"string","example":"gareth@plannrcrm.com"},"user_type":{"type":"string","example":"standard"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"is_impersonated":{"type":"boolean","example":false}}}}},"example":[{"uuid":"f6ae5440-f9b4-48cf-bce2-4acbb42ccae3","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","linked_clients":[{"uuid":"4b2d5dd2-751c-4e9a-a221-9a6c321eaa4b","name":"Gareth","relationship":"Father"}],"logins":[{"uuid":"436a99ce-638d-433a-8433-46638a345c41","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2026-08-16T14:41:54+01:00","has_write_permission":false,"has_delete_permission":false,"primary":false,"receives_unread_notifications_email":true,"wealth_enabled":true,"goals_enabled":true,"factfind_enabled":true,"tasks_enabled":true,"welcome_enabled":true,"first_name":"Gareth","last_name":"Thompson","email":"gareth@plannrcrm.com","user_type":"standard","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource","is_impersonated":false}]}]},"App_Http_Resources_FormSubmissionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"6a900e52-1179-47ab-96a3-a265cac585c9"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"stage":{"type":"string","example":"draft"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"e29372f0-5e7a-4eb7-ac15-334c704604a8"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"request":{"type":"object","properties":{"uuid":{"type":"string","example":"f85b5c2f-2936-4e92-abef-51d7ccc270e4"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"Please submit your annual survey form"},"form":{"type":"string","example":"App\\Http\\Resources\\FormResource"},"has_submission":{"type":"boolean","example":true},"submission":{"type":"string","example":"App\\Http\\Resources\\FormSubmissionResource"}}},"form":{"type":"object","properties":{"uuid":{"type":"string","example":"6a581d0b-7cbf-4518-8ced-7eef433d646e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"title":{"type":"string","example":"Annual Catchup 2022"},"description":{"type":"string","example":"This is the annual catchup form for 2022"},"live":{"type":"boolean","example":true},"visibility":{"type":"string","example":"public"},"sections":{"type":"string","example":"App\\Http\\Resources\\FormQuestionResource"},"allowed_hosts":{"type":"array","example":["domain.com","subdomain.domain.com"],"items":{"type":"string"}},"draft_submissions_count":{"type":"integer","example":5},"submitted_submissions_count":{"type":"integer","example":5},"create_client":{"type":"boolean","example":true},"client_type":{"type":"string","example":"client"}}},"answers":{"type":"array","example":[{"first_name":"john","last_name":"olive"}],"items":{"type":"object","properties":{"first_name":{"type":"string","example":"john"},"last_name":{"type":"string","example":"olive"}}}}},"example":[{"uuid":"6a900e52-1179-47ab-96a3-a265cac585c9","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","stage":"draft","account":{"uuid":"e29372f0-5e7a-4eb7-ac15-334c704604a8","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"request":{"uuid":"f85b5c2f-2936-4e92-abef-51d7ccc270e4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","description":"Please submit your annual survey form","form":"App\\Http\\Resources\\FormResource","has_submission":true,"submission":"App\\Http\\Resources\\FormSubmissionResource"},"form":{"uuid":"6a581d0b-7cbf-4518-8ced-7eef433d646e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","title":"Annual Catchup 2022","description":"This is the annual catchup form for 2022","live":true,"visibility":"public","sections":"App\\Http\\Resources\\FormQuestionResource","allowed_hosts":["domain.com","subdomain.domain.com"],"draft_submissions_count":5,"submitted_submissions_count":5,"create_client":true,"client_type":"client"},"answers":[{"first_name":"john","last_name":"olive"}]}]},"App_Http_Resources_LinkedClients_CircleLinkedClientsResource":{"type":"object","properties":{"uuid":{"type":"string","example":"bd21f926-f8c6-4922-9330-d250f7af7f16"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"linked_clients":{"type":"array","example":[{"uuid":"817047a6-dc68-4f74-99a9-6a24f8d7d39f","name":"Gareth","relationship":"Father"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"817047a6-dc68-4f74-99a9-6a24f8d7d39f"},"name":{"type":"string","example":"Gareth"},"relationship":{"type":"string","example":"Father"}}}}},"example":[{"uuid":"bd21f926-f8c6-4922-9330-d250f7af7f16","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","linked_clients":[{"uuid":"817047a6-dc68-4f74-99a9-6a24f8d7d39f","name":"Gareth","relationship":"Father"}]}]},"App_Http_Resources_NetWorthResource":{"type":"object","properties":{"valued_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the networth was calculated"},"total":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"100000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£1,000,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The total wealth of the client at the given date"},"abstract_types":{"type":"object","properties":{"assets":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"59500000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£595,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"liabilities":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"32500000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£325,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"protection":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"8000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£80,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"The total wealth broken down in to plan abstract types"},"plan_types":{"type":"object","properties":{"annuity":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"9172106"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£91,721.06"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"cash_account":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"9452110"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£94,521.10"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"fixed_asset":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"8394776"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£83,947.76"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"general_insurance":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"3091804"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£30,918.04"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"group_protection":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"9767027"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£97,670.27"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"investment":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"3848845"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£38,488.45"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"loan_credit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"7564545"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£75,645.45"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"mortgage":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"3630342"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£36,303.42"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"pension":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"6850594"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£68,505.94"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"protection_policy":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"8796070"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£87,960.70"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"The total wealth broken down in to plan types"}},"example":{"valued_at":"2026-05-08T14:41:54+01:00","total":{"amount":{"example":"100000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£1,000,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"abstract_types":{"assets":{"amount":{"example":"59500000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£595,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"liabilities":{"amount":{"example":"32500000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£325,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"protection":{"amount":{"example":"8000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£80,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"plan_types":{"annuity":{"amount":{"example":"9172106","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£91,721.06","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"cash_account":{"amount":{"example":"9452110","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£94,521.10","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"fixed_asset":{"amount":{"example":"8394776","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£83,947.76","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"general_insurance":{"amount":{"example":"3091804","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£30,918.04","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"group_protection":{"amount":{"example":"9767027","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£97,670.27","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"investment":{"amount":{"example":"3848845","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£38,488.45","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"loan_credit":{"amount":{"example":"7564545","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£75,645.45","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"mortgage":{"amount":{"example":"3630342","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£36,303.42","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"pension":{"amount":{"example":"6850594","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£68,505.94","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"protection_policy":{"amount":{"example":"8796070","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£87,960.70","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}}},"App_Http_Resources_Plans_ClaimResource":{"type":"object","properties":{"uuid":{"type":"string","example":"8b129c4b-fea2-48b7-96a9-11d77f7f4c2f","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"claim_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Claim amount"},"claim_start_date":{"type":"string","example":"2025-05-08","description":"Claim start date"},"claim_end_date":{"type":"string","example":"2031-05-08","description":"Claim end date"},"claim_notes":{"type":"string","example":"Claim notes","description":"Claim notes"},"client":{"type":"object","properties":{"uuid":{"type":"string","example":"44be9d91-3fc8-42fb-a06a-6e8724c00016"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Client this claim is for"}},"example":{"uuid":"8b129c4b-fea2-48b7-96a9-11d77f7f4c2f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":{"uuid":"44be9d91-3fc8-42fb-a06a-6e8724c00016","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_ClientStatusResource":{"type":"object","properties":{"uuid":{"type":"string","example":"10f6fcff-1bc0-4e13-b1d4-d8660170cb70","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"On Hold","description":"The name of the custom status."},"colour":{"type":"string","example":"#FFFFFF","description":"The colour of the custom status"}},"example":{"uuid":"10f6fcff-1bc0-4e13-b1d4-d8660170cb70","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"On Hold","colour":"#FFFFFF"}},"App_Http_Resources_Plans_PlanResource":{"type":"object","properties":{"uuid":{"type":"string","example":"0ccedbfe-f941-4246-a3bd-a8e39ec506b4"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"object","properties":{"uuid":{"type":"string","example":"6d6691a3-f47b-4455-bd40-6539d7e8bfb6"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}},"sub_accounts":{"type":"array","example":[{"uuid":"77b86509-7c12-4d6d-9c9a-a70f31008b25","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"77b86509-7c12-4d6d-9c9a-a70f31008b25"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}}},"provider":{"type":"object","properties":{"uuid":{"type":"string","example":"2e205a3e-a973-41be-b8e5-15a6848b8bf5"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"AJ Bell"},"slug":{"type":"string","example":"aj-bell"}}},"covers":{"type":"array","example":[{"uuid":"138f8fa3-bed1-4c8f-bffb-28f7c2c6c526","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"138f8fa3-bed1-4c8f-bffb-28f7c2c6c526"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"cover_type":{"type":"string","example":"critical_illness"},"benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"benefit_frequency":{"type":"string","example":"monthly"},"benefit_status":{"type":"string","example":"active"},"excess":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"indexation":{"type":"number","example":1.4},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}}},"claims":{"type":"array","example":[{"uuid":"058050fb-52fd-4f12-8b1f-5e119550568d","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":"App\\Http\\Resources\\AccountResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"058050fb-52fd-4f12-8b1f-5e119550568d"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"claim_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"claim_start_date":{"type":"string","example":"2025-05-08"},"claim_end_date":{"type":"string","example":"2031-05-08"},"claim_notes":{"type":"string","example":"Claim notes"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}}},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"array","example":[{"uuid":"6452fc67-b90e-40f9-b7cb-e28567015394","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","valued_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"6452fc67-b90e-40f9-b7cb-e28567015394"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"}}}},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"object","properties":{"uuid":{"type":"string","example":"571a23be-d711-43f2-a159-8846d5c432bc"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"accounts":{"type":"array","example":[{"uuid":"c28b448d-a7d7-46eb-af3c-a6f079dd3fe1","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"c28b448d-a7d7-46eb-af3c-a6f079dd3fe1"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"seller":{"type":"object","properties":{"uuid":{"type":"string","example":"3d70f9c8-da4d-44f9-81ef-3ee8ea70f891"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"linked_owners":{"type":"array","example":[{"uuid":"74fca2f0-06d5-451d-96e2-0a4897c80bc4","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"74fca2f0-06d5-451d-96e2-0a4897c80bc4"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"linked_plans":{"type":"array","example":[{"uuid":"d1cc186a-17f3-48d0-8c63-cbe204c8c2f7","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"d1cc186a-17f3-48d0-8c63-cbe204c8c2f7"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"visible_to_circles":{"type":"object","properties":{"uuid":{"type":"string","example":"4ec9af7f-8181-4762-81bc-1d0a0f2bc264"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Jones Family"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=jones+family"},"bg_colour":{"type":"string","example":"#35f4e1"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"joint_account_uuid":{"type":"string","example":"da31b7a3-031f-4144-bcf0-f6290567e3bc"},"login_access_level":{"type":"string","example":"write"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"array","example":[{"uuid":"e4152e42-0809-487d-ad2f-857f64e89e0f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:56+01:00","assigned_to_uuids":["a030ec1f-90e6-4071-842f-e3237e970ba4"],"group_uuids":["e30915fc-1c77-4b01-9a01-19a072a9f928"],"completed_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"f756c770-23e5-413e-81b5-eedc199b3d11","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"e4152e42-0809-487d-ad2f-857f64e89e0f"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"assigned_to_uuids":{"type":"array","example":["a030ec1f-90e6-4071-842f-e3237e970ba4"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["e30915fc-1c77-4b01-9a01-19a072a9f928"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"f756c770-23e5-413e-81b5-eedc199b3d11"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}}}},"tags":{"type":"array","example":[{"uuid":"b5bc43a9-d4c1-4e7f-ac0f-4702ff81530a","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"b5bc43a9-d4c1-4e7f-ac0f-4702ff81530a"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"object","properties":{"uuid":{"type":"string","example":"dc39671c-4f2b-4a22-bd30-7f91f8cbfb71"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"wrap_children":{"type":"array","example":[{"uuid":"e83d40e1-1cd8-4357-be3c-3e2ba99d89ba","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"e83d40e1-1cd8-4357-be3c-3e2ba99d89ba"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"linked_policy_numbers":{"type":"array","example":[{"uuid":"e6fd4322-d3ca-4324-bfb1-382358400623","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","linked_policy_number":"ABC123-X","plan":"App\\Http\\Resources\\Plans\\PlanResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"e6fd4322-d3ca-4324-bfb1-382358400623"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"linked_policy_number":{"type":"string","example":"ABC123-X"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"}}}},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"object","properties":{"uuid":{"type":"string","example":"f2867bd2-8246-4aa6-a421-ad6a03d9b432"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"custom_fields":{"type":"array","example":[{"uuid":"881a54d5-9be7-470c-aa14-f182711eded2","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"881a54d5-9be7-470c-aa14-f182711eded2"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}},"external_references":{"type":"array","example":[{"uuid":"49a1cdf2-1da9-420f-a174-badcdfc39133","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","third_party":"nucleus","reference":"AB123456"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"49a1cdf2-1da9-420f-a174-badcdfc39133"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}}},"example":[{"uuid":"0ccedbfe-f941-4246-a3bd-a8e39ec506b4","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":{"uuid":"6d6691a3-f47b-4455-bd40-6539d7e8bfb6","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"sub_accounts":[{"uuid":"77b86509-7c12-4d6d-9c9a-a70f31008b25","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}],"provider":{"uuid":"2e205a3e-a973-41be-b8e5-15a6848b8bf5","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"AJ Bell","slug":"aj-bell"},"covers":[{"uuid":"138f8fa3-bed1-4c8f-bffb-28f7c2c6c526","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}],"claims":[{"uuid":"058050fb-52fd-4f12-8b1f-5e119550568d","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":"App\\Http\\Resources\\AccountResource"}],"total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":[{"uuid":"6452fc67-b90e-40f9-b7cb-e28567015394","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","valued_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"}],"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":{"uuid":"571a23be-d711-43f2-a159-8846d5c432bc","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"accounts":[{"uuid":"c28b448d-a7d7-46eb-af3c-a6f079dd3fe1","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"seller":{"uuid":"3d70f9c8-da4d-44f9-81ef-3ee8ea70f891","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"linked_owners":[{"uuid":"74fca2f0-06d5-451d-96e2-0a4897c80bc4","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"linked_plans":[{"uuid":"d1cc186a-17f3-48d0-8c63-cbe204c8c2f7","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"visible_to_circles":{"uuid":"4ec9af7f-8181-4762-81bc-1d0a0f2bc264","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":"App\\Http\\Resources\\AccountResource","groups":"App\\Http\\Resources\\GroupResource","joint_account_uuid":"da31b7a3-031f-4144-bcf0-f6290567e3bc","login_access_level":"write","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"statistics":{"recent_growth":100},"cases":[{"uuid":"e4152e42-0809-487d-ad2f-857f64e89e0f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:56+01:00","assigned_to_uuids":["a030ec1f-90e6-4071-842f-e3237e970ba4"],"group_uuids":["e30915fc-1c77-4b01-9a01-19a072a9f928"],"completed_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"f756c770-23e5-413e-81b5-eedc199b3d11","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"tags":[{"uuid":"b5bc43a9-d4c1-4e7f-ac0f-4702ff81530a","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"is_wrap_product":false,"is_wrap_child":false,"wrap":{"uuid":"dc39671c-4f2b-4a22-bd30-7f91f8cbfb71","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"wrap_children":[{"uuid":"e83d40e1-1cd8-4357-be3c-3e2ba99d89ba","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"linked_policy_numbers":[{"uuid":"e6fd4322-d3ca-4324-bfb1-382358400623","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","linked_policy_number":"ABC123-X","plan":"App\\Http\\Resources\\Plans\\PlanResource"}],"can_be_deleted":"false","contract_enquiry_account":{"uuid":"f2867bd2-8246-4aa6-a421-ad6a03d9b432","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"custom_fields":[{"uuid":"881a54d5-9be7-470c-aa14-f182711eded2","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"external_references":[{"uuid":"49a1cdf2-1da9-420f-a174-badcdfc39133","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","third_party":"nucleus","reference":"AB123456"}]}]},"App_Http_Resources_LinkedClients_LinkedClientsResource":{"type":"object","properties":{"uuid":{"type":"string","example":"82283ae2-6f7a-4563-8c7e-ecc971c548ac","description":"The unique identifier of the linked client."},"name":{"type":"string","example":"Gareth","description":"The name of the linked client."},"relationship":{"type":"string","example":"Father","description":"The relationship to the linked client."}},"example":{"uuid":"82283ae2-6f7a-4563-8c7e-ecc971c548ac","name":"Gareth","relationship":"Father"}},"App_Http_Resources_FactFind_FactFindRequestResource":{"type":"object","properties":{"uuid":{"type":"string","example":"38155159-8cbd-4484-88a1-41c2aa9b5af0","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"status":{"type":"string","example":"complete","description":"The status of the fact find request. Available options: in_progress,complete,approved,rejected"},"completed_at":{"type":"string","example":"2026-05-03T14:41:55+01:00","description":"The datetime when the fact find request has been completed"},"invitation_text":{"type":"string","example":"Please complete this fact find!","description":"The text that is used in the notification/email sent out to the client."},"schema":{"type":"object","properties":{"uuid":{"type":"string","example":"2210fc30-0e4e-42d4-b1ef-eb5a5eac0d07"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"archived_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"is_archived":{"type":"boolean","example":false},"name":{"type":"string","example":"Default fact find"},"introduction_html":{"type":"string","example":"Welcome to our fact find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e"},"sections_count":{"type":"integer","example":5},"public_url":{"type":"string","example":"https://api.plannrcrm.com/fact-find/bab8a17e-0a67-4d40-be70-be6ef6641d5e"}},"description":"The fact find schema used for the fact find request."},"latest_file":{"type":"object","properties":{"uuid":{"type":"string","example":"db809aea-5cd4-49c8-af55-fafe1f5efd29"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"status":{"type":"string","example":"uploaded"},"filename":{"type":"string","example":"Welcome to Plannr.pdf"},"name":{"type":"string","example":"Welcome to Plannr"},"extension":{"type":"string","example":"pdf"},"type":{"type":"string","example":"type"},"size":{"type":"string","example":"21691783"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf"},"last_modified":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"progress":{"type":"string","example":"100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/a86ef461-b1bf-482c-a253-307fa2d5f012/download"},"folder_name":{"type":"string","example":"folder 2"},"folder":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"documentable_type":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"42cda05c-907f-4b7e-b3c2-9f07f9792e8c"}}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"}},"description":"The latest file that has been generated for the fact find request."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"735443ec-9f8b-4df9-a0ca-46cab4609ae2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account that the fact find request was sent to. Only visible when listing fact find requests for a circle."},"invitation_url":{"type":"string","example":"https://api.plannrcrm.com/fact-find/069a4009-dc7a-42ad-afb6-304334e2d621/1d673ea3-e4b3-414d-a1c3-ec6cedf6b6e6","description":"The invitation URL sent to the client."},"fact_find_passes":{"type":"object","properties":{"uuid":{"type":"string","example":"a2e0cf93-11d1-47f8-aad4-bd6dc6bc5957"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"9a9d1802-198e-487d-8236-005e2cd26a8f"},"name":{"type":"string","example":"Codepotato Ltd"}}},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"circle":{"type":"object","properties":{"uuid":{"type":"string","example":"4bed4ec9-c212-4573-9338-62cc8c124b06"},"name":{"type":"string","example":"The Codepotato Gang"}}},"expires_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"progress":{"type":"integer","example":50},"is_complete":{"type":"boolean","example":false},"completed_sections":{"type":"integer","example":2}},"description":"The fact find passes added to the fact find request."}},"example":{"uuid":"38155159-8cbd-4484-88a1-41c2aa9b5af0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","status":"complete","completed_at":"2026-05-03T14:41:55+01:00","invitation_text":"Please complete this fact find!","schema":{"uuid":"2210fc30-0e4e-42d4-b1ef-eb5a5eac0d07","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","archived_at":"2026-05-07T14:41:55+01:00","is_archived":false,"name":"Default fact find","introduction_html":"Welcome to our fact find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e","sections_count":5,"public_url":"https://api.plannrcrm.com/fact-find/bab8a17e-0a67-4d40-be70-be6ef6641d5e"},"latest_file":{"uuid":"db809aea-5cd4-49c8-af55-fafe1f5efd29","created_at":"2026-05-08T14:41:55+01:00","original_created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","uploaded_at":"2026-05-08T14:41:55+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:55+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/a86ef461-b1bf-482c-a253-307fa2d5f012/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"42cda05c-907f-4b7e-b3c2-9f07f9792e8c"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"},"account":{"uuid":"735443ec-9f8b-4df9-a0ca-46cab4609ae2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"invitation_url":"https://api.plannrcrm.com/fact-find/069a4009-dc7a-42ad-afb6-304334e2d621/1d673ea3-e4b3-414d-a1c3-ec6cedf6b6e6","fact_find_passes":{"uuid":"a2e0cf93-11d1-47f8-aad4-bd6dc6bc5957","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","firm":{"uuid":"9a9d1802-198e-487d-8236-005e2cd26a8f","name":"Codepotato Ltd"},"account":"App\\Http\\Resources\\MinimalAccountResource","circle":{"uuid":"4bed4ec9-c212-4573-9338-62cc8c124b06","name":"The Codepotato Gang"},"expires_at":"2026-05-08T14:41:55+01:00","progress":50,"is_complete":false,"completed_sections":2}}},"App_Http_Resources_NewBusinessEventResource":{"type":"object","properties":{"uuid":{"type":"string","example":"d141ba29-cff1-4daa-9654-81a9cbb07faf"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"888214ac-eeb0-4ab1-a20e-caffd4839f9d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"clients":{"type":"object","properties":{"uuid":{"type":"string","example":"bd95f602-d99e-4fee-8af5-7424ce543ce6"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"modelable":{"type":"object","properties":{"uuid":{"type":"string","example":"a942059f-30a9-49be-835a-18fa3d2811ae"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"modelable_type":{"type":"string","example":"plan"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"5e6e6f1b-565c-4998-b62b-0f88001448b5"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}}},"contribution_type":{"type":"string","example":"increment"},"contribution_type_notes":{"type":"string","example":"Contribution type notes"},"adviser":{"type":"object","properties":{"uuid":{"type":"string","example":"14aac750-2d4a-4147-834e-465c3c923902"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"advice_type":{"type":"string","example":"execution_only"},"conducted_by":{"type":"string","example":"email"},"premium":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"premium_frequency":{"type":"string","example":"monthly"},"start_date":{"type":"string","example":"2021-09-24"},"proposal_date":{"type":"string","example":"2021-09-01"},"case":{"type":"object","properties":{"uuid":{"type":"string","example":"614bf97c-603c-4695-bfcb-9f6a66aba3bc"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"assigned_to_uuids":{"type":"array","example":["e54ed7c2-b94c-4cc5-a9ff-aca2d022022d"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["9f210c7a-773c-4f33-9aeb-34bbb3ba33c7"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"917379b6-03a9-423e-baf2-39d5b9c3344b"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}}},"is_vulnerable_client":{"type":"boolean","example":true},"is_replacing_existing_plan":{"type":"boolean","example":true},"existing_plan":{"type":"object","properties":{"uuid":{"type":"string","example":"41be2dac-b058-4635-b8d0-a996d90e2b68"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"existing_plan_details":{"type":"string","example":"Existing plan details"},"opted_out_of_pension_scheme_for_plan":{"type":"boolean","example":true},"opted_out_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opted_out_notes":{"type":"string","example":"Opted out notes"},"status":{"type":"string","example":"accepted"}},"example":[{"uuid":"d141ba29-cff1-4daa-9654-81a9cbb07faf","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","plan":{"uuid":"888214ac-eeb0-4ab1-a20e-caffd4839f9d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"clients":{"uuid":"bd95f602-d99e-4fee-8af5-7424ce543ce6","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"modelable":{"uuid":"a942059f-30a9-49be-835a-18fa3d2811ae","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"modelable_type":"plan","firm":{"uuid":"5e6e6f1b-565c-4998-b62b-0f88001448b5","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"contribution_type":"increment","contribution_type_notes":"Contribution type notes","adviser":{"uuid":"14aac750-2d4a-4147-834e-465c3c923902","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"advice_type":"execution_only","conducted_by":"email","premium":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"premium_frequency":"monthly","start_date":"2021-09-24","proposal_date":"2021-09-01","case":{"uuid":"614bf97c-603c-4695-bfcb-9f6a66aba3bc","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["e54ed7c2-b94c-4cc5-a9ff-aca2d022022d"],"group_uuids":["9f210c7a-773c-4f33-9aeb-34bbb3ba33c7"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"917379b6-03a9-423e-baf2-39d5b9c3344b","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"},"is_vulnerable_client":true,"is_replacing_existing_plan":true,"existing_plan":{"uuid":"41be2dac-b058-4635-b8d0-a996d90e2b68","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"existing_plan_details":"Existing plan details","opted_out_of_pension_scheme_for_plan":true,"opted_out_at":"2026-05-08T14:41:55+01:00","opted_out_notes":"Opted out notes","status":"accepted"}]},"App_Http_Resources_MailboxMessageResource":{"type":"object","properties":{"uuid":{"type":"string","example":"e347b1db-92f6-461c-b01d-89605fa484b6","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"message_created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the message was sent."},"mailbox":{"type":"object","properties":{"uuid":{"type":"string","example":"0882e483-449e-48ea-a164-9eb898ec2910"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"created_by":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"c34f5d16-c0c7-4ece-babe-2a361661b43a"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use primary_email instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"description":{"type":"string","example":"URL for initial avatar image"},"collection":{"type":"boolean","example":false}}},"firm":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"description":{"type":"string","example":"Firm"},"collection":{"type":"boolean","example":false}}},"primary_phone_number":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"description":{"type":"string","example":"Primary phone number"},"collection":{"type":"boolean","example":false}}},"primary_email":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"description":{"type":"string","example":"Primary email"},"collection":{"type":"boolean","example":false}}},"current_time_entry":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"description":{"type":"string","example":"Current time entry"},"collection":{"type":"boolean","example":false}}},"assigned_adviser":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Assigned adviser"},"collection":{"type":"boolean","example":false}}},"assigned_administrator":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Assigned administrator"},"collection":{"type":"boolean","example":false}}},"assigned_paraplanner":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Assigned paraplanner"},"collection":{"type":"boolean","example":false}}},"introduced_by":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Introduced by"},"collection":{"type":"boolean","example":false}}},"business_unit":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"description":{"type":"string","example":"The business unit this account belongs to"},"collection":{"type":"boolean","example":false}}},"groups":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"description":{"type":"string","example":"Groups"},"collection":{"type":"boolean","example":true}}},"tags":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"description":{"type":"string","example":"Tags"},"collection":{"type":"boolean","example":true}}},"owners":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Accounts that own this account"},"collection":{"type":"boolean","example":true}}},"first_contact_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"First contact date"},"collection":{"type":"boolean","example":false}}},"next_review_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"Next review date"},"collection":{"type":"boolean","example":false}}},"previous_review_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"Previous review date"},"collection":{"type":"boolean","example":false}}},"anniversary_review_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"Anniversary review date"},"collection":{"type":"boolean","example":false}}},"with_login":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes whether the account has a login to Plannr"},"collection":{"type":"boolean","example":false}}},"has_joint_account":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes whether this account belongs to a joint account too"},"collection":{"type":"boolean","example":false}}},"can_be_deleted":{"type":"object","properties":{"example":{"type":"string","example":"false"},"description":{"type":"string","example":"Denotes if the account can be deleted"},"collection":{"type":"boolean","example":false}}},"joint_account_circle":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"description":{"type":"string","example":"This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles."},"collection":{"type":"boolean","example":false}}},"circles":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"description":{"type":"string","example":"The circles the account belongs to"},"collection":{"type":"boolean","example":true}}},"ownership_percentage":{"type":"object","properties":{"example":{"type":"integer","example":100},"description":{"type":"string","example":"Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -\u003e Accounts)"},"collection":{"type":"boolean","example":false}}},"inactive_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08"},"description":{"type":"string","example":"Inactive from date"},"collection":{"type":"boolean","example":false}}},"last_interaction_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08 14:41:54"},"description":{"type":"string","example":"Last interaction date"},"collection":{"type":"boolean","example":false}}},"referral_code":{"type":"object","properties":{"example":{"type":"string","example":"ABC12345"},"description":{"type":"string","example":"Unique referral code for the employee account (employees only)"},"collection":{"type":"boolean","example":false}}},"permissions":{"type":"object","properties":{"example":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"description":{"type":"string","example":"Permission map where keys are permission names and values are target arrays"},"collection":{"type":"boolean","example":false}}},"custom_fields":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"description":{"type":"string","example":"Any custom fields on the model."},"collection":{"type":"boolean","example":true}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}}},"type":{"type":"string","example":"imap"},"email":{"type":"string","example":"test@example.org"},"name":{"type":"string","example":"Test Mailbox"},"state":{"type":"string","example":"connected"},"enabled":{"type":"boolean","example":true},"message_count":{"type":"integer","example":1}},"description":"The mailbox the message belongs to."},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"0acc5a52-8ef5-4e5a-a180-cc7a9279aed7"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The firm the message belongs to."},"ancestors":{"type":"object","properties":{"data":{"type":"string","example":"App\\Http\\Resources\\MailboxMessageResource"},"meta":{"type":"string","example":"object"},"links":{"type":"string","example":"object"}},"description":"Paginated thread of messages that come before this message"},"descendants":{"type":"object","properties":{"data":{"type":"string","example":"App\\Http\\Resources\\MailboxMessageResource"},"meta":{"type":"string","example":"object"},"links":{"type":"string","example":"object"}},"description":"Paginated thread of messages that come after this message"},"thread_count":{"type":"integer","example":0,"description":"The number of thread messages."},"participants":{"type":"array","example":[{"uuid":"e71b0189-0b76-4be5-8b09-eeb5ec706191","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","mailbox_message":"App\\Http\\Resources\\MailboxMessageResource","firm":"App\\Http\\Resources\\FirmResource","mailbox":"App\\Http\\Resources\\MailboxResource","type":"cc","name":"John Doe","email":"john.doe@example.com"}],"description":"The participants of the message.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"e71b0189-0b76-4be5-8b09-eeb5ec706191"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"mailbox_message":{"type":"string","example":"App\\Http\\Resources\\MailboxMessageResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"mailbox":{"type":"string","example":"App\\Http\\Resources\\MailboxResource"},"type":{"type":"string","example":"cc"},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@example.com"}}}},"attachments":{"type":"array","example":[{"uuid":"ea84bcbc-6d69-427c-94ad-7552637fe5e8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","firm":"App\\Http\\Resources\\FirmResource","name":"example.pdf","type":"application/pdf","size":123456,"download_url":"https://example.com/download/attachment","extension":"pdf","status":"uploaded"}],"description":"The attachments of the message.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"ea84bcbc-6d69-427c-94ad-7552637fe5e8"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"name":{"type":"string","example":"example.pdf"},"type":{"type":"string","example":"application/pdf"},"size":{"type":"integer","example":123456},"download_url":{"type":"string","example":"https://example.com/download/attachment"},"extension":{"type":"string","example":"pdf"},"status":{"type":"string","example":"uploaded"}}}},"subject":{"type":"string","example":"Hello World","description":"The subject of the message."},"incoming":{"type":"boolean","example":true,"description":"Whether the message is incoming or outgoing."},"text":{"type":"string","example":"Message body here in plain text","description":"The plain text content of the message."},"html":{"type":"string","example":"\u003cp\u003eMessage body here in HTML\u003c/p\u003e","description":"The HTML content of the message. Only available when the message is retrieved directly."}},"example":{"uuid":"e347b1db-92f6-461c-b01d-89605fa484b6","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","message_created_at":"2026-05-08T14:41:54+01:00","mailbox":{"uuid":"0882e483-449e-48ea-a164-9eb898ec2910","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","created_by":{"uuid":{"example":"c34f5d16-c0c7-4ece-babe-2a361661b43a","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use primary_email instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=gareth+thompson","description":"URL for initial avatar image","collection":false},"firm":{"example":"App\\Http\\Resources\\FirmResource","description":"Firm","collection":false},"primary_phone_number":{"example":"App\\Http\\Resources\\ContactDetailResource","description":"Primary phone number","collection":false},"primary_email":{"example":"App\\Http\\Resources\\ContactDetailResource","description":"Primary email","collection":false},"current_time_entry":{"example":"App\\Http\\Resources\\TimeEntryResource","description":"Current time entry","collection":false},"assigned_adviser":{"example":"App\\Http\\Resources\\AccountResource","description":"Assigned adviser","collection":false},"assigned_administrator":{"example":"App\\Http\\Resources\\AccountResource","description":"Assigned administrator","collection":false},"assigned_paraplanner":{"example":"App\\Http\\Resources\\AccountResource","description":"Assigned paraplanner","collection":false},"introduced_by":{"example":"App\\Http\\Resources\\AccountResource","description":"Introduced by","collection":false},"business_unit":{"example":"App\\Http\\Resources\\BusinessUnitResource","description":"The business unit this account belongs to","collection":false},"groups":{"example":"App\\Http\\Resources\\GroupResource","description":"Groups","collection":true},"tags":{"example":"App\\Http\\Resources\\TagResource","description":"Tags","collection":true},"owners":{"example":"App\\Http\\Resources\\AccountResource","description":"Accounts that own this account","collection":true},"first_contact_date":{"example":"2026-05-08T14:41:54+01:00","description":"First contact date","collection":false},"next_review_date":{"example":"2026-05-08T14:41:54+01:00","description":"Next review date","collection":false},"previous_review_date":{"example":"2026-05-08T14:41:54+01:00","description":"Previous review date","collection":false},"anniversary_review_date":{"example":"2026-05-08T14:41:54+01:00","description":"Anniversary review date","collection":false},"with_login":{"example":true,"description":"Denotes whether the account has a login to Plannr","collection":false},"has_joint_account":{"example":true,"description":"Denotes whether this account belongs to a joint account too","collection":false},"can_be_deleted":{"example":"false","description":"Denotes if the account can be deleted","collection":false},"joint_account_circle":{"example":"App\\Http\\Resources\\CircleResource","description":"This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.","collection":false},"circles":{"example":"App\\Http\\Resources\\CircleResource","description":"The circles the account belongs to","collection":true},"ownership_percentage":{"example":100,"description":"Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -\u003e Accounts)","collection":false},"inactive_at":{"example":"2026-05-08","description":"Inactive from date","collection":false},"last_interaction_at":{"example":"2026-05-08 14:41:54","description":"Last interaction date","collection":false},"referral_code":{"example":"ABC12345","description":"Unique referral code for the employee account (employees only)","collection":false},"permissions":{"example":{"firm:read":["firm"],"network:read":["network:uuid"]},"description":"Permission map where keys are permission names and values are target arrays","collection":false},"custom_fields":{"example":"App\\Http\\Resources\\CustomFieldValueResource","description":"Any custom fields on the model.","collection":true},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"type":"imap","email":"test@example.org","name":"Test Mailbox","state":"connected","enabled":true,"message_count":1},"firm":{"uuid":"0acc5a52-8ef5-4e5a-a180-cc7a9279aed7","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"ancestors":{"data":"App\\Http\\Resources\\MailboxMessageResource","meta":"object","links":"object"},"descendants":{"data":"App\\Http\\Resources\\MailboxMessageResource","meta":"object","links":"object"},"thread_count":0,"participants":[{"uuid":"e71b0189-0b76-4be5-8b09-eeb5ec706191","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","mailbox_message":"App\\Http\\Resources\\MailboxMessageResource","firm":"App\\Http\\Resources\\FirmResource","mailbox":"App\\Http\\Resources\\MailboxResource","type":"cc","name":"John Doe","email":"john.doe@example.com"}],"attachments":[{"uuid":"ea84bcbc-6d69-427c-94ad-7552637fe5e8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","firm":"App\\Http\\Resources\\FirmResource","name":"example.pdf","type":"application/pdf","size":123456,"download_url":"https://example.com/download/attachment","extension":"pdf","status":"uploaded"}],"subject":"Hello World","incoming":true,"text":"Message body here in plain text","html":"\u003cp\u003eMessage body here in HTML\u003c/p\u003e"}},"App_Http_Resources_IllustrationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"5c355c96-3664-4218-a12a-f2570709db2a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"generated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the illustration was generated with the platform."},"status":{"type":"string","example":"created","description":"The status of the illustration. Available values: created, generating_illustration and generated_illustration"},"client":{"type":"object","properties":{"uuid":{"type":"string","example":"f99e72f1-dfe8-4dfd-b47e-34ac4db5ca37"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The lead account that the illustration belongs to."},"accounts":{"type":"array","example":[{"uuid":"40446d18-5554-4d26-a9ac-acbf5baddfb0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"The list of accounts that the illustration belongs to. This will include the lead account.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"40446d18-5554-4d26-a9ac-acbf5baddfb0"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"application":{"type":"object","properties":{"uuid":{"type":"string","example":"8ff3230f-9349-4b00-8014-3bb7c44aac5a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"generated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Illustration Name"},"request_data":{"type":"array","example":[]},"status":{"type":"string","example":"draft"},"platform":{"type":"string","example":"seccl"},"platform_illustration_id":{"type":"string","example":"ABC0123456789"},"clients":{"type":"array","example":["App\\Http\\Resources\\MinimalAccountResource"],"items":{"type":"string"}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"illustration":{"type":"string","example":"App\\Http\\Resources\\IllustrationResource"},"requested_by":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"}},"description":"If the illustration is linked to an application, this will be the application resource."},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"33cb3460-d704-4d46-91e4-e86a8d2a3fb9"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The plan that the illustration belongs to."},"requested_by":{"type":"object","properties":{"uuid":{"type":"string","example":"37992bee-024d-44a5-b93b-34fb30bcf0aa"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account (adviser) that requested the illustration."},"name":{"type":"string","example":"Illustration Name","description":"The name of the illustration."},"request_data":{"type":"array","example":[],"description":"The request data used to generate the illustration."},"platform":{"type":"string","example":"seccl","description":"The platform used to generate the illustration."},"platform_illustration_id":{"type":"string","example":"ABC0123456789","description":"The platform specific illustration id."},"account_opening_allowed":{"type":"boolean","example":true,"description":"Whether the account opening is allowed for the illustration."},"is_draft":{"type":"boolean","example":true,"description":"Whether the illustration is in the created/draft state."}},"example":{"uuid":"5c355c96-3664-4218-a12a-f2570709db2a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","generated_at":"2026-05-08T14:41:55+01:00","status":"created","client":{"uuid":"f99e72f1-dfe8-4dfd-b47e-34ac4db5ca37","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"accounts":[{"uuid":"40446d18-5554-4d26-a9ac-acbf5baddfb0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"application":{"uuid":"8ff3230f-9349-4b00-8014-3bb7c44aac5a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","generated_at":"2026-05-08T14:41:55+01:00","name":"Illustration Name","request_data":[],"status":"draft","platform":"seccl","platform_illustration_id":"ABC0123456789","clients":["App\\Http\\Resources\\MinimalAccountResource"],"firm":"App\\Http\\Resources\\FirmResource","illustration":"App\\Http\\Resources\\IllustrationResource","requested_by":"App\\Http\\Resources\\MinimalAccountResource","plan":"App\\Http\\Resources\\Plans\\PlanResource"},"plan":{"uuid":"33cb3460-d704-4d46-91e4-e86a8d2a3fb9","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"requested_by":{"uuid":"37992bee-024d-44a5-b93b-34fb30bcf0aa","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"name":"Illustration Name","request_data":[],"platform":"seccl","platform_illustration_id":"ABC0123456789","account_opening_allowed":true,"is_draft":true}},"App_Http_Resources_ContactDetailResource":{"type":"object","properties":{"uuid":{"type":"string","example":"c1a576c9-aed4-4b31-b56d-270ebc221168","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"type":{"type":"string","example":"phone_number","description":"Contact detail type"},"name":{"type":"string","example":"Work number","description":"Contact detail description"},"value":{"type":"string","example":"+443330903630","description":"Contact detail value"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}},"description":"If the type is a phone number, this additional field will be displayed giving you information about the phone number."},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"e154e9c1-6c2c-4f13-a517-131d035658e2"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Accounts that own contact detail"}},"example":{"uuid":"c1a576c9-aed4-4b31-b56d-270ebc221168","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":{"uuid":"e154e9c1-6c2c-4f13-a517-131d035658e2","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_ContactDetailResource":{"type":"object","properties":{"uuid":{"type":"string","example":"c7c07026-ad16-43dd-ab02-2f674b0194f3"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"email"},"name":{"type":"string","example":"Personal number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"5fc78787-89b3-4d66-a25a-a0484adf93df"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"primary_accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"cea7ce92-76d6-432c-b57d-79a6025c278c"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"example":[{"uuid":"c7c07026-ad16-43dd-ab02-2f674b0194f3","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"email","name":"Personal number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":{"uuid":"5fc78787-89b3-4d66-a25a-a0484adf93df","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"primary_accounts":{"uuid":"cea7ce92-76d6-432c-b57d-79a6025c278c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}]},"App_Http_Resources_Plans_ContributionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3b539dad-b329-4a6d-ab70-2a1ce0a2674d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"paid_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"example":[{"uuid":"3b539dad-b329-4a6d-ab70-2a1ce0a2674d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","paid_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}]},"App_Http_Resources_ConversationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"9e884392-9cbb-4448-a13f-f050074583ec","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Welcome to Plannr","description":"Conversation title"},"slug":{"type":"string","example":"welcome-to-plannr","description":"Conversation title as a slug"},"belongs_to_case":{"type":"boolean","example":true,"description":"Whether or not the conversation belongs to a case."},"case":{"type":"object","properties":{"uuid":{"type":"string","example":"433159d9-c5d8-4137-9794-54c4a6bc0d4d"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"assigned_to_uuids":{"type":"array","example":["f1e3c9ee-4ed8-452d-beff-91a9f91d817d"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["36db8a23-d6b7-4f56-84a6-de5669a7a109"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"905a4a8d-02f6-404d-92a7-6ea615c39ea4"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}},"description":"Case the conversation belongs to (if included)"},"participants_count":{"type":"integer","example":3,"description":"Number of participants in conversation (if included)"},"participants":{"type":"array","example":[{"uuid":"708432cb-ce9e-442b-98af-1d8f77452901","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"Participants in this conversation (if included)","items":{"type":"object","properties":{"uuid":{"type":"string","example":"708432cb-ce9e-442b-98af-1d8f77452901"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"latest_message":{"type":"object","properties":{"uuid":{"type":"string","example":"f8015f31-5d5a-415b-87fd-0c35188321bc"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"deleted_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"contents":{"type":"string","example":"Welcome to Plannr!"},"edited":{"type":"boolean","example":true},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"author":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"user":{"type":"string","example":"App\\Http\\Resources\\UserResource"},"reactions":{"type":"string","example":"App\\Http\\Resources\\ReactionResource"}},"description":"The latest message of the conversation (if included)"},"messages_count":{"type":"integer","example":30,"description":"Number of messages in the conversation (if included)"},"files_count":{"type":"integer","example":2,"description":"Number of files in the conversation (if included)"},"tags":{"type":"array","example":[{"uuid":"8c783024-b353-4c38-bd9d-ea762d8e1179","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"description":"Conversation tags (if included)","items":{"type":"object","properties":{"uuid":{"type":"string","example":"8c783024-b353-4c38-bd9d-ea762d8e1179"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}},"pinned":{"type":"boolean","example":true,"description":"Whether the conversation has been pinned to the top (if participants included)"},"is_admin":{"type":"boolean","example":false,"description":"If the authenticated account is an admin of the conversation (if participants included)"}},"example":{"uuid":"9e884392-9cbb-4448-a13f-f050074583ec","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Welcome to Plannr","slug":"welcome-to-plannr","belongs_to_case":true,"case":{"uuid":"433159d9-c5d8-4137-9794-54c4a6bc0d4d","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:54+01:00","assigned_to_uuids":["f1e3c9ee-4ed8-452d-beff-91a9f91d817d"],"group_uuids":["36db8a23-d6b7-4f56-84a6-de5669a7a109"],"completed_at":"2026-05-08T14:41:54+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"905a4a8d-02f6-404d-92a7-6ea615c39ea4","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"},"participants_count":3,"participants":[{"uuid":"708432cb-ce9e-442b-98af-1d8f77452901","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"latest_message":{"uuid":"f8015f31-5d5a-415b-87fd-0c35188321bc","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","deleted_at":"2026-05-08T14:41:54+01:00","contents":"Welcome to Plannr!","edited":true,"files":"App\\Http\\Resources\\FileResource","author":"App\\Http\\Resources\\AccountResource","user":"App\\Http\\Resources\\UserResource","reactions":"App\\Http\\Resources\\ReactionResource"},"messages_count":30,"files_count":2,"tags":[{"uuid":"8c783024-b353-4c38-bd9d-ea762d8e1179","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"pinned":true,"is_admin":false}},"App_Http_Resources_MessageResource":{"type":"object","properties":{"uuid":{"type":"string","example":"405ec324-f5be-4634-8271-7b764e35dae8","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"deleted_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was deleted."},"contents":{"type":"string","example":"Welcome to Plannr!","description":"The message contents"},"edited":{"type":"boolean","example":true,"description":"Whether the message has been edited or not"},"files":{"type":"array","example":[{"uuid":"5cc394cf-5723-4c89-9487-6591c33f61f1","created_at":"2026-05-08T14:41:54+01:00","original_created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","uploaded_at":"2026-05-08T14:41:54+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:54+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/669b7109-7bf6-4b42-ba00-e8c5c4703aaa/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"b8c86fa0-d5bb-485c-afea-d42626b0654c"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"description":"Message file attachments","items":{"type":"object","properties":{"uuid":{"type":"string","example":"5cc394cf-5723-4c89-9487-6591c33f61f1"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"original_created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"status":{"type":"string","example":"uploaded"},"filename":{"type":"string","example":"Welcome to Plannr.pdf"},"name":{"type":"string","example":"Welcome to Plannr"},"extension":{"type":"string","example":"pdf"},"type":{"type":"string","example":"type"},"size":{"type":"string","example":"21691783"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf"},"last_modified":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"progress":{"type":"string","example":"100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/669b7109-7bf6-4b42-ba00-e8c5c4703aaa/download"},"folder_name":{"type":"string","example":"folder 2"},"folder":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"documentable_type":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"b8c86fa0-d5bb-485c-afea-d42626b0654c"}}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"}}}},"author":{"type":"object","properties":{"uuid":{"type":"string","example":"6bda6044-af79-4a5c-9afb-4daaf3f63d31"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Message author"},"user":{"type":"object","properties":{"uuid":{"type":"string","example":"b44595b3-b44b-4f5b-88ce-e8fb2e23c38a"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"standard"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"current_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"current_login":{"type":"string","example":"App\\Http\\Resources\\LoginResource"},"two_factor_enabled":{"type":"boolean","example":true},"two_factor_type":{"type":"string","example":"sms"},"otp_confirmed_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"otp_pending":{"type":"boolean","example":false},"sms_two_factor_enabled":{"type":"boolean","example":true},"two_factor_mobile":{"type":"boolean","example":true},"two_factor_mobile_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"session_expires_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"remember_token_expires_at":{"type":"boolean","example":true},"should_auto_save_notes":{"type":"boolean","example":true}},"description":"Message user"},"reactions":{"type":"array","example":[{"uuid":"a4d3560b-fa0b-4585-aae5-8ce1226a45e9","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","account_uuid":"fe62579b-4a88-4cda-a0ab-9a4ffd15853a","account_name":"Gareth Thompson","reaction":"like"}],"description":"Array of reactions to the message","items":{"type":"object","properties":{"uuid":{"type":"string","example":"a4d3560b-fa0b-4585-aae5-8ce1226a45e9"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"account_uuid":{"type":"string","example":"fe62579b-4a88-4cda-a0ab-9a4ffd15853a"},"account_name":{"type":"string","example":"Gareth Thompson"},"reaction":{"type":"string","example":"like"}}}}},"example":{"uuid":"405ec324-f5be-4634-8271-7b764e35dae8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","deleted_at":"2026-05-08T14:41:54+01:00","contents":"Welcome to Plannr!","edited":true,"files":[{"uuid":"5cc394cf-5723-4c89-9487-6591c33f61f1","created_at":"2026-05-08T14:41:54+01:00","original_created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","uploaded_at":"2026-05-08T14:41:54+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:54+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/669b7109-7bf6-4b42-ba00-e8c5c4703aaa/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"b8c86fa0-d5bb-485c-afea-d42626b0654c"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"author":{"uuid":"6bda6044-af79-4a5c-9afb-4daaf3f63d31","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"user":{"uuid":"b44595b3-b44b-4f5b-88ce-e8fb2e23c38a","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"standard","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","current_account":"App\\Http\\Resources\\AccountResource","current_login":"App\\Http\\Resources\\LoginResource","two_factor_enabled":true,"two_factor_type":"sms","otp_confirmed_at":"2026-05-08T14:41:54+01:00","otp_pending":false,"sms_two_factor_enabled":true,"two_factor_mobile":true,"two_factor_mobile_meta":{"country":"GB","formatted":"0333 090 3630"},"current_time_entry":"App\\Http\\Resources\\TimeEntryResource","session_expires_at":"2026-05-08T14:41:54+01:00","remember_token_expires_at":true,"should_auto_save_notes":true},"reactions":[{"uuid":"a4d3560b-fa0b-4585-aae5-8ce1226a45e9","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","account_uuid":"fe62579b-4a88-4cda-a0ab-9a4ffd15853a","account_name":"Gareth Thompson","reaction":"like"}]}},"App_Http_Resources_EditedMessageResource":{"type":"object","properties":{"contents":{"type":"string","example":"Welcome to Plannr!"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}},"example":[{"contents":"Welcome to Plannr!","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}]},"App_Http_Resources_Plans_CoverResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b771d042-fa52-4fe7-956d-6c4ff96ea62a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"cover_type":{"type":"string","example":"critical_illness","description":"Cover type"},"benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Benefit amount"},"benefit_frequency":{"type":"string","example":"monthly","description":"Benefit frequency"},"benefit_status":{"type":"string","example":"active","description":"Benefit status"},"excess":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Excess"},"indexation":{"type":"number","example":1.4,"description":"Indexation percentage"},"client":{"type":"object","properties":{"uuid":{"type":"string","example":"635c7445-2c14-4089-8cef-558df3d076ac"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Client this cover is for"}},"example":{"uuid":"b771d042-fa52-4fe7-956d-6c4ff96ea62a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":{"uuid":"635c7445-2c14-4089-8cef-558df3d076ac","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_CustomDefaultFoldersResource":{"type":"object","properties":{"uuid":{"type":"string","example":"7d0cac5c-3eda-4dfc-936c-0959b0b20e8e","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"description":{"type":"string","example":"Shared client default folders","description":"The description of the custom default folders structure."},"model":{"type":"string","example":"client","description":"The model the default folders structure is for."},"parameter":{"type":"string","example":"client","description":"The parameter the default folders structure is for."},"case_type":{"type":"object","properties":{"uuid":{"type":"string","example":"3877aa2f-fc95-4254-97ac-194d2d6a9d37"},"name":{"type":"string","example":"Mortgage Plan"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"}},"description":"The case type object when model is \"case\" and the parameter is a valid case type UUID."},"structure":{"type":"array","example":[{"name":"Documents","children":[{"name":"Contracts","children":[]},{"name":"Emails","children":[]}]},{"name":"Notes","children":[]}],"description":"The default folders structure.","items":{"type":"object","properties":{"name":{"type":"string","example":"Documents"},"children":{"type":"array","example":[{"name":"Contracts","children":[]},{"name":"Emails","children":[]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Contracts"},"children":{"type":"array","example":[]}}}}}}},"is_active":{"type":"boolean","example":true,"description":"Whether the default folders structure is active."},"for_existing":{"type":"boolean","example":true,"description":"Whether the default folders structure is for existing clients."}},"example":{"uuid":"7d0cac5c-3eda-4dfc-936c-0959b0b20e8e","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","description":"Shared client default folders","model":"client","parameter":"client","case_type":{"uuid":"3877aa2f-fc95-4254-97ac-194d2d6a9d37","name":"Mortgage Plan","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00"},"structure":[{"name":"Documents","children":[{"name":"Contracts","children":[]},{"name":"Emails","children":[]}]},{"name":"Notes","children":[]}],"is_active":true,"for_existing":true}},"App_Http_Resources_CustomFieldResource":{"type":"object","properties":{"uuid":{"type":"string","example":"d7246d70-f380-4474-835e-f972e1508f4d","description":"The UUID of the custom field"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"type":{"type":"string","example":"string","description":"The type of custom field"},"name":{"type":"string","example":"Favourite Drink","description":"The name of the custom field"},"reference":{"type":"string","example":"favourite_drink","description":"The reference of the custom field, used when updating the custom field on the model."},"is_required":{"type":"boolean","example":false,"description":"Denotes if the custom field is required"},"model_type":{"type":"string","example":"client","description":"The type of model that the custom field is for."},"help_text":{"type":"string","example":"This is the client's favourite drink.","description":"Optional help text to aide the custom field. Will be displayed on Plannr."},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"0727fe32-8531-4ba1-b49e-485668aab886"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The custom field firm"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"description":"This is the array of available options for the selection box. If the type is \"selection\" this array will be provided.","items":{"type":"string"}},"is_visible_to_clients":{"type":"boolean","example":true,"description":"Denotes if the custom field is visible and editable to clients."},"position":{"type":"integer","example":5,"description":"The position of the custom field"},"conditions":{"type":"array","example":[{"attribute":"case_type","values":["uuid-1"]}],"description":"The conditions that must be met for this custom field to apply. Empty array means no conditions.","items":{"type":"object","properties":{"attribute":{"type":"string","example":"case_type"},"values":{"type":"array","example":["uuid-1"],"items":{"type":"string"}}}}},"conditions_operator":{"type":"string","example":"all","description":"The logical operator for combining conditions. \"all\" (AND) or \"any\" (OR)."}},"example":{"uuid":"d7246d70-f380-4474-835e-f972e1508f4d","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"model_type":"client","help_text":"This is the client's favourite drink.","firm":{"uuid":"0727fe32-8531-4ba1-b49e-485668aab886","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"selection_options":["Coffee","Tea","Water"],"is_visible_to_clients":true,"position":5,"conditions":[{"attribute":"case_type","values":["uuid-1"]}],"conditions_operator":"all"}},"App_Http_Resources_DependantResource":{"type":"object","properties":{"uuid":{"type":"string","example":"51db7984-54e0-4f0e-b330-55bb1a4887ed","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"first_name":{"type":"string","example":"Christopher","description":"The first name of the dependant."},"last_name":{"type":"string","example":"Nolan","description":"The last name of the dependant."},"name":{"type":"string","example":"Christopher Nolan","description":"The full name of the dependant. If known_as has been provided, the first name will be replaced with the known_as."},"known_as":{"type":"string","example":"Chris","description":"An optional nickname for the dependant."},"relationship":{"type":"string","example":"Brother","description":"The relationship of the dependant."},"date_of_birth":{"type":"string","example":"2014-05-08T14:41:56+01:00","description":"The date of birth of the dependant."},"is_financially_dependant":{"type":"boolean","example":true,"description":"Denotes if the dependant is financially dependant on the client."},"notes":{"type":"string","example":"Example notes","description":"Optional notes for the dependant."},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"bb5f0a8c-97e5-40bd-b6e9-35a683a5516f"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Accounts that own this dependant."},"shared_owner_type":{"type":"string","example":"individual","description":"@deprecated Denotes if the dependant is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)"},"shared_owner":{"type":"object","properties":{"uuid":{"type":"string","example":"9955992a-b2f2-4534-8fb4-a80a0396a320"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"@deprecated The owner of the dependant. Only provided if the shared_owner_type is \"individual\"."}},"example":{"uuid":"51db7984-54e0-4f0e-b330-55bb1a4887ed","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","first_name":"Christopher","last_name":"Nolan","name":"Christopher Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2014-05-08T14:41:56+01:00","is_financially_dependant":true,"notes":"Example notes","accounts":{"uuid":"bb5f0a8c-97e5-40bd-b6e9-35a683a5516f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"shared_owner_type":"individual","shared_owner":{"uuid":"9955992a-b2f2-4534-8fb4-a80a0396a320","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_DependantResource":{"type":"object","properties":{"uuid":{"type":"string","example":"accf4ced-b539-4038-a2ea-1a7cbb65e0c6"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"first_name":{"type":"string","example":"Christopher"},"last_name":{"type":"string","example":"Nolan"},"name":{"type":"string","example":"Christopher Nolan"},"known_as":{"type":"string","example":"Chris"},"relationship":{"type":"string","example":"Brother"},"date_of_birth":{"type":"string","example":"1986-05-08T14:41:56+01:00"},"is_financially_dependant":{"type":"boolean","example":true},"notes":{"type":"string","example":"Example notes"},"accounts":{"type":"object","properties":{"uuid":{"type":"string","example":"1dc8f644-57b6-4b31-976f-e29d4c71b87c"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"example":[{"uuid":"accf4ced-b539-4038-a2ea-1a7cbb65e0c6","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","first_name":"Christopher","last_name":"Nolan","name":"Christopher Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"1986-05-08T14:41:56+01:00","is_financially_dependant":true,"notes":"Example notes","accounts":{"uuid":"1dc8f644-57b6-4b31-976f-e29d4c71b87c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}]},"App_Http_Resources_DocumentBuilder_DocumentVariablesResource":{"type":"object","properties":{"client":{"type":"array","example":["first_name","last_name"],"description":"Available services and its variables","items":{"type":"string"}}},"example":{"client":["first_name","last_name"]}},"App_Http_Resources_DocumentBuilder_DocumentTemplateResource":{"type":"object","properties":{"uuid":{"type":"string","example":"0d536a11-825a-4d2e-a284-f13ee29db533","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"version":{"type":"integer","example":3,"description":"The document builder version. Used for internal purposes only. Defaults to 3"},"name":{"type":"string","example":"Welcome Template","description":"The name of the document template."},"required_dependants":{"type":"object","properties":{"client-1":{"type":"string","example":"client"}},"description":"The required dependant variables of the document template."},"public_docx_url":{"type":"string","example":"https://api.plannrcrm.com/document-template/d130e17c-9943-467d-9cc2-d1de72ff0631/content/docx?plannr_account_uuid=245ec4b6-05cb-4116-b427-04a8b44bf3f7","description":"The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1."},"public_sfdt_url":{"type":"string","example":"https://api.plannrcrm.com/document-template/b5010451-1b67-4bd2-bc89-9ecce8b22e65/content/sfdt?plannr_account_uuid=98b551b8-9b2b-4140-bf3e-57dc2c980181","description":"The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1."},"public_pdf_url":{"type":"string","example":"https://api.plannrcrm.com/document-template/93e0d9b9-f52d-4d9e-a794-91d704e868f3/content/pdf?plannr_account_uuid=6bf96dd0-b597-4a4f-a5f4-39eef25ef890","description":"The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1."},"public_preview_url":{"type":"string","example":"https://api.plannrcrm.com/document-template/e1c854bc-ccb0-4adb-8f80-6f130511de2c/content/preview?plannr_account_uuid=2ee22f92-65df-4878-8338-3b4593eddd06","description":"The image preview URL of the template. This is intended for the user to preview the template before opening it. You can access this data via the API using the route in /api/v1."}},"example":{"uuid":"0d536a11-825a-4d2e-a284-f13ee29db533","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","version":3,"name":"Welcome Template","required_dependants":{"client-1":"client"},"public_docx_url":"https://api.plannrcrm.com/document-template/d130e17c-9943-467d-9cc2-d1de72ff0631/content/docx?plannr_account_uuid=245ec4b6-05cb-4116-b427-04a8b44bf3f7","public_sfdt_url":"https://api.plannrcrm.com/document-template/b5010451-1b67-4bd2-bc89-9ecce8b22e65/content/sfdt?plannr_account_uuid=98b551b8-9b2b-4140-bf3e-57dc2c980181","public_pdf_url":"https://api.plannrcrm.com/document-template/93e0d9b9-f52d-4d9e-a794-91d704e868f3/content/pdf?plannr_account_uuid=6bf96dd0-b597-4a4f-a5f4-39eef25ef890","public_preview_url":"https://api.plannrcrm.com/document-template/e1c854bc-ccb0-4adb-8f80-6f130511de2c/content/preview?plannr_account_uuid=2ee22f92-65df-4878-8338-3b4593eddd06"}},"App_Http_Resources_DocumentBuilder_DocumentResource":{"type":"object","properties":{"uuid":{"type":"string","example":"1980c420-2c2f-4986-91f8-8664516098f7","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"version":{"type":"integer","example":3,"description":"The document builder version. Used for internal purposes only. Defaults to 3"},"name":{"type":"string","example":"Welcome Template","description":"The name of the document."},"status":{"type":"string","example":"published","description":"The status of the document."},"last_publishing_error":{"type":"string","example":"There was an error converting this file to PDF. Please try again later.","description":"The last error that occurred during publishing."},"required_dependants":{"type":"object","properties":{"client-1":{"type":"string","example":"client"}},"description":"The required dependant variables of the document."},"known_dependants":{"type":"object","properties":{"client-1":{"type":"string","example":"8fc03737-f14c-47cf-87e2-a917f40649d6"}},"description":"The dependants submitted to the document previously."},"public_docx_url":{"type":"string","example":"https://api.plannrcrm.com/document/69ef3ceb-a309-4341-8b00-dabda5576593/content/docx?plannr_account_uuid=22cb6248-a19b-4b80-939c-ed368e63bac8","description":"The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1."},"public_sfdt_url":{"type":"string","example":"https://api.plannrcrm.com/document/363caa1d-ac53-4616-8575-f58b6a9a383d/content/sfdt?plannr_account_uuid=6499d2b0-882f-438d-9b94-cc06ccdf43f8","description":"The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1."},"public_pdf_url":{"type":"string","example":"https://api.plannrcrm.com/document/a8327769-353d-43b5-8e49-8981ad53ac80/content/pdf?plannr_account_uuid=c158cdf2-58dd-4fc9-9dbf-2fa0f8e12977","description":"The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1."},"public_preview_url":{"type":"string","example":"https://api.plannrcrm.com/document/984f9699-bc5b-4985-9a39-d416114c2786/content/preview?plannr_account_uuid=8fd25d0d-ef54-4ac4-a305-937d2207ba79","description":"The image preview URL of the document. This is intended for the user to preview the document before opening it. You can access this data via the API using the route in /api/v1."}},"example":{"uuid":"1980c420-2c2f-4986-91f8-8664516098f7","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","version":3,"name":"Welcome Template","status":"published","last_publishing_error":"There was an error converting this file to PDF. Please try again later.","required_dependants":{"client-1":"client"},"known_dependants":{"client-1":"8fc03737-f14c-47cf-87e2-a917f40649d6"},"public_docx_url":"https://api.plannrcrm.com/document/69ef3ceb-a309-4341-8b00-dabda5576593/content/docx?plannr_account_uuid=22cb6248-a19b-4b80-939c-ed368e63bac8","public_sfdt_url":"https://api.plannrcrm.com/document/363caa1d-ac53-4616-8575-f58b6a9a383d/content/sfdt?plannr_account_uuid=6499d2b0-882f-438d-9b94-cc06ccdf43f8","public_pdf_url":"https://api.plannrcrm.com/document/a8327769-353d-43b5-8e49-8981ad53ac80/content/pdf?plannr_account_uuid=c158cdf2-58dd-4fc9-9dbf-2fa0f8e12977","public_preview_url":"https://api.plannrcrm.com/document/984f9699-bc5b-4985-9a39-d416114c2786/content/preview?plannr_account_uuid=8fd25d0d-ef54-4ac4-a305-937d2207ba79"}},"App_Http_Resources_DocumentPackResource":{"type":"object","properties":{"uuid":{"type":"string","example":"0f0e9908-5953-4919-ad7b-492a4c838967"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Name of Document Pack"},"description":{"type":"string","example":"Description of Document Pack"},"is_template":{"type":"string","example":"Is Document Pack a template"}},"example":[{"uuid":"0f0e9908-5953-4919-ad7b-492a4c838967","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Name of Document Pack","description":"Description of Document Pack","is_template":"Is Document Pack a template"}]},"App_Http_Resources_Plans_SubAccountResource":{"type":"object","properties":{"uuid":{"type":"string","example":"64f77a19-0086-473c-b0ca-00bf510bb426","description":"UUID of the sub account"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"name":{"type":"string","example":"John's ISA","description":"Descriptive name of the sub account"},"policy_number":{"type":"string","example":"AVI-4837","description":"Provider reference of the sub account"},"latest_valuation":{"type":"object","properties":{"uuid":{"type":"string","example":"71fd8f5b-3bce-495b-912e-52aeb9ab605e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"}},"description":"The latest valuation of the sub account"},"is_main_account":{"type":"boolean","example":false,"description":"Denotes if the sub account a main account of the plan"},"active_portfolio":{"type":"object","properties":{"uuid":{"type":"string","example":"53f4146b-305a-4ee8-867c-4049fa148e91"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"is_proposed":{"type":"boolean","example":true},"proposed_at":{"type":"string","example":"2026-05-08T00:00:00+01:00"},"name":{"type":"string","example":"Risky Portfolio"}},"description":"The active portfolio of the sub account"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}},"description":"The statistics on a sub account. Only displayed when you retrieve an individual sub-account."}},"example":{"uuid":"64f77a19-0086-473c-b0ca-00bf510bb426","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":{"uuid":"71fd8f5b-3bce-495b-912e-52aeb9ab605e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","valued_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"},"is_main_account":false,"active_portfolio":{"uuid":"53f4146b-305a-4ee8-867c-4049fa148e91","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","is_proposed":true,"proposed_at":"2026-05-08T00:00:00+01:00","name":"Risky Portfolio"},"statistics":{"recent_growth":100}}},"App_Http_Resources_SignatureTransactionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"0833b01b-ea79-4e04-b75f-0b030ad49e87","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"integer","example":1000243230,"description":"Transaction ID on Alphatrust"},"status":{"type":"string","example":"pending","description":"Current status of the document signing process."},"participants":{"type":"array","example":[{"uuid":"fc69ae14-bce0-4c87-afef-fce34594034a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","alphatrust_id":1000145124,"name":"Gareth Thompson","status":"pending"}],"description":"Participants of the document signing process.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"fc69ae14-bce0-4c87-afef-fce34594034a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"alphatrust_id":{"type":"integer","example":1000145124},"name":{"type":"string","example":"Gareth Thompson"},"status":{"type":"string","example":"pending"}}}},"documents":{"type":"array","example":[{"uuid":"16e0e2c6-4240-4c8e-978d-9bb2ff60e096","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","alphatrust_id":1000455612,"name":"Welcome Pack","status":"pending"}],"description":"Documents of the document signing process.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"16e0e2c6-4240-4c8e-978d-9bb2ff60e096"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"alphatrust_id":{"type":"integer","example":1000455612},"name":{"type":"string","example":"Welcome Pack"},"status":{"type":"string","example":"pending"}}}},"launched_by":{"type":"object","properties":{"uuid":{"type":"string","example":"02364ec7-459c-44b7-8c47-e5996c66bd65"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that launched the document signing process."}},"example":{"uuid":"0833b01b-ea79-4e04-b75f-0b030ad49e87","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":1000243230,"status":"pending","participants":[{"uuid":"fc69ae14-bce0-4c87-afef-fce34594034a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","alphatrust_id":1000145124,"name":"Gareth Thompson","status":"pending"}],"documents":[{"uuid":"16e0e2c6-4240-4c8e-978d-9bb2ff60e096","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","alphatrust_id":1000455612,"name":"Welcome Pack","status":"pending"}],"launched_by":{"uuid":"02364ec7-459c-44b7-8c47-e5996c66bd65","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_EmploymentResource":{"type":"object","properties":{"uuid":{"type":"string","example":"d82db168-d964-45ec-bcac-4f258006393b"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"status":{"type":"string","example":"employed"},"primary":{"type":"boolean","example":true},"occupation":{"type":"string","example":"Financial Adviser"},"occupation_code":{"type":"string","example":"FAC02774"},"job_title":{"type":"string","example":"Senior financial adviser"},"employer":{"type":"string","example":"Plannr Technologies Ltd"},"started_at":{"type":"string","example":"2021-05-08T14:41:56+01:00"},"ended_at":{"type":"string","example":"2022-05-08T14:41:56+01:00"},"is_business_owner":{"type":"boolean","example":true},"percentage_of_business_shared":{"type":"integer","example":50},"address":{"type":"object","properties":{"uuid":{"type":"string","example":"3c39bb44-fa88-4495-a5d2-7aa8d02e0c88"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Work Address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"address_3":{"type":"string","example":"The Innovative Centre"},"address_4":{"type":"string","example":"Waterlooville"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"move_in_date":{"type":"string","example":"2025-05-08"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}},"phone_number":{"type":"object","properties":{"uuid":{"type":"string","example":"82d209eb-991a-49a5-afa0-4fa82cf170d0"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}},"email_address":{"type":"object","properties":{"uuid":{"type":"string","example":"e0835eba-dfa9-4bf5-860f-ebb88fcd381b"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}},"shared_owner_type":{"type":"string","example":"individual"},"shared_owner":{"type":"object","properties":{"uuid":{"type":"string","example":"377bcea1-30c9-4a4c-a882-f34e4c6b9dbd"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"last_salary_increase":{"type":"string","example":"2019-01-01"},"business_name":{"type":"string","example":"My Business"},"business_year_end":{"type":"string","example":"2020-12-31"},"business_value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"directors":{"type":"string","example":"Susan F. Lancaster"},"shareholding_in_business":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"profit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"accountant_company_name":{"type":"string","example":"My Accountant"},"accountant_email":{"type":"string","example":"accountant@email.com"},"accountant_telephone_number":{"type":"string","example":"+441234567890"},"accountant_address":{"type":"string","example":"23 Chollerton, Hexham, Northumberland, NE46 4TF"},"turnover_history":{"type":"object","properties":{"year":{"type":"integer","example":2020},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"income":{"type":"object","properties":{"uuid":{"type":"string","example":"01adfe79-3cd0-47bc-84a9-f98e93fdb21e"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"My Salary"},"type":{"type":"string","example":"salary"},"type_other":{"type":"string","example":"Other income type"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"amount_type":{"type":"string","example":"net"},"start_date":{"type":"string","example":"2025-05-08"},"end_date":{"type":"string","example":"2026-05-08"},"frequency":{"type":"string","example":"annually"},"is_taxable":{"type":"boolean","example":true},"shared_owner_type":{"type":"string","example":"individual"},"shared_owner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"employment":{"type":"string","example":"App\\Http\\Resources\\EmploymentResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}}},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"9a7ab83a-70d5-42ff-a833-0aa6754f4734"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"example":[{"uuid":"d82db168-d964-45ec-bcac-4f258006393b","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","status":"employed","primary":true,"occupation":"Financial Adviser","occupation_code":"FAC02774","job_title":"Senior financial adviser","employer":"Plannr Technologies Ltd","started_at":"2021-05-08T14:41:56+01:00","ended_at":"2022-05-08T14:41:56+01:00","is_business_owner":true,"percentage_of_business_shared":50,"address":{"uuid":"3c39bb44-fa88-4495-a5d2-7aa8d02e0c88","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2025-05-08","accounts":"App\\Http\\Resources\\AccountResource"},"phone_number":{"uuid":"82d209eb-991a-49a5-afa0-4fa82cf170d0","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"email_address":{"uuid":"e0835eba-dfa9-4bf5-860f-ebb88fcd381b","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"shared_owner_type":"individual","shared_owner":{"uuid":"377bcea1-30c9-4a4c-a882-f34e4c6b9dbd","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"last_salary_increase":"2019-01-01","business_name":"My Business","business_year_end":"2020-12-31","business_value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"directors":"Susan F. Lancaster","shareholding_in_business":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"profit":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"accountant_company_name":"My Accountant","accountant_email":"accountant@email.com","accountant_telephone_number":"+441234567890","accountant_address":"23 Chollerton, Hexham, Northumberland, NE46 4TF","turnover_history":{"year":2020,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"income":{"uuid":"01adfe79-3cd0-47bc-84a9-f98e93fdb21e","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"My Salary","type":"salary","type_other":"Other income type","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount_type":"net","start_date":"2025-05-08","end_date":"2026-05-08","frequency":"annually","is_taxable":true,"shared_owner_type":"individual","shared_owner":"App\\Http\\Resources\\AccountResource","employment":"App\\Http\\Resources\\EmploymentResource","account":"App\\Http\\Resources\\MinimalAccountResource"},"account":{"uuid":"9a7ab83a-70d5-42ff-a833-0aa6754f4734","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}]},"_App_Http_Resources_V2_EmploymentResource":{"type":"object","properties":{"uuid":{"type":"string","example":"af628f60-c249-4497-8ab1-b873ddb5ca7c","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"status":{"type":"string","example":"employed","description":"The employment status. Available values: employed, self_employed, student, unemployed, house_person, retired and other"},"primary":{"type":"boolean","example":true,"description":"Denotes if the employment is the primary employment for the account associated."},"occupation":{"type":"string","example":"Financial Adviser","description":"The occupation name found from the occupation code provided."},"occupation_code":{"type":"string","example":"FAC02774","description":"The Origo occupation code."},"job_title":{"type":"string","example":"Senior financial adviser","description":"Job title if not suitable occupation code is found."},"employer":{"type":"string","example":"Plannr Technologies Ltd","description":"The name of the employer."},"started_at":{"type":"string","example":"2021-05-08T14:41:56+01:00","description":"The employment start date."},"ended_at":{"type":"string","example":"2022-05-08T14:41:56+01:00","description":"The employment end date if provided."},"is_business_owner":{"type":"boolean","example":true,"description":"Denotes if the account is the business owner."},"percentage_of_business_shared":{"type":"integer","example":50,"description":"The percentage of business shared."},"address":{"type":"object","properties":{"uuid":{"type":"string","example":"92fffd45-6637-4dd7-8388-d399dbd7a52a"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Work Address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"address_3":{"type":"string","example":"The Innovative Centre"},"address_4":{"type":"string","example":"Waterlooville"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"move_in_date":{"type":"string","example":"2025-05-08"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The address of the employer."},"phone_number":{"type":"object","properties":{"uuid":{"type":"string","example":"89bea399-310d-47d3-9149-7097dd56a5e8"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The phone number of the employer."},"email_address":{"type":"object","properties":{"uuid":{"type":"string","example":"1ba6d958-440d-4d35-a53c-b73fc5c52015"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The email address of the employer."},"shared_owner_type":{"type":"string","example":"individual","description":"Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)"},"shared_owner":{"type":"object","properties":{"uuid":{"type":"string","example":"5a3aab3c-a907-49d3-b264-176306ce97df"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The owner of the employment. Only provided if the shared_owner_type is \"individual\"."},"last_salary_increase":{"type":"string","example":"2019-01-01","description":"The date of the last salary increase."},"business_name":{"type":"string","example":"My Business","description":"The name of the business."},"business_year_end":{"type":"string","example":"2020-12-31","description":"The year end of the business."},"business_value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The value of the business."},"directors":{"type":"string","example":"Susan F. Lancaster","description":"The directors of the business."},"shareholding_in_business":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The shareholding in the business."},"profit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The profit of the business."},"accountant_company_name":{"type":"string","example":"My Accountant","description":"The name of the accountant."},"accountant_email":{"type":"string","example":"accountant@email.com","description":"The email of the accountant."},"accountant_telephone_number":{"type":"string","example":"+441234567890","description":"The telephone number of the accountant."},"accountant_address":{"type":"string","example":"23 Chollerton, Hexham, Northumberland, NE46 4TF","description":"The address of the accountant."},"turnover_history":{"type":"object","properties":{"year":{"type":"integer","example":2020},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"The turnover history of the income."},"income":{"type":"object","properties":{"uuid":{"type":"string","example":"b142b775-4400-44de-8110-09fc44fd58cf"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"My Salary"},"type":{"type":"string","example":"salary"},"type_other":{"type":"string","example":"Other income type"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"amount_type":{"type":"string","example":"net"},"start_date":{"type":"string","example":"2025-05-08"},"end_date":{"type":"string","example":"2026-05-08"},"frequency":{"type":"string","example":"annually"},"is_taxable":{"type":"boolean","example":true},"shared_owner_type":{"type":"string","example":"individual"},"shared_owner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"employment":{"type":"string","example":"App\\Http\\Resources\\EmploymentResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}},"description":"Incomes that have been linked to thi employment."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"676e283e-9178-44cb-85e6-7046e61e58cf"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account for this employment."}},"example":{"uuid":"af628f60-c249-4497-8ab1-b873ddb5ca7c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","status":"employed","primary":true,"occupation":"Financial Adviser","occupation_code":"FAC02774","job_title":"Senior financial adviser","employer":"Plannr Technologies Ltd","started_at":"2021-05-08T14:41:56+01:00","ended_at":"2022-05-08T14:41:56+01:00","is_business_owner":true,"percentage_of_business_shared":50,"address":{"uuid":"92fffd45-6637-4dd7-8388-d399dbd7a52a","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2025-05-08","accounts":"App\\Http\\Resources\\AccountResource"},"phone_number":{"uuid":"89bea399-310d-47d3-9149-7097dd56a5e8","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"email_address":{"uuid":"1ba6d958-440d-4d35-a53c-b73fc5c52015","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"shared_owner_type":"individual","shared_owner":{"uuid":"5a3aab3c-a907-49d3-b264-176306ce97df","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"last_salary_increase":"2019-01-01","business_name":"My Business","business_year_end":"2020-12-31","business_value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"directors":"Susan F. Lancaster","shareholding_in_business":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"profit":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"accountant_company_name":"My Accountant","accountant_email":"accountant@email.com","accountant_telephone_number":"+441234567890","accountant_address":"23 Chollerton, Hexham, Northumberland, NE46 4TF","turnover_history":{"year":2020,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"income":{"uuid":"b142b775-4400-44de-8110-09fc44fd58cf","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"My Salary","type":"salary","type_other":"Other income type","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount_type":"net","start_date":"2025-05-08","end_date":"2026-05-08","frequency":"annually","is_taxable":true,"shared_owner_type":"individual","shared_owner":"App\\Http\\Resources\\AccountResource","employment":"App\\Http\\Resources\\EmploymentResource","account":"App\\Http\\Resources\\MinimalAccountResource"},"account":{"uuid":"676e283e-9178-44cb-85e6-7046e61e58cf","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_EmploymentResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3a077450-21ed-4dbf-a1d3-0409637237d7","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"status":{"type":"string","example":"employed","description":"The employment status. Available values: employed, self_employed, student, unemployed, house_person, retired and other"},"occupation":{"type":"string","example":"Financial Adviser","description":"The occupation name found from the occupation code provided."},"occupation_code":{"type":"string","example":"FAC02774","description":"@deprecated The Origo occupation code."},"job_title":{"type":"string","example":"Senior financial adviser","description":"Job title if not suitable occupation code is found."},"employer":{"type":"string","example":"Plannr Technologies Ltd","description":"The name of the employer."},"started_at":{"type":"string","example":"2021-05-08T14:41:54+01:00","description":"The employment start date."},"ended_at":{"type":"string","example":"2022-05-08T14:41:54+01:00","description":"The employment end date if provided."},"is_business_owner":{"type":"boolean","example":true,"description":"Denotes if the account is the business owner."},"percentage_of_business_shared":{"type":"integer","example":50,"description":"The percentage of business shared."},"address":{"type":"object","properties":{"uuid":{"type":"string","example":"9df3ba11-162a-489c-8c3f-be85b31ae7fe"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Work Address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"address_3":{"type":"string","example":"The Innovative Centre"},"address_4":{"type":"string","example":"Waterlooville"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"move_in_date":{"type":"string","example":"2025-05-08"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The address of the employer."},"phone_number":{"type":"object","properties":{"uuid":{"type":"string","example":"85d63c76-2e43-4c53-8099-2ec0269f7859"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The phone number of the employer."},"email_address":{"type":"object","properties":{"uuid":{"type":"string","example":"41af1fdf-df24-479d-841a-7e10920dde8e"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"phone_number"},"name":{"type":"string","example":"Work number"},"value":{"type":"string","example":"+443330903630"},"phone_number_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}}},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The email address of the employer."},"shared_owner_type":{"type":"string","example":"individual","description":"Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)"},"shared_owner":{"type":"object","properties":{"uuid":{"type":"string","example":"cd93f71a-08eb-41ca-9299-287f8988348a"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The owner of the employment. Only provided if the shared_owner_type is \"individual\"."},"last_salary_increase":{"type":"string","example":"2019-01-01","description":"The date of the last salary increase."},"business_name":{"type":"string","example":"My Business","description":"The name of the business."},"business_year_end":{"type":"string","example":"2020-12-31","description":"The year end of the business."},"business_value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The value of the business."},"directors":{"type":"string","example":"Susan F. Lancaster","description":"The directors of the business."},"shareholding_in_business":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The shareholding in the business."},"profit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The profit of the business."},"accountant_company_name":{"type":"string","example":"My Accountant","description":"The name of the accountant."},"accountant_email":{"type":"string","example":"accountant@email.com","description":"The email of the accountant."},"accountant_telephone_number":{"type":"string","example":"+441234567890","description":"The telephone number of the accountant."},"accountant_address":{"type":"string","example":"23 Chollerton, Hexham, Northumberland, NE46 4TF","description":"The address of the accountant."},"primary":{"type":"boolean","example":true,"description":"Denotes if the employment is the primary employment for the account associated."},"turnover_history":{"type":"object","properties":{"year":{"type":"integer","example":2020},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"The turnover history of the income."},"income":{"type":"object","properties":{"uuid":{"type":"string","example":"9249d47d-aa82-4dcb-b833-2f2b7f6802d6"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"My Salary"},"type":{"type":"string","example":"salary"},"type_other":{"type":"string","example":"Other income type"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"amount_type":{"type":"string","example":"net"},"start_date":{"type":"string","example":"2025-05-08"},"end_date":{"type":"string","example":"2026-05-08"},"frequency":{"type":"string","example":"annually"},"is_taxable":{"type":"boolean","example":true},"shared_owner_type":{"type":"string","example":"individual"},"shared_owner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"employment":{"type":"string","example":"App\\Http\\Resources\\EmploymentResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}},"description":"Incomes that have been linked to the employment."}},"example":{"uuid":"3a077450-21ed-4dbf-a1d3-0409637237d7","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","status":"employed","occupation":"Financial Adviser","occupation_code":"FAC02774","job_title":"Senior financial adviser","employer":"Plannr Technologies Ltd","started_at":"2021-05-08T14:41:54+01:00","ended_at":"2022-05-08T14:41:54+01:00","is_business_owner":true,"percentage_of_business_shared":50,"address":{"uuid":"9df3ba11-162a-489c-8c3f-be85b31ae7fe","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2025-05-08","accounts":"App\\Http\\Resources\\AccountResource"},"phone_number":{"uuid":"85d63c76-2e43-4c53-8099-2ec0269f7859","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"email_address":{"uuid":"41af1fdf-df24-479d-841a-7e10920dde8e","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"phone_number","name":"Work number","value":"+443330903630","phone_number_meta":{"country":"GB","formatted":"0333 090 3630"},"accounts":"App\\Http\\Resources\\AccountResource"},"shared_owner_type":"individual","shared_owner":{"uuid":"cd93f71a-08eb-41ca-9299-287f8988348a","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"last_salary_increase":"2019-01-01","business_name":"My Business","business_year_end":"2020-12-31","business_value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"directors":"Susan F. Lancaster","shareholding_in_business":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"profit":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"accountant_company_name":"My Accountant","accountant_email":"accountant@email.com","accountant_telephone_number":"+441234567890","accountant_address":"23 Chollerton, Hexham, Northumberland, NE46 4TF","primary":true,"turnover_history":{"year":2020,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"income":{"uuid":"9249d47d-aa82-4dcb-b833-2f2b7f6802d6","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"My Salary","type":"salary","type_other":"Other income type","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount_type":"net","start_date":"2025-05-08","end_date":"2026-05-08","frequency":"annually","is_taxable":true,"shared_owner_type":"individual","shared_owner":"App\\Http\\Resources\\AccountResource","employment":"App\\Http\\Resources\\EmploymentResource","account":"App\\Http\\Resources\\MinimalAccountResource"}}},"App_Http_Resources_ReferralConnectionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"fcdd7069-4b02-4f55-ae80-9b031471f0d8","description":"The UUID of the resource."},"direction":{"type":"string","example":"sent","description":"The direction of the connection relative to the current firm. Possible values: sent, received"},"status":{"type":"string","example":"pending","description":"The status of the referral connection. Possible values: pending, accepted, denied, expired"},"sender_firm":{"type":"object","properties":{"uuid":{"type":"string","example":"abc-123"},"name":{"type":"string","example":"Sender Firm Name"}},"description":"The firm that sent the referral connection request"},"recipient_firm":{"type":"object","properties":{"uuid":{"type":"string","example":"def-456"},"name":{"type":"string","example":"Recipient Firm Name"}},"description":"The firm that received the referral connection request"},"sender_account":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"b1b2d588-b6b3-404a-bb4e-c99c860e261b"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that sent the referral connection request"},"recipient_account":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"29302643-f50b-4e09-a8d2-0048b41bd196"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that received the referral connection request"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"expires_at":{"type":"string","example":"2026-06-07T14:41:54+01:00","description":"The datetime when the referral connection request expires"}},"example":{"uuid":"fcdd7069-4b02-4f55-ae80-9b031471f0d8","direction":"sent","status":"pending","sender_firm":{"uuid":"abc-123","name":"Sender Firm Name"},"recipient_firm":{"uuid":"def-456","name":"Recipient Firm Name"},"sender_account":{"uuid":{"example":"b1b2d588-b6b3-404a-bb4e-c99c860e261b","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"recipient_account":{"uuid":{"example":"29302643-f50b-4e09-a8d2-0048b41bd196","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2026-06-07T14:41:54+01:00"}},"App_Http_Resources_ReferralResource":{"type":"object","properties":{"uuid":{"type":"string","example":"74e6e596-80a5-4c48-985e-1214fe88b7bd","description":"The UUID of the resource."},"direction":{"type":"string","example":"sent","description":"The direction of the referral relative to the current firm. Possible values: sent, received"},"connection":{"type":"object","properties":{"uuid":{"type":"string","example":"abc-123"}},"description":"The referral connection this referral belongs to"},"clients":{"type":"array","example":[{"uuid":"client-uuid-1","name":"John Doe"}],"description":"The original client accounts being referred","items":{"type":"object","properties":{"uuid":{"type":"string","example":"client-uuid-1"},"name":{"type":"string","example":"John Doe"}}}},"cloned_clients":{"type":"array","example":[{"uuid":"cloned-uuid-1","name":"John Doe"}],"description":"The cloned client accounts in the recipient firm","items":{"type":"object","properties":{"uuid":{"type":"string","example":"cloned-uuid-1"},"name":{"type":"string","example":"John Doe"}}}},"advice_type":{"type":"string","example":"investments","description":"The type of advice. Possible values: investments, protection, mortgages, estate_planning, other, pensions and tax"},"duration_months":{"type":"integer","example":3,"description":"Duration in months (1, 2, 3, or 6). Null for lifetime."},"shared_data":{"type":"array","example":["basic_details","contact_details"],"description":"Data categories being shared. Possible values: basic_details, contact_details, income, expenditure, dependants, investments_and_plans, pensions, liabilities, protection, cash_accounts, goals and notes","items":{"type":"string"}},"note":{"type":"string","example":"Client needs help with retirement planning.","description":"Additional notes about the referral"},"sla_deadline":{"type":"string","example":"2026-02-28","description":"SLA deadline for recipient to respond"},"status":{"type":"string","example":"pending","description":"The status of the referral. Possible values: pending, accepted, rejected and expired"},"rejection_reason":{"type":"string","example":"Unable to take on new clients.","description":"Reason for rejection (only present if rejected)"},"sender_firm":{"type":"object","properties":{"uuid":{"type":"string","example":"abc-123"},"name":{"type":"string","example":"Sender Firm Name"}},"description":"The firm that sent the referral"},"recipient_firm":{"type":"object","properties":{"uuid":{"type":"string","example":"def-456"},"name":{"type":"string","example":"Recipient Firm Name"}},"description":"The firm that received the referral"},"sender_account":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"becd67f8-b1eb-4dfa-975d-9b41f57ce905"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that sent the referral"},"recipient_account":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"5e8c8f15-3235-49c8-8e46-c9a22ccb33b7"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that received the referral"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"expires_at":{"type":"string","example":"2026-08-08T14:41:54+01:00","description":"The datetime when the referral expires"}},"example":{"uuid":"74e6e596-80a5-4c48-985e-1214fe88b7bd","direction":"sent","connection":{"uuid":"abc-123"},"clients":[{"uuid":"client-uuid-1","name":"John Doe"}],"cloned_clients":[{"uuid":"cloned-uuid-1","name":"John Doe"}],"advice_type":"investments","duration_months":3,"shared_data":["basic_details","contact_details"],"note":"Client needs help with retirement planning.","sla_deadline":"2026-02-28","status":"pending","rejection_reason":"Unable to take on new clients.","sender_firm":{"uuid":"abc-123","name":"Sender Firm Name"},"recipient_firm":{"uuid":"def-456","name":"Recipient Firm Name"},"sender_account":{"uuid":{"example":"becd67f8-b1eb-4dfa-975d-9b41f57ce905","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"recipient_account":{"uuid":{"example":"5e8c8f15-3235-49c8-8e46-c9a22ccb33b7","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2026-08-08T14:41:54+01:00"}},"App_Http_Resources_Expenditure_LifeStageResource":{"type":"object","properties":{"uuid":{"type":"string","example":"\"c538220f-6bcd-4112-834b-632a0e82fe33","description":"uuid of the Expenditure Life Stage"},"name":{"type":"string","example":"Current Lifestyle","description":"The name of the Expenditure Life Stage. This is the name that will be displayed to the client. Example: \"Survivor’s Lifestyle\""},"position":{"type":"string","example":"1","description":"The expected position of the Expenditure Life Stage in any listing of the Expenditure Life Stages. The first Expenditure Life Stage should have a position of 1, the second 2, etc."},"start_age":{"type":"string","example":"21","description":"The expected age of the client as they enter the Expenditure Life Stage. This field is not required and may be null."},"end_age":{"type":"string","example":"28","description":"The expected age of the client as they mature beyond this Expenditure Life Stage. This field is not required and may be null."},"sections":{"type":"object","properties":{"uuid":{"type":"string","example":"be37c8cd-d751-4592-bbe9-88d1b8db0e6a"},"name":{"type":"string","example":"House Keeping"},"position":{"type":"string","example":"1"},"fields":{"type":"string","example":"App\\Http\\Resources\\Expenditure\\LifeStageFieldResource"},"created_at":{"type":"string","example":"2023-06-16T15:25:06+01:00"},"updated_at":{"type":"string","example":"2023-06-16T15:25:06+01:00"}},"description":"Array containing the Expenditure Life Stage Sections that will be displayed to the client. Including any Expenditure Life Stage fields associated with the section."},"created_at":{"type":"string","example":"2023-06-16T15:25:06+01:00","description":"timestamp of when the Expenditure Life Stage was created"},"updated_at":{"type":"string","example":"2023-06-16T15:25:06+01:00","description":"timestamp of when the Expenditure Life Stage was updated"}},"example":{"uuid":"\"c538220f-6bcd-4112-834b-632a0e82fe33","name":"Current Lifestyle","position":"1","start_age":"21","end_age":"28","sections":{"uuid":"be37c8cd-d751-4592-bbe9-88d1b8db0e6a","name":"House Keeping","position":"1","fields":"App\\Http\\Resources\\Expenditure\\LifeStageFieldResource","created_at":"2023-06-16T15:25:06+01:00","updated_at":"2023-06-16T15:25:06+01:00"},"created_at":"2023-06-16T15:25:06+01:00","updated_at":"2023-06-16T15:25:06+01:00"}},"App_Http_Resources_Expenditure_LifeStageSectionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"be37c8cd-d751-4592-bbe9-88d1b8db0e6a","description":"uuid of the Expenditure Life Stage Section"},"name":{"type":"string","example":"House Keeping","description":"The name of the Expenditure Life Stage Section. This is the name that will be displayed to the client."},"position":{"type":"string","example":"1","description":"The expected position of the Expenditure Life Stage Section in any listing of the Expenditure Life Stage Section. The first Expenditure Life Stage Section should have a position of 1, the second 2, etc."},"fields":{"type":"object","properties":{"uuid":{"type":"string","example":"28d90778-b9b4-48a4-a21e-9f664749058d"},"name":{"type":"string","example":"Electricity"},"section":{"type":"string","example":"Housekeeping Expenses"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"}},"description":"The fields associated with the Expenditure Life Stage Section."},"created_at":{"type":"string","example":"2023-06-16T15:25:06+01:00","description":"timestamp of when the Expenditure was created"},"updated_at":{"type":"string","example":"2023-06-16T15:25:06+01:00","description":"timestamp of when the Expenditure was updated"}},"example":{"uuid":"be37c8cd-d751-4592-bbe9-88d1b8db0e6a","name":"House Keeping","position":"1","fields":{"uuid":"28d90778-b9b4-48a4-a21e-9f664749058d","name":"Electricity","section":"Housekeeping Expenses","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"},"created_at":"2023-06-16T15:25:06+01:00","updated_at":"2023-06-16T15:25:06+01:00"}},"App_Http_Resources_Expenditure_LifeStageFieldResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3a437f0f-0152-452f-a43f-37f18d548a26","description":"uuid of the  Life Stage Field."},"name":{"type":"string","example":"Electricity","description":"The name of the Life Stage Field."},"section":{"type":"string","example":"Housekeeping Expenses","description":"The parent Life Stage Section of Field. Example: \"Housekeeping Expenses\""},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."}},"example":{"uuid":"3a437f0f-0152-452f-a43f-37f18d548a26","name":"Electricity","section":"Housekeeping Expenses","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}},"App_Http_Resources_Expenditure_ExpenditureResource":{"type":"object","properties":{"uuid":{"type":"string","example":"dca4f78d-2eb8-4d04-a0ac-149b43c4107e","description":"UUID of the Expenditure"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Electricity","description":"The name of the Expenditure."},"section":{"type":"string","example":"Housekeeping Expenses","description":"The Life Stage Section of the Expenditure."},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The amount of the Expenditure."},"position":{"type":"string","example":"1","description":"The position/order of the Expenditure in any listing."},"life_stage_uuid":{"type":"string","example":"af88e610-8fea-4bfa-90c1-f78f7db64756","description":"UUID of the Life Stage"},"life_stage_section_uuid":{"type":"string","example":"7c6f8080-112d-4c49-96fe-974aa63863b4","description":"UUID of the parent Life Stage Section"},"life_stage_field_uuid":{"type":"string","example":"cc26dcee-81ab-45e3-8ff2-891fffbbe22a","description":"UUID of the parent Life Stage Field"},"accounts":{"type":"string","example":"[]","description":"The accounts associated with this expenditure. Only present when loaded."}},"example":{"uuid":"dca4f78d-2eb8-4d04-a0ac-149b43c4107e","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Electricity","section":"Housekeeping Expenses","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"position":"1","life_stage_uuid":"af88e610-8fea-4bfa-90c1-f78f7db64756","life_stage_section_uuid":"7c6f8080-112d-4c49-96fe-974aa63863b4","life_stage_field_uuid":"cc26dcee-81ab-45e3-8ff2-891fffbbe22a","accounts":"[]"}},"App_Http_Resources_Expenditure_CustomExpenditureFieldResource":{"type":"object","properties":{"uuid":{"type":"string","example":"19a5d5f4-feca-4a20-9681-bf068a54f582","description":"uuid of the  Life Stage Field."},"name":{"type":"string","example":"Electricity","description":"The name of the Life Stage Field."},"section":{"type":"string","example":"Housekeeping Expenses","description":"The parent Life Stage Section of Field. Example: \"Housekeeping Expenses\""},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."}},"example":{"uuid":"19a5d5f4-feca-4a20-9681-bf068a54f582","name":"Electricity","section":"Housekeeping Expenses","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}},"App_Http_Resources_FcaNumberResource":{"type":"object","properties":{"uuid":{"type":"string","example":"07a60f32-3776-463f-b1f0-cde379732736","description":"The UUID of the resource."},"fca_number":{"type":"integer","example":123456,"description":"FCA Number"},"status":{"type":"string","example":"verified","description":"FCA Number Status, possible values are pending, verified and rejected"},"rejected_reason":{"type":"string","example":"Reason for rejection","description":"Reason for rejection"},"actioned_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"DateTime FCA Number was verified or rejected"}},"example":{"uuid":"07a60f32-3776-463f-b1f0-cde379732736","fca_number":123456,"status":"verified","rejected_reason":"Reason for rejection","actioned_at":"2026-05-08T14:41:54+01:00"}},"App_Http_Resources_MinimalAccountResource":{"type":"object","properties":{"uuid":{"type":"string","example":"994ba34e-3a2c-48b6-aed0-cb6a60d9197b","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"type":{"type":"string","example":"client","description":"Account type"},"role":{"type":"string","example":"client","description":"Account role"},"first_name":{"type":"string","example":"Gareth","description":"First name"},"last_name":{"type":"string","example":"Thompson","description":"Last name"},"name":{"type":"string","example":"Gareth Thompson","description":"Name"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client"},"external_references":{"type":"array","example":[{"uuid":"9a7cb428-dcce-45f0-819e-656f084c8809","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","third_party":"nucleus","reference":"AB123456"}],"description":"The external references that have been added to the client.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"9a7cb428-dcce-45f0-819e-656f084c8809"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}}},"example":{"uuid":"994ba34e-3a2c-48b6-aed0-cb6a60d9197b","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":[{"uuid":"9a7cb428-dcce-45f0-819e-656f084c8809","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","third_party":"nucleus","reference":"AB123456"}]}},"App_Http_Resources_FactFind_FactFindSubmissionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3a605052-485e-4e6a-9297-01e883154308","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"fact_find_answers":{"type":"object","properties":{"fact_find_question":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"fb67d53d-ba06-41c5-b33a-2752b287ab81"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"field_name":{"type":"object","properties":{"example":{"type":"string","example":"Field Name"},"description":{"type":"string","example":"The name of the field."},"collection":{"type":"boolean","example":false}}},"position":{"type":"object","properties":{"example":{"type":"string","example":"Position"},"description":{"type":"string","example":"The position/order of this question within the block."},"collection":{"type":"boolean","example":false}}},"is_required":{"type":"object","properties":{"example":{"type":"string","example":"Is Required"},"description":{"type":"string","example":"Bool to indicate if the question is required."},"collection":{"type":"boolean","example":false}}},"is_visible":{"type":"object","properties":{"example":{"type":"string","example":"Is Visible"},"description":{"type":"string","example":"Bool to indicate if the question is visible."},"collection":{"type":"boolean","example":false}}},"always_required":{"type":"object","properties":{"example":{"type":"string","example":"Always Required"},"description":{"type":"string","example":"Bool indicating the underlying database column is NOT NULL; the template builder must not allow this question to be hidden or made non-required."},"collection":{"type":"boolean","example":false}}},"has_conditional":{"type":"object","properties":{"example":{"type":"string","example":"Has Condition"},"description":{"type":"string","example":"Bool to indicate if the question has any conditions."},"collection":{"type":"boolean","example":false}}},"condition_type":{"type":"object","properties":{"example":{"type":"string","example":"Condition Type"},"description":{"type":"string","example":"ALL/ANY."},"collection":{"type":"boolean","example":false}}}}},"answer":{"type":"string","example":"Stored Answer (if any)"},"previous_value":{"type":"string","example":"Extracted previous value from account or block even if no question exists"},"block":{"type":"string","example":"The Block enum the question belongs to"}},"description":"All fact find questions under the submission, including previous values and block-level answers"}},"example":{"uuid":"3a605052-485e-4e6a-9297-01e883154308","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","fact_find_answers":{"fact_find_question":{"uuid":{"example":"fb67d53d-ba06-41c5-b33a-2752b287ab81","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated.","collection":false},"field_name":{"example":"Field Name","description":"The name of the field.","collection":false},"position":{"example":"Position","description":"The position/order of this question within the block.","collection":false},"is_required":{"example":"Is Required","description":"Bool to indicate if the question is required.","collection":false},"is_visible":{"example":"Is Visible","description":"Bool to indicate if the question is visible.","collection":false},"always_required":{"example":"Always Required","description":"Bool indicating the underlying database column is NOT NULL; the template builder must not allow this question to be hidden or made non-required.","collection":false},"has_conditional":{"example":"Has Condition","description":"Bool to indicate if the question has any conditions.","collection":false},"condition_type":{"example":"Condition Type","description":"ALL/ANY.","collection":false}},"answer":"Stored Answer (if any)","previous_value":"Extracted previous value from account or block even if no question exists","block":"The Block enum the question belongs to"}}},"App_Http_Resources_FactFind_FactFindSchemaResource":{"type":"object","properties":{"uuid":{"type":"string","example":"271494de-c4cd-42f3-a0fa-812b2d90bde6","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"archived_at":{"type":"string","example":"2026-05-07T14:41:55+01:00","description":"If the schema has been archived, the datetime of when it was archived."},"is_archived":{"type":"boolean","example":false,"description":"Denotes if the schema has been archived."},"name":{"type":"string","example":"Default fact find","description":"The name of the fact find schema."},"introduction_html":{"type":"string","example":"Welcome to our fact find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e","description":"The name of the fact find schema. Must be unique."},"sections_count":{"type":"integer","example":5,"description":"The number of sections inside of a fact find schema."},"public_url":{"type":"string","example":"https://api.plannrcrm.com/fact-find/a971d66f-86c7-4a03-aeb6-832e8a9c804f","description":"The public URL of the fact find schema."}},"example":{"uuid":"271494de-c4cd-42f3-a0fa-812b2d90bde6","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","archived_at":"2026-05-07T14:41:55+01:00","is_archived":false,"name":"Default fact find","introduction_html":"Welcome to our fact find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e","sections_count":5,"public_url":"https://api.plannrcrm.com/fact-find/a971d66f-86c7-4a03-aeb6-832e8a9c804f"}},"App_Http_Resources_FactFind_FactFindSchemaSectionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"7a2fc41d-daf4-4aa2-8d54-8858adee3a79"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Basic Details"},"front_end_section":{"type":"string","example":"basic_details"},"introduction_html":{"type":"string","example":"\u003cp\u003ePlease tell us your \u003cb\u003ebasic details.\u003c/b\u003e\u003c/p\u003e"},"position":{"type":"integer","example":1}},"example":[{"uuid":"7a2fc41d-daf4-4aa2-8d54-8858adee3a79","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Basic Details","front_end_section":"basic_details","introduction_html":"\u003cp\u003ePlease tell us your \u003cb\u003ebasic details.\u003c/b\u003e\u003c/p\u003e","position":1}]},"_App_Http_Resources_FileResource":{"type":"object","properties":{"uuid":{"type":"string","example":"43366adf-174f-485c-8539-fdfa35f62344","description":"UUID of the file"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"original_created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the file was originally created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the file was uploaded"},"status":{"type":"string","example":"uploaded","description":"Current status of the uploading progress"},"filename":{"type":"string","example":"Welcome to Plannr.pdf","description":"The filename including extension"},"name":{"type":"string","example":"Welcome to Plannr","description":"The name of the file without extension"},"extension":{"type":"string","example":"pdf","description":"The extension of the file"},"type":{"type":"string","example":"type","description":"The MIME type of the file"},"size":{"type":"string","example":"21691783","description":"The size of the file in bytes"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","description":"The path of the file"},"last_modified":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the file was last modified before uploading"},"progress":{"type":"string","example":"100","description":"The progress of the uploaded file as a percentage between 0 and 100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/dc645bae-c388-4d76-9451-e453f4aab828/download","description":"The download URL of the file"},"folder_name":{"type":"string","example":"folder 2","description":"The name of the folder the file is located in"},"folder":{"type":"object","properties":{"uuid":{"type":"string","example":"3d81340e-8491-496d-91ed-334860daebb8"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}},"description":"The folder this file is located in"},"documentable_type":{"type":"string","example":"account","description":"The documentable type such as account/plan/case/etc the file was uploaded to"},"documentable":{"type":"string","example":"Object","description":"The documentable the file was uploaded to"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"659a7a6a-42c6-4ab8-ad5f-a88a92cb81d3"}},"description":"The documentable type and its UUID in order to navigator to the correct resource"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"20da0f96-9f07-4136-96a9-b05d9c5dd50a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The firm which the file belongs to"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"96eb1288-2f98-46bf-9db1-13aa508a1788"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account that uploaded the file (if specified)"},"tags":{"type":"array","example":[{"uuid":"41a04cb4-0977-4b02-8ef8-df54f7164424","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"description":"The tags added to the file (if provided)","items":{"type":"object","properties":{"uuid":{"type":"string","example":"41a04cb4-0977-4b02-8ef8-df54f7164424"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}}},"example":{"uuid":"43366adf-174f-485c-8539-fdfa35f62344","created_at":"2026-05-08T14:41:55+01:00","original_created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","uploaded_at":"2026-05-08T14:41:55+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:55+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/dc645bae-c388-4d76-9451-e453f4aab828/download","folder_name":"folder 2","folder":{"uuid":"3d81340e-8491-496d-91ed-334860daebb8","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false},"documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"659a7a6a-42c6-4ab8-ad5f-a88a92cb81d3"},"firm":{"uuid":"20da0f96-9f07-4136-96a9-b05d9c5dd50a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"account":{"uuid":"96eb1288-2f98-46bf-9db1-13aa508a1788","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"tags":[{"uuid":"41a04cb4-0977-4b02-8ef8-df54f7164424","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}]}},"App_Http_Resources_FolderResource":{"type":"object","properties":{"uuid":{"type":"string","example":"5585ab48-a1ad-4895-a5a3-5aef53fa7a9b","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Important Documents","description":"Folder name"},"slug":{"type":"string","example":"important-documents","description":"Slug of the folder name"},"path":{"type":"string","example":"Codepotato/Important Documents","description":"Folder path"},"clients_read":{"type":"boolean","example":true,"description":"Denotes whether clients can access this folder and files"},"clients_write":{"type":"boolean","example":true,"description":"Denotes whether clients can upload files to this folder"},"show_client_permissions":{"type":"boolean","example":true,"description":"Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting"},"is_system_folder":{"type":"boolean","example":true,"description":"Denotes if this folder is a system folder"},"is_pseudo_folder":{"type":"boolean","example":true,"description":"Denotes if this folder is a pseudo folder"},"is_root_folder":{"type":"boolean","example":true,"description":"Denotes if this folder is a root folder of a documentable item"},"documentable_type":{"type":"string","example":"account","description":"The documentable type such as account/plan/case/etc the file was uploaded to"},"documentable_uuid":{"type":"string","example":"account","description":"The UUID of the documentable resource"},"documentable":{"type":"string","example":"Object","description":"The documentable the file was uploaded to"},"participants_count":{"type":"integer","example":3,"description":"Number of accounts this folder has been directly shared with"},"participants":{"type":"array","example":[{"uuid":"ae23dff0-6604-4a49-954f-90a65e258d12","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Gareth Thompson","write":true}],"description":"Participants whom this folder has been directly shared with.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"ae23dff0-6604-4a49-954f-90a65e258d12"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Gareth Thompson"},"write":{"type":"boolean","example":true}}}},"folders_count":{"type":"integer","example":5,"description":"Number of subfolders within the folder"},"folders":{"type":"array","example":[{"uuid":"5134321f-cef1-46c1-b80b-1e1a5c68e004","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"description":"Subfolders within the folder.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"5134321f-cef1-46c1-b80b-1e1a5c68e004"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}}}},"files_count":{"type":"integer","example":8,"description":"Number of files stored in the folder"},"files":{"type":"array","example":[{"uuid":"476ac3ea-b880-41da-a727-3138ec263042","created_at":"2026-05-08T14:41:55+01:00","original_created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","uploaded_at":"2026-05-08T14:41:55+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:55+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/2089707d-5561-4fc5-aa48-d3b1470b71eb/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"6ea81715-9fb2-4833-a209-8f4ab091582c"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"description":"Files stored in the folder.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"476ac3ea-b880-41da-a727-3138ec263042"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"status":{"type":"string","example":"uploaded"},"filename":{"type":"string","example":"Welcome to Plannr.pdf"},"name":{"type":"string","example":"Welcome to Plannr"},"extension":{"type":"string","example":"pdf"},"type":{"type":"string","example":"type"},"size":{"type":"string","example":"21691783"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf"},"last_modified":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"progress":{"type":"string","example":"100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/2089707d-5561-4fc5-aa48-d3b1470b71eb/download"},"folder_name":{"type":"string","example":"folder 2"},"folder":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"documentable_type":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"6ea81715-9fb2-4833-a209-8f4ab091582c"}}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"}}}},"parents":{"type":"array","example":[{"uuid":"94eb88de-4620-4d26-a74d-f2843fda00b5","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"description":"Parent folders.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"94eb88de-4620-4d26-a74d-f2843fda00b5"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}}}},"ancestors":{"type":"array","example":[{"uuid":"0a03386f-43b6-44e8-8de1-f9d72058f99e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"description":"All parents folders up the folder hierarchy structure.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"0a03386f-43b6-44e8-8de1-f9d72058f99e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}}}},"children":{"type":"array","example":[{"uuid":"0161aa08-9beb-4e2c-8c36-656a12ce9a1e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"description":"Subfolders within the folder.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"0161aa08-9beb-4e2c-8c36-656a12ce9a1e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}}}},"depth":{"type":"integer","example":5,"description":"How many levels deep there are to this folder hierarchy structure"},"owned":{"type":"boolean","example":false,"description":"Is true if the authenticated account in the request has created this folder"}},"example":{"uuid":"5585ab48-a1ad-4895-a5a3-5aef53fa7a9b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":[{"uuid":"ae23dff0-6604-4a49-954f-90a65e258d12","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Gareth Thompson","write":true}],"folders_count":5,"folders":[{"uuid":"5134321f-cef1-46c1-b80b-1e1a5c68e004","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"files_count":8,"files":[{"uuid":"476ac3ea-b880-41da-a727-3138ec263042","created_at":"2026-05-08T14:41:55+01:00","original_created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","uploaded_at":"2026-05-08T14:41:55+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:55+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/2089707d-5561-4fc5-aa48-d3b1470b71eb/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"6ea81715-9fb2-4833-a209-8f4ab091582c"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"parents":[{"uuid":"94eb88de-4620-4d26-a74d-f2843fda00b5","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"ancestors":[{"uuid":"0a03386f-43b6-44e8-8de1-f9d72058f99e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"children":[{"uuid":"0161aa08-9beb-4e2c-8c36-656a12ce9a1e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}],"depth":5,"owned":false}},"App_Http_Resources_FileResource":{"type":"object","properties":{"uuid":{"type":"string","example":"74dbf1cf-8888-4bf1-971c-bbb5d9a3c16e","description":"UUID of the file"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"original_created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the file was originally created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the file was uploaded"},"status":{"type":"string","example":"uploaded","description":"Current status of the uploading progress"},"filename":{"type":"string","example":"Welcome to Plannr.pdf","description":"The filename including extension"},"name":{"type":"string","example":"Welcome to Plannr","description":"The name of the file without extension"},"extension":{"type":"string","example":"pdf","description":"The extension of the file"},"type":{"type":"string","example":"type","description":"The MIME type of the file"},"size":{"type":"string","example":"21691783","description":"The size of the file in bytes"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","description":"The path of the file"},"last_modified":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the file was last modified before uploading"},"progress":{"type":"string","example":"100","description":"The progress of the uploaded file as a percentage between 0 and 100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/642f7af4-2f58-4c68-ab4c-47316e1f3178/download","description":"The download URL of the file"},"folder_name":{"type":"string","example":"folder 2","description":"The name of the folder the file is located in"},"folder":{"type":"object","properties":{"uuid":{"type":"string","example":"55ea26dd-8b33-4f4a-9bf3-817b3f974ebf"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}},"description":"The folder this file is located in"},"documentable_type":{"type":"string","example":"account","description":"The documentable type such as account/plan/case/etc the file was uploaded to"},"documentable":{"type":"string","example":"Object","description":"The documentable the file was uploaded to"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"3195fcc9-38cd-4f2a-bde0-1e404ac9fec0"}},"description":"The documentable type and its UUID in order to navigator to the correct resource"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"f88395c3-1859-4ab8-ba8e-576a60e7817e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The firm which the file belongs to"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"8c7d78e6-5aee-461c-bb91-4985ec0c2df9"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account that uploaded the file (if specified)"},"tags":{"type":"array","example":[{"uuid":"117ffaa9-ea0c-468b-aa99-3d59f74f608d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"description":"The tags added to the file (if provided)","items":{"type":"object","properties":{"uuid":{"type":"string","example":"117ffaa9-ea0c-468b-aa99-3d59f74f608d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}}},"example":{"uuid":"74dbf1cf-8888-4bf1-971c-bbb5d9a3c16e","created_at":"2026-05-08T14:41:55+01:00","original_created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","uploaded_at":"2026-05-08T14:41:55+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:55+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/642f7af4-2f58-4c68-ab4c-47316e1f3178/download","folder_name":"folder 2","folder":{"uuid":"55ea26dd-8b33-4f4a-9bf3-817b3f974ebf","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false},"documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"3195fcc9-38cd-4f2a-bde0-1e404ac9fec0"},"firm":{"uuid":"f88395c3-1859-4ab8-ba8e-576a60e7817e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"account":{"uuid":"8c7d78e6-5aee-461c-bb91-4985ec0c2df9","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"tags":[{"uuid":"117ffaa9-ea0c-468b-aa99-3d59f74f608d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}]}},"App_Http_Resources_FirmResource":{"type":"object","properties":{"uuid":{"type":"string","example":"10a94a1a-1834-4d8b-ad3f-d28541219124","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Codepotato","description":"Name of the firm"},"slug":{"type":"string","example":"codepotato","description":"Slug of the firm"},"address_1":{"type":"string","example":"Suite E, 5 The Briars","description":"First line of the address"},"address_2":{"type":"string","example":"Waterberry Drive","description":"Second line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"regulatory_text":{"type":"string","example":"Regulatory text","description":"Regulatory text of the firm."},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg","description":"URL of your firm logo."},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg","description":"URL of your firm logo icon."},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}},"description":"Firm branding colours."},"is_subscribed":{"type":"boolean","example":true,"description":"Subscription status."},"addon_subscriptions":{"type":"array","example":[{"uuid":"5095ffcf-5705-4bb1-a9ec-4de5dedee44c","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","enabled":"true","addon":"App\\Http\\Resources\\Addons\\AddonResource","trial_ends_at":"2026-05-22","trial_ends_in_days":14,"payment_confirmed_at":"2026-05-26"}],"description":"All addons the firm is subscribed to.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"5095ffcf-5705-4bb1-a9ec-4de5dedee44c"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"enabled":{"type":"string","example":"true"},"addon":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonResource"},"trial_ends_at":{"type":"string","example":"2026-05-22"},"trial_ends_in_days":{"type":"integer","example":14},"payment_confirmed_at":{"type":"string","example":"2026-05-26"}}}},"keep_deleted_files_for":{"type":"integer","example":30,"description":"Number of days to keep deleted files for"},"tax":{"type":"number","example":17.5,"description":"Tax percent"},"month_end":{"type":"integer","example":25,"description":"Date of the month for the monthly income reconciliation statements to end"},"statement_frequency":{"type":"string","example":"monthly","description":"The frequency of the income reconciliation statements"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}},"description":"Firm invoice details for billing"},"task_board_template":{"type":"object","properties":{"uuid":{"type":"string","example":"6e430af6-f678-4e66-baac-cff5df5ccfa9"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"is_template":{"type":"boolean","example":false},"name":{"type":"string","example":"Task Board"},"default_list_uuid":{"type":"string","example":"f089272b-4ffc-471b-9b6a-007203e551cc"},"lists":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardListResource"},"is_editable":{"type":"boolean","example":true},"priorities":{"type":"array","example":[{"name":"High","value":"high"},{"name":"Low","value":"low"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"High"},"value":{"type":"string","example":"high"}}}},"modelable":{"type":"string","example":"App\\Http\\Resources\\CasesResource"}},"description":"The task board template that is used when every client or case is created"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"description":"A list of IP Addresses a firm is allowed to log in from.","items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e","description":"Custom welcome paragraph html for the branded auth welcome page"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!","description":"Custom welcome paragraph for the welcome/new user email"},"show_fact_find_illustrations":{"type":"boolean","example":true,"description":"Determines if the illustrations/graphics are displayed on the fact find."},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"description":"Array of email cc addresses.","items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"description":"Array of email bcc addresses.","items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com","description":"Firm reply to email address."},"mobile_app_support_number":{"type":"string","example":"01234 567890","description":"Firm mobile app support number."},"mobile_app_support_email":{"type":"string","example":"support@example.com","description":"Firm mobile app support email address."}},"example":{"uuid":"10a94a1a-1834-4d8b-ad3f-d28541219124","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":[{"uuid":"5095ffcf-5705-4bb1-a9ec-4de5dedee44c","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","enabled":"true","addon":"App\\Http\\Resources\\Addons\\AddonResource","trial_ends_at":"2026-05-22","trial_ends_in_days":14,"payment_confirmed_at":"2026-05-26"}],"keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":{"uuid":"6e430af6-f678-4e66-baac-cff5df5ccfa9","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","is_template":false,"name":"Task Board","default_list_uuid":"f089272b-4ffc-471b-9b6a-007203e551cc","lists":"App\\Http\\Resources\\Board\\BoardListResource","is_editable":true,"priorities":[{"name":"High","value":"high"},{"name":"Low","value":"low"}],"modelable":"App\\Http\\Resources\\CasesResource"},"ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"}},"App_Http_Resources_FormResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b181c455-202b-437f-8b28-753d4085d3f9","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"title":{"type":"string","example":"Annual Catchup 2022","description":"The title of the form"},"description":{"type":"string","example":"This is the annual catchup form for 2022","description":"The description of the form"},"live":{"type":"boolean","example":true,"description":"Whether the form is live"},"visibility":{"type":"string","example":"public","description":"The visibility of the form"},"sections":{"type":"object","properties":{"uuid":{"type":"string","example":"389e02e7-8b16-4694-b867-0ac536f49b8b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"section":{"type":"string","example":"App\\Http\\Resources\\FormSectionResource"},"title":{"type":"string","example":"What is your name?"},"help_text":{"type":"string","example":"Gareth"},"caption":{"type":"string","example":"Your full legal name"},"type":{"type":"string","example":"string"},"required":{"type":"boolean","example":true},"position":{"type":"integer","example":1},"selection_options":{"type":"array","example":["option 1","option 2"],"items":{"type":"string"}},"target_field":{"type":"string","example":"name"},"key":{"type":"string","example":"what_is_your_name"},"linked_question":{"type":"string","example":"App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource"},"linked_primary":{"type":"boolean","example":true}},"description":"The sections of the form. They include the forms questions in a array"},"allowed_hosts":{"type":"array","example":["domain.com","subdomain.domain.com"],"description":"Array of allowed domains that this form can be accessed from using different origins","items":{"type":"string"}},"draft_submissions_count":{"type":"integer","example":5,"description":"Count of draft submissions against this form"},"submitted_submissions_count":{"type":"integer","example":5,"description":"Count of submitted submissions against this form"},"create_client":{"type":"boolean","example":true,"description":"Denotes if this form creates a new client when it is submitted from a public embed"},"client_type":{"type":"string","example":"client","description":"If create_client is true, then the client_type is the type of client that will be created, possible values are client and prospect"}},"example":{"uuid":"b181c455-202b-437f-8b28-753d4085d3f9","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","title":"Annual Catchup 2022","description":"This is the annual catchup form for 2022","live":true,"visibility":"public","sections":{"uuid":"389e02e7-8b16-4694-b867-0ac536f49b8b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","section":"App\\Http\\Resources\\FormSectionResource","title":"What is your name?","help_text":"Gareth","caption":"Your full legal name","type":"string","required":true,"position":1,"selection_options":["option 1","option 2"],"target_field":"name","key":"what_is_your_name","linked_question":"App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource","linked_primary":true},"allowed_hosts":["domain.com","subdomain.domain.com"],"draft_submissions_count":5,"submitted_submissions_count":5,"create_client":true,"client_type":"client"}},"App_Http_Resources_FormBuilder_LinkedFormQuestionResource":{"type":"object","properties":{"type":{"type":"string","example":"selection"},"field":{"type":"string","example":"gender"},"label":{"type":"string","example":"Gender"},"formatted_field":{"type":"string","example":"Gender"},"selection_options":{"type":"array","example":["male","female","non-binary","transgender","intersex","other","unknown"],"items":{"type":"string"}},"is_custom_field":{"type":"boolean","example":false},"forced_required":{"type":"boolean","example":false},"caption":{"type":"string","example":"Your drink preference"}},"example":[{"type":"selection","field":"gender","label":"Gender","formatted_field":"Gender","selection_options":["male","female","non-binary","transgender","intersex","other","unknown"],"is_custom_field":false,"forced_required":false,"caption":"Your drink preference"}]},"App_Http_Resources_FormSubmissionRequestResource":{"type":"object","properties":{"uuid":{"type":"string","example":"f7b470d6-32b0-47b1-8570-76a05e5a0813","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"description":{"type":"string","example":"Please submit your annual survey form","description":"The description of the form submission request"},"form":{"type":"object","properties":{"uuid":{"type":"string","example":"aede1cf1-9775-4bca-a1c6-5fb6721f3f98"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"title":{"type":"string","example":"Annual Catchup 2022"},"description":{"type":"string","example":"This is the annual catchup form for 2022"},"live":{"type":"boolean","example":true},"visibility":{"type":"string","example":"public"},"sections":{"type":"string","example":"App\\Http\\Resources\\FormQuestionResource"},"allowed_hosts":{"type":"array","example":["domain.com","subdomain.domain.com"],"items":{"type":"string"}},"draft_submissions_count":{"type":"integer","example":5},"submitted_submissions_count":{"type":"integer","example":5},"create_client":{"type":"boolean","example":true},"client_type":{"type":"string","example":"client"}},"description":"The form linked to this submission request"},"has_submission":{"type":"boolean","example":true,"description":"Denotes if this request has a submission stored against it"},"submission":{"type":"object","properties":{"uuid":{"type":"string","example":"614a6e5c-fbac-4fde-9fe5-165d40056145"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"stage":{"type":"string","example":"draft"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"request":{"type":"string","example":"App\\Http\\Resources\\FormSubmissionRequestResource"},"form":{"type":"string","example":"App\\Http\\Resources\\FormResource"},"answers":{"type":"array","example":[{"first_name":"john","last_name":"olive"}],"items":{"type":"object","properties":{"first_name":{"type":"string","example":"john"},"last_name":{"type":"string","example":"olive"}}}}},"description":"The submission stored against this request"}},"example":{"uuid":"f7b470d6-32b0-47b1-8570-76a05e5a0813","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","description":"Please submit your annual survey form","form":{"uuid":"aede1cf1-9775-4bca-a1c6-5fb6721f3f98","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","title":"Annual Catchup 2022","description":"This is the annual catchup form for 2022","live":true,"visibility":"public","sections":"App\\Http\\Resources\\FormQuestionResource","allowed_hosts":["domain.com","subdomain.domain.com"],"draft_submissions_count":5,"submitted_submissions_count":5,"create_client":true,"client_type":"client"},"has_submission":true,"submission":{"uuid":"614a6e5c-fbac-4fde-9fe5-165d40056145","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","stage":"draft","account":"App\\Http\\Resources\\AccountResource","request":"App\\Http\\Resources\\FormSubmissionRequestResource","form":"App\\Http\\Resources\\FormResource","answers":[{"first_name":"john","last_name":"olive"}]}}},"App_Http_Resources_FormSectionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"328d7f77-e7ca-44b2-8976-cadfdd1bc107","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"form":{"type":"object","properties":{"uuid":{"type":"string","example":"80c4bebc-5f64-4370-a73e-5b8698cd9f15"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"title":{"type":"string","example":"Annual Catchup 2022"},"description":{"type":"string","example":"This is the annual catchup form for 2022"},"live":{"type":"boolean","example":true},"visibility":{"type":"string","example":"public"},"sections":{"type":"string","example":"App\\Http\\Resources\\FormQuestionResource"},"allowed_hosts":{"type":"array","example":["domain.com","subdomain.domain.com"],"items":{"type":"string"}},"draft_submissions_count":{"type":"integer","example":5},"submitted_submissions_count":{"type":"integer","example":5},"create_client":{"type":"boolean","example":true},"client_type":{"type":"string","example":"client"}},"description":"The form this section belongs to"},"title":{"type":"string","example":"Personal Details","description":"The title of the section"},"position":{"type":"integer","example":1,"description":"The position of the section"},"questions":{"type":"object","properties":{"uuid":{"type":"string","example":"a9af72b4-d6ae-434e-9b51-fd8e34590b2f"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"section":{"type":"string","example":"App\\Http\\Resources\\FormSectionResource"},"title":{"type":"string","example":"What is your name?"},"help_text":{"type":"string","example":"Gareth"},"caption":{"type":"string","example":"Your full legal name"},"type":{"type":"string","example":"string"},"required":{"type":"boolean","example":true},"position":{"type":"integer","example":1},"selection_options":{"type":"array","example":["option 1","option 2"],"items":{"type":"string"}},"target_field":{"type":"string","example":"name"},"key":{"type":"string","example":"what_is_your_name"},"linked_question":{"type":"string","example":"App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource"},"linked_primary":{"type":"boolean","example":true}},"description":"The questions in the section"}},"example":{"uuid":"328d7f77-e7ca-44b2-8976-cadfdd1bc107","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","form":{"uuid":"80c4bebc-5f64-4370-a73e-5b8698cd9f15","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","title":"Annual Catchup 2022","description":"This is the annual catchup form for 2022","live":true,"visibility":"public","sections":"App\\Http\\Resources\\FormQuestionResource","allowed_hosts":["domain.com","subdomain.domain.com"],"draft_submissions_count":5,"submitted_submissions_count":5,"create_client":true,"client_type":"client"},"title":"Personal Details","position":1,"questions":{"uuid":"a9af72b4-d6ae-434e-9b51-fd8e34590b2f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","section":"App\\Http\\Resources\\FormSectionResource","title":"What is your name?","help_text":"Gareth","caption":"Your full legal name","type":"string","required":true,"position":1,"selection_options":["option 1","option 2"],"target_field":"name","key":"what_is_your_name","linked_question":"App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource","linked_primary":true}}},"App_Http_Resources_FormQuestionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"a028ddfd-1830-4d15-8a9c-8b2d9857cf1a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"section":{"type":"object","properties":{"uuid":{"type":"string","example":"1d155dd8-905b-465b-a253-59e14d084fbf"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"form":{"type":"string","example":"App\\Http\\Resources\\FormResource"},"title":{"type":"string","example":"Personal Details"},"position":{"type":"integer","example":1},"questions":{"type":"string","example":"App\\Http\\Resources\\FormQuestionResource"}},"description":"The section this question belongs to"},"title":{"type":"string","example":"What is your name?","description":"The title of the question"},"help_text":{"type":"string","example":"Gareth","description":"Input placeholder text"},"caption":{"type":"string","example":"Your full legal name","description":"Text to describe the input"},"type":{"type":"string","example":"string","description":"The type of question"},"required":{"type":"boolean","example":true,"description":"Whether the question is required"},"position":{"type":"integer","example":1,"description":"The position of the question in the section"},"selection_options":{"type":"array","example":["option 1","option 2"],"description":"The options for selection questions","items":{"type":"string"}},"target_field":{"type":"string","example":"name","description":"The field to update upon question completion"},"key":{"type":"string","example":"what_is_your_name","description":"The key to use when updating the target field"},"linked_question":{"type":"object","properties":{"type":{"type":"string","example":"selection"},"field":{"type":"string","example":"gender"},"label":{"type":"string","example":"Gender"},"formatted_field":{"type":"string","example":"Gender"},"selection_options":{"type":"array","example":["male","female","non-binary","transgender","intersex","other","unknown"],"items":{"type":"string"}},"is_custom_field":{"type":"boolean","example":false},"forced_required":{"type":"boolean","example":false},"caption":{"type":"string","example":"Your drink preference"}},"description":"the linked form question"},"linked_primary":{"type":"boolean","example":true,"description":"Will the this linked field become a primary Address/Phone Number/Email Address"}},"example":{"uuid":"a028ddfd-1830-4d15-8a9c-8b2d9857cf1a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","section":{"uuid":"1d155dd8-905b-465b-a253-59e14d084fbf","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","form":"App\\Http\\Resources\\FormResource","title":"Personal Details","position":1,"questions":"App\\Http\\Resources\\FormQuestionResource"},"title":"What is your name?","help_text":"Gareth","caption":"Your full legal name","type":"string","required":true,"position":1,"selection_options":["option 1","option 2"],"target_field":"name","key":"what_is_your_name","linked_question":{"type":"selection","field":"gender","label":"Gender","formatted_field":"Gender","selection_options":["male","female","non-binary","transgender","intersex","other","unknown"],"is_custom_field":false,"forced_required":false,"caption":"Your drink preference"},"linked_primary":true}},"App_Http_Resources_FormAnswerResource":{"type":"object","properties":{"uuid":{"type":"string","example":"99718ccb-c762-4f35-9525-58b6f4f36134"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"string","example":"this as an answer to a form question"},"question":{"type":"object","properties":{"uuid":{"type":"string","example":"a9611ba1-7ce7-4c02-b17b-328cb989be65"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"section":{"type":"string","example":"App\\Http\\Resources\\FormSectionResource"},"title":{"type":"string","example":"What is your name?"},"help_text":{"type":"string","example":"Gareth"},"caption":{"type":"string","example":"Your full legal name"},"type":{"type":"string","example":"string"},"required":{"type":"boolean","example":true},"position":{"type":"integer","example":1},"selection_options":{"type":"array","example":["option 1","option 2"],"items":{"type":"string"}},"target_field":{"type":"string","example":"name"},"key":{"type":"string","example":"what_is_your_name"},"linked_question":{"type":"string","example":"App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource"},"linked_primary":{"type":"boolean","example":true}}}},"example":[{"uuid":"99718ccb-c762-4f35-9525-58b6f4f36134","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","value":"this as an answer to a form question","question":{"uuid":"a9611ba1-7ce7-4c02-b17b-328cb989be65","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","section":"App\\Http\\Resources\\FormSectionResource","title":"What is your name?","help_text":"Gareth","caption":"Your full legal name","type":"string","required":true,"position":1,"selection_options":["option 1","option 2"],"target_field":"name","key":"what_is_your_name","linked_question":"App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource","linked_primary":true}}]},"App_Http_Resources_GoalResource":{"type":"object","properties":{"uuid":{"type":"string","example":"72ba5b04-28e4-4e6f-8ec5-1eea28dabcb7","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Reduced Mileage","description":"The goal's name."},"description":{"type":"string","example":"Reduce the amount of gas spent yearly.","description":"The goal's description."},"target_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The goal's target amount."},"progress":{"type":"string","example":"68","description":"The goal's progress as a percentage."},"timeframe":{"type":"string","example":"Within the year.","description":"The goal's timeframe."},"complete_goal_by":{"type":"string","example":"2027-05-08T14:41:56+01:00","description":"The goal's deadline as a specific date."},"priority":{"type":"string","example":"4","description":"The goal's priority on a scale from 1 to 5."},"shared_owner_type":{"type":"string","example":"individual","description":"Denotes if the goal is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)"},"shared_owner":{"type":"object","properties":{"uuid":{"type":"string","example":"8a5e194b-c816-4d50-a713-8a5aa3d2c544"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The owner of the goal. Only provided if the shared_owner_type is \"individual\"."}},"example":{"uuid":"72ba5b04-28e4-4e6f-8ec5-1eea28dabcb7","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Reduced Mileage","description":"Reduce the amount of gas spent yearly.","target_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"progress":"68","timeframe":"Within the year.","complete_goal_by":"2027-05-08T14:41:56+01:00","priority":"4","shared_owner_type":"individual","shared_owner":{"uuid":"8a5e194b-c816-4d50-a713-8a5aa3d2c544","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_GroupResource":{"type":"object","properties":{"uuid":{"type":"string","example":"7a99b2aa-08e2-4371-9c7f-1c9db0aac3f3","description":"UUID of the group"},"name":{"type":"string","example":"finance","description":"Name of the group"},"slug":{"type":"string","example":"finance","description":"Slug of the group"},"participants_count":{"type":"string","example":"3","description":"Number of participants in the group"},"participants":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"10fd3f55-0df0-4225-af47-d4bcc77c4e4e"},"description":{"type":"string","example":"UUID of the account"}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Role of the account"}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name of the account"}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name of the account"}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name of the account"}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"Email of the account"}}}},"description":"Participants in this group"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the group was created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the group was updated"}},"example":{"uuid":"7a99b2aa-08e2-4371-9c7f-1c9db0aac3f3","name":"finance","slug":"finance","participants_count":"3","participants":{"uuid":{"example":"10fd3f55-0df0-4225-af47-d4bcc77c4e4e","description":"UUID of the account"},"role":{"example":"client","description":"Role of the account"},"first_name":{"example":"Gareth","description":"First name of the account"},"last_name":{"example":"Thompson","description":"Last name of the account"},"name":{"example":"Gareth Thompson","description":"Name of the account"},"email":{"example":"gareth@codepotato.co.uk","description":"Email of the account"}},"created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00"}},"App_Http_Resources_Plans_HoldingResource":{"type":"object","properties":{"uuid":{"type":"string","example":"31244951-f61a-49ab-89bd-6aff56d6f0ec"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"fund_name":{"type":"string","example":"Fund"},"reference":{"type":"string","example":"REF123"},"sector":{"type":"string","example":"Europe"},"sedol":{"type":"string","example":"ACB123"},"isin":{"type":"string","example":"ACB123"},"citi":{"type":"string","example":"ACB123"},"units":{"type":"integer","example":5},"unit_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£10.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"unit_price_raw":{"type":"integer","example":10},"purchase_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"is_active":{"type":"boolean","example":true},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"object","properties":{"uuid":{"type":"string","example":"498c5698-d11c-4a43-97af-647edd9749ac"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}},"external_references":{"type":"object","properties":{"uuid":{"type":"string","example":"16a8eab2-d35d-4ade-abff-867d04cccbd5"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}},"example":[{"uuid":"31244951-f61a-49ab-89bd-6aff56d6f0ec","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","fund_name":"Fund","reference":"REF123","sector":"Europe","sedol":"ACB123","isin":"ACB123","citi":"ACB123","units":5,"unit_price":{"amount":{"example":"1000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£10.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"unit_price_raw":10,"purchase_price":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"is_active":true,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":{"uuid":"498c5698-d11c-4a43-97af-647edd9749ac","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"external_references":{"uuid":"16a8eab2-d35d-4ade-abff-867d04cccbd5","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}}]},"App_Http_Resources_ImportResource":{"type":"object","properties":{"uuid":{"type":"string","example":"c7082c34-335e-4b2d-9b3b-4fa82770af1d","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"type":{"type":"string","example":"clients","description":"The type of model the importer is importing"},"mode":{"type":"string","example":"store","description":"The mode this import was run on"},"headers":{"type":"array","example":["fname","lname","email"],"description":"Headers taken from uploaded csv, not visible on index route","items":{"type":"string"}},"mapping":{"type":"object","properties":{"fname":{"type":"string","example":"first_name"},"lname":{"type":"string","example":"last_name"},"email":{"type":"string","example":"email"}},"description":"Mapped headers, not visible on index route"},"importable_uuid":{"type":"string","example":"a44394d9-6597-40d3-b244-b6f3c1168b58","description":"The uuid of the model this importer is importing. For example, for a provider statement import, this would be the uuid of the provider statement being imported"},"parameters":{"type":"object","properties":{"revenue_type_mapping":{"type":"object","properties":{"IF":{"type":"string","example":"initial_fee"},"ADJ":{"type":"string","example":"adjustment"}}}},"description":"additional parameters for the import"},"status":{"type":"string","example":"processing","description":"The status of the importer"},"total_jobs":{"type":"integer","example":4,"description":"Total amount of imports in the importer"},"progress":{"type":"integer","example":100,"description":"The current progress of the importer"},"jobs_remaining":{"type":"integer","example":1,"description":"Number of pending imports"},"failed_jobs":{"type":"integer","example":1,"description":"Number of failed imports"},"error_report":{"type":"object","properties":{"uuid":{"type":"string","example":"6559152e-7631-4131-a2eb-4520981220f7"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"status":{"type":"string","example":"uploaded"},"filename":{"type":"string","example":"Welcome to Plannr.pdf"},"name":{"type":"string","example":"Welcome to Plannr"},"extension":{"type":"string","example":"pdf"},"type":{"type":"string","example":"type"},"size":{"type":"string","example":"21691783"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf"},"last_modified":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"progress":{"type":"string","example":"100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/a973f854-5f5f-4941-93cd-a411781bcd54/download"},"folder_name":{"type":"string","example":"folder 2"},"folder":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"documentable_type":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"6630f905-7ade-4428-bcd1-aad98636e6cc"}}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"}},"description":"Error report file"},"errors":{"type":"object","properties":{"client":{"type":"object","properties":{"example":{"type":"array","example":[]},"description":{"type":"string","example":"Client that failed importing"}}},"errors":{"type":"object","properties":{"example":{"type":"object","properties":{"send_welcome_email":{"type":"array","example":["The send welcome email field is required."],"items":{"type":"string"}}}},"description":{"type":"string","example":"The reasons why the client failed importing"}}}},"description":"Array of failed imports, limited to 25 rows"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"12b57f39-125d-4253-8ba4-17c2c3903651"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that initiated the import"}},"example":{"uuid":"c7082c34-335e-4b2d-9b3b-4fa82770af1d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"clients","mode":"store","headers":["fname","lname","email"],"mapping":{"fname":"first_name","lname":"last_name","email":"email"},"importable_uuid":"a44394d9-6597-40d3-b244-b6f3c1168b58","parameters":{"revenue_type_mapping":{"IF":"initial_fee","ADJ":"adjustment"}},"status":"processing","total_jobs":4,"progress":100,"jobs_remaining":1,"failed_jobs":1,"error_report":{"uuid":"6559152e-7631-4131-a2eb-4520981220f7","created_at":"2026-05-08T14:41:55+01:00","original_created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","uploaded_at":"2026-05-08T14:41:55+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:55+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/a973f854-5f5f-4941-93cd-a411781bcd54/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"6630f905-7ade-4428-bcd1-aad98636e6cc"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"},"errors":{"client":{"example":[],"description":"Client that failed importing"},"errors":{"example":{"send_welcome_email":["The send welcome email field is required."]},"description":"The reasons why the client failed importing"}},"account":{"uuid":"12b57f39-125d-4253-8ba4-17c2c3903651","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_ImportKeysResource":{"type":"object","properties":{"keys":{"type":"array","example":["name","uuid","client_uuid","type","sub_type","provider_uuid","policy_number"],"description":"List of keys for the specified importer","items":{"type":"string"}}},"example":{"keys":["name","uuid","client_uuid","type","sub_type","provider_uuid","policy_number"]}},"App_Http_Resources_ImportModesResource":{"type":"object","properties":{"modes":{"type":"array","example":["store","update","validate"],"description":"List of allowed modes for the specified importer","items":{"type":"string"}}},"example":{"modes":["store","update","validate"]}},"App_Http_Resources_IncomeResource":{"type":"object","properties":{"uuid":{"type":"string","example":"e62e96a0-a805-4bf8-a75c-7617429c19ee","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"My Salary","description":"The name of the income."},"type":{"type":"string","example":"salary","description":"The type of income."},"type_other":{"type":"string","example":"Other income type","description":"The other type of income, if the type is \"other\"."},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The amount of the income."},"amount_type":{"type":"string","example":"net","description":"The type of the amount."},"start_date":{"type":"string","example":"2025-05-08","description":"The start date of the income."},"end_date":{"type":"string","example":"2026-05-08","description":"The end date of the income."},"frequency":{"type":"string","example":"annually","description":"The frequency of the income."},"is_taxable":{"type":"boolean","example":true,"description":"Denotes if the income is taxable or not."},"shared_owner_type":{"type":"string","example":"individual","description":"Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)."},"shared_owner":{"type":"object","properties":{"uuid":{"type":"string","example":"5def7e4c-3368-42cc-b5b4-8acfa30f6240"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The owner of the employment. Only provided if the shared_owner_type is \"individual\"."},"employment":{"type":"object","properties":{"uuid":{"type":"string","example":"3bc1b4c9-23cf-4e0b-a612-48ff20573f7b"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"status":{"type":"string","example":"employed"},"occupation":{"type":"string","example":"Financial Adviser"},"occupation_code":{"type":"string","example":"FAC02774"},"job_title":{"type":"string","example":"Senior financial adviser"},"employer":{"type":"string","example":"Plannr Technologies Ltd"},"started_at":{"type":"string","example":"2021-05-08T14:41:54+01:00"},"ended_at":{"type":"string","example":"2022-05-08T14:41:54+01:00"},"is_business_owner":{"type":"boolean","example":true},"percentage_of_business_shared":{"type":"integer","example":50},"address":{"type":"string","example":"App\\Http\\Resources\\AddressResource"},"phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"email_address":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"shared_owner_type":{"type":"string","example":"individual"},"shared_owner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"last_salary_increase":{"type":"string","example":"2019-01-01"},"business_name":{"type":"string","example":"My Business"},"business_year_end":{"type":"string","example":"2020-12-31"},"business_value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"directors":{"type":"string","example":"Susan F. Lancaster"},"shareholding_in_business":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"profit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"accountant_company_name":{"type":"string","example":"My Accountant"},"accountant_email":{"type":"string","example":"accountant@email.com"},"accountant_telephone_number":{"type":"string","example":"+441234567890"},"accountant_address":{"type":"string","example":"23 Chollerton, Hexham, Northumberland, NE46 4TF"},"primary":{"type":"boolean","example":true},"turnover_history":{"type":"string","example":"App\\Http\\Resources\\TurnoverHistoryResource"},"income":{"type":"string","example":"App\\Http\\Resources\\IncomeResource"}},"description":"Employment of this income."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"06b1a862-5c0a-4c60-8aab-eb82803aa859"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that owns this income."}},"example":{"uuid":"e62e96a0-a805-4bf8-a75c-7617429c19ee","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"My Salary","type":"salary","type_other":"Other income type","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount_type":"net","start_date":"2025-05-08","end_date":"2026-05-08","frequency":"annually","is_taxable":true,"shared_owner_type":"individual","shared_owner":{"uuid":"5def7e4c-3368-42cc-b5b4-8acfa30f6240","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"employment":{"uuid":"3bc1b4c9-23cf-4e0b-a612-48ff20573f7b","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","status":"employed","occupation":"Financial Adviser","occupation_code":"FAC02774","job_title":"Senior financial adviser","employer":"Plannr Technologies Ltd","started_at":"2021-05-08T14:41:54+01:00","ended_at":"2022-05-08T14:41:54+01:00","is_business_owner":true,"percentage_of_business_shared":50,"address":"App\\Http\\Resources\\AddressResource","phone_number":"App\\Http\\Resources\\ContactDetailResource","email_address":"App\\Http\\Resources\\ContactDetailResource","shared_owner_type":"individual","shared_owner":"App\\Http\\Resources\\AccountResource","last_salary_increase":"2019-01-01","business_name":"My Business","business_year_end":"2020-12-31","business_value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"directors":"Susan F. Lancaster","shareholding_in_business":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"profit":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"accountant_company_name":"My Accountant","accountant_email":"accountant@email.com","accountant_telephone_number":"+441234567890","accountant_address":"23 Chollerton, Hexham, Northumberland, NE46 4TF","primary":true,"turnover_history":"App\\Http\\Resources\\TurnoverHistoryResource","income":"App\\Http\\Resources\\IncomeResource"},"account":{"uuid":"06b1a862-5c0a-4c60-8aab-eb82803aa859","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_IncomeResource":{"type":"object","properties":{"uuid":{"type":"string","example":"829834ab-38c3-4e56-9ac4-418989e71247","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"My Salary","description":"The name of the income."},"type":{"type":"string","example":"salary","description":"The type of income."},"type_other":{"type":"string","example":"Other income type","description":"The other type of income, if the type is \"other\"."},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The amount of the income."},"amount_type":{"type":"string","example":"net","description":"The type of the amount."},"start_date":{"type":"string","example":"2025-05-08","description":"The start date of the income."},"end_date":{"type":"string","example":"2026-05-08","description":"The end date of the income."},"frequency":{"type":"string","example":"annually","description":"The frequency of the income."},"is_taxable":{"type":"boolean","example":true,"description":"Denotes if the income is taxable or not."},"employment":{"type":"object","properties":{"uuid":{"type":"string","example":"2a805550-51ea-402c-9499-d2abd596256f"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"status":{"type":"string","example":"employed"},"primary":{"type":"boolean","example":true},"occupation":{"type":"string","example":"Financial Adviser"},"occupation_code":{"type":"string","example":"FAC02774"},"job_title":{"type":"string","example":"Senior financial adviser"},"employer":{"type":"string","example":"Plannr Technologies Ltd"},"started_at":{"type":"string","example":"2021-05-08T14:41:56+01:00"},"ended_at":{"type":"string","example":"2022-05-08T14:41:56+01:00"},"is_business_owner":{"type":"boolean","example":true},"percentage_of_business_shared":{"type":"integer","example":50},"address":{"type":"string","example":"App\\Http\\Resources\\AddressResource"},"phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"email_address":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"shared_owner_type":{"type":"string","example":"individual"},"shared_owner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"last_salary_increase":{"type":"string","example":"2019-01-01"},"business_name":{"type":"string","example":"My Business"},"business_year_end":{"type":"string","example":"2020-12-31"},"business_value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"directors":{"type":"string","example":"Susan F. Lancaster"},"shareholding_in_business":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"profit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"accountant_company_name":{"type":"string","example":"My Accountant"},"accountant_email":{"type":"string","example":"accountant@email.com"},"accountant_telephone_number":{"type":"string","example":"+441234567890"},"accountant_address":{"type":"string","example":"23 Chollerton, Hexham, Northumberland, NE46 4TF"},"turnover_history":{"type":"string","example":"App\\Http\\Resources\\TurnoverHistoryResource"},"income":{"type":"string","example":"App\\Http\\Resources\\IncomeResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}},"description":"Employment of this income."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"159260c9-b1e6-46cb-9e41-a3e991b226b0"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that owns this income."}},"example":{"uuid":"829834ab-38c3-4e56-9ac4-418989e71247","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"My Salary","type":"salary","type_other":"Other income type","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount_type":"net","start_date":"2025-05-08","end_date":"2026-05-08","frequency":"annually","is_taxable":true,"employment":{"uuid":"2a805550-51ea-402c-9499-d2abd596256f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","status":"employed","primary":true,"occupation":"Financial Adviser","occupation_code":"FAC02774","job_title":"Senior financial adviser","employer":"Plannr Technologies Ltd","started_at":"2021-05-08T14:41:56+01:00","ended_at":"2022-05-08T14:41:56+01:00","is_business_owner":true,"percentage_of_business_shared":50,"address":"App\\Http\\Resources\\AddressResource","phone_number":"App\\Http\\Resources\\ContactDetailResource","email_address":"App\\Http\\Resources\\ContactDetailResource","shared_owner_type":"individual","shared_owner":"App\\Http\\Resources\\AccountResource","last_salary_increase":"2019-01-01","business_name":"My Business","business_year_end":"2020-12-31","business_value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"directors":"Susan F. Lancaster","shareholding_in_business":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"profit":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"accountant_company_name":"My Accountant","accountant_email":"accountant@email.com","accountant_telephone_number":"+441234567890","accountant_address":"23 Chollerton, Hexham, Northumberland, NE46 4TF","turnover_history":"App\\Http\\Resources\\TurnoverHistoryResource","income":"App\\Http\\Resources\\IncomeResource","account":"App\\Http\\Resources\\MinimalAccountResource"},"account":{"uuid":"159260c9-b1e6-46cb-9e41-a3e991b226b0","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_ExpectationWithReconciliationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"10034143-6d1e-4840-86b4-c3b36704732a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"payment_origin":{"type":"string","example":"provider","description":"Who you expect to be paying this expectation"},"type":{"type":"string","example":"fee","description":"Expectation type, fee or commission"},"category":{"type":"string","example":"ongoing_fee","description":"Expectation category, used for accurate reporting"},"expected_payment_date":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Expected payment date of expectation"},"tax_exempt":{"type":"boolean","example":true,"description":"Denotes if this expectation is tax exempt"},"tax":{"type":"integer","example":20,"description":"Tax percentage that was applied to this expectation"},"recurring":{"type":"boolean","example":true,"description":"Denotes if this expectation is from a recurring charge"},"is_balanced":{"type":"boolean","example":false,"description":"Denotes if the expected amount has been balanced to the reconciled amount"},"unbalanced_expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The unbalanced amount the expectation is expected to received"},"expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Amount the expectation is expected to be received"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Gross amount the expectation is expected to be received"},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Net amount the expectation is expected to be received"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Amount that was entered for the charge"},"percentage":{"type":"number","example":0.75,"description":"Percentage of plans value that was entered for the charge"},"exclude_from_rmar":{"type":"boolean","example":true,"description":"Denotes if this expectation will be excluded from RMAR"},"rmar_type":{"type":"string","example":"adviser_charge","description":"RMAR type"},"advice_type":{"type":"string","example":"independent","description":"Advice type"},"service_type":{"type":"string","example":"initial","description":"Service type"},"advice_area_gross":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}},"description":"RMAR advice area gross values."},"advice_area_net":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}},"description":"RMAR advice area net values."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"356640dd-61a3-4b73-9aed-e344818590d7"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Client this expectation belongs to"},"seller":{"type":"object","properties":{"uuid":{"type":"string","example":"778068d2-090d-46b0-8790-f4012b139bde"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Adviser who sold this expectation"},"author":{"type":"object","properties":{"uuid":{"type":"string","example":"1c8b9ac6-f949-4d06-8469-ed033e156e6c"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Adviser who created the charge of this expectation"},"charge_schedule":{"type":"object","properties":{"uuid":{"type":"string","example":"9b054102-594b-4004-94ed-90310aa8f8e0"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"payment_origin":{"type":"string","example":"provider"},"type":{"type":"string","example":"fee"},"category":{"type":"string","example":"ongoing_fee"},"recurring":{"type":"boolean","example":true},"frequency":{"type":"string","example":"monthly"},"start_date":{"type":"string","example":"2025-09-08"},"end_date":{"type":"string","example":"2026-06-08"},"next_expectation_date":{"type":"string","example":"2026-05-18"},"tax_exempt":{"type":"boolean","example":false},"tax":{"type":"number","example":17.5},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"number","example":0.75},"percentage_frequency":{"type":"string","example":"annually"},"charge_identifier":{"type":"string","example":"PLANNR-72484"},"exclude_from_rmar":{"type":"boolean","example":true},"rmar_type":{"type":"string","example":"adviser_charge"},"advice_type":{"type":"string","example":"independent"},"service_type":{"type":"string","example":"initial"},"advice_area":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"plan_value":{"type":"string","example":"plan"},"chargeable_type":{"type":"object","properties":{"amount":{"type":"string","example":"12000000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£120,000.00"}}},"chargeable":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"author":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"premium":{"type":"string","example":"App\\Http\\Resources\\Plans\\PremiumResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"notes_count":{"type":"integer","example":5}},"description":"The expectation schedule for a recurring expectation"},"chargeable_type":{"type":"string","example":"plan","description":"Model type this expectation belongs to"},"chargeable":{"type":"object","properties":{"uuid":{"type":"string","example":"a365b963-cd73-4983-a013-e6a6e5e27927"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Model this expectation belongs to e.g. plan"},"statement_transactions":{"type":"array","example":[{"uuid":"fc371635-f208-426a-959e-11fd36b65345","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"rP7QRyb3o7","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"Payments used to reconcile the expectation","items":{"type":"object","properties":{"uuid":{"type":"string","example":"fc371635-f208-426a-959e-11fd36b65345"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"client_name":{"type":"string","example":"Gareth Thompson"},"transaction_reference":{"type":"string","example":"rP7QRyb3o7"},"policy_number":{"type":"string","example":"AVIVA_00001"},"date":{"type":"string","example":"2026-05-08"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"category":{"type":"string","example":"initial_fee"},"payment_origin":{"type":"string","example":"provider"},"agency_number":{"type":"string","example":"Agency number"},"product_reference":{"type":"string","example":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number"},"reason":{"type":"string","example":"Reason"},"scheme_name":{"type":"string","example":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number"},"customer_number":{"type":"string","example":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value"},"provider":{"type":"string","example":"Aviva"},"provider_statement":{"type":"string","example":"App\\Http\\Resources\\ProviderStatementResource"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"expectation":{"type":"string","example":"App\\Http\\Resources\\ExpectationResource"},"bank_transactions":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"ed656197-1450-4d9f-8234-fc9e4daf89f0"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"The statement period this expectation belongs to"},"income_splits":{"type":"array","example":[{"splitable_type":"account","splitable_uuid":"18eba9c0-f94d-4353-8259-fd3cf36ce4b3","type":"selling_adviser","name":"Gareth Thompson","requested_percentage":70,"percentage":70,"expected_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_gross_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_net_amount":{"amount":"10400","currency":"GBP","formatted":"£104.00"},"expected_fci_recognition":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"reconciled_gross_amount":{"amount":"11483","currency":"GBP","formatted":"£114.83"},"reconciled_net_amount":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"reconciled_fci_recognition":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"bank_receipt_date":"2026-05-08"}],"description":"Details of who will be receiving what of this expectation","items":{"type":"object","properties":{"splitable_type":{"type":"string","example":"account"},"splitable_uuid":{"type":"string","example":"18eba9c0-f94d-4353-8259-fd3cf36ce4b3"},"type":{"type":"string","example":"selling_adviser"},"name":{"type":"string","example":"Gareth Thompson"},"requested_percentage":{"type":"integer","example":70},"percentage":{"type":"integer","example":70},"expected_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12500"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£125.00"}}},"expected_gross_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12500"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£125.00"}}},"expected_net_amount":{"type":"object","properties":{"amount":{"type":"string","example":"10400"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£104.00"}}},"expected_fci_recognition":{"type":"object","properties":{"amount":{"type":"string","example":"12500"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£125.00"}}},"reconciled_gross_amount":{"type":"object","properties":{"amount":{"type":"string","example":"11483"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£114.83"}}},"reconciled_net_amount":{"type":"object","properties":{"amount":{"type":"string","example":"9569"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£95.69"}}},"reconciled_fci_recognition":{"type":"object","properties":{"amount":{"type":"string","example":"9569"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£95.69"}}},"bank_receipt_date":{"type":"string","example":"2026-05-08"}}}},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"2fabe435-b292-4b36-85a7-daa7266a8e80"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm this expectation schedule belongs to"},"notes_count":{"type":"integer","example":5,"description":"Notes count"},"reconciliation":{"type":"object","properties":{"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"integer","example":100},"is_reconciled":{"type":"boolean","example":true}},"description":"The amount that the expectation has been reconciled to statement transactions."}},"example":{"uuid":"10034143-6d1e-4840-86b4-c3b36704732a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","expected_payment_date":"2026-05-08T14:41:55+01:00","tax_exempt":true,"tax":20,"recurring":true,"is_balanced":false,"unbalanced_expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area_gross":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"advice_area_net":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"account":{"uuid":"356640dd-61a3-4b73-9aed-e344818590d7","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"seller":{"uuid":"778068d2-090d-46b0-8790-f4012b139bde","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"author":{"uuid":"1c8b9ac6-f949-4d06-8469-ed033e156e6c","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"charge_schedule":{"uuid":"9b054102-594b-4004-94ed-90310aa8f8e0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","recurring":true,"frequency":"monthly","start_date":"2025-09-08","end_date":"2026-06-08","next_expectation_date":"2026-05-18","tax_exempt":false,"tax":17.5,"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"percentage_frequency":"annually","charge_identifier":"PLANNR-72484","exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"plan_value":"plan","chargeable_type":{"amount":"12000000","currency":"GBP","formatted":"£120,000.00"},"chargeable":"App\\Http\\Resources\\Plans\\PlanResource","account":"App\\Http\\Resources\\AccountResource","author":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","premium":"App\\Http\\Resources\\Plans\\PremiumResource","firm":"App\\Http\\Resources\\FirmResource","notes_count":5},"chargeable_type":"plan","chargeable":{"uuid":"a365b963-cd73-4983-a013-e6a6e5e27927","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"statement_transactions":[{"uuid":"fc371635-f208-426a-959e-11fd36b65345","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"rP7QRyb3o7","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"statement":{"uuid":"ed656197-1450-4d9f-8234-fc9e4daf89f0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"income_splits":[{"splitable_type":"account","splitable_uuid":"18eba9c0-f94d-4353-8259-fd3cf36ce4b3","type":"selling_adviser","name":"Gareth Thompson","requested_percentage":70,"percentage":70,"expected_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_gross_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_net_amount":{"amount":"10400","currency":"GBP","formatted":"£104.00"},"expected_fci_recognition":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"reconciled_gross_amount":{"amount":"11483","currency":"GBP","formatted":"£114.83"},"reconciled_net_amount":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"reconciled_fci_recognition":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"bank_receipt_date":"2026-05-08"}],"firm":{"uuid":"2fabe435-b292-4b36-85a7-daa7266a8e80","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"notes_count":5,"reconciliation":{"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":100,"is_reconciled":true}}},"App_Http_Resources_StatementTransactionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3c121772-12e2-4bd8-950b-d4fc71573b3b","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"client_name":{"type":"string","example":"Gareth Thompson","description":"Client name"},"transaction_reference":{"type":"string","example":"lfWQoCfTHb","description":"Unique statement transactions reference assigned by the provider"},"policy_number":{"type":"string","example":"AVIVA_00001","description":"Provider reference of the plan the statement transactions belongs to"},"date":{"type":"string","example":"2026-05-08","description":"Date of when the provider received the statement transactions"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Net amount"},"category":{"type":"string","example":"initial_fee","description":"Expected payment category for accurate reporting"},"payment_origin":{"type":"string","example":"provider","description":"Who is expected to pay this statement transactions"},"agency_number":{"type":"string","example":"Agency number","description":"Agency number"},"product_reference":{"type":"string","example":"Product reference","description":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name","description":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number","description":"Sender id sib number"},"reason":{"type":"string","example":"Reason","description":"Reason"},"scheme_name":{"type":"string","example":"Scheme name","description":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number","description":"Scheme number"},"customer_number":{"type":"string","example":"Customer number","description":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value","description":"Policy market value"},"provider":{"type":"string","example":"Aviva","description":"Provider this statement transaction belongs to if provided"},"provider_statement":{"type":"object","properties":{"uuid":{"type":"string","example":"041bd2ca-c3f1-448d-844c-b45e891cbd69"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"number":{"type":"integer","example":23},"name":{"type":"string","example":"Aviva"},"date":{"type":"string","example":"2026-05-08"},"reference":{"type":"string","example":"SW#8434"},"filename":{"type":"string","example":"aviva-statement-may.csv"},"origin":{"type":"string","example":"upload"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"},"total_amount":{"type":"object","properties":{"amount":{"type":"string","example":"345895"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£3,458.95"}}},"reconciled_expectations_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12849"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£128.49"}}},"reconciled_expectations_percentage":{"type":"number","example":95.68},"reconciled_bank_transactions_amount":{"type":"object","properties":{"amount":{"type":"string","example":"22985"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£229.85"}}},"reconciled_bank_transactions_percentage":{"type":"number","example":95.68},"is_fully_reconciled_to_expectations":{"type":"boolean","example":true}},"description":"Provider statement this statement transaction belongs to"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}},"description":"Any metadata that was saved during a CSV import for statement transactions"},"expectation":{"type":"object","properties":{"uuid":{"type":"string","example":"98d789d1-4a19-4292-8d24-84ff573778be"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"payment_origin":{"type":"string","example":"provider"},"type":{"type":"string","example":"fee"},"category":{"type":"string","example":"ongoing_fee"},"expected_payment_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"tax_exempt":{"type":"boolean","example":true},"tax":{"type":"integer","example":20},"recurring":{"type":"boolean","example":true},"is_balanced":{"type":"boolean","example":false},"unbalanced_expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"number","example":0.75},"exclude_from_rmar":{"type":"boolean","example":true},"rmar_type":{"type":"string","example":"adviser_charge"},"advice_type":{"type":"string","example":"independent"},"service_type":{"type":"string","example":"initial"},"advice_area_gross":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"advice_area_net":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"author":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"charge_schedule":{"type":"string","example":"App\\Http\\Resources\\ChargeResource"},"chargeable_type":{"type":"string","example":"plan"},"chargeable":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"income_splits":{"type":"string","example":"App\\Http\\Resources\\IncomeSplitResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"notes_count":{"type":"integer","example":5}},"description":"The expectation that the statement transaction has been reconciled against"},"bank_transactions":{"type":"array","example":[{"uuid":"4a57372c-96ce-4605-883d-ce72a5106bcb","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"The bank payments used to reconcile this statement transaction","items":{"type":"object","properties":{"uuid":{"type":"string","example":"4a57372c-96ce-4605-883d-ce72a5106bcb"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"date":{"type":"string","example":"2022-07-15"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"12399"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£123.99"}}},"reference":{"type":"string","example":"VitalityLtd"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"filename":{"type":"string","example":"Natwest June 2022 Statement.xlsx"},"bank_statement":{"type":"string","example":"App\\Http\\Resources\\BankStatementResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"9b864d3e-0e10-4c33-af8d-ab2d2ec4f3d5"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"The statement period this statement transaction belongs to"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"2b9c8f4d-1aa5-4767-8810-76b377c94d2c"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that created this statement transaction"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"7abfb2b7-e568-41cb-8db9-02451a195b2e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm this statement transaction belongs to"}},"example":{"uuid":"3c121772-12e2-4bd8-950b-d4fc71573b3b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"lfWQoCfTHb","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":{"uuid":"041bd2ca-c3f1-448d-844c-b45e891cbd69","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","number":23,"name":"Aviva","date":"2026-05-08","reference":"SW#8434","filename":"aviva-statement-may.csv","origin":"upload","provider":"App\\Http\\Resources\\Plans\\ProviderResource","statement":"App\\Http\\Resources\\StatementResource","statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource","total_amount":{"amount":"345895","currency":"GBP","formatted":"£3,458.95"},"reconciled_expectations_amount":{"amount":"12849","currency":"GBP","formatted":"£128.49"},"reconciled_expectations_percentage":95.68,"reconciled_bank_transactions_amount":{"amount":"22985","currency":"GBP","formatted":"£229.85"},"reconciled_bank_transactions_percentage":95.68,"is_fully_reconciled_to_expectations":true},"metadata":{"client_name":"Gareth Thompson"},"expectation":{"uuid":"98d789d1-4a19-4292-8d24-84ff573778be","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","expected_payment_date":"2026-05-08T14:41:55+01:00","tax_exempt":true,"tax":20,"recurring":true,"is_balanced":false,"unbalanced_expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area_gross":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"advice_area_net":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"account":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","author":"App\\Http\\Resources\\AccountResource","charge_schedule":"App\\Http\\Resources\\ChargeResource","chargeable_type":"plan","chargeable":"App\\Http\\Resources\\Plans\\PlanResource","statement_transactions":"App\\Http\\Resources\\StatementTransactionResource","statement":"App\\Http\\Resources\\StatementResource","income_splits":"App\\Http\\Resources\\IncomeSplitResource","firm":"App\\Http\\Resources\\FirmResource","notes_count":5},"bank_transactions":[{"uuid":"4a57372c-96ce-4605-883d-ce72a5106bcb","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"statement":{"uuid":"9b864d3e-0e10-4c33-af8d-ab2d2ec4f3d5","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"account":{"uuid":"2b9c8f4d-1aa5-4767-8810-76b377c94d2c","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"firm":{"uuid":"7abfb2b7-e568-41cb-8db9-02451a195b2e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"}}},"App_Http_Resources_ProviderStatementResource":{"type":"object","properties":{"uuid":{"type":"string","example":"c602f346-15a4-4ef8-a952-ee456b27c18a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"number":{"type":"integer","example":23,"description":"Provider statement number"},"name":{"type":"string","example":"Aviva","description":"Provider name"},"date":{"type":"string","example":"2026-05-08","description":"Provider statement date"},"reference":{"type":"string","example":"SW#8434","description":"provider statement reference given by provider"},"filename":{"type":"string","example":"aviva-statement-may.csv","description":"Filename if uploaded by CSV or automatically from EDI"},"origin":{"type":"string","example":"upload","description":"how the provider statement was created. Values are edi, manual, upload and auto"},"provider":{"type":"object","properties":{"uuid":{"type":"string","example":"c49d95e5-cfce-4ac5-910c-3c5db24062cf"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"AJ Bell"},"slug":{"type":"string","example":"aj-bell"}},"description":"Provider"},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"d6e9fac1-1687-4d94-82c8-981dbedc2bfd"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"Statement"},"statement_transactions_count":{"type":"integer","example":6,"description":"Total number of statement transactions within provider statement"},"statement_transactions":{"type":"array","example":[{"uuid":"c6b66a71-d2d0-4313-8970-7160f61245fb","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"dPltCvBuUl","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"Statement transactions within provider statement","items":{"type":"object","properties":{"uuid":{"type":"string","example":"c6b66a71-d2d0-4313-8970-7160f61245fb"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"client_name":{"type":"string","example":"Gareth Thompson"},"transaction_reference":{"type":"string","example":"dPltCvBuUl"},"policy_number":{"type":"string","example":"AVIVA_00001"},"date":{"type":"string","example":"2026-05-08"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"category":{"type":"string","example":"initial_fee"},"payment_origin":{"type":"string","example":"provider"},"agency_number":{"type":"string","example":"Agency number"},"product_reference":{"type":"string","example":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number"},"reason":{"type":"string","example":"Reason"},"scheme_name":{"type":"string","example":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number"},"customer_number":{"type":"string","example":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value"},"provider":{"type":"string","example":"Aviva"},"provider_statement":{"type":"string","example":"App\\Http\\Resources\\ProviderStatementResource"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"expectation":{"type":"string","example":"App\\Http\\Resources\\ExpectationResource"},"bank_transactions":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}},"total_amount":{"type":"object","properties":{"amount":{"type":"string","example":"345895"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£3,458.95"}},"description":"Total amount of all statement transactions within this provider statement"},"reconciled_expectations_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12849"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£128.49"}},"description":"Total amount reconciled against expectations"},"reconciled_expectations_percentage":{"type":"number","example":95.68,"description":"Total percentage reconciled against expectations"},"reconciled_bank_transactions_amount":{"type":"object","properties":{"amount":{"type":"string","example":"22985"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£229.85"}},"description":"Total amount reconciled against bank transactions"},"reconciled_bank_transactions_percentage":{"type":"number","example":95.68,"description":"Total percentage reconciled against bank transactions"},"is_fully_reconciled_to_expectations":{"type":"boolean","example":true,"description":"Returns if all statement transactions are fully reconciled to expectations"}},"example":{"uuid":"c602f346-15a4-4ef8-a952-ee456b27c18a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","number":23,"name":"Aviva","date":"2026-05-08","reference":"SW#8434","filename":"aviva-statement-may.csv","origin":"upload","provider":{"uuid":"c49d95e5-cfce-4ac5-910c-3c5db24062cf","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"AJ Bell","slug":"aj-bell"},"statement":{"uuid":"d6e9fac1-1687-4d94-82c8-981dbedc2bfd","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"statement_transactions_count":6,"statement_transactions":[{"uuid":"c6b66a71-d2d0-4313-8970-7160f61245fb","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"dPltCvBuUl","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"total_amount":{"amount":"345895","currency":"GBP","formatted":"£3,458.95"},"reconciled_expectations_amount":{"amount":"12849","currency":"GBP","formatted":"£128.49"},"reconciled_expectations_percentage":95.68,"reconciled_bank_transactions_amount":{"amount":"22985","currency":"GBP","formatted":"£229.85"},"reconciled_bank_transactions_percentage":95.68,"is_fully_reconciled_to_expectations":true}},"App_Http_Resources_BankStatementResource":{"type":"object","properties":{"uuid":{"type":"string","example":"a9c69f8e-bcb8-48ac-9aaa-59fa5c9bea9f","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"number":{"type":"integer","example":23,"description":"Bank statement number"},"reference":{"type":"string","example":"SW#8434","description":"Bank statement reference given by bank statement"},"date":{"type":"string","example":"2026-05-08","description":"Bank statement date"},"name":{"type":"string","example":"Aviva","description":"Bank statement name"},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"684369a0-6983-4f1b-b12c-2fb6423c234f"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"Statement"},"bank_transactions_count":{"type":"integer","example":6,"description":"Total number of bank transactions within bank statement"},"bank_transactions":{"type":"array","example":[{"uuid":"ab14d28c-91e6-4d3f-9082-c3c29c24e00b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"Bank transactions within bank statement","items":{"type":"object","properties":{"uuid":{"type":"string","example":"ab14d28c-91e6-4d3f-9082-c3c29c24e00b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"date":{"type":"string","example":"2022-07-15"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"12399"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£123.99"}}},"reference":{"type":"string","example":"VitalityLtd"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"filename":{"type":"string","example":"Natwest June 2022 Statement.xlsx"},"bank_statement":{"type":"string","example":"App\\Http\\Resources\\BankStatementResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}},"total_amount":{"type":"object","properties":{"amount":{"type":"string","example":"345895"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£3,458.95"}},"description":"Total amount of all bank transactions within this bank statement"},"reconciled_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12849"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£128.49"}},"description":"Total amount reconciled"},"reconciled_percentage":{"type":"number","example":95.68,"description":"Total percentage reconciled"}},"example":{"uuid":"a9c69f8e-bcb8-48ac-9aaa-59fa5c9bea9f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","number":23,"reference":"SW#8434","date":"2026-05-08","name":"Aviva","statement":{"uuid":"684369a0-6983-4f1b-b12c-2fb6423c234f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"bank_transactions_count":6,"bank_transactions":[{"uuid":"ab14d28c-91e6-4d3f-9082-c3c29c24e00b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"total_amount":{"amount":"345895","currency":"GBP","formatted":"£3,458.95"},"reconciled_amount":{"amount":"12849","currency":"GBP","formatted":"£128.49"},"reconciled_percentage":95.68}},"App_Http_Resources_ChargeResource":{"type":"object","properties":{"uuid":{"type":"string","example":"8f285965-7a60-42b8-8668-031dfb3603b7"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"payment_origin":{"type":"string","example":"provider"},"type":{"type":"string","example":"fee"},"category":{"type":"string","example":"ongoing_fee"},"recurring":{"type":"boolean","example":true},"frequency":{"type":"string","example":"monthly"},"start_date":{"type":"string","example":"2025-09-08"},"end_date":{"type":"string","example":"2026-06-08"},"next_expectation_date":{"type":"string","example":"2026-05-18"},"tax_exempt":{"type":"boolean","example":false},"tax":{"type":"number","example":17.5},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"number","example":0.75},"percentage_frequency":{"type":"string","example":"annually"},"charge_identifier":{"type":"string","example":"PLANNR-72484"},"exclude_from_rmar":{"type":"boolean","example":true},"rmar_type":{"type":"string","example":"adviser_charge"},"advice_type":{"type":"string","example":"independent"},"service_type":{"type":"string","example":"initial"},"advice_area":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"plan_value":{"type":"string","example":"plan"},"chargeable_type":{"type":"object","properties":{"amount":{"type":"string","example":"12000000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£120,000.00"}}},"chargeable":{"type":"object","properties":{"uuid":{"type":"string","example":"fc48f21e-31be-4c5a-9640-314c4cd8768d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"61f78bdc-5018-48e5-92d1-cf01e9d93581"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"author":{"type":"object","properties":{"uuid":{"type":"string","example":"3e02f8a4-c60e-4dca-9260-53d638f376ef"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"seller":{"type":"object","properties":{"uuid":{"type":"string","example":"010b1386-0690-44f8-8943-0ecd9b781565"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"premium":{"type":"object","properties":{"uuid":{"type":"string","example":"72a0bef8-b0c6-4117-8944-3c1f8d033358"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"transfer_type":{"type":"string","example":"transfer"},"date_of_transfer_valuation":{"type":"string","example":"2025-12-20"},"date_advice_given":{"type":"string","example":"2025-11-15"},"premium":{"type":"integer","example":74584},"premium_monthly":{"type":"integer","example":298336},"premium_annually":{"type":"integer","example":3580032},"total_premium_to_date":{"type":"integer","example":74584},"amount":{"type":"integer","example":74584},"percentage":{"type":"number","example":5.5},"frequency":{"type":"string","example":"weekly"},"source":{"type":"string","example":"employee"},"payment_method":{"type":"string","example":"direct_debit"},"start_date":{"type":"string","example":"2026-03-24"},"end_date":{"type":"string","example":"2028-05-08"},"pensionable_salary":{"type":"integer","example":10000000},"details":{"type":"string","example":"Extra premium details"},"created_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"transferred_from_plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"transferred_from_plan_type":{"type":"string","example":"cash_account"},"transferred_from_plan_sub_type":{"type":"string","example":"cash_deposit"}}},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"994397b4-d091-40aa-b5b8-012926702501"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}}},"notes_count":{"type":"integer","example":5}},"example":[{"uuid":"8f285965-7a60-42b8-8668-031dfb3603b7","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","recurring":true,"frequency":"monthly","start_date":"2025-09-08","end_date":"2026-06-08","next_expectation_date":"2026-05-18","tax_exempt":false,"tax":17.5,"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"percentage_frequency":"annually","charge_identifier":"PLANNR-72484","exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"plan_value":"plan","chargeable_type":{"amount":"12000000","currency":"GBP","formatted":"£120,000.00"},"chargeable":{"uuid":"fc48f21e-31be-4c5a-9640-314c4cd8768d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"account":{"uuid":"61f78bdc-5018-48e5-92d1-cf01e9d93581","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"author":{"uuid":"3e02f8a4-c60e-4dca-9260-53d638f376ef","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"seller":{"uuid":"010b1386-0690-44f8-8943-0ecd9b781565","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"premium":{"uuid":"72a0bef8-b0c6-4117-8944-3c1f8d033358","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","transfer_type":"transfer","date_of_transfer_valuation":"2025-12-20","date_advice_given":"2025-11-15","premium":74584,"premium_monthly":298336,"premium_annually":3580032,"total_premium_to_date":74584,"amount":74584,"percentage":5.5,"frequency":"weekly","source":"employee","payment_method":"direct_debit","start_date":"2026-03-24","end_date":"2028-05-08","pensionable_salary":10000000,"details":"Extra premium details","created_by":"App\\Http\\Resources\\AccountResource","plan":"App\\Http\\Resources\\Plans\\PlanResource","transferred_from_plan":"App\\Http\\Resources\\Plans\\PlanResource","transferred_from_plan_type":"cash_account","transferred_from_plan_sub_type":"cash_deposit"},"firm":{"uuid":"994397b4-d091-40aa-b5b8-012926702501","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"notes_count":5}]},"App_Http_Resources_StatementTransactionWithReconciliationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"10c8cdae-ae5d-4c4f-bb79-561a03d5c2b6","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"client_name":{"type":"string","example":"Gareth Thompson","description":"Client name"},"transaction_reference":{"type":"string","example":"sGzW88k4dN","description":"Unique statement transactions reference assigned by the provider"},"policy_number":{"type":"string","example":"AVIVA_00001","description":"Provider reference of the plan the statement transactions belongs to"},"date":{"type":"string","example":"2026-05-08","description":"Date of when the provider received the statement transactions"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Net amount"},"category":{"type":"string","example":"initial_fee","description":"Expected payment category for accurate reporting"},"payment_origin":{"type":"string","example":"provider","description":"Who is expected to pay this statement transactions"},"agency_number":{"type":"string","example":"Agency number","description":"Agency number"},"product_reference":{"type":"string","example":"Product reference","description":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name","description":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number","description":"Sender id sib number"},"reason":{"type":"string","example":"Reason","description":"Reason"},"scheme_name":{"type":"string","example":"Scheme name","description":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number","description":"Scheme number"},"customer_number":{"type":"string","example":"Customer number","description":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value","description":"Policy market value"},"provider":{"type":"string","example":"Aviva","description":"Provider this statement transaction belongs to if provided"},"provider_statement":{"type":"object","properties":{"uuid":{"type":"string","example":"cdfa0727-aef9-45d0-add5-b54da67869fe"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"number":{"type":"integer","example":23},"name":{"type":"string","example":"Aviva"},"date":{"type":"string","example":"2026-05-08"},"reference":{"type":"string","example":"SW#8434"},"filename":{"type":"string","example":"aviva-statement-may.csv"},"origin":{"type":"string","example":"upload"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"},"total_amount":{"type":"object","properties":{"amount":{"type":"string","example":"345895"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£3,458.95"}}},"reconciled_expectations_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12849"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£128.49"}}},"reconciled_expectations_percentage":{"type":"number","example":95.68},"reconciled_bank_transactions_amount":{"type":"object","properties":{"amount":{"type":"string","example":"22985"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£229.85"}}},"reconciled_bank_transactions_percentage":{"type":"number","example":95.68},"is_fully_reconciled_to_expectations":{"type":"boolean","example":true}},"description":"Provider statement this statement transaction belongs to"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}},"description":"Any metadata that was saved during a CSV import for statement transactions"},"expectation":{"type":"object","properties":{"uuid":{"type":"string","example":"43897753-fb13-407b-989d-e9e13d7af502"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"payment_origin":{"type":"string","example":"provider"},"type":{"type":"string","example":"fee"},"category":{"type":"string","example":"ongoing_fee"},"expected_payment_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"tax_exempt":{"type":"boolean","example":true},"tax":{"type":"integer","example":20},"recurring":{"type":"boolean","example":true},"is_balanced":{"type":"boolean","example":false},"unbalanced_expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"number","example":0.75},"exclude_from_rmar":{"type":"boolean","example":true},"rmar_type":{"type":"string","example":"adviser_charge"},"advice_type":{"type":"string","example":"independent"},"service_type":{"type":"string","example":"initial"},"advice_area_gross":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"advice_area_net":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"author":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"charge_schedule":{"type":"string","example":"App\\Http\\Resources\\ChargeResource"},"chargeable_type":{"type":"string","example":"plan"},"chargeable":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"income_splits":{"type":"string","example":"App\\Http\\Resources\\IncomeSplitResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"notes_count":{"type":"integer","example":5}},"description":"The expectation that the statement transaction has been reconciled against"},"bank_transactions":{"type":"array","example":[{"uuid":"0d7cf2e2-4617-4d61-80d3-178912b48732","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"The bank payments used to reconcile this statement transaction","items":{"type":"object","properties":{"uuid":{"type":"string","example":"0d7cf2e2-4617-4d61-80d3-178912b48732"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"date":{"type":"string","example":"2022-07-15"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"12399"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£123.99"}}},"reference":{"type":"string","example":"VitalityLtd"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"filename":{"type":"string","example":"Natwest June 2022 Statement.xlsx"},"bank_statement":{"type":"string","example":"App\\Http\\Resources\\BankStatementResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"836331c3-91bc-4bd9-b451-82b652c49f5b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"The statement period this statement transaction belongs to"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"143bc957-3ea4-4454-9df7-602923a8f480"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that created this statement transaction"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"52ca1c42-9dd5-4867-b887-b0e9df18154e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm this statement transaction belongs to"},"reconciliation":{"type":"object","properties":{"bank_transaction_reconciliation_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"bank_transaction_reconciliation_percentage":{"type":"integer","example":100},"is_fully_reconciled_with_bank_transactions":{"type":"boolean","example":true},"expectation_reconciliation_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"expectation_reconciliation_percentage":{"type":"integer","example":50},"is_reconciled_with_expectation":{"type":"boolean","example":false},"is_fully_reconciled_with_expectations":{"type":"boolean","example":false}},"description":"The reconciliation amount to both expectations and bank transactions"},"bank_transaction_reconciliations":{"type":"object","properties":{"uuid":{"type":"string","example":"5e827586-20bf-470e-b266-c00eaee3a073"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"statement_transaction":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"},"bank_transaction":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The individual reconciliations against the statement transaction for bank transactions"}},"example":{"uuid":"10c8cdae-ae5d-4c4f-bb79-561a03d5c2b6","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"sGzW88k4dN","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":{"uuid":"cdfa0727-aef9-45d0-add5-b54da67869fe","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","number":23,"name":"Aviva","date":"2026-05-08","reference":"SW#8434","filename":"aviva-statement-may.csv","origin":"upload","provider":"App\\Http\\Resources\\Plans\\ProviderResource","statement":"App\\Http\\Resources\\StatementResource","statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource","total_amount":{"amount":"345895","currency":"GBP","formatted":"£3,458.95"},"reconciled_expectations_amount":{"amount":"12849","currency":"GBP","formatted":"£128.49"},"reconciled_expectations_percentage":95.68,"reconciled_bank_transactions_amount":{"amount":"22985","currency":"GBP","formatted":"£229.85"},"reconciled_bank_transactions_percentage":95.68,"is_fully_reconciled_to_expectations":true},"metadata":{"client_name":"Gareth Thompson"},"expectation":{"uuid":"43897753-fb13-407b-989d-e9e13d7af502","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","expected_payment_date":"2026-05-08T14:41:55+01:00","tax_exempt":true,"tax":20,"recurring":true,"is_balanced":false,"unbalanced_expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area_gross":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"advice_area_net":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"account":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","author":"App\\Http\\Resources\\AccountResource","charge_schedule":"App\\Http\\Resources\\ChargeResource","chargeable_type":"plan","chargeable":"App\\Http\\Resources\\Plans\\PlanResource","statement_transactions":"App\\Http\\Resources\\StatementTransactionResource","statement":"App\\Http\\Resources\\StatementResource","income_splits":"App\\Http\\Resources\\IncomeSplitResource","firm":"App\\Http\\Resources\\FirmResource","notes_count":5},"bank_transactions":[{"uuid":"0d7cf2e2-4617-4d61-80d3-178912b48732","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"statement":{"uuid":"836331c3-91bc-4bd9-b451-82b652c49f5b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"account":{"uuid":"143bc957-3ea4-4454-9df7-602923a8f480","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"firm":{"uuid":"52ca1c42-9dd5-4867-b887-b0e9df18154e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"reconciliation":{"bank_transaction_reconciliation_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"bank_transaction_reconciliation_percentage":100,"is_fully_reconciled_with_bank_transactions":true,"expectation_reconciliation_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"expectation_reconciliation_percentage":50,"is_reconciled_with_expectation":false,"is_fully_reconciled_with_expectations":false},"bank_transaction_reconciliations":{"uuid":"5e827586-20bf-470e-b266-c00eaee3a073","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"statement_transaction":"App\\Http\\Resources\\StatementTransactionResource","bank_transaction":"App\\Http\\Resources\\BankTransactionResource","account":"App\\Http\\Resources\\AccountResource"}}},"App_Http_Resources_BankTransactionWithReconciliationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"20f152db-5f8c-4e3a-8291-ed1cae3e3b53","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"date":{"type":"string","example":"2022-07-15","description":"Transaction date on bank statement"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"12399"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£123.99"}},"description":"Transaction amount"},"reference":{"type":"string","example":"VitalityLtd","description":"Transaction reference on bank statement"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}},"description":"Any metadata that was saved during a CSV import for transactions"},"filename":{"type":"string","example":"Natwest June 2022 Statement.xlsx","description":"Filename of the CSV import transactions"},"bank_statement":{"type":"object","properties":{"uuid":{"type":"string","example":"2e8119fc-14e8-47c5-ac3d-c5fbe010c364"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"number":{"type":"integer","example":23},"reference":{"type":"string","example":"SW#8434"},"date":{"type":"string","example":"2026-05-08"},"name":{"type":"string","example":"Aviva"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"bank_transactions_count":{"type":"integer","example":6},"bank_transactions":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"total_amount":{"type":"object","properties":{"amount":{"type":"string","example":"345895"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£3,458.95"}}},"reconciled_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12849"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£128.49"}}},"reconciled_percentage":{"type":"number","example":95.68}},"description":"Bank statement this bank transaction belongs to"},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"9257ee3c-11c4-4fec-baf4-e1f3bc1af502"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"The statement period this bank transaction belongs to"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"3b800014-76ab-4329-9f29-b2e5f63696db"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that created this bank transaction"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"253078c7-b192-4c4d-ac15-95f5d674ec78"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm this bank transaction belongs to"},"reconciliation":{"type":"object","properties":{"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"integer","example":100},"is_reconciled":{"type":"boolean","example":true}},"description":"The amount that the payment has been reconciled to statement transactions."},"reconciliations":{"type":"object","properties":{"uuid":{"type":"string","example":"d7715f60-9223-4055-b36f-3b8bee267387"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"statement_transaction":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"},"bank_transaction":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"The individual reconciliations against the expected bank payment"}},"example":{"uuid":"20f152db-5f8c-4e3a-8291-ed1cae3e3b53","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":{"uuid":"2e8119fc-14e8-47c5-ac3d-c5fbe010c364","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","number":23,"reference":"SW#8434","date":"2026-05-08","name":"Aviva","statement":"App\\Http\\Resources\\StatementResource","bank_transactions_count":6,"bank_transactions":"App\\Http\\Resources\\BankTransactionResource","total_amount":{"amount":"345895","currency":"GBP","formatted":"£3,458.95"},"reconciled_amount":{"amount":"12849","currency":"GBP","formatted":"£128.49"},"reconciled_percentage":95.68},"statement":{"uuid":"9257ee3c-11c4-4fec-baf4-e1f3bc1af502","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"account":{"uuid":"3b800014-76ab-4329-9f29-b2e5f63696db","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"firm":{"uuid":"253078c7-b192-4c4d-ac15-95f5d674ec78","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"reconciliation":{"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":100,"is_reconciled":true},"reconciliations":{"uuid":"d7715f60-9223-4055-b36f-3b8bee267387","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"statement_transaction":"App\\Http\\Resources\\StatementTransactionResource","bank_transaction":"App\\Http\\Resources\\BankTransactionResource","account":"App\\Http\\Resources\\AccountResource"}}},"App_Http_Resources_ExpectationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"db5cd906-9987-4066-b7f4-7f1cb6e3d8c7","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"payment_origin":{"type":"string","example":"provider","description":"Who you expect to be paying this expectation"},"type":{"type":"string","example":"fee","description":"Expectation type, fee or commission"},"category":{"type":"string","example":"ongoing_fee","description":"Expectation category, used for accurate reporting"},"expected_payment_date":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Expected payment date of expectation"},"tax_exempt":{"type":"boolean","example":true,"description":"Denotes if this expectation is tax exempt"},"tax":{"type":"integer","example":20,"description":"Tax percentage that was applied to this expectation"},"recurring":{"type":"boolean","example":true,"description":"Denotes if this expectation is from a recurring charge"},"is_balanced":{"type":"boolean","example":false,"description":"Denotes if the expected amount has been balanced to the reconciled amount"},"unbalanced_expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The unbalanced amount the expectation is expected to received"},"expected_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Amount the expectation is expected to be received"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Gross amount the expectation is expected to be received"},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Net amount the expectation is expected to be received"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Amount that was entered for the charge"},"percentage":{"type":"number","example":0.75,"description":"Percentage of plans value that was entered for the charge"},"exclude_from_rmar":{"type":"boolean","example":true,"description":"Denotes if this expectation will be excluded from RMAR"},"rmar_type":{"type":"string","example":"adviser_charge","description":"RMAR type"},"advice_type":{"type":"string","example":"independent","description":"Advice type"},"service_type":{"type":"string","example":"initial","description":"Service type"},"advice_area_gross":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}},"description":"RMAR advice area gross values."},"advice_area_net":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}},"description":"RMAR advice area net values."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"be857b02-869b-4b2a-9fce-cefa08a3ce35"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Client this expectation belongs to"},"seller":{"type":"object","properties":{"uuid":{"type":"string","example":"470d390f-cb03-44a8-b441-9c7e5e1fd3e3"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Adviser who sold this expectation"},"author":{"type":"object","properties":{"uuid":{"type":"string","example":"e2a3d68c-e76c-4aca-b5b3-f7569076f0a0"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Adviser who created the charge of this expectation"},"charge_schedule":{"type":"object","properties":{"uuid":{"type":"string","example":"3b16c40e-7983-4b60-979b-2f124828e7aa"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"payment_origin":{"type":"string","example":"provider"},"type":{"type":"string","example":"fee"},"category":{"type":"string","example":"ongoing_fee"},"recurring":{"type":"boolean","example":true},"frequency":{"type":"string","example":"monthly"},"start_date":{"type":"string","example":"2025-09-08"},"end_date":{"type":"string","example":"2026-06-08"},"next_expectation_date":{"type":"string","example":"2026-05-18"},"tax_exempt":{"type":"boolean","example":false},"tax":{"type":"number","example":17.5},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"percentage":{"type":"number","example":0.75},"percentage_frequency":{"type":"string","example":"annually"},"charge_identifier":{"type":"string","example":"PLANNR-72484"},"exclude_from_rmar":{"type":"boolean","example":true},"rmar_type":{"type":"string","example":"adviser_charge"},"advice_type":{"type":"string","example":"independent"},"service_type":{"type":"string","example":"initial"},"advice_area":{"type":"object","properties":{"deposit":{"type":"integer","example":7500},"non_regulated":{"type":"integer","example":0},"non_rmar":{"type":"integer","example":0},"non_investment_insurance":{"type":"integer","example":0},"regulated_mortgage":{"type":"integer","example":2500},"retail_investment":{"type":"integer","example":0},"other_fca_regulated":{"type":"integer","example":0},"unknown":{"type":"integer","example":0}}},"plan_value":{"type":"string","example":"plan"},"chargeable_type":{"type":"object","properties":{"amount":{"type":"string","example":"12000000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£120,000.00"}}},"chargeable":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"author":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"premium":{"type":"string","example":"App\\Http\\Resources\\Plans\\PremiumResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"notes_count":{"type":"integer","example":5}},"description":"The expectation schedule for a recurring expectation"},"chargeable_type":{"type":"string","example":"plan","description":"Model type this expectation belongs to"},"chargeable":{"type":"object","properties":{"uuid":{"type":"string","example":"e908e2b6-8f42-4042-b199-bf7fd0c20704"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Model this expectation belongs to e.g. plan"},"statement_transactions":{"type":"array","example":[{"uuid":"9ae9951e-627a-41ee-8980-5d7981893f5d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"vnn2bWWgXB","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"Payments used to reconcile the expectation","items":{"type":"object","properties":{"uuid":{"type":"string","example":"9ae9951e-627a-41ee-8980-5d7981893f5d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"client_name":{"type":"string","example":"Gareth Thompson"},"transaction_reference":{"type":"string","example":"vnn2bWWgXB"},"policy_number":{"type":"string","example":"AVIVA_00001"},"date":{"type":"string","example":"2026-05-08"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"category":{"type":"string","example":"initial_fee"},"payment_origin":{"type":"string","example":"provider"},"agency_number":{"type":"string","example":"Agency number"},"product_reference":{"type":"string","example":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number"},"reason":{"type":"string","example":"Reason"},"scheme_name":{"type":"string","example":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number"},"customer_number":{"type":"string","example":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value"},"provider":{"type":"string","example":"Aviva"},"provider_statement":{"type":"string","example":"App\\Http\\Resources\\ProviderStatementResource"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"expectation":{"type":"string","example":"App\\Http\\Resources\\ExpectationResource"},"bank_transactions":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}},"statement":{"type":"object","properties":{"uuid":{"type":"string","example":"d66c6719-a85e-48bf-8f98-9b90bf110967"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"01/06/2022 - 30/06/2022"},"start_date":{"type":"string","example":"2022-06-30"},"end_date":{"type":"string","example":"2022-06-01"},"locked":{"type":"boolean","example":false},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"locked_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}}},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}}},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}}},"expectations_count":{"type":"integer","example":6},"statement_transactions_count":{"type":"integer","example":6},"statement_transactions":{"type":"string","example":"App\\Http\\Resources\\StatementTransactionResource"}},"description":"The statement period this expectation belongs to"},"income_splits":{"type":"array","example":[{"splitable_type":"account","splitable_uuid":"8d92b404-c88c-4d9a-bab8-b2b66ac0e489","type":"selling_adviser","name":"Gareth Thompson","requested_percentage":70,"percentage":70,"expected_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_gross_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_net_amount":{"amount":"10400","currency":"GBP","formatted":"£104.00"},"expected_fci_recognition":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"reconciled_gross_amount":{"amount":"11483","currency":"GBP","formatted":"£114.83"},"reconciled_net_amount":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"reconciled_fci_recognition":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"bank_receipt_date":"2026-05-08"}],"description":"Details of who will be receiving what of this expectation","items":{"type":"object","properties":{"splitable_type":{"type":"string","example":"account"},"splitable_uuid":{"type":"string","example":"8d92b404-c88c-4d9a-bab8-b2b66ac0e489"},"type":{"type":"string","example":"selling_adviser"},"name":{"type":"string","example":"Gareth Thompson"},"requested_percentage":{"type":"integer","example":70},"percentage":{"type":"integer","example":70},"expected_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12500"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£125.00"}}},"expected_gross_amount":{"type":"object","properties":{"amount":{"type":"string","example":"12500"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£125.00"}}},"expected_net_amount":{"type":"object","properties":{"amount":{"type":"string","example":"10400"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£104.00"}}},"expected_fci_recognition":{"type":"object","properties":{"amount":{"type":"string","example":"12500"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£125.00"}}},"reconciled_gross_amount":{"type":"object","properties":{"amount":{"type":"string","example":"11483"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£114.83"}}},"reconciled_net_amount":{"type":"object","properties":{"amount":{"type":"string","example":"9569"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£95.69"}}},"reconciled_fci_recognition":{"type":"object","properties":{"amount":{"type":"string","example":"9569"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£95.69"}}},"bank_receipt_date":{"type":"string","example":"2026-05-08"}}}},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"41324df4-bcea-4b22-8105-da46e9eb7dbd"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm this expectation schedule belongs to"},"notes_count":{"type":"integer","example":5,"description":"Notes count"}},"example":{"uuid":"db5cd906-9987-4066-b7f4-7f1cb6e3d8c7","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","expected_payment_date":"2026-05-08T14:41:55+01:00","tax_exempt":true,"tax":20,"recurring":true,"is_balanced":false,"unbalanced_expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"expected_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area_gross":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"advice_area_net":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"account":{"uuid":"be857b02-869b-4b2a-9fce-cefa08a3ce35","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"seller":{"uuid":"470d390f-cb03-44a8-b441-9c7e5e1fd3e3","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"author":{"uuid":"e2a3d68c-e76c-4aca-b5b3-f7569076f0a0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"charge_schedule":{"uuid":"3b16c40e-7983-4b60-979b-2f124828e7aa","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","payment_origin":"provider","type":"fee","category":"ongoing_fee","recurring":true,"frequency":"monthly","start_date":"2025-09-08","end_date":"2026-06-08","next_expectation_date":"2026-05-18","tax_exempt":false,"tax":17.5,"amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"percentage":0.75,"percentage_frequency":"annually","charge_identifier":"PLANNR-72484","exclude_from_rmar":true,"rmar_type":"adviser_charge","advice_type":"independent","service_type":"initial","advice_area":{"deposit":7500,"non_regulated":0,"non_rmar":0,"non_investment_insurance":0,"regulated_mortgage":2500,"retail_investment":0,"other_fca_regulated":0,"unknown":0},"plan_value":"plan","chargeable_type":{"amount":"12000000","currency":"GBP","formatted":"£120,000.00"},"chargeable":"App\\Http\\Resources\\Plans\\PlanResource","account":"App\\Http\\Resources\\AccountResource","author":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","premium":"App\\Http\\Resources\\Plans\\PremiumResource","firm":"App\\Http\\Resources\\FirmResource","notes_count":5},"chargeable_type":"plan","chargeable":{"uuid":"e908e2b6-8f42-4042-b199-bf7fd0c20704","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"statement_transactions":[{"uuid":"9ae9951e-627a-41ee-8980-5d7981893f5d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"vnn2bWWgXB","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"statement":{"uuid":"d66c6719-a85e-48bf-8f98-9b90bf110967","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":"App\\Http\\Resources\\AccountResource","total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":"App\\Http\\Resources\\StatementTransactionResource"},"income_splits":[{"splitable_type":"account","splitable_uuid":"8d92b404-c88c-4d9a-bab8-b2b66ac0e489","type":"selling_adviser","name":"Gareth Thompson","requested_percentage":70,"percentage":70,"expected_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_gross_amount":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"expected_net_amount":{"amount":"10400","currency":"GBP","formatted":"£104.00"},"expected_fci_recognition":{"amount":"12500","currency":"GBP","formatted":"£125.00"},"reconciled_gross_amount":{"amount":"11483","currency":"GBP","formatted":"£114.83"},"reconciled_net_amount":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"reconciled_fci_recognition":{"amount":"9569","currency":"GBP","formatted":"£95.69"},"bank_receipt_date":"2026-05-08"}],"firm":{"uuid":"41324df4-bcea-4b22-8105-da46e9eb7dbd","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"notes_count":5}},"App_Http_Resources_IncomeReconciliation_ReconciliationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"213ee54c-5616-4ae3-aa50-ce840a6c5d69","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The amount that has been reconciled."},"statement_transaction":{"type":"object","properties":{"uuid":{"type":"string","example":"e0a393fa-9260-4642-97da-6e9257507e3e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"client_name":{"type":"string","example":"Gareth Thompson"},"transaction_reference":{"type":"string","example":"NyoJgnYpPg"},"policy_number":{"type":"string","example":"AVIVA_00001"},"date":{"type":"string","example":"2026-05-08"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"category":{"type":"string","example":"initial_fee"},"payment_origin":{"type":"string","example":"provider"},"agency_number":{"type":"string","example":"Agency number"},"product_reference":{"type":"string","example":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number"},"reason":{"type":"string","example":"Reason"},"scheme_name":{"type":"string","example":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number"},"customer_number":{"type":"string","example":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value"},"provider":{"type":"string","example":"Aviva"},"provider_statement":{"type":"string","example":"App\\Http\\Resources\\ProviderStatementResource"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"expectation":{"type":"string","example":"App\\Http\\Resources\\ExpectationResource"},"bank_transactions":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}},"description":"The statement transaction the reconciliation has been made against."},"bank_transaction":{"type":"object","properties":{"uuid":{"type":"string","example":"966dcd07-ed08-4224-a303-47262d07ac88"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"date":{"type":"string","example":"2022-07-15"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"12399"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£123.99"}}},"reference":{"type":"string","example":"VitalityLtd"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"filename":{"type":"string","example":"Natwest June 2022 Statement.xlsx"},"bank_statement":{"type":"string","example":"App\\Http\\Resources\\BankStatementResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}},"description":"The bank transaction this reconciliation is for."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"cb88795b-4d5c-48da-ad29-3af5724b6bcf"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account that created the reconciliation."}},"example":{"uuid":"213ee54c-5616-4ae3-aa50-ce840a6c5d69","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"statement_transaction":{"uuid":"e0a393fa-9260-4642-97da-6e9257507e3e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"NyoJgnYpPg","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"},"bank_transaction":{"uuid":"966dcd07-ed08-4224-a303-47262d07ac88","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","date":"2022-07-15","amount":{"amount":"12399","currency":"GBP","formatted":"£123.99"},"reference":"VitalityLtd","metadata":{"client_name":"Gareth Thompson"},"filename":"Natwest June 2022 Statement.xlsx","bank_statement":"App\\Http\\Resources\\BankStatementResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"},"account":{"uuid":"cb88795b-4d5c-48da-ad29-3af5724b6bcf","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_AdviserSplitResource":{"type":"object","properties":{"uuid":{"type":"string","example":"be6ca5fc-d477-4487-94ba-6147d3da1320","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Trainee Rate","description":"The name of the adviser split"},"firm_percentage":{"type":"integer","example":30,"description":"The percentage held by the firm on a charge"},"adviser_percentage":{"type":"integer","example":30,"description":"The percentage held by the selling adviser on a charge"},"type":{"type":"string","example":"adviser","description":"Whether this adviser split is for an adviser or a plan charge"}},"example":{"uuid":"be6ca5fc-d477-4487-94ba-6147d3da1320","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Trainee Rate","firm_percentage":30,"adviser_percentage":30,"type":"adviser"}},"App_Http_Resources_ChargeSplitSchemaResource":{"type":"object","properties":{"uuid":{"type":"string","example":"d4e0fe20-16bb-4c2c-bcaf-9cf9eb376cec","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Basic Introducer Rate","description":"Introducer split name"},"min_percentage":{"type":"integer","example":10,"description":"Minimum percentage of overall charge introducer can be entitled to"},"max_percentage":{"type":"integer","example":20,"description":"Maximum percentage of overall charge introducer can be entitled to"},"default_percentage":{"type":"integer","example":15,"description":"Default percentage of overall charge introducer can be entitled to. Must be between minimum and maximum"},"percentage_paid_by_firm":{"type":"integer","example":25,"description":"Percentage of the introducer's cut of the expected amount to be paid by the firm"},"percentage_paid_by_adviser":{"type":"integer","example":75,"description":"Percentage of the introducer's cut of the expected amount to be paid by the selling adviser"},"can_change_transfer_fci":{"type":"boolean","example":true,"description":"Whether the value for FCI contributions can be changed. Will only apply to advisers"},"default_transfer_fci":{"type":"boolean","example":true,"description":"Default value to whether the introducer will be recognised for FCI contributions. Will only apply to advisers"},"can_change_initial":{"type":"boolean","example":true,"description":"Whether the value for initial charges can be changed"},"default_initial":{"type":"boolean","example":true,"description":"Default value to whether this charge split schema will be applied to initial charges"},"can_change_ongoing":{"type":"boolean","example":true,"description":"Whether the value for ongoing charges can be changed"},"default_ongoing":{"type":"boolean","example":true,"description":"Default value to whether this charge split schema will be applied to ongoing charges"},"valid_for_advisers":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for adviser accounts"},"valid_for_clients":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for client accounts"},"valid_for_introducers":{"type":"boolean","example":true,"description":"Whether this charge split schema can be applied for introducer accounts"},"visible_to_advisers":{"type":"boolean","example":true,"description":"Whether this charge split schema is visible to advisers to use"}},"example":{"uuid":"d4e0fe20-16bb-4c2c-bcaf-9cf9eb376cec","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Basic Introducer Rate","min_percentage":10,"max_percentage":20,"default_percentage":15,"percentage_paid_by_firm":25,"percentage_paid_by_adviser":75,"can_change_transfer_fci":true,"default_transfer_fci":true,"can_change_initial":true,"default_initial":true,"can_change_ongoing":true,"default_ongoing":true,"valid_for_advisers":true,"valid_for_clients":true,"valid_for_introducers":true,"visible_to_advisers":true}},"App_Http_Resources_LoginResource":{"type":"object","properties":{"uuid":{"type":"string","example":"f2e5386d-75f3-4b56-ac24-1b8778770ee1"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"expires_at":{"type":"string","example":"2026-08-16T14:41:54+01:00"},"has_write_permission":{"type":"boolean","example":false},"has_delete_permission":{"type":"boolean","example":false},"primary":{"type":"boolean","example":false},"receives_unread_notifications_email":{"type":"boolean","example":true},"wealth_enabled":{"type":"boolean","example":true},"goals_enabled":{"type":"boolean","example":true},"factfind_enabled":{"type":"boolean","example":true},"tasks_enabled":{"type":"boolean","example":true},"welcome_enabled":{"type":"boolean","example":true},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"email":{"type":"string","example":"gareth@plannrcrm.com"},"user_type":{"type":"string","example":"standard"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"908cee06-4065-4a22-bdea-ef63bf02a098"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"59c57bc4-6af5-407e-9c54-cd852aec23df"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}}},"is_impersonated":{"type":"boolean","example":false}},"example":[{"uuid":"f2e5386d-75f3-4b56-ac24-1b8778770ee1","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2026-08-16T14:41:54+01:00","has_write_permission":false,"has_delete_permission":false,"primary":false,"receives_unread_notifications_email":true,"wealth_enabled":true,"goals_enabled":true,"factfind_enabled":true,"tasks_enabled":true,"welcome_enabled":true,"first_name":"Gareth","last_name":"Thompson","email":"gareth@plannrcrm.com","user_type":"standard","account":{"uuid":"908cee06-4065-4a22-bdea-ef63bf02a098","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"firm":{"uuid":"59c57bc4-6af5-407e-9c54-cd852aec23df","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"is_impersonated":false}]},"App_Http_Resources_LogResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b3cd6a20-d3e7-4eca-ab78-3c52054d707a"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"description":{"type":"string","example":":author :action Mantas Ruigys"},"author":{"type":"object","properties":{"uuid":{"type":"string","example":"9e1a1a74-1d45-4a19-896a-e5747f5dabc0"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"modelable":{"type":"object","properties":{"uuid":{"type":"string","example":"08f92f7b-dcd2-4d68-b9c7-172def3ed0a4"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"modelable_type":{"type":"string","example":"client"},"modelable_name":{"type":"string","example":"Mantas Ruigys"},"through":{"type":"object","properties":{"uuid":{"type":"string","example":"dfcfe5c2-7f44-4552-9959-7fbcbf59f445"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"3de69dff-5df1-49e8-b064-37f442801a3f"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"accounts":{"type":"array","example":[{"uuid":{"example":"ac3a53a3-5e2a-4909-a1e0-f3ac7db76a00","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}}],"items":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"ac3a53a3-5e2a-4909-a1e0-f3ac7db76a00"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}}}},"type":{"type":"string","example":"viewed"},"level":{"type":"string","example":"info"},"metadata":{"type":"array","example":[]},"is_impersonated":{"type":"string","example":"false"}},"example":[{"uuid":"b3cd6a20-d3e7-4eca-ab78-3c52054d707a","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","description":":author :action Mantas Ruigys","author":{"uuid":"9e1a1a74-1d45-4a19-896a-e5747f5dabc0","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"modelable":{"uuid":"08f92f7b-dcd2-4d68-b9c7-172def3ed0a4","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"modelable_type":"client","modelable_name":"Mantas Ruigys","through":{"uuid":"dfcfe5c2-7f44-4552-9959-7fbcbf59f445","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"account":{"uuid":"3de69dff-5df1-49e8-b064-37f442801a3f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"accounts":[{"uuid":{"example":"ac3a53a3-5e2a-4909-a1e0-f3ac7db76a00","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}}],"type":"viewed","level":"info","metadata":[],"is_impersonated":"false"}]},"App_Http_Resources_MailboxResource":{"type":"object","properties":{"uuid":{"type":"string","example":"7bed2e26-842f-4258-b4b7-9260833ab023","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"created_by":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"2b72e4ba-a160-4607-afe2-2282ee0cfe61"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use primary_email instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"description":{"type":"string","example":"URL for initial avatar image"},"collection":{"type":"boolean","example":false}}},"firm":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"description":{"type":"string","example":"Firm"},"collection":{"type":"boolean","example":false}}},"primary_phone_number":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"description":{"type":"string","example":"Primary phone number"},"collection":{"type":"boolean","example":false}}},"primary_email":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"description":{"type":"string","example":"Primary email"},"collection":{"type":"boolean","example":false}}},"current_time_entry":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"description":{"type":"string","example":"Current time entry"},"collection":{"type":"boolean","example":false}}},"assigned_adviser":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Assigned adviser"},"collection":{"type":"boolean","example":false}}},"assigned_administrator":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Assigned administrator"},"collection":{"type":"boolean","example":false}}},"assigned_paraplanner":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Assigned paraplanner"},"collection":{"type":"boolean","example":false}}},"introduced_by":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Introduced by"},"collection":{"type":"boolean","example":false}}},"business_unit":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"description":{"type":"string","example":"The business unit this account belongs to"},"collection":{"type":"boolean","example":false}}},"groups":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"description":{"type":"string","example":"Groups"},"collection":{"type":"boolean","example":true}}},"tags":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"description":{"type":"string","example":"Tags"},"collection":{"type":"boolean","example":true}}},"owners":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"Accounts that own this account"},"collection":{"type":"boolean","example":true}}},"first_contact_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"First contact date"},"collection":{"type":"boolean","example":false}}},"next_review_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"Next review date"},"collection":{"type":"boolean","example":false}}},"previous_review_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"Previous review date"},"collection":{"type":"boolean","example":false}}},"anniversary_review_date":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"description":{"type":"string","example":"Anniversary review date"},"collection":{"type":"boolean","example":false}}},"with_login":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes whether the account has a login to Plannr"},"collection":{"type":"boolean","example":false}}},"has_joint_account":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes whether this account belongs to a joint account too"},"collection":{"type":"boolean","example":false}}},"can_be_deleted":{"type":"object","properties":{"example":{"type":"string","example":"false"},"description":{"type":"string","example":"Denotes if the account can be deleted"},"collection":{"type":"boolean","example":false}}},"joint_account_circle":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"description":{"type":"string","example":"This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles."},"collection":{"type":"boolean","example":false}}},"circles":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"description":{"type":"string","example":"The circles the account belongs to"},"collection":{"type":"boolean","example":true}}},"ownership_percentage":{"type":"object","properties":{"example":{"type":"integer","example":100},"description":{"type":"string","example":"Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -\u003e Accounts)"},"collection":{"type":"boolean","example":false}}},"inactive_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08"},"description":{"type":"string","example":"Inactive from date"},"collection":{"type":"boolean","example":false}}},"last_interaction_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08 14:41:54"},"description":{"type":"string","example":"Last interaction date"},"collection":{"type":"boolean","example":false}}},"referral_code":{"type":"object","properties":{"example":{"type":"string","example":"ABC12345"},"description":{"type":"string","example":"Unique referral code for the employee account (employees only)"},"collection":{"type":"boolean","example":false}}},"permissions":{"type":"object","properties":{"example":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"description":{"type":"string","example":"Permission map where keys are permission names and values are target arrays"},"collection":{"type":"boolean","example":false}}},"custom_fields":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"description":{"type":"string","example":"Any custom fields on the model."},"collection":{"type":"boolean","example":true}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that created this mailbox."},"type":{"type":"string","example":"imap","description":"The type of mailbox this is. Possible values are: imap, gmail and outlook"},"email":{"type":"string","example":"test@example.org","description":"The email address of the mailbox."},"name":{"type":"string","example":"Test Mailbox","description":"The name of the mailbox."},"state":{"type":"string","example":"connected","description":"The status of the mailbox. Possible values are: init, syncing, connecting, connected, authenticationError, connectError, unset, disconnected and deleting"},"enabled":{"type":"boolean","example":true,"description":"Whether the mailbox is enabled or not."},"message_count":{"type":"integer","example":1,"description":"The number of messages synced by this mailbox."}},"example":{"uuid":"7bed2e26-842f-4258-b4b7-9260833ab023","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","created_by":{"uuid":{"example":"2b72e4ba-a160-4607-afe2-2282ee0cfe61","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use primary_email instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=gareth+thompson","description":"URL for initial avatar image","collection":false},"firm":{"example":"App\\Http\\Resources\\FirmResource","description":"Firm","collection":false},"primary_phone_number":{"example":"App\\Http\\Resources\\ContactDetailResource","description":"Primary phone number","collection":false},"primary_email":{"example":"App\\Http\\Resources\\ContactDetailResource","description":"Primary email","collection":false},"current_time_entry":{"example":"App\\Http\\Resources\\TimeEntryResource","description":"Current time entry","collection":false},"assigned_adviser":{"example":"App\\Http\\Resources\\AccountResource","description":"Assigned adviser","collection":false},"assigned_administrator":{"example":"App\\Http\\Resources\\AccountResource","description":"Assigned administrator","collection":false},"assigned_paraplanner":{"example":"App\\Http\\Resources\\AccountResource","description":"Assigned paraplanner","collection":false},"introduced_by":{"example":"App\\Http\\Resources\\AccountResource","description":"Introduced by","collection":false},"business_unit":{"example":"App\\Http\\Resources\\BusinessUnitResource","description":"The business unit this account belongs to","collection":false},"groups":{"example":"App\\Http\\Resources\\GroupResource","description":"Groups","collection":true},"tags":{"example":"App\\Http\\Resources\\TagResource","description":"Tags","collection":true},"owners":{"example":"App\\Http\\Resources\\AccountResource","description":"Accounts that own this account","collection":true},"first_contact_date":{"example":"2026-05-08T14:41:54+01:00","description":"First contact date","collection":false},"next_review_date":{"example":"2026-05-08T14:41:54+01:00","description":"Next review date","collection":false},"previous_review_date":{"example":"2026-05-08T14:41:54+01:00","description":"Previous review date","collection":false},"anniversary_review_date":{"example":"2026-05-08T14:41:54+01:00","description":"Anniversary review date","collection":false},"with_login":{"example":true,"description":"Denotes whether the account has a login to Plannr","collection":false},"has_joint_account":{"example":true,"description":"Denotes whether this account belongs to a joint account too","collection":false},"can_be_deleted":{"example":"false","description":"Denotes if the account can be deleted","collection":false},"joint_account_circle":{"example":"App\\Http\\Resources\\CircleResource","description":"This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.","collection":false},"circles":{"example":"App\\Http\\Resources\\CircleResource","description":"The circles the account belongs to","collection":true},"ownership_percentage":{"example":100,"description":"Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -\u003e Accounts)","collection":false},"inactive_at":{"example":"2026-05-08","description":"Inactive from date","collection":false},"last_interaction_at":{"example":"2026-05-08 14:41:54","description":"Last interaction date","collection":false},"referral_code":{"example":"ABC12345","description":"Unique referral code for the employee account (employees only)","collection":false},"permissions":{"example":{"firm:read":["firm"],"network:read":["network:uuid"]},"description":"Permission map where keys are permission names and values are target arrays","collection":false},"custom_fields":{"example":"App\\Http\\Resources\\CustomFieldValueResource","description":"Any custom fields on the model.","collection":true},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"type":"imap","email":"test@example.org","name":"Test Mailbox","state":"connected","enabled":true,"message_count":1}},"App_Http_Resources_V2_DirectDebitMandateResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b05613c0-5fc8-4768-a3e0-7c086eb8fc68","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"completed_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the direct debit mandate was completed."},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"b5d9465e-fce3-49f8-883b-ec66790249a6"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The firm that the application belongs to."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"e3e8a2f6-32a5-4e9d-aeb2-c4d7113db898"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account the direct debit mandate belongs to."},"supported_platform":{"type":"string","example":"seccl","description":"The Platform linked with the direct debit mandate."}},"example":{"uuid":"b05613c0-5fc8-4768-a3e0-7c086eb8fc68","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","completed_at":"2026-05-08T14:41:56+01:00","firm":{"uuid":"b5d9465e-fce3-49f8-883b-ec66790249a6","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"account":{"uuid":"e3e8a2f6-32a5-4e9d-aeb2-c4d7113db898","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"supported_platform":"seccl"}},"App_Http_Resources_MortgageSearchResource":{"type":"object","properties":{"uuid":{"type":"string","example":"10c4b27c-096f-430e-b6dd-5399830ef481","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"My Mortgage Search","description":"The name of the mortgage search"},"status":{"type":"string","example":"pending","description":"The status of the mortgage search"},"provider":{"type":"string","example":"Mortgage Brain","description":"The provider that the mortgage search is for"},"provider_reference":{"type":"string","example":"123456789","description":"The provider reference of the mortgage search"},"provider_data":{"type":"array","example":[],"description":"Any provider data related to the mortgage search"},"applicants":{"type":"array","example":[{"uuid":"7778b059-f101-4924-a172-522418bca0c5","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","account":"App\\Http\\Resources\\MinimalAccountResource"}],"description":"The applicants of the mortgage search","items":{"type":"object","properties":{"uuid":{"type":"string","example":"7778b059-f101-4924-a172-522418bca0c5"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}}}},"cases":{"type":"array","example":[{"uuid":"0590f662-df2f-4284-9d2c-4a52b65aa42f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:56+01:00","assigned_to_uuids":["b795834a-92c8-465c-bf11-875ebf068b30"],"group_uuids":["8eda1d66-3fb5-4ceb-9b30-ee1c9f8d09af"],"completed_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"6fe152e5-6d85-46b0-9b53-b5d4cba72c58","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"description":"The cases that are related to the mortgage search","items":{"type":"object","properties":{"uuid":{"type":"string","example":"0590f662-df2f-4284-9d2c-4a52b65aa42f"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"assigned_to_uuids":{"type":"array","example":["b795834a-92c8-465c-bf11-875ebf068b30"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["8eda1d66-3fb5-4ceb-9b30-ee1c9f8d09af"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"6fe152e5-6d85-46b0-9b53-b5d4cba72c58"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}}}},"products":{"type":"array","example":[{"uuid":"5151f19f-797e-4c3c-90fb-14e48adb4cbf","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","provider_reference":"example-reference","provider_scenario_name":"Single Applicant, Small Deposit","provider_scenario_data":[],"lender_name":"HSBC","product_title":"5% Fixed Rate - 5 year","files":"App\\Http\\Resources\\FileResource"}],"description":"The products that are related to the mortgage search","items":{"type":"object","properties":{"uuid":{"type":"string","example":"5151f19f-797e-4c3c-90fb-14e48adb4cbf"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"provider_reference":{"type":"string","example":"example-reference"},"provider_scenario_name":{"type":"string","example":"Single Applicant, Small Deposit"},"provider_scenario_data":{"type":"array","example":[]},"lender_name":{"type":"string","example":"HSBC"},"product_title":{"type":"string","example":"5% Fixed Rate - 5 year"},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"}}}},"files":{"type":"array","example":[{"uuid":"f6ca99a3-96ca-404d-a20e-057aa699fc77","created_at":"2026-05-08T14:41:56+01:00","original_created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","uploaded_at":"2026-05-08T14:41:56+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:56+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/a108f7e2-daf0-4f84-a924-81cfec00ebba/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"19038e30-b4c2-47a4-85a0-6f147819430d"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"description":"The files that are related to the mortgage search","items":{"type":"object","properties":{"uuid":{"type":"string","example":"f6ca99a3-96ca-404d-a20e-057aa699fc77"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"status":{"type":"string","example":"uploaded"},"filename":{"type":"string","example":"Welcome to Plannr.pdf"},"name":{"type":"string","example":"Welcome to Plannr"},"extension":{"type":"string","example":"pdf"},"type":{"type":"string","example":"type"},"size":{"type":"string","example":"21691783"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf"},"last_modified":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"progress":{"type":"string","example":"100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/a108f7e2-daf0-4f84-a924-81cfec00ebba/download"},"folder_name":{"type":"string","example":"folder 2"},"folder":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"documentable_type":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"19038e30-b4c2-47a4-85a0-6f147819430d"}}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"}}}}},"example":{"uuid":"10c4b27c-096f-430e-b6dd-5399830ef481","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"My Mortgage Search","status":"pending","provider":"Mortgage Brain","provider_reference":"123456789","provider_data":[],"applicants":[{"uuid":"7778b059-f101-4924-a172-522418bca0c5","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","account":"App\\Http\\Resources\\MinimalAccountResource"}],"cases":[{"uuid":"0590f662-df2f-4284-9d2c-4a52b65aa42f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:56+01:00","assigned_to_uuids":["b795834a-92c8-465c-bf11-875ebf068b30"],"group_uuids":["8eda1d66-3fb5-4ceb-9b30-ee1c9f8d09af"],"completed_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"6fe152e5-6d85-46b0-9b53-b5d4cba72c58","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"products":[{"uuid":"5151f19f-797e-4c3c-90fb-14e48adb4cbf","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","provider_reference":"example-reference","provider_scenario_name":"Single Applicant, Small Deposit","provider_scenario_data":[],"lender_name":"HSBC","product_title":"5% Fixed Rate - 5 year","files":"App\\Http\\Resources\\FileResource"}],"files":[{"uuid":"f6ca99a3-96ca-404d-a20e-057aa699fc77","created_at":"2026-05-08T14:41:56+01:00","original_created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","uploaded_at":"2026-05-08T14:41:56+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:56+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/a108f7e2-daf0-4f84-a924-81cfec00ebba/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"19038e30-b4c2-47a4-85a0-6f147819430d"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}]}},"App_Http_Resources_NetworthResource":{"type":"object","properties":{"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the networth was calculated"},"total":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"100000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£1,000,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The total wealth of the client at the given date"},"abstract_types":{"type":"object","properties":{"assets":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"59500000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£595,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"liabilities":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"32500000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£325,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"protection":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"8000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£80,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"The total wealth broken down in to plan abstract types"},"plan_types":{"type":"object","properties":{"annuity":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"9172106"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£91,721.06"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"cash_account":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"9452110"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£94,521.10"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"fixed_asset":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"8394776"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£83,947.76"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"general_insurance":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"3091804"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£30,918.04"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"group_protection":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"9767027"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£97,670.27"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"investment":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"3848845"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£38,488.45"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"loan_credit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"7564545"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£75,645.45"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"mortgage":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"3630342"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£36,303.42"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"pension":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"6850594"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£68,505.94"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"protection_policy":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"8796070"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£87,960.70"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"The total wealth broken down in to plan types"}},"example":{"valued_at":"2026-05-08T14:41:56+01:00","total":{"amount":{"example":"100000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£1,000,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"abstract_types":{"assets":{"amount":{"example":"59500000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£595,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"liabilities":{"amount":{"example":"32500000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£325,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"protection":{"amount":{"example":"8000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£80,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"plan_types":{"annuity":{"amount":{"example":"9172106","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£91,721.06","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"cash_account":{"amount":{"example":"9452110","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£94,521.10","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"fixed_asset":{"amount":{"example":"8394776","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£83,947.76","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"general_insurance":{"amount":{"example":"3091804","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£30,918.04","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"group_protection":{"amount":{"example":"9767027","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£97,670.27","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"investment":{"amount":{"example":"3848845","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£38,488.45","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"loan_credit":{"amount":{"example":"7564545","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£75,645.45","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"mortgage":{"amount":{"example":"3630342","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£36,303.42","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"pension":{"amount":{"example":"6850594","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£68,505.94","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"protection_policy":{"amount":{"example":"8796070","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£87,960.70","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}}},"App_Http_Resources_newBusinessEventResource":{"type":"object","properties":{"uuid":{"type":"string","example":"cad4f225-3f11-4829-967e-cea07102188b","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"b3b93fb7-407c-4ece-889e-22fe81190fdc"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The plan this event belongs to (if included)"},"clients":{"type":"object","properties":{"uuid":{"type":"string","example":"fd567fae-3ca4-4448-b6cc-de8495b1c9c7"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The clients this event belongs to"},"modelable":{"type":"object","properties":{"uuid":{"type":"string","example":"91cc57e9-9bcd-4c0f-879f-9543ead340d3"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"This will return a plan or first client in the clients collection"},"modelable_type":{"type":"string","example":"plan","description":"The type of model this event belongs to (plan or client)"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"bd59b84a-6176-402b-a11d-5cf4a881949c"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"The firm which this event belongs to (if included)"},"contribution_type":{"type":"string","example":"increment","description":"The type of contribution this event represents"},"contribution_type_notes":{"type":"string","example":"Contribution type notes","description":"Notes about the contribution type"},"adviser":{"type":"object","properties":{"uuid":{"type":"string","example":"ff4a0dcd-6fee-4e43-a4df-0149d6079373"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The adviser attached to the event"},"advice_type":{"type":"string","example":"execution_only","description":"The type of advice given"},"conducted_by":{"type":"string","example":"email","description":"How the advice was conducted"},"premium":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"How much premium was paid"},"premium_frequency":{"type":"string","example":"monthly","description":"How often premium is paid"},"start_date":{"type":"string","example":"2021-09-24","description":"The date the premiums started"},"proposal_date":{"type":"string","example":"2021-09-01","description":"The date the proposal was made"},"case":{"type":"object","properties":{"uuid":{"type":"string","example":"3205785b-eebc-4117-a809-17cc9e961e1c"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"assigned_to_uuids":{"type":"array","example":["88d96b07-9e64-40a0-b86d-85f360e3eada"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["a54a60f9-4644-41a6-922e-11ff80254611"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"a3092def-3947-4e06-a442-4e4d88c875ab"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}},"description":"The case this event belongs to (if included)"},"is_vulnerable_client":{"type":"boolean","example":true,"description":"Whether the client is vulnerable"},"is_replacing_existing_plan":{"type":"boolean","example":true,"description":"Whether the client is replacing an existing plan"},"existing_plan":{"type":"object","properties":{"uuid":{"type":"string","example":"2935b351-4147-468f-812c-9a583b21644c"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The existing plan (if included)"},"existing_plan_details":{"type":"string","example":"Existing plan details","description":"Details about the existing plan"},"opted_out_of_pension_scheme_for_plan":{"type":"boolean","example":true,"description":"Whether the client opted out of a pension scheme"},"opted_out_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"Timestamp of when the client opted out"},"opted_out_notes":{"type":"string","example":"Opted out notes","description":"Notes about the opt out"},"status":{"type":"string","example":"accepted","description":"The status of the event"}},"example":{"uuid":"cad4f225-3f11-4829-967e-cea07102188b","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","plan":{"uuid":"b3b93fb7-407c-4ece-889e-22fe81190fdc","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"clients":{"uuid":"fd567fae-3ca4-4448-b6cc-de8495b1c9c7","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"modelable":{"uuid":"91cc57e9-9bcd-4c0f-879f-9543ead340d3","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"modelable_type":"plan","firm":{"uuid":"bd59b84a-6176-402b-a11d-5cf4a881949c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"contribution_type":"increment","contribution_type_notes":"Contribution type notes","adviser":{"uuid":"ff4a0dcd-6fee-4e43-a4df-0149d6079373","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"advice_type":"execution_only","conducted_by":"email","premium":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"premium_frequency":"monthly","start_date":"2021-09-24","proposal_date":"2021-09-01","case":{"uuid":"3205785b-eebc-4117-a809-17cc9e961e1c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:56+01:00","assigned_to_uuids":["88d96b07-9e64-40a0-b86d-85f360e3eada"],"group_uuids":["a54a60f9-4644-41a6-922e-11ff80254611"],"completed_at":"2026-05-08T14:41:56+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"a3092def-3947-4e06-a442-4e4d88c875ab","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"},"is_vulnerable_client":true,"is_replacing_existing_plan":true,"existing_plan":{"uuid":"2935b351-4147-468f-812c-9a583b21644c","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"existing_plan_details":"Existing plan details","opted_out_of_pension_scheme_for_plan":true,"opted_out_at":"2026-05-08T14:41:56+01:00","opted_out_notes":"Opted out notes","status":"accepted"}},"App_Http_Resources_SubscribeableResource":{"type":"object","properties":{"subscribeable_type":{"type":"string","example":"firm","description":"type of model subscribed to"},"subscribeable_uuid":{"type":"string","example":"43ee314b-578c-4f3d-bee5-705e2567e9cd","description":"uuid of model subscribed to"}},"example":{"subscribeable_type":"firm","subscribeable_uuid":"43ee314b-578c-4f3d-bee5-705e2567e9cd"}},"App_Http_Resources_NotificationResource":{"type":"object","properties":{"title":{"type":"string","example":"notification-title"},"description":{"type":"string","example":"notification-description"},"model_uuid":{"type":"string","example":"73d40a7c-0cd6-43ed-806f-532ceb10327e"},"model_type":{"type":"string","example":"firm"}},"example":{"uuid":"cc3f6012-2f46-40d4-bbb9-337f17895077","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","read_at":"2026-05-08T14:41:54+01:00","data":{"title":"notification-title","description":"notification-description","model_uuid":"73d40a7c-0cd6-43ed-806f-532ceb10327e","model_type":"firm"},"type":"App/Notifications/AppNotification","notifiable":{"uuid":"411663be-7679-49de-aa77-1c0a7d7904af","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"triggered_by":{"uuid":"337f3f36-f637-4e4e-a9e4-5260eb0c9581","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_OAuth_OAuthProviderResource":{"type":"object","properties":{"name":{"type":"string","example":"fundment"},"label":{"type":"string","example":"Fundment"},"logo_url":{"type":"string","example":"https://api.plannrcrm.com/imgs/fundment-banner.png"},"authorization_url":{"type":"string","example":"https://api.plannrcrm.com/oauth/fundment/authorize"}},"example":[{"name":"fundment","label":"Fundment","logo_url":"https://api.plannrcrm.com/imgs/fundment-banner.png","authorization_url":"https://api.plannrcrm.com/oauth/fundment/authorize"}]},"App_Http_Resources_OAuth_OAuthConnectionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"4d2aeed1-71cd-4ceb-9712-10fd6db8948f","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"provider":{"type":"object","properties":{"name":{"type":"string","example":"fundment"},"label":{"type":"string","example":"Fundment"},"logo_url":{"type":"string","example":"https://api.plannrcrm.com/imgs/fundment-banner.png"},"authorization_url":{"type":"string","example":"https://api.plannrcrm.com/oauth/fundment/authorize"}},"description":"The name of the provider the OAuth2 connection is for"},"access_token_expires_at":{"type":"string","example":"2026-05-08T17:41:56.266801Z","description":"The expiry date of the access token. If blank, the access token will not expire."},"refresh_token_expires_at":{"type":"string","example":"2027-05-08T13:41:56.266834Z","description":"The expiry date of the refresh token. If blank, the refresh token will not expire."},"refresh_authorization_url":{"type":"string","example":"https://api.plannrcrm.com/oauth/fundment/authorize/2ceb2236-9ecf-4cb0-9169-bf1edcaf53ac","description":"The authorization URL to refresh the connection. Only visible when listing all OAuth2 providers."},"label":{"type":"string","example":"My Fundment Account 1","description":"The user generated label for the OAuth2 connection."}},"example":{"uuid":"4d2aeed1-71cd-4ceb-9712-10fd6db8948f","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","provider":{"name":"fundment","label":"Fundment","logo_url":"https://api.plannrcrm.com/imgs/fundment-banner.png","authorization_url":"https://api.plannrcrm.com/oauth/fundment/authorize"},"access_token_expires_at":"2026-05-08T17:41:56.266801Z","refresh_token_expires_at":"2027-05-08T13:41:56.266834Z","refresh_authorization_url":"https://api.plannrcrm.com/oauth/fundment/authorize/2ceb2236-9ecf-4cb0-9169-bf1edcaf53ac","label":"My Fundment Account 1"}},"App_Http_Resources_PlanReturnResource":{"type":"object","properties":{"calculated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"initial_valuation_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"first_valuation_within_date_range":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"time_weighted_return":{"type":"object","properties":{"value":{"type":"number","example":0.21},"status":{"type":"string","example":"success"},"reason":{"type":"string","example":null,"nullable":true}}},"time_weighted_return.value":{"type":"number","example":0.21},"time_weighted_return.status":{"type":"string","example":"success"},"money_weighted_return":{"type":"object","properties":{"value":{"type":"number","example":0.18},"status":{"type":"string","example":"success"},"reason":{"type":"string","example":null,"nullable":true}}},"money_weighted_return.value":{"type":"number","example":0.18},"money_weighted_return.status":{"type":"string","example":"success"}},"example":[{"calculated_at":"2026-05-08T14:41:56+01:00","initial_valuation_at":"2026-05-08T14:41:56+01:00","first_valuation_within_date_range":"2026-05-08T14:41:56+01:00","time_weighted_return":{"value":0.21,"status":"success","reason":null},"time_weighted_return.value":0.21,"time_weighted_return.status":"success","money_weighted_return":{"value":0.18,"status":"success","reason":null},"money_weighted_return.value":0.18,"money_weighted_return.status":"success"}]},"App_Http_Resources_Plans_ValuationGraphResource":{"type":"object","properties":{"valued_at":{"type":"string","example":"2026-05-08","description":"The total valuations for that day if there were any."},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"The total valuation value for that day."}},"example":{"valued_at":"2026-05-08","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}},"App_Http_Resources_Plans_GroupSchemeMemberResource":{"type":"object","properties":{"uuid":{"type":"string","example":"700bc74b-03fc-4798-bb28-4c49c72e44b4"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":true},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"object","properties":{"uuid":{"type":"string","example":"858a4d82-3a5d-4061-a078-614bf846c374"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}},"sub_accounts":{"type":"array","example":[{"uuid":"3857d466-8307-47e1-80d1-3d870b3a1596","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"3857d466-8307-47e1-80d1-3d870b3a1596"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}}},"provider":{"type":"object","properties":{"uuid":{"type":"string","example":"c4d4248c-30dc-4d68-969e-b84ab4f36b05"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"AJ Bell"},"slug":{"type":"string","example":"aj-bell"}}},"covers":{"type":"array","example":[{"uuid":"0b6a5a38-ece4-40dc-9539-f28a627a9bc1","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"0b6a5a38-ece4-40dc-9539-f28a627a9bc1"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"cover_type":{"type":"string","example":"critical_illness"},"benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"benefit_frequency":{"type":"string","example":"monthly"},"benefit_status":{"type":"string","example":"active"},"excess":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"indexation":{"type":"number","example":1.4},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}}},"claims":{"type":"array","example":[{"uuid":"d080617f-2db3-416c-91bf-0ae9ed6b473a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":"App\\Http\\Resources\\AccountResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"d080617f-2db3-416c-91bf-0ae9ed6b473a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"claim_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"claim_start_date":{"type":"string","example":"2025-05-08"},"claim_end_date":{"type":"string","example":"2031-05-08"},"claim_notes":{"type":"string","example":"Claim notes"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}}},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"array","example":[{"uuid":"d8377b9f-e09d-423e-88c1-6bc36c45baae","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","valued_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"d8377b9f-e09d-423e-88c1-6bc36c45baae"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"}}}},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"object","properties":{"uuid":{"type":"string","example":"6f311ee0-d089-4643-bafd-2e84e94a67fc"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"accounts":{"type":"array","example":[{"uuid":"16a4654a-438c-4f56-9368-82358a21ed3e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"16a4654a-438c-4f56-9368-82358a21ed3e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"seller":{"type":"object","properties":{"uuid":{"type":"string","example":"f25fd08e-ae45-4291-8731-9b7f7b30d392"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"linked_owners":{"type":"array","example":[{"uuid":"f5166c22-b1a5-4405-91b2-f0147550c8f2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"f5166c22-b1a5-4405-91b2-f0147550c8f2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"linked_plans":{"type":"array","example":[{"uuid":"348c6d32-8951-4dc7-8825-04f67ce1b391","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":true,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource","group_scheme":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource","group_scheme_member_detail":{"workplace_location":"London","employment_division":"Management"}}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"348c6d32-8951-4dc7-8825-04f67ce1b391"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":true},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"group_scheme":{"type":"string","example":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource"},"group_scheme_member_detail":{"type":"object","properties":{"workplace_location":{"type":"string","example":"London"},"employment_division":{"type":"string","example":"Management"}}}}}},"visible_to_circles":{"type":"object","properties":{"uuid":{"type":"string","example":"38f21f0b-6574-4e9b-a1d0-dc06bbc149a0"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Jones Family"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=jones+family"},"bg_colour":{"type":"string","example":"#35f4e1"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"joint_account_uuid":{"type":"string","example":"ce459149-c0f9-434a-8139-71e788f85e40"},"login_access_level":{"type":"string","example":"write"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"array","example":[{"uuid":"ebe11e74-1a17-4cbd-99c8-605e0ae9b842","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["fb42fcdc-3c3a-4ea5-a9ba-9cd3c2cfeb44"],"group_uuids":["9a0c124f-26c8-4ec2-8250-f1b53a6297d1"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"d4bf9dff-5274-4dd7-942d-706e961f9bce","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"ebe11e74-1a17-4cbd-99c8-605e0ae9b842"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"assigned_to_uuids":{"type":"array","example":["fb42fcdc-3c3a-4ea5-a9ba-9cd3c2cfeb44"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["9a0c124f-26c8-4ec2-8250-f1b53a6297d1"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"d4bf9dff-5274-4dd7-942d-706e961f9bce"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}}}},"tags":{"type":"array","example":[{"uuid":"6c5a16c8-e433-4906-9940-b07e7341afff","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"6c5a16c8-e433-4906-9940-b07e7341afff"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"object","properties":{"uuid":{"type":"string","example":"96e130a4-5367-4cf8-ab01-bdceca0b9a05"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"wrap_children":{"type":"array","example":[{"uuid":"50326a4c-8295-4407-b5bd-1b675ca5577b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"50326a4c-8295-4407-b5bd-1b675ca5577b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"linked_policy_numbers":{"type":"array","example":[{"uuid":"474671a5-7bec-42e5-9e41-dfd933dd2565","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","linked_policy_number":"ABC123-X","plan":"App\\Http\\Resources\\Plans\\PlanResource"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"474671a5-7bec-42e5-9e41-dfd933dd2565"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"linked_policy_number":{"type":"string","example":"ABC123-X"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"}}}},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"object","properties":{"uuid":{"type":"string","example":"a374a81b-98c5-4232-bd87-8653c1e96b09"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"custom_fields":{"type":"array","example":[{"uuid":"f2fd84ed-d262-4682-8a81-5e370a8ecd8e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"f2fd84ed-d262-4682-8a81-5e370a8ecd8e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}},"external_references":{"type":"array","example":[{"uuid":"7bf8e49c-350e-4b50-9749-3c9ee791abd1","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"7bf8e49c-350e-4b50-9749-3c9ee791abd1"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}},"group_scheme":{"type":"object","properties":{"uuid":{"type":"string","example":"2acb5a3c-8a26-4359-b0ee-6f71c3bd9f2e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":true},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"group_scheme":{"type":"string","example":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource"},"group_scheme_member_detail":{"type":"object","properties":{"workplace_location":{"type":"string","example":"London"},"employment_division":{"type":"string","example":"Management"}}}}},"group_scheme_member_detail":{"type":"object","properties":{"workplace_location":{"type":"string","example":"London"},"employment_division":{"type":"string","example":"Management"}}}},"example":[{"uuid":"700bc74b-03fc-4798-bb28-4c49c72e44b4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":true,"advice_area":"non_investment_insurance","main_account":{"uuid":"858a4d82-3a5d-4061-a078-614bf846c374","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"sub_accounts":[{"uuid":"3857d466-8307-47e1-80d1-3d870b3a1596","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}],"provider":{"uuid":"c4d4248c-30dc-4d68-969e-b84ab4f36b05","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"AJ Bell","slug":"aj-bell"},"covers":[{"uuid":"0b6a5a38-ece4-40dc-9539-f28a627a9bc1","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}],"claims":[{"uuid":"d080617f-2db3-416c-91bf-0ae9ed6b473a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":"App\\Http\\Resources\\AccountResource"}],"total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":[{"uuid":"d8377b9f-e09d-423e-88c1-6bc36c45baae","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","valued_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"}],"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":{"uuid":"6f311ee0-d089-4643-bafd-2e84e94a67fc","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"accounts":[{"uuid":"16a4654a-438c-4f56-9368-82358a21ed3e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"seller":{"uuid":"f25fd08e-ae45-4291-8731-9b7f7b30d392","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"linked_owners":[{"uuid":"f5166c22-b1a5-4405-91b2-f0147550c8f2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"linked_plans":[{"uuid":"348c6d32-8951-4dc7-8825-04f67ce1b391","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":true,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource","group_scheme":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource","group_scheme_member_detail":{"workplace_location":"London","employment_division":"Management"}}],"visible_to_circles":{"uuid":"38f21f0b-6574-4e9b-a1d0-dc06bbc149a0","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":"App\\Http\\Resources\\AccountResource","groups":"App\\Http\\Resources\\GroupResource","joint_account_uuid":"ce459149-c0f9-434a-8139-71e788f85e40","login_access_level":"write","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"statistics":{"recent_growth":100},"cases":[{"uuid":"ebe11e74-1a17-4cbd-99c8-605e0ae9b842","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["fb42fcdc-3c3a-4ea5-a9ba-9cd3c2cfeb44"],"group_uuids":["9a0c124f-26c8-4ec2-8250-f1b53a6297d1"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"d4bf9dff-5274-4dd7-942d-706e961f9bce","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"tags":[{"uuid":"6c5a16c8-e433-4906-9940-b07e7341afff","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"is_wrap_product":false,"is_wrap_child":false,"wrap":{"uuid":"96e130a4-5367-4cf8-ab01-bdceca0b9a05","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"wrap_children":[{"uuid":"50326a4c-8295-4407-b5bd-1b675ca5577b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"linked_policy_numbers":[{"uuid":"474671a5-7bec-42e5-9e41-dfd933dd2565","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","linked_policy_number":"ABC123-X","plan":"App\\Http\\Resources\\Plans\\PlanResource"}],"can_be_deleted":"false","contract_enquiry_account":{"uuid":"a374a81b-98c5-4232-bd87-8653c1e96b09","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"custom_fields":[{"uuid":"f2fd84ed-d262-4682-8a81-5e370a8ecd8e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"external_references":[{"uuid":"7bf8e49c-350e-4b50-9749-3c9ee791abd1","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}],"group_scheme":{"uuid":"2acb5a3c-8a26-4359-b0ee-6f71c3bd9f2e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":true,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource","group_scheme":"App\\Http\\Resources\\Plans\\GroupSchemeMemberResource","group_scheme_member_detail":{"workplace_location":"London","employment_division":"Management"}},"group_scheme_member_detail":{"workplace_location":"London","employment_division":"Management"}}]},"App_Http_Resources_Plans_SubGroupSchemeResource":{"type":"object","properties":{"uuid":{"type":"string","example":"51472132-d2af-4349-8699-fde682d8906a","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the plan was originally opened"},"name":{"type":"string","example":"Johns ISA","description":"Name of the plan"},"type":{"type":"string","example":"cash_account","description":"Type of plan, this will indicate what to expect from the fields attribute"},"sub_type":{"type":"string","example":"lifetime isa","description":"Plan sub type"},"abstract_type":{"type":"string","example":"asset","description":"describes if the plan is an asset, protection or liability"},"policy_number":{"type":"string","example":"AVIVA-123","description":"The policy number on the main sub account of the plan"},"proposal_reference":{"type":"string","example":"AB123456","description":"The proposal reference on the main sub account of the plan"},"status":{"type":"string","example":"inactive","description":"Plan status"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Timestamp of when the plan became inactive"},"inactive_reason":{"type":"string","example":"claimed","description":"Reason for inactivity"},"agency_in_your_name":{"type":"boolean","example":true,"description":"Denotes if plan has agency in your name"},"agency_in_your_name_from":{"type":"string","example":"2025-05-08","description":"Date the agency was in your name from"},"originally_sold_by_firm":{"type":"boolean","example":true,"description":"Denotes if the plan was originally sold by your firm"},"under_advice":{"type":"boolean","example":true,"description":"Denotes if plan is under advice"},"visible_on_client_portal":{"type":"boolean","example":true,"description":"Denotes if this plan is visible to clients on the client portal"},"include_in_client_valuation":{"type":"boolean","example":true,"description":"Denotes if this plan should be included in the client valuation"},"show_on_joint":{"type":"boolean","example":true,"description":"Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of"},"shown_on_circles":{"type":"boolean","example":true,"description":"Determines if plan should be shown on a circle"},"review_date":{"type":"string","example":"2025-05-08","description":"Review date"},"on_panel":{"type":"boolean","example":true,"description":"On panel"},"is_group_scheme":{"type":"boolean","example":false,"description":"Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes."},"is_sub_group_scheme":{"type":"boolean","example":true,"description":"Denotes if the plan is sub scheme of the group scheme plan."},"is_group_scheme_member":{"type":"boolean","example":false,"description":"Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation."},"advice_area":{"type":"string","example":"non_investment_insurance","description":"The advice area of the plan based on the plan's sub type."},"main_account":{"type":"object","properties":{"uuid":{"type":"string","example":"d2fdb5e9-0e8b-42e4-a08d-e570399883ee"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}},"description":"Plans main account"},"sub_accounts":{"type":"array","example":[{"uuid":"bd2bb98f-cbee-4c50-89b9-ce8a9e0bface","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}],"description":"Plans sub accounts","items":{"type":"object","properties":{"uuid":{"type":"string","example":"bd2bb98f-cbee-4c50-89b9-ce8a9e0bface"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}}},"provider":{"type":"object","properties":{"uuid":{"type":"string","example":"21665d7b-031c-490f-906c-127b113d20be"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"AJ Bell"},"slug":{"type":"string","example":"aj-bell"}},"description":"The plan's provider"},"covers":{"type":"array","example":[{"uuid":"c1a24018-e27f-4c51-b784-57fb6ece023d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}],"description":"Covers of the plan","items":{"type":"object","properties":{"uuid":{"type":"string","example":"c1a24018-e27f-4c51-b784-57fb6ece023d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"cover_type":{"type":"string","example":"critical_illness"},"benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"benefit_frequency":{"type":"string","example":"monthly"},"benefit_status":{"type":"string","example":"active"},"excess":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"indexation":{"type":"number","example":1.4},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}}},"claims":{"type":"array","example":[{"uuid":"5b672e12-6860-4162-9da0-1ef2cb2ebad2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":"App\\Http\\Resources\\AccountResource"}],"description":"Claims of the plan","items":{"type":"object","properties":{"uuid":{"type":"string","example":"5b672e12-6860-4162-9da0-1ef2cb2ebad2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"claim_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"claim_start_date":{"type":"string","example":"2025-05-08"},"claim_end_date":{"type":"string","example":"2031-05-08"},"claim_notes":{"type":"string","example":"Claim notes"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}}}},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Total amount benefit of all covers"},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"description":"Total benefits broken down in to cover types"},"latest_valuations":{"type":"array","example":[{"uuid":"896e86b0-931e-44f5-8f00-27044a7ee7cb","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","valued_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"}],"description":"The plan's latest valuations (Included when the \"latest_valuations\" relationship is included)","items":{"type":"object","properties":{"uuid":{"type":"string","example":"896e86b0-931e-44f5-8f00-27044a7ee7cb"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"}}}},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}},"description":"Total value of the plan"},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00","description":"When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system."},"client":{"type":"object","properties":{"uuid":{"type":"string","example":"e1fed590-bee0-4679-9227-6618401f5385"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"[DEPRACATED] Please use accounts instead. The plan's client"},"accounts":{"type":"array","example":[{"uuid":"cbea1a79-9f13-4cfb-87ea-3b6c210fbe0d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"The plan's accounts","items":{"type":"object","properties":{"uuid":{"type":"string","example":"cbea1a79-9f13-4cfb-87ea-3b6c210fbe0d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"seller":{"type":"object","properties":{"uuid":{"type":"string","example":"b5eb2299-e2a8-4a13-8e82-5ca91185af77"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Adviser who sold the plan"},"linked_owners":{"type":"array","example":[{"uuid":"8bd30b10-8d53-4d03-85cd-6cd067045d4d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"Other clients who have been linked to this plan","items":{"type":"object","properties":{"uuid":{"type":"string","example":"8bd30b10-8d53-4d03-85cd-6cd067045d4d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"linked_plans":{"type":"array","example":[{"uuid":"b1774caf-dc1d-4f9e-9ea1-96a50fa7412b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":true,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource","group_scheme":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"}],"description":"Other plans that have been linked to this plan","items":{"type":"object","properties":{"uuid":{"type":"string","example":"b1774caf-dc1d-4f9e-9ea1-96a50fa7412b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":true},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"group_scheme":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"}}}},"visible_to_circles":{"type":"object","properties":{"uuid":{"type":"string","example":"067e3f66-952b-49c9-97d8-5a78a329487a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Jones Family"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=jones+family"},"bg_colour":{"type":"string","example":"#35f4e1"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"joint_account_uuid":{"type":"string","example":"9079faf3-9925-43e0-a0ab-68208bc5be36"},"login_access_level":{"type":"string","example":"write"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Circles which members of circles can see the plan as long as they have the right access level for the circle"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}},"description":"The statistics on a plan. Only displayed when you retrieve an individual plan"},"cases":{"type":"array","example":[{"uuid":"a6065418-5c7e-4fa0-bfa4-7c7fd88f4b43","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["654e1f94-c126-49f3-b675-49a3faecaba4"],"group_uuids":["4e53cdfa-c65c-4f2b-9507-5f159a9b4442"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"b36e7b31-d0f4-4590-befb-b1c788ed07a2","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"description":"Cases this plan belongs to","items":{"type":"object","properties":{"uuid":{"type":"string","example":"a6065418-5c7e-4fa0-bfa4-7c7fd88f4b43"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"assigned_to_uuids":{"type":"array","example":["654e1f94-c126-49f3-b675-49a3faecaba4"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["4e53cdfa-c65c-4f2b-9507-5f159a9b4442"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"b36e7b31-d0f4-4590-befb-b1c788ed07a2"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}}}},"tags":{"type":"array","example":[{"uuid":"95580036-47d6-45e6-9eab-830a0784495f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"description":"Tags this plan have been tagged with","items":{"type":"object","properties":{"uuid":{"type":"string","example":"95580036-47d6-45e6-9eab-830a0784495f"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Mortgage"},"slug":{"type":"string","example":"mortgage"},"colour":{"type":"string","example":"#ef4582"}}}},"is_wrap_product":{"type":"boolean","example":false,"description":"Determines if the plan is a wrap plan"},"is_wrap_child":{"type":"boolean","example":false,"description":"Determines if the plan is a wrap child"},"wrap":{"type":"object","properties":{"uuid":{"type":"string","example":"0d5fdbed-eab2-44d7-9bd9-624922c00269"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Parent wrap plan. if this plan is linked to a wrap product"},"wrap_children":{"type":"array","example":[{"uuid":"dc29294e-4849-4d9c-b78c-f657bc6619a6","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"description":"List of child plans on a wrap product","items":{"type":"object","properties":{"uuid":{"type":"string","example":"dc29294e-4849-4d9c-b78c-f657bc6619a6"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}}},"linked_policy_numbers":{"type":"array","example":[{"uuid":"408c0c7c-0da9-49ee-a132-014e1c24ecab","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","linked_policy_number":"ABC123-X","plan":"App\\Http\\Resources\\Plans\\PlanResource"}],"description":"Linked policy numbers","items":{"type":"object","properties":{"uuid":{"type":"string","example":"408c0c7c-0da9-49ee-a132-014e1c24ecab"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"linked_policy_number":{"type":"string","example":"ABC123-X"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"}}}},"can_be_deleted":{"type":"string","example":"false","description":"Denotes if the plan can be deleted"},"contract_enquiry_account":{"type":"object","properties":{"uuid":{"type":"string","example":"637b30bc-6569-4853-9d82-e1e59df643f2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The specific account used to make contract enquiry requests."},"custom_fields":{"type":"array","example":[{"uuid":"df0cb3f1-fb0d-4d24-a212-58ae6573b2b4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"description":"Any custom fields on the model.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"df0cb3f1-fb0d-4d24-a212-58ae6573b2b4"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}},"external_references":{"type":"array","example":[{"uuid":"d4872139-514c-4801-8f51-8766dfbf3645","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}],"description":"The external references that have been added to the client.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"d4872139-514c-4801-8f51-8766dfbf3645"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"third_party":{"type":"string","example":"nucleus"},"reference":{"type":"string","example":"AB123456"}}}},"group_scheme":{"type":"object","properties":{"uuid":{"type":"string","example":"09f0c586-b232-4c47-b151-cebbec53d092"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":true},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"group_scheme":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"}},"description":"The group scheme that the sub scheme is part of."}},"example":{"uuid":"51472132-d2af-4349-8699-fde682d8906a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":true,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":{"uuid":"d2fdb5e9-0e8b-42e4-a08d-e570399883ee","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"sub_accounts":[{"uuid":"bd2bb98f-cbee-4c50-89b9-ce8a9e0bface","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}],"provider":{"uuid":"21665d7b-031c-490f-906c-127b113d20be","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"AJ Bell","slug":"aj-bell"},"covers":[{"uuid":"c1a24018-e27f-4c51-b784-57fb6ece023d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","cover_type":"critical_illness","benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"benefit_frequency":"monthly","benefit_status":"active","excess":{"amount":{"example":"10000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"indexation":1.4,"client":"App\\Http\\Resources\\AccountResource"}],"claims":[{"uuid":"5b672e12-6860-4162-9da0-1ef2cb2ebad2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","claim_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"claim_start_date":"2025-05-08","claim_end_date":"2031-05-08","claim_notes":"Claim notes","client":"App\\Http\\Resources\\AccountResource"}],"total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":[{"uuid":"896e86b0-931e-44f5-8f00-27044a7ee7cb","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","valued_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource"}],"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":{"uuid":"e1fed590-bee0-4679-9227-6618401f5385","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"accounts":[{"uuid":"cbea1a79-9f13-4cfb-87ea-3b6c210fbe0d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"seller":{"uuid":"b5eb2299-e2a8-4a13-8e82-5ca91185af77","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"linked_owners":[{"uuid":"8bd30b10-8d53-4d03-85cd-6cd067045d4d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"linked_plans":[{"uuid":"b1774caf-dc1d-4f9e-9ea1-96a50fa7412b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":true,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource","group_scheme":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"}],"visible_to_circles":{"uuid":"067e3f66-952b-49c9-97d8-5a78a329487a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Jones Family","photo_url":"https://eu.ui-avatars.com/api/?name=jones+family","bg_colour":"#35f4e1","accounts":"App\\Http\\Resources\\AccountResource","groups":"App\\Http\\Resources\\GroupResource","joint_account_uuid":"9079faf3-9925-43e0-a0ab-68208bc5be36","login_access_level":"write","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"statistics":{"recent_growth":100},"cases":[{"uuid":"a6065418-5c7e-4fa0-bfa4-7c7fd88f4b43","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["654e1f94-c126-49f3-b675-49a3faecaba4"],"group_uuids":["4e53cdfa-c65c-4f2b-9507-5f159a9b4442"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"b36e7b31-d0f4-4590-befb-b1c788ed07a2","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"}],"tags":[{"uuid":"95580036-47d6-45e6-9eab-830a0784495f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}],"is_wrap_product":false,"is_wrap_child":false,"wrap":{"uuid":"0d5fdbed-eab2-44d7-9bd9-624922c00269","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"wrap_children":[{"uuid":"dc29294e-4849-4d9c-b78c-f657bc6619a6","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}],"linked_policy_numbers":[{"uuid":"408c0c7c-0da9-49ee-a132-014e1c24ecab","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","linked_policy_number":"ABC123-X","plan":"App\\Http\\Resources\\Plans\\PlanResource"}],"can_be_deleted":"false","contract_enquiry_account":{"uuid":"637b30bc-6569-4853-9d82-e1e59df643f2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"custom_fields":[{"uuid":"df0cb3f1-fb0d-4d24-a212-58ae6573b2b4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"external_references":[{"uuid":"d4872139-514c-4801-8f51-8766dfbf3645","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","third_party":"nucleus","reference":"AB123456"}],"group_scheme":{"uuid":"09f0c586-b232-4c47-b151-cebbec53d092","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":true,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource","group_scheme":"App\\Http\\Resources\\Plans\\SubGroupSchemeResource"}}},"App_Http_Resources_Plans_ProviderFeedLogResource":{"type":"object","properties":{"uuid":{"type":"string","example":"8d0c7f34-fea2-431d-8c41-33ed0aea6244","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"sub_account":{"type":"object","properties":{"uuid":{"type":"string","example":"7c4427aa-f02c-40b2-b78b-6004cd2e2457"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}},"description":"The sub-account if the log was added to the sub-account level."},"level":{"type":"string","example":"info","description":"The level of the log. Available options: info, warning and error"},"message":{"type":"string","example":"Successfully updated valuation and holdings from provider feed.","description":"The message of the log"},"context":{"type":"object","properties":{"additional":{"type":"string","example":"info"}},"description":"Key-value store for additional information about the log."}},"example":{"uuid":"8d0c7f34-fea2-431d-8c41-33ed0aea6244","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","sub_account":{"uuid":"7c4427aa-f02c-40b2-b78b-6004cd2e2457","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"level":"info","message":"Successfully updated valuation and holdings from provider feed.","context":{"additional":"info"}}},"App_Http_Resources_Plans_LinkedPolicyNumberResource":{"type":"object","properties":{"uuid":{"type":"string","example":"7866b5b2-5105-49b5-a59e-19473b12a7ee","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"linked_policy_number":{"type":"string","example":"ABC123-X","description":"The linked policy number."},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"900989db-52a6-4857-8beb-dc9be6504422"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The plan this linked policy number belongs to."}},"example":{"uuid":"7866b5b2-5105-49b5-a59e-19473b12a7ee","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","linked_policy_number":"ABC123-X","plan":{"uuid":"900989db-52a6-4857-8beb-dc9be6504422","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_PlatformDetailResource":{"type":"object","properties":{"uuid":{"type":"string","example":"1723ed21-d1ca-4ea8-b935-829cdfbdcac4"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"supported_platform":{"type":"string","example":"seccl"},"config":{"type":"array","example":[]},"friendly_name":{"type":"string","example":"A cool name"}},"example":[{"uuid":"1723ed21-d1ca-4ea8-b935-829cdfbdcac4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","supported_platform":"seccl","config":[],"friendly_name":"A cool name"}]},"App_Http_Resources_Platform_PlatformModelResource":{"type":"object","properties":{"id":{"type":"string","example":"0T8B25"},"name":{"type":"string","example":"Balanced Model Portfolio"},"active":{"type":"boolean","example":true},"riskRating":{"type":"integer","example":3},"additional_data":{"type":"array","example":[]}},"example":[{"id":"0T8B25","name":"Balanced Model Portfolio","active":true,"riskRating":3,"additional_data":[]}]},"App_Http_Resources_Plans_PremiumResource":{"type":"object","properties":{"uuid":{"type":"string","example":"0afb8d6d-38d0-4890-851d-b058efe3010c","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"transfer_type":{"type":"string","example":"transfer","description":"Transfer type"},"date_of_transfer_valuation":{"type":"string","example":"2025-12-20","description":"Date of transfer valuation"},"date_advice_given":{"type":"string","example":"2025-11-15","description":"Date advice given"},"premium":{"type":"integer","example":74584,"description":"The calculated premium amount which is received at frequency intervals"},"premium_monthly":{"type":"integer","example":298336,"description":"The calculated premium amount which is received as a monthly value"},"premium_annually":{"type":"integer","example":3580032,"description":"The calculated premium amount which is received as an annual value"},"total_premium_to_date":{"type":"integer","example":74584,"description":"The total of this premium so far to current date or end date according to frequency"},"amount":{"type":"integer","example":74584,"description":"Premium amount in pennies. Either amount or percentage can be given in request"},"percentage":{"type":"number","example":5.5,"description":"Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request"},"frequency":{"type":"string","example":"weekly","description":"Frequency of the premium"},"source":{"type":"string","example":"employee","description":"Premium source. Only required for pension plans"},"payment_method":{"type":"string","example":"direct_debit","description":"Payment method"},"start_date":{"type":"string","example":"2026-03-24","description":"Start date"},"end_date":{"type":"string","example":"2028-05-08","description":"End date. Blank for ongoing"},"pensionable_salary":{"type":"integer","example":10000000,"description":"The pensionable salary that was used to calculate percentage based premium"},"details":{"type":"string","example":"Extra premium details","description":"Details"},"created_by":{"type":"object","properties":{"uuid":{"type":"string","example":"3f309b08-9129-4337-bd3d-ba19bb79d80b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that created this premium"},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"5f747299-8121-47ed-8426-75ddec4f5b6e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Plan this premium belongs to, only if included"},"transferred_from_plan":{"type":"object","properties":{"uuid":{"type":"string","example":"b55d692f-d271-4138-abd3-2c8dc9a8a465"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Plan this premium was transferred from"},"transferred_from_plan_type":{"type":"string","example":"cash_account","description":"Plan type this premium was transferred from if the actual plan is unknown"},"transferred_from_plan_sub_type":{"type":"string","example":"cash_deposit","description":"Plan sub type this premium was transferred from if the actual plan is unknown"}},"example":{"uuid":"0afb8d6d-38d0-4890-851d-b058efe3010c","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","transfer_type":"transfer","date_of_transfer_valuation":"2025-12-20","date_advice_given":"2025-11-15","premium":74584,"premium_monthly":298336,"premium_annually":3580032,"total_premium_to_date":74584,"amount":74584,"percentage":5.5,"frequency":"weekly","source":"employee","payment_method":"direct_debit","start_date":"2026-03-24","end_date":"2028-05-08","pensionable_salary":10000000,"details":"Extra premium details","created_by":{"uuid":"3f309b08-9129-4337-bd3d-ba19bb79d80b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"plan":{"uuid":"5f747299-8121-47ed-8426-75ddec4f5b6e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"transferred_from_plan":{"uuid":"b55d692f-d271-4138-abd3-2c8dc9a8a465","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"transferred_from_plan_type":"cash_account","transferred_from_plan_sub_type":"cash_deposit"}},"App_Http_Resources_Plans_ProviderResource":{"type":"object","properties":{"uuid":{"type":"string","example":"f77cf3d3-dc3a-4adb-9cc0-54854cb4bf05","description":"UUID of the provider"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"AJ Bell","description":"Provider name"},"slug":{"type":"string","example":"aj-bell","description":"Provider name slug"}},"example":{"uuid":"f77cf3d3-dc3a-4adb-9cc0-54854cb4bf05","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"AJ Bell","slug":"aj-bell"}},"App_Http_Resources_ReportTemplateResource":{"type":"object","properties":{"uuid":{"type":"string","example":"897e20fe-d045-455f-b430-918b66ee8b77"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"2 weeks overdue task report"},"created_by":{"type":"object","properties":{"uuid":{"type":"string","example":"400c9678-1c10-4a50-8242-2c3c46fc20ab"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"report_type_id":{"type":"string","example":"rmar"},"report_query":{"type":"object","properties":{"start_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"}}}},"example":[{"uuid":"897e20fe-d045-455f-b430-918b66ee8b77","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"2 weeks overdue task report","created_by":{"uuid":"400c9678-1c10-4a50-8242-2c3c46fc20ab","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"report_type_id":"rmar","report_query":{"start_date":"2026-05-08T14:41:56+01:00"}}]},"App_Http_Resources_ReportResource":{"type":"object","properties":{"uuid":{"type":"string","example":"9111332b-784e-4d3a-af4e-fbb5033ad558","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"last_interaction_at":{"type":"string","example":"2024-01-24T10:30:00Z","description":"Last interaction date of an account associated with this report"},"last_login_at":{"type":"string","example":"2024-01-24T09:15:00Z","description":"Last login date of an account associated with this report"},"name":{"type":"string","example":"rmar-report-2026-05-08T14:41:56+01:00","description":"Name of the report"},"created_by":{"type":"object","properties":{"uuid":{"type":"string","example":"60cc9076-d4f6-4fe5-b500-09b4a89601fe"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"the account that created this report"},"report_type_id":{"type":"string","example":"rmar","description":"report type id"},"status":{"type":"string","example":"complete","description":"Current status of report generation"},"progress":{"type":"integer","example":100,"description":"Current progress of the report when generating"},"files":{"type":"array","example":[{"uuid":"c2f7317e-63fc-4c94-b00d-e2b6d0080659","created_at":"2026-05-08T14:41:56+01:00","original_created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","uploaded_at":"2026-05-08T14:41:56+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:56+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/f34f7418-7840-41f9-aa30-572da8272780/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"3e69c90a-2295-48a1-98e6-1cc573f65d14"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"description":"Files generated for this report instance","items":{"type":"object","properties":{"uuid":{"type":"string","example":"c2f7317e-63fc-4c94-b00d-e2b6d0080659"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"uploaded_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"status":{"type":"string","example":"uploaded"},"filename":{"type":"string","example":"Welcome to Plannr.pdf"},"name":{"type":"string","example":"Welcome to Plannr"},"extension":{"type":"string","example":"pdf"},"type":{"type":"string","example":"type"},"size":{"type":"string","example":"21691783"},"path":{"type":"string","example":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf"},"last_modified":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"progress":{"type":"string","example":"100"},"download_url":{"type":"string","example":"https://api.plannrcrm.com/file/f34f7418-7840-41f9-aa30-572da8272780/download"},"folder_name":{"type":"string","example":"folder 2"},"folder":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"documentable_type":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"navigator":{"type":"object","properties":{"model_type":{"type":"string","example":"account"},"model_uuid":{"type":"string","example":"3e69c90a-2295-48a1-98e6-1cc573f65d14"}}},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"}}}},"folder":{"type":"object","properties":{"uuid":{"type":"string","example":"6c00e514-40ca-4f85-aead-830571bc5b99"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Important Documents"},"slug":{"type":"string","example":"important-documents"},"path":{"type":"string","example":"Codepotato/Important Documents"},"clients_read":{"type":"boolean","example":true},"clients_write":{"type":"boolean","example":true},"show_client_permissions":{"type":"boolean","example":true},"is_system_folder":{"type":"boolean","example":true},"is_pseudo_folder":{"type":"boolean","example":true},"is_root_folder":{"type":"boolean","example":true},"documentable_type":{"type":"string","example":"account"},"documentable_uuid":{"type":"string","example":"account"},"documentable":{"type":"string","example":"Object"},"participants_count":{"type":"integer","example":3},"participants":{"type":"string","example":"App\\Http\\Resources\\FolderParticipantResource"},"folders_count":{"type":"integer","example":5},"folders":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"files_count":{"type":"integer","example":8},"files":{"type":"string","example":"App\\Http\\Resources\\FileResource"},"parents":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"ancestors":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"children":{"type":"string","example":"App\\Http\\Resources\\FolderResource"},"depth":{"type":"integer","example":5},"owned":{"type":"boolean","example":false}},"description":"Folder generated with the report. this is the default folder that all generated documents will be stored"}},"example":{"uuid":"9111332b-784e-4d3a-af4e-fbb5033ad558","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","last_interaction_at":"2024-01-24T10:30:00Z","last_login_at":"2024-01-24T09:15:00Z","name":"rmar-report-2026-05-08T14:41:56+01:00","created_by":{"uuid":"60cc9076-d4f6-4fe5-b500-09b4a89601fe","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"report_type_id":"rmar","status":"complete","progress":100,"files":[{"uuid":"c2f7317e-63fc-4c94-b00d-e2b6d0080659","created_at":"2026-05-08T14:41:56+01:00","original_created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","uploaded_at":"2026-05-08T14:41:56+01:00","status":"uploaded","filename":"Welcome to Plannr.pdf","name":"Welcome to Plannr","extension":"pdf","type":"type","size":"21691783","path":"Gareth Thompson/Subfolder/Welcome to Plannr.pdf","last_modified":"2026-05-08T14:41:56+01:00","progress":"100","download_url":"https://api.plannrcrm.com/file/f34f7418-7840-41f9-aa30-572da8272780/download","folder_name":"folder 2","folder":"App\\Http\\Resources\\FolderResource","documentable_type":"account","documentable":"Object","navigator":{"model_type":"account","model_uuid":"3e69c90a-2295-48a1-98e6-1cc573f65d14"},"firm":"App\\Http\\Resources\\FirmResource","account":"App\\Http\\Resources\\MinimalAccountResource","tags":"App\\Http\\Resources\\TagResource"}],"folder":{"uuid":"6c00e514-40ca-4f85-aead-830571bc5b99","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Important Documents","slug":"important-documents","path":"Codepotato/Important Documents","clients_read":true,"clients_write":true,"show_client_permissions":true,"is_system_folder":true,"is_pseudo_folder":true,"is_root_folder":true,"documentable_type":"account","documentable_uuid":"account","documentable":"Object","participants_count":3,"participants":"App\\Http\\Resources\\FolderParticipantResource","folders_count":5,"folders":"App\\Http\\Resources\\FolderResource","files_count":8,"files":"App\\Http\\Resources\\FileResource","parents":"App\\Http\\Resources\\FolderResource","ancestors":"App\\Http\\Resources\\FolderResource","children":"App\\Http\\Resources\\FolderResource","depth":5,"owned":false}}},"App_Http_Resources_RiskResource":{"type":"object","properties":{"uuid":{"type":"string","example":"69524b6f-7a87-418d-850e-e8de00d4e344","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"level":{"type":"integer","example":52,"description":"The risk level of the clients risk assessment. Cannot be set with level_string"},"level_string":{"type":"string","example":"Moderately Aggressive","description":"The risk level of the client as a string/text. Cannot be set with level."},"completed_at":{"type":"string","example":"2025-05-08T14:41:54+01:00","description":"Date of risk assessment completion."},"completed_by":{"type":"object","properties":{"uuid":{"type":"string","example":"97b00b4d-55d6-4dde-bbf2-a9f0c60bb197"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account of the employee that completed the risk assessment"},"risk_assessment_provider":{"type":"string","example":"Defaqto","description":"Name of the risk assessment provider."},"time_horizon":{"type":"string","example":"For the next 5 years","description":"How long the risk assessment will last for the client."},"time_horizon_set_at":{"type":"string","example":"2026-04-08T14:41:54+01:00","description":"The date the time_horizon was set. Can be used as a reference point against time horizon for users."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"252d747b-6ccf-4166-bff2-03f267d86546"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account who owns the Risk. This may not be included when viewing all risks. Refer to the documentation to include this field."}},"example":{"uuid":"69524b6f-7a87-418d-850e-e8de00d4e344","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","level":52,"level_string":"Moderately Aggressive","completed_at":"2025-05-08T14:41:54+01:00","completed_by":{"uuid":"97b00b4d-55d6-4dde-bbf2-a9f0c60bb197","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"risk_assessment_provider":"Defaqto","time_horizon":"For the next 5 years","time_horizon_set_at":"2026-04-08T14:41:54+01:00","account":{"uuid":"252d747b-6ccf-4166-bff2-03f267d86546","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_V2_RiskResource":{"type":"object","properties":{"uuid":{"type":"string","example":"414e1b32-ed1b-41e8-ac61-8b29df8fda87","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"level":{"type":"integer","example":52,"description":"The risk level of the clients risk assessment. Cannot be set with level_string"},"level_string":{"type":"string","example":"Moderately Aggressive","description":"The risk level of the client as a string/text. Cannot be set with level."},"completed_at":{"type":"string","example":"2025-05-08T14:41:56+01:00","description":"Date of risk assessment completion."},"completed_by":{"type":"object","properties":{"uuid":{"type":"string","example":"ceec23bf-3f24-46eb-8d1b-e78c151998e2"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account of the employee that completed the risk assessment"},"risk_assessment_provider":{"type":"string","example":"Defaqto","description":"Name of the risk assessment provider."},"time_horizon":{"type":"string","example":"For the next 5 years","description":"How long the risk assessment will last for the client."},"time_horizon_set_at":{"type":"string","example":"2026-04-08T14:41:56+01:00","description":"The date the time_horizon was set. Can be used as a reference point against time horizon for users."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"d19bdf71-29e2-4b55-b1e2-967d43b410bf"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account who owns the Risk. This may not be included when viewing all risks. Refer to the documentation to include this field."}},"example":{"uuid":"414e1b32-ed1b-41e8-ac61-8b29df8fda87","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","level":52,"level_string":"Moderately Aggressive","completed_at":"2025-05-08T14:41:56+01:00","completed_by":{"uuid":"ceec23bf-3f24-46eb-8d1b-e78c151998e2","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"risk_assessment_provider":"Defaqto","time_horizon":"For the next 5 years","time_horizon_set_at":"2026-04-08T14:41:56+01:00","account":{"uuid":"d19bdf71-29e2-4b55-b1e2-967d43b410bf","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_ShareholderResource":{"type":"object","properties":{"uuid":{"type":"string","example":"a201d774-1dd6-4bd9-8b6a-c05630c0de72","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"full_name":{"type":"string","example":"Connor Richards","description":"Full name of the shareholder"},"role":{"type":"string","example":"Director","description":"Role of the shareholder"},"appointed_at":{"type":"string","example":"2015-01-19","description":"Date the shareholder was appointed"},"address":{"type":"object","properties":{"uuid":{"type":"string","example":"e424a88e-052b-4944-8f39-2ef166c21c30"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Work Address"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"address_3":{"type":"string","example":"The Innovative Centre"},"address_4":{"type":"string","example":"Waterlooville"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"move_in_date":{"type":"string","example":"2025-05-08"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"}},"description":"Registered address of the shareholder"},"percentage":{"type":"number","example":42.54,"description":"Percentage of shares owned by the shareholder"},"shares_owned":{"type":"number","example":60.53,"description":"Number of shares owned by the shareholder"},"voting_rights":{"type":"string","example":"Yes","description":"Voting rights of the shareholder"},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"f08ba1e1-4454-41eb-b48c-d4755f0c0616"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Codepotato"},"slug":{"type":"string","example":"codepotato"},"address_1":{"type":"string","example":"Suite E, 5 The Briars"},"address_2":{"type":"string","example":"Waterberry Drive"},"town_city":{"type":"string","example":"Waterlooville"},"county":{"type":"string","example":"Hampshire"},"postcode":{"type":"string","example":"PO7 7YH"},"country":{"type":"string","example":"United Kingdom"},"regulatory_text":{"type":"string","example":"Regulatory text"},"logo":{"type":"string","example":"https://api.plannrcrm.com/images/plannr.jpg"},"logo_icon":{"type":"string","example":"https://api.plannrcrm.com/images/plannr-icon.jpg"},"brand_colours":{"type":"object","properties":{"sidebar_background":{"type":"string","example":"#0E0E56"},"sidebar_accent":{"type":"string","example":"#36367E"},"sidebar_text":{"type":"string","example":"#FFFFFF"},"sidebar_hover":{"type":"string","example":"#0A0A42"},"sidebar_active":{"type":"string","example":"#53DBB8"},"sidebar_title_background":{"type":"string","example":"#36367E"},"sidebar_title_primary":{"type":"string","example":"#FFC634"},"sidebar_title_secondary":{"type":"string","example":"#FFFFFF"},"sidebar_title_secondary_hover":{"type":"string","example":"#FFFFFF"},"email_background":{"type":"string","example":"#0E0E56"},"email_logo_background_panel":{"type":"string","example":"#36367E"},"email_sub_text":{"type":"string","example":"#FFFFFF"},"email_button_background":{"type":"string","example":"#36367E"},"email_button_text":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_button_hover":{"type":"string","example":"#FFFFFF"},"portal_sidebar_button_active":{"type":"string","example":"#FFFFFF"},"portal_brand_title":{"type":"string","example":"#323B4B"},"portal_brand_sub_title":{"type":"string","example":"#828994"},"portal_sidebar_title":{"type":"string","example":"#11151D"},"portal_sidebar_text":{"type":"string","example":"#323B4B"},"portal_sidebar_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_text_active":{"type":"string","example":"#323B4B"},"portal_sidebar_icon":{"type":"string","example":"#828994"},"portal_sidebar_icon_hover":{"type":"string","example":"#828994"},"portal_sidebar_icon_active":{"type":"string","example":"#828994"},"portal_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_account_title":{"type":"string","example":"#11151D"},"portal_sidebar_account_email":{"type":"string","example":"#828994"},"portal_sidebar_divider":{"type":"string","example":"#E3E5E9"},"portal_dashboard_bg_one":{"type":"string","example":"#EF4583"},"portal_dashboard_bg_two":{"type":"string","example":"#FFC634"},"portal_sidebar_collapse_button":{"type":"string","example":"#828994"},"portal_sidebar_collapse_button_hover":{"type":"string","example":"#B3B9C4"},"portal_sidebar_user_select_background":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_hover":{"type":"string","example":"#F6F6F6"},"portal_sidebar_user_select_text":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_text_hover":{"type":"string","example":"#323B4B"},"portal_sidebar_user_select_border":{"type":"string","example":"#EEEEEE"},"portal_sidebar_user_select_border_hover":{"type":"string","example":"#828994"}}},"is_subscribed":{"type":"boolean","example":true},"addon_subscriptions":{"type":"string","example":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource"},"keep_deleted_files_for":{"type":"integer","example":30},"tax":{"type":"number","example":17.5},"month_end":{"type":"integer","example":25},"statement_frequency":{"type":"string","example":"monthly"},"billing":{"type":"object","properties":{"invoice_address_1":{"type":"string","example":"Suite E, 5 The Briars"},"invoice_address_2":{"type":"string","example":"Waterberry Drive"},"invoice_town_city":{"type":"string","example":"Waterlooville"},"invoice_county":{"type":"string","example":"Hampshire"},"invoice_postcode":{"type":"string","example":"PO7 7YH"},"invoice_country":{"type":"string","example":"United Kingdom"},"invoice_email":{"type":"string","example":"gareth@codepotato.co.uk"}}},"task_board_template":{"type":"string","example":"App\\Http\\Resources\\Board\\BoardResource"},"ip_whitelist":{"type":"array","example":["192.168.0.1","127.0.0.1"],"items":{"type":"string"}},"welcome_paragraph_html":{"type":"string","example":"\u003ch1\u003eWelcome.\u003c/h1\u003e"},"email_welcome_paragraph_html":{"type":"string","example":"Welcome to Plannr!"},"show_fact_find_illustrations":{"type":"boolean","example":true},"cc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"bcc_email_addresses":{"type":"array","example":["jack@example.com","jill@example.com"],"items":{"type":"string"}},"reply_to_email_address":{"type":"string","example":"jack@example.com"},"mobile_app_support_number":{"type":"string","example":"01234 567890"},"mobile_app_support_email":{"type":"string","example":"support@example.com"}},"description":"Firm the shareholder is associated with"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"63b698fb-d326-41e8-8926-4ed8b5a171f0"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:56"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Business the shareholder is associated with"}},"example":{"uuid":"a201d774-1dd6-4bd9-8b6a-c05630c0de72","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","full_name":"Connor Richards","role":"Director","appointed_at":"2015-01-19","address":{"uuid":"e424a88e-052b-4944-8f39-2ef166c21c30","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2025-05-08","accounts":"App\\Http\\Resources\\AccountResource"},"percentage":42.54,"shares_owned":60.53,"voting_rights":"Yes","firm":{"uuid":"f08ba1e1-4454-41eb-b48c-d4755f0c0616","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"Codepotato","slug":"codepotato","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","regulatory_text":"Regulatory text","logo":"https://api.plannrcrm.com/images/plannr.jpg","logo_icon":"https://api.plannrcrm.com/images/plannr-icon.jpg","brand_colours":{"sidebar_background":"#0E0E56","sidebar_accent":"#36367E","sidebar_text":"#FFFFFF","sidebar_hover":"#0A0A42","sidebar_active":"#53DBB8","sidebar_title_background":"#36367E","sidebar_title_primary":"#FFC634","sidebar_title_secondary":"#FFFFFF","sidebar_title_secondary_hover":"#FFFFFF","email_background":"#0E0E56","email_logo_background_panel":"#36367E","email_sub_text":"#FFFFFF","email_button_background":"#36367E","email_button_text":"#FFFFFF","portal_sidebar_button_background":"#F6F6F6","portal_sidebar_button_hover":"#FFFFFF","portal_sidebar_button_active":"#FFFFFF","portal_brand_title":"#323B4B","portal_brand_sub_title":"#828994","portal_sidebar_title":"#11151D","portal_sidebar_text":"#323B4B","portal_sidebar_text_hover":"#323B4B","portal_sidebar_text_active":"#323B4B","portal_sidebar_icon":"#828994","portal_sidebar_icon_hover":"#828994","portal_sidebar_icon_active":"#828994","portal_background":"#F6F6F6","portal_sidebar_account_title":"#11151D","portal_sidebar_account_email":"#828994","portal_sidebar_divider":"#E3E5E9","portal_dashboard_bg_one":"#EF4583","portal_dashboard_bg_two":"#FFC634","portal_sidebar_collapse_button":"#828994","portal_sidebar_collapse_button_hover":"#B3B9C4","portal_sidebar_user_select_background":"#F6F6F6","portal_sidebar_user_select_hover":"#F6F6F6","portal_sidebar_user_select_text":"#323B4B","portal_sidebar_user_select_text_hover":"#323B4B","portal_sidebar_user_select_border":"#EEEEEE","portal_sidebar_user_select_border_hover":"#828994"},"is_subscribed":true,"addon_subscriptions":"App\\Http\\Resources\\Addons\\AddonSubscriptionResource","keep_deleted_files_for":30,"tax":17.5,"month_end":25,"statement_frequency":"monthly","billing":{"invoice_address_1":"Suite E, 5 The Briars","invoice_address_2":"Waterberry Drive","invoice_town_city":"Waterlooville","invoice_county":"Hampshire","invoice_postcode":"PO7 7YH","invoice_country":"United Kingdom","invoice_email":"gareth@codepotato.co.uk"},"task_board_template":"App\\Http\\Resources\\Board\\BoardResource","ip_whitelist":["192.168.0.1","127.0.0.1"],"welcome_paragraph_html":"\u003ch1\u003eWelcome.\u003c/h1\u003e","email_welcome_paragraph_html":"Welcome to Plannr!","show_fact_find_illustrations":true,"cc_email_addresses":["jack@example.com","jill@example.com"],"bcc_email_addresses":["jack@example.com","jill@example.com"],"reply_to_email_address":"jack@example.com","mobile_app_support_number":"01234 567890","mobile_app_support_email":"support@example.com"},"account":{"uuid":"63b698fb-d326-41e8-8926-4ed8b5a171f0","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:56+01:00","next_review_date":"2026-05-08T14:41:56+01:00","previous_review_date":"2026-05-08T14:41:56+01:00","anniversary_review_date":"2026-05-08T14:41:56+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:56","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_StaffMemberResource":{"type":"object","properties":{"uuid":{"type":"string","example":"e3e2525d-18b7-4668-939b-0a4e90679bc8","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"hired_at":{"type":"string","example":"2018-01-15T00:00:00+00:00","description":"Date (y-m-d) of when the staff member was hired."},"left_at":{"type":"string","example":"2025-01-15T00:00:00+00:00","description":"Date (y-m-d) of when the staff member left."},"job_title":{"type":"string","example":"Chief Coffee Maker","description":"The job title of the staff member."},"basic_annual_salary":{"type":"object","properties":{"amount":{"type":"integer","example":5000000},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£50,000.00"}},"description":"The basic annual salary of the staff member. Must be in pennies, for example: £50,000 would be 5000000."},"payroll_number":{"type":"string","example":"#12345","description":"The payroll number of the staff member."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"a4032b62-be43-4629-a5f4-f7a6b4f94200"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Client account in Plannr."}},"example":{"uuid":"e3e2525d-18b7-4668-939b-0a4e90679bc8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","hired_at":"2018-01-15T00:00:00+00:00","left_at":"2025-01-15T00:00:00+00:00","job_title":"Chief Coffee Maker","basic_annual_salary":{"amount":5000000,"currency":"GBP","formatted":"£50,000.00"},"payroll_number":"#12345","account":{"uuid":"a4032b62-be43-4629-a5f4-f7a6b4f94200","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_StatementResource":{"type":"object","properties":{"uuid":{"type":"string","example":"20a0344a-d06a-455e-b4a6-a6bab67efa1e","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"01/06/2022 - 30/06/2022","description":"Statement description"},"start_date":{"type":"string","example":"2022-06-30","description":"End date of the statement"},"end_date":{"type":"string","example":"2022-06-01","description":"Start date of the statement"},"locked":{"type":"boolean","example":false,"description":"Denotes whether the statement is locked or not"},"locked_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The time that the statement was locked at"},"locked_by":{"type":"object","properties":{"uuid":{"type":"string","example":"999c9e06-fe1c-4dc7-a965-781b23f25df9"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account that locked the statement"},"total_expectations":{"type":"object","properties":{"amount":{"type":"string","example":"124585"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,245.85"}},"description":"Total amount of expectations for the statement period"},"total_statement_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}},"description":"Total amount of statement transactions received for the statement period"},"total_bank_transactions":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}},"description":"Total amount of bank transactions received for the statement period"},"total_expectation_amount_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"125599"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£1,255.99"}},"description":"Total amount of expectations that have been reconciled to the bank received for the statement period"},"total_expectation_percentage_reconciled_to_bank":{"type":"object","properties":{"amount":{"type":"string","example":"8570"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£85.70"}},"description":"Total percentage of expectations that have been reconciled to the bank received for the statement period"},"expectations_count":{"type":"integer","example":6,"description":"Total number of expectations for the statement period"},"statement_transactions_count":{"type":"integer","example":6,"description":"Total number of statement transactions received for the statement period"},"statement_transactions":{"type":"array","example":[{"uuid":"df41b695-9047-4bc7-966d-7b2ce8f06783","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"dYlNEoYUdx","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}],"description":"Statement transactions for the statement period","items":{"type":"object","properties":{"uuid":{"type":"string","example":"df41b695-9047-4bc7-966d-7b2ce8f06783"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"client_name":{"type":"string","example":"Gareth Thompson"},"transaction_reference":{"type":"string","example":"dYlNEoYUdx"},"policy_number":{"type":"string","example":"AVIVA_00001"},"date":{"type":"string","example":"2026-05-08"},"gross_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"net_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"category":{"type":"string","example":"initial_fee"},"payment_origin":{"type":"string","example":"provider"},"agency_number":{"type":"string","example":"Agency number"},"product_reference":{"type":"string","example":"Product reference"},"adviser_name":{"type":"string","example":"Adviser name"},"sender_id_sib_number":{"type":"string","example":"Sender id sib number"},"reason":{"type":"string","example":"Reason"},"scheme_name":{"type":"string","example":"Scheme name"},"scheme_number":{"type":"string","example":"Scheme number"},"customer_number":{"type":"string","example":"Customer number"},"policy_market_value":{"type":"string","example":"Policy market value"},"provider":{"type":"string","example":"Aviva"},"provider_statement":{"type":"string","example":"App\\Http\\Resources\\ProviderStatementResource"},"metadata":{"type":"object","properties":{"client_name":{"type":"string","example":"Gareth Thompson"}}},"expectation":{"type":"string","example":"App\\Http\\Resources\\ExpectationResource"},"bank_transactions":{"type":"string","example":"App\\Http\\Resources\\BankTransactionResource"},"statement":{"type":"string","example":"App\\Http\\Resources\\StatementResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"}}}}},"example":{"uuid":"20a0344a-d06a-455e-b4a6-a6bab67efa1e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"01/06/2022 - 30/06/2022","start_date":"2022-06-30","end_date":"2022-06-01","locked":false,"locked_at":"2026-05-08T14:41:55+01:00","locked_by":{"uuid":"999c9e06-fe1c-4dc7-a965-781b23f25df9","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"total_expectations":{"amount":"124585","currency":"GBP","formatted":"£1,245.85"},"total_statement_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_bank_transactions":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_amount_reconciled_to_bank":{"amount":"125599","currency":"GBP","formatted":"£1,255.99"},"total_expectation_percentage_reconciled_to_bank":{"amount":"8570","currency":"GBP","formatted":"£85.70"},"expectations_count":6,"statement_transactions_count":6,"statement_transactions":[{"uuid":"df41b695-9047-4bc7-966d-7b2ce8f06783","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","client_name":"Gareth Thompson","transaction_reference":"dYlNEoYUdx","policy_number":"AVIVA_00001","date":"2026-05-08","gross_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"net_amount":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"category":"initial_fee","payment_origin":"provider","agency_number":"Agency number","product_reference":"Product reference","adviser_name":"Adviser name","sender_id_sib_number":"Sender id sib number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","provider":"Aviva","provider_statement":"App\\Http\\Resources\\ProviderStatementResource","metadata":{"client_name":"Gareth Thompson"},"expectation":"App\\Http\\Resources\\ExpectationResource","bank_transactions":"App\\Http\\Resources\\BankTransactionResource","statement":"App\\Http\\Resources\\StatementResource","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource"}]}},"App_Http_Resources_Static_StaticOccupationResource":{"type":"object","properties":{"name":{"type":"string","example":"Accountant"},"code":{"type":"string","example":"AAB00011"}},"example":[{"name":"Accountant","code":"AAB00011"}]},"App_Http_Resources_Static_StaticNationalityResource":{"type":"object","properties":{"country":{"type":"string","example":"United Kingdom of Great Britain and Northern Ireland"},"nationality":{"type":"string","example":"British"},"code":{"type":"string","example":"GB"}},"example":[{"country":"United Kingdom of Great Britain and Northern Ireland","nationality":"British","code":"GB"}]},"App_Http_Resources_Static_StaticAddonCategoryResource":{"type":"object","properties":{"name":{"type":"string","example":"Valuation Feed Integration"},"value":{"type":"string","example":"valuation_feed_integration"}},"example":[{"name":"Valuation Feed Integration","value":"valuation_feed_integration"}]},"App_Http_Resources_Static_StaticPlanTypeResource":{"type":"object","properties":{"name":{"type":"string","example":"CASH_ACCOUNT"},"value":{"type":"string","example":"cash_account"}},"example":[{"name":"CASH_ACCOUNT","value":"cash_account"}]},"App_Http_Resources_Static_StaticPlanSubTypeResource":{"type":"object","properties":{"name":{"type":"string","example":"ISA Cash"},"value":{"type":"string","example":"isa_cash"}},"example":[{"name":"ISA Cash","value":"isa_cash"}]},"App_Http_Resources_Plans_PortfolioResource":{"type":"object","properties":{"uuid":{"type":"string","example":"96672872-a126-4202-b2fd-268bdf3b608c","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"is_proposed":{"type":"boolean","example":true,"description":"Denotes if the portfolio is proposed"},"proposed_at":{"type":"string","example":"2026-05-08T00:00:00+01:00","description":"The date the portfolio was proposed."},"name":{"type":"string","example":"Risky Portfolio","description":"The name of the portfolio."}},"example":{"uuid":"96672872-a126-4202-b2fd-268bdf3b608c","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","is_proposed":true,"proposed_at":"2026-05-08T00:00:00+01:00","name":"Risky Portfolio"}},"App_Http_Resources_TagResource":{"type":"object","properties":{"uuid":{"type":"string","example":"742f25e7-fd26-4fe1-8046-7657b1265450","description":"UUID of the tag"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Mortgage","description":"The name of the tag"},"slug":{"type":"string","example":"mortgage","description":"The slug of the tag"},"colour":{"type":"string","example":"#ef4582","description":"The colour of the tag"}},"example":{"uuid":"742f25e7-fd26-4fe1-8046-7657b1265450","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Mortgage","slug":"mortgage","colour":"#ef4582"}},"App_Http_Resources_TaskStatusResource":{"type":"object","properties":{"uuid":{"type":"string","example":"8a253c55-544a-4636-b1b0-2a482d1500a1","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Incomplete","description":"The name of the status"},"colour":{"type":"string","example":"#398898","description":"Status colour"},"position":{"type":"integer","example":1,"description":"The position of the status"},"is_type_completed":{"type":"boolean","example":false,"description":"Whether the status is a completed status"},"is_archived":{"type":"boolean","example":false,"description":"Whether the status is a archived status"},"is_not_started":{"type":"boolean","example":false,"description":"Whether the status is a not started status"}},"example":{"uuid":"8a253c55-544a-4636-b1b0-2a482d1500a1","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Incomplete","colour":"#398898","position":1,"is_type_completed":false,"is_archived":false,"is_not_started":false}},"App_Http_Resources_IndexTaskResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b064735a-ace2-4739-9427-378a087acd1b"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Document the transaction"},"priority":{"type":"string","example":"high"},"position":{"type":"integer","example":1},"due_at":{"type":"string","example":"2021-01-01 00:00:00"},"status":{"type":"object","properties":{"uuid":{"type":"string","example":"37d731a7-b983-4800-b8eb-7df27456a994"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Incomplete"},"colour":{"type":"string","example":"#398898"},"position":{"type":"integer","example":1},"is_type_completed":{"type":"boolean","example":false},"is_archived":{"type":"boolean","example":false},"is_not_started":{"type":"boolean","example":false}}},"taskable_type":{"type":"string","example":"case"},"taskable":{"type":"object","properties":{"uuid":{"type":"string","example":"9514a0a5-8558-40f7-b671-a2a8db657bc4"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"assigned_to_uuids":{"type":"array","example":["47c37df7-d9b6-4675-a0e1-2fac20c5de98"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["d0cb84ca-feda-40fe-a4dd-a3f8008d9c7b"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"983b36cd-cd2d-4e35-8a47-fb1c088afc38"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}}},"author":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"90393fae-a4af-49ee-aef8-f1d4a403423d"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}}},"assigned_to":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"e2e39eb2-2004-489a-969c-58b9cf23a263"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}}},"completed_at":{"type":"string","example":"2021-01-01 00:00:00"},"completed_by":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"dabc0fd8-7b2b-4dbf-be2d-0d09cd279042"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}}},"workflow_task":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"052895f4-08ae-4090-b6ee-be4d0127d975"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Mortgage Review"},"description":{"type":"string","example":"The name of the task"},"collection":{"type":"boolean","example":false}}},"description":{"type":"object","properties":{"example":{"type":"string","example":"We need to run through a mortgage review with Gareth, as he can probably find a better deal."},"description":{"type":"string","example":"The extra description added to a task"},"collection":{"type":"boolean","example":false}}},"priority":{"type":"object","properties":{"example":{"type":"string","example":"high"},"description":{"type":"string","example":"The priority level of the task (e.g p1, p2, p3, p4)"},"collection":{"type":"boolean","example":false}}},"position":{"type":"object","properties":{"example":{"type":"integer","example":2},"description":{"type":"string","example":"The task position."},"collection":{"type":"boolean","example":false}}},"task_status":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TaskStatusResource"},"description":{"type":"string","example":"Task status."},"collection":{"type":"boolean","example":false}}},"offset_due_at_by":{"type":"object","properties":{"example":{"type":"integer","example":2},"description":{"type":"string","example":"How many days from the day the workflow is run should the due at be set by."},"collection":{"type":"boolean","example":false}}},"visible_to_clients":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Indicator for if the task is visible to clients."},"collection":{"type":"boolean","example":false}}},"auto_assign_assigned_adviser":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created."},"collection":{"type":"boolean","example":false}}},"auto_assign_assigned_administrator":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if the task will auto-assign the administrator of the client when it is created."},"collection":{"type":"boolean","example":false}}},"auto_assign_clients":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned."},"collection":{"type":"boolean","example":false}}},"author":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"The author of the task."},"collection":{"type":"boolean","example":false}}},"participants":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"The participants/assignees of the task."},"collection":{"type":"boolean","example":true}}},"tags":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"description":{"type":"string","example":"The tags added to the task."},"collection":{"type":"boolean","example":true}}},"location_uuid":{"type":"object","properties":{"example":{"type":"string","example":"4a845522-3316-4aa9-ab40-d687d4ba1fa7"},"description":{"type":"string","example":"The parent task or workflow trigger task this task is a child of."},"collection":{"type":"boolean","example":false}}},"parent":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The parent task."},"collection":{"type":"boolean","example":false}}},"trigger":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The task that will trigger this task to be created."},"collection":{"type":"boolean","example":false}}},"trigger_tasks":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The tasks that will be triggered when this task is completed."},"collection":{"type":"boolean","example":true}}},"sub_tasks":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The tasks sub tasks."},"collection":{"type":"boolean","example":true}}},"groups":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"description":{"type":"string","example":"The groups that will be added to the task."},"collection":{"type":"boolean","example":true}}},"workflow":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowResource"},"description":{"type":"string","example":"The workflow that the workflow task belongs to."},"collection":{"type":"boolean","example":false}}},"is_trigger_task":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if this is a triggered task."},"collection":{"type":"boolean","example":false}}}}},"is_recurring":{"type":"boolean","example":true},"recurring_frequency":{"type":"string","example":"weekly"},"recurring_last_run":{"type":"string","example":"2026-01-01 00:00:00"},"recurring_next_run":{"type":"string","example":"2026-01-01 00:00:00"},"custom_fields":{"type":"array","example":[{"uuid":"13acad8d-6961-43ff-b666-e7a4c641479a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"items":{"type":"object","properties":{"uuid":{"type":"string","example":"13acad8d-6961-43ff-b666-e7a4c641479a"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}}},"example":[{"uuid":"b064735a-ace2-4739-9427-378a087acd1b","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Document the transaction","priority":"high","position":1,"due_at":"2021-01-01 00:00:00","status":{"uuid":"37d731a7-b983-4800-b8eb-7df27456a994","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Incomplete","colour":"#398898","position":1,"is_type_completed":false,"is_archived":false,"is_not_started":false},"taskable_type":"case","taskable":{"uuid":"9514a0a5-8558-40f7-b671-a2a8db657bc4","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["47c37df7-d9b6-4675-a0e1-2fac20c5de98"],"group_uuids":["d0cb84ca-feda-40fe-a4dd-a3f8008d9c7b"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"983b36cd-cd2d-4e35-8a47-fb1c088afc38","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"},"author":{"uuid":{"example":"90393fae-a4af-49ee-aef8-f1d4a403423d","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"assigned_to":{"uuid":{"example":"e2e39eb2-2004-489a-969c-58b9cf23a263","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"completed_at":"2021-01-01 00:00:00","completed_by":{"uuid":{"example":"dabc0fd8-7b2b-4dbf-be2d-0d09cd279042","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"workflow_task":{"uuid":{"example":"052895f4-08ae-4090-b6ee-be4d0127d975","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"name":{"example":"Mortgage Review","description":"The name of the task","collection":false},"description":{"example":"We need to run through a mortgage review with Gareth, as he can probably find a better deal.","description":"The extra description added to a task","collection":false},"priority":{"example":"high","description":"The priority level of the task (e.g p1, p2, p3, p4)","collection":false},"position":{"example":2,"description":"The task position.","collection":false},"task_status":{"example":"App\\Http\\Resources\\TaskStatusResource","description":"Task status.","collection":false},"offset_due_at_by":{"example":2,"description":"How many days from the day the workflow is run should the due at be set by.","collection":false},"visible_to_clients":{"example":true,"description":"Indicator for if the task is visible to clients.","collection":false},"auto_assign_assigned_adviser":{"example":true,"description":"Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created.","collection":false},"auto_assign_assigned_administrator":{"example":true,"description":"Denotes if the task will auto-assign the administrator of the client when it is created.","collection":false},"auto_assign_clients":{"example":true,"description":"Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned.","collection":false},"author":{"example":"App\\Http\\Resources\\AccountResource","description":"The author of the task.","collection":false},"participants":{"example":"App\\Http\\Resources\\AccountResource","description":"The participants/assignees of the task.","collection":true},"tags":{"example":"App\\Http\\Resources\\TagResource","description":"The tags added to the task.","collection":true},"location_uuid":{"example":"4a845522-3316-4aa9-ab40-d687d4ba1fa7","description":"The parent task or workflow trigger task this task is a child of.","collection":false},"parent":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The parent task.","collection":false},"trigger":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The task that will trigger this task to be created.","collection":false},"trigger_tasks":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The tasks that will be triggered when this task is completed.","collection":true},"sub_tasks":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The tasks sub tasks.","collection":true},"groups":{"example":"App\\Http\\Resources\\GroupResource","description":"The groups that will be added to the task.","collection":true},"workflow":{"example":"App\\Http\\Resources\\Board\\WorkflowResource","description":"The workflow that the workflow task belongs to.","collection":false},"is_trigger_task":{"example":true,"description":"Denotes if this is a triggered task.","collection":false}},"is_recurring":true,"recurring_frequency":"weekly","recurring_last_run":"2026-01-01 00:00:00","recurring_next_run":"2026-01-01 00:00:00","custom_fields":[{"uuid":"13acad8d-6961-43ff-b666-e7a4c641479a","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}]}]},"App_Http_Resources_TaskResource":{"type":"object","properties":{"uuid":{"type":"string","example":"e18730c9-f8bc-4f90-9639-8fb743be355f","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Document the transaction","description":"The name of the task"},"description":{"type":"string","example":"Document the transaction","description":"The description of the task"},"priority":{"type":"string","example":"high","description":"The priority of the task. Available Options: low, medium, high and highest"},"position":{"type":"integer","example":1,"description":"The position of the task"},"due_at":{"type":"string","example":"2021-01-01 00:00:00","description":"The due date of the task"},"status":{"type":"object","properties":{"uuid":{"type":"string","example":"118c59f6-77e2-4d59-bc20-f1dbb6a0049d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Incomplete"},"colour":{"type":"string","example":"#398898"},"position":{"type":"integer","example":1},"is_type_completed":{"type":"boolean","example":false},"is_archived":{"type":"boolean","example":false},"is_not_started":{"type":"boolean","example":false}},"description":"The status of the task. Can be any of the task statuses defined in the firm's settings"},"taskable_type":{"type":"string","example":"case","description":"The type of the taskable. Available options: client, case, plan"},"taskable":{"type":"object","properties":{"uuid":{"type":"string","example":"09b5707c-d21f-4d3d-87b5-82d393894637"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"finance"},"slug":{"type":"string","example":"finance"},"status":{"type":"string","example":"App\\Http\\Resources\\CasesStatusResource"},"type":{"type":"string","example":"App\\Http\\Resources\\CasesTypeResource"},"review_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"assigned_to_uuids":{"type":"array","example":["a7badb5b-7631-4b5c-a3e6-1f5bf33ed1b1"],"items":{"type":"string"}},"group_uuids":{"type":"array","example":["6441f424-de1a-4987-a55c-64cc29a1bfa1"],"items":{"type":"string"}},"completed_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"status_position":{"type":"integer","example":4},"participants_count":{"type":"integer","example":4},"participants":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"task_board_uuid":{"type":"string","example":"0fe1e044-893a-467a-8816-1ff40eed3bc2"},"plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"}},"description":"The type of the taskable."},"author":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"cb82fa2b-7d93-4c27-8e89-a15dc5e70f48"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that created the task"},"assigned_to":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"b2f1184b-a21e-4b41-b212-b82c3d4418bd"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The accounts that the task is assigned to"},"completed_at":{"type":"string","example":"2021-01-01 00:00:00","description":"The date the task was completed"},"completed_by":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"4f5aaaac-31d0-4223-acc1-bc70958c19cc"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"type":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account type"},"collection":{"type":"boolean","example":false}}},"role":{"type":"object","properties":{"example":{"type":"string","example":"client"},"description":{"type":"string","example":"Account role"},"collection":{"type":"boolean","example":false}}},"first_name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth"},"description":{"type":"string","example":"First name"},"collection":{"type":"boolean","example":false}}},"last_name":{"type":"object","properties":{"example":{"type":"string","example":"Thompson"},"description":{"type":"string","example":"Last name"},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Gareth Thompson"},"description":{"type":"string","example":"Name"},"collection":{"type":"boolean","example":false}}},"email":{"type":"object","properties":{"example":{"type":"string","example":"gareth@codepotato.co.uk"},"description":{"type":"string","example":"(Deprecated - Please use the primary email of the account instead). The email of the account."},"collection":{"type":"boolean","example":false}}},"photo_url":{"type":"object","properties":{"example":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"description":{"type":"string","example":"The photo URL of the client"},"collection":{"type":"boolean","example":false}}},"external_references":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"},"description":{"type":"string","example":"The external references that have been added to the client."},"collection":{"type":"boolean","example":true}}}},"description":"The account that completed the task"},"workflow_task":{"type":"object","properties":{"uuid":{"type":"object","properties":{"example":{"type":"string","example":"5f918c08-4b18-4b8c-9e5c-a397fb79d20c"},"description":{"type":"string","example":"The UUID of the resource."},"collection":{"type":"boolean","example":false}}},"created_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was created."},"collection":{"type":"boolean","example":false}}},"updated_at":{"type":"object","properties":{"example":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"description":{"type":"string","example":"The timestamp of when the resource was updated."},"collection":{"type":"boolean","example":false}}},"name":{"type":"object","properties":{"example":{"type":"string","example":"Mortgage Review"},"description":{"type":"string","example":"The name of the task"},"collection":{"type":"boolean","example":false}}},"description":{"type":"object","properties":{"example":{"type":"string","example":"We need to run through a mortgage review with Gareth, as he can probably find a better deal."},"description":{"type":"string","example":"The extra description added to a task"},"collection":{"type":"boolean","example":false}}},"priority":{"type":"object","properties":{"example":{"type":"string","example":"high"},"description":{"type":"string","example":"The priority level of the task (e.g p1, p2, p3, p4)"},"collection":{"type":"boolean","example":false}}},"position":{"type":"object","properties":{"example":{"type":"integer","example":2},"description":{"type":"string","example":"The task position."},"collection":{"type":"boolean","example":false}}},"task_status":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TaskStatusResource"},"description":{"type":"string","example":"Task status."},"collection":{"type":"boolean","example":false}}},"offset_due_at_by":{"type":"object","properties":{"example":{"type":"integer","example":2},"description":{"type":"string","example":"How many days from the day the workflow is run should the due at be set by."},"collection":{"type":"boolean","example":false}}},"visible_to_clients":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Indicator for if the task is visible to clients."},"collection":{"type":"boolean","example":false}}},"auto_assign_assigned_adviser":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created."},"collection":{"type":"boolean","example":false}}},"auto_assign_assigned_administrator":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if the task will auto-assign the administrator of the client when it is created."},"collection":{"type":"boolean","example":false}}},"auto_assign_clients":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned."},"collection":{"type":"boolean","example":false}}},"author":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"The author of the task."},"collection":{"type":"boolean","example":false}}},"participants":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"description":{"type":"string","example":"The participants/assignees of the task."},"collection":{"type":"boolean","example":true}}},"tags":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"description":{"type":"string","example":"The tags added to the task."},"collection":{"type":"boolean","example":true}}},"location_uuid":{"type":"object","properties":{"example":{"type":"string","example":"836a777e-70b2-470c-914f-3c3f45209943"},"description":{"type":"string","example":"The parent task or workflow trigger task this task is a child of."},"collection":{"type":"boolean","example":false}}},"parent":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The parent task."},"collection":{"type":"boolean","example":false}}},"trigger":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The task that will trigger this task to be created."},"collection":{"type":"boolean","example":false}}},"trigger_tasks":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The tasks that will be triggered when this task is completed."},"collection":{"type":"boolean","example":true}}},"sub_tasks":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource"},"description":{"type":"string","example":"The tasks sub tasks."},"collection":{"type":"boolean","example":true}}},"groups":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"description":{"type":"string","example":"The groups that will be added to the task."},"collection":{"type":"boolean","example":true}}},"workflow":{"type":"object","properties":{"example":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowResource"},"description":{"type":"string","example":"The workflow that the workflow task belongs to."},"collection":{"type":"boolean","example":false}}},"is_trigger_task":{"type":"object","properties":{"example":{"type":"boolean","example":true},"description":{"type":"string","example":"Denotes if this is a triggered task."},"collection":{"type":"boolean","example":false}}}},"description":"The workflow task associated with this task"},"is_recurring":{"type":"boolean","example":true,"description":"Whether the task is recurring or not"},"recurring_frequency":{"type":"string","example":"weekly","description":"The frequency of the recurrence."},"recurring_last_run":{"type":"string","example":"2026-01-01 00:00:00","description":"The last time the recurring task was run"},"recurring_next_run":{"type":"string","example":"2026-01-01 00:00:00","description":"The next time the recurring task will be run"},"custom_fields":{"type":"array","example":[{"uuid":"00aa8c8f-a10a-4b09-a05a-de06eb54cc2d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}],"description":"Any custom fields on the model.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"00aa8c8f-a10a-4b09-a05a-de06eb54cc2d"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"string"},"name":{"type":"string","example":"Favourite Drink"},"reference":{"type":"string","example":"favourite_drink"},"is_required":{"type":"boolean","example":false},"value":{"type":"string","example":"Coffee"},"selection_options":{"type":"array","example":["Coffee","Tea","Water"],"items":{"type":"string"}},"help_text":{"type":"string","example":"This is the client's favourite drink."}}}}},"example":{"uuid":"e18730c9-f8bc-4f90-9639-8fb743be355f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Document the transaction","description":"Document the transaction","priority":"high","position":1,"due_at":"2021-01-01 00:00:00","status":{"uuid":"118c59f6-77e2-4d59-bc20-f1dbb6a0049d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Incomplete","colour":"#398898","position":1,"is_type_completed":false,"is_archived":false,"is_not_started":false},"taskable_type":"case","taskable":{"uuid":"09b5707c-d21f-4d3d-87b5-82d393894637","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"finance","slug":"finance","status":"App\\Http\\Resources\\CasesStatusResource","type":"App\\Http\\Resources\\CasesTypeResource","review_at":"2026-05-08T14:41:55+01:00","assigned_to_uuids":["a7badb5b-7631-4b5c-a3e6-1f5bf33ed1b1"],"group_uuids":["6441f424-de1a-4987-a55c-64cc29a1bfa1"],"completed_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"status_position":4,"participants_count":4,"participants":"App\\Http\\Resources\\AccountResource","task_board_uuid":"0fe1e044-893a-467a-8816-1ff40eed3bc2","plans":"App\\Http\\Resources\\Plans\\PlanResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource"},"author":{"uuid":{"example":"cb82fa2b-7d93-4c27-8e89-a15dc5e70f48","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"assigned_to":{"uuid":{"example":"b2f1184b-a21e-4b41-b212-b82c3d4418bd","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"completed_at":"2021-01-01 00:00:00","completed_by":{"uuid":{"example":"4f5aaaac-31d0-4223-acc1-bc70958c19cc","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"type":{"example":"client","description":"Account type","collection":false},"role":{"example":"client","description":"Account role","collection":false},"first_name":{"example":"Gareth","description":"First name","collection":false},"last_name":{"example":"Thompson","description":"Last name","collection":false},"name":{"example":"Gareth Thompson","description":"Name","collection":false},"email":{"example":"gareth@codepotato.co.uk","description":"(Deprecated - Please use the primary email of the account instead). The email of the account.","collection":false},"photo_url":{"example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the client","collection":false},"external_references":{"example":"App\\Http\\Resources\\ExternalReferenceResource","description":"The external references that have been added to the client.","collection":true}},"workflow_task":{"uuid":{"example":"5f918c08-4b18-4b8c-9e5c-a397fb79d20c","description":"The UUID of the resource.","collection":false},"created_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created.","collection":false},"updated_at":{"example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated.","collection":false},"name":{"example":"Mortgage Review","description":"The name of the task","collection":false},"description":{"example":"We need to run through a mortgage review with Gareth, as he can probably find a better deal.","description":"The extra description added to a task","collection":false},"priority":{"example":"high","description":"The priority level of the task (e.g p1, p2, p3, p4)","collection":false},"position":{"example":2,"description":"The task position.","collection":false},"task_status":{"example":"App\\Http\\Resources\\TaskStatusResource","description":"Task status.","collection":false},"offset_due_at_by":{"example":2,"description":"How many days from the day the workflow is run should the due at be set by.","collection":false},"visible_to_clients":{"example":true,"description":"Indicator for if the task is visible to clients.","collection":false},"auto_assign_assigned_adviser":{"example":true,"description":"Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created.","collection":false},"auto_assign_assigned_administrator":{"example":true,"description":"Denotes if the task will auto-assign the administrator of the client when it is created.","collection":false},"auto_assign_clients":{"example":true,"description":"Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned.","collection":false},"author":{"example":"App\\Http\\Resources\\AccountResource","description":"The author of the task.","collection":false},"participants":{"example":"App\\Http\\Resources\\AccountResource","description":"The participants/assignees of the task.","collection":true},"tags":{"example":"App\\Http\\Resources\\TagResource","description":"The tags added to the task.","collection":true},"location_uuid":{"example":"836a777e-70b2-470c-914f-3c3f45209943","description":"The parent task or workflow trigger task this task is a child of.","collection":false},"parent":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The parent task.","collection":false},"trigger":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The task that will trigger this task to be created.","collection":false},"trigger_tasks":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The tasks that will be triggered when this task is completed.","collection":true},"sub_tasks":{"example":"App\\Http\\Resources\\Board\\WorkflowBoardTaskResource","description":"The tasks sub tasks.","collection":true},"groups":{"example":"App\\Http\\Resources\\GroupResource","description":"The groups that will be added to the task.","collection":true},"workflow":{"example":"App\\Http\\Resources\\Board\\WorkflowResource","description":"The workflow that the workflow task belongs to.","collection":false},"is_trigger_task":{"example":true,"description":"Denotes if this is a triggered task.","collection":false}},"is_recurring":true,"recurring_frequency":"weekly","recurring_last_run":"2026-01-01 00:00:00","recurring_next_run":"2026-01-01 00:00:00","custom_fields":[{"uuid":"00aa8c8f-a10a-4b09-a05a-de06eb54cc2d","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"string","name":"Favourite Drink","reference":"favourite_drink","is_required":false,"value":"Coffee","selection_options":["Coffee","Tea","Water"],"help_text":"This is the client's favourite drink."}]}},"App_Http_Resources_TimeEntryResource":{"type":"object","properties":{"uuid":{"type":"string","example":"08f75636-3928-4adf-9101-0a8665fa3c1f","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Research","description":"The name of the time entry."},"description":{"type":"string","example":"This is a description.","description":"The description of the time entry."},"trackable_type":{"type":"string","example":"Client","description":"The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task."},"trackable":{"type":"object","properties":{"uuid":{"type":"string","example":"c3604259-9ae9-4454-8100-276e5b47fa6e"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The model that is being tracked. The example given is a client, but it can be a case, firm, or task."},"start_date":{"type":"string","example":"2026-05-08T13:51:55+01:00","description":"The start time of the time entry."},"end_date":{"type":"string","example":"2026-05-08T14:19:55+01:00","description":"The end time of the time entry."},"is_active":{"type":"boolean","example":true,"description":"Determines if the time entry is currently ongoing."},"total_time_in_minutes":{"type":"integer","example":28,"description":"Total time in minutes."},"computed_time_elapsed_in_seconds":{"type":"integer","example":1680,"description":"Computed time elapsed in seconds."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"3640341c-295b-4c3a-af13-3c9cfbb07400"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Who started the timer."}},"example":{"uuid":"08f75636-3928-4adf-9101-0a8665fa3c1f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Research","description":"This is a description.","trackable_type":"Client","trackable":{"uuid":"c3604259-9ae9-4454-8100-276e5b47fa6e","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"start_date":"2026-05-08T13:51:55+01:00","end_date":"2026-05-08T14:19:55+01:00","is_active":true,"total_time_in_minutes":28,"computed_time_elapsed_in_seconds":1680,"account":{"uuid":"3640341c-295b-4c3a-af13-3c9cfbb07400","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"}}},"App_Http_Resources_TransactionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"57634cdb-c523-48cb-9333-7664724085b5","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"4a3bebe1-f9cb-490b-86f5-4140add08147"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Plan of the transaction"},"sub_account":{"type":"object","properties":{"uuid":{"type":"string","example":"0f2b20cf-44e8-4bbf-ab03-e5a82627ae96"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}},"description":"Sub account of the transaction"},"holding":{"type":"object","properties":{"uuid":{"type":"string","example":"a5b79d8c-6734-4a4e-a370-d7334dc69836"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"fund_name":{"type":"string","example":"Fund"},"reference":{"type":"string","example":"REF123"},"sector":{"type":"string","example":"Europe"},"sedol":{"type":"string","example":"ACB123"},"isin":{"type":"string","example":"ACB123"},"citi":{"type":"string","example":"ACB123"},"units":{"type":"integer","example":5},"unit_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£10.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"unit_price_raw":{"type":"integer","example":10},"purchase_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"is_active":{"type":"boolean","example":true},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Holding of the subaccount"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"ab4e2e0e-9dfa-4b5f-bb4a-b1c3a8fe4b1f"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that added the transaction"},"transaction_schedule":{"type":"object","properties":{"uuid":{"type":"string","example":"79b14590-9924-4743-a00f-34b58af617b7"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"holding":{"type":"string","example":"App\\Http\\Resources\\Plans\\HoldingResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"provider_controlled":{"type":"boolean","example":true},"type":{"type":"string","example":"contribution"},"sub_type":{"type":"string","example":"product_fees"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"1099"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.99"}}},"frequency":{"type":"string","example":"monthly"},"start_date":{"type":"string","example":"2026-05-08"},"end_date":{"type":"string","example":"2027-05-08"},"next_transaction_date":{"type":"string","example":"2026-06-08"},"paused_until":{"type":"string","example":"2026-05-08T14:41:55+01:00"}},"description":"Schedule that created this transaction"},"provider":{"type":"object","properties":{"uuid":{"type":"string","example":"da9ae76b-ffd7-44c5-87c1-78606d950204"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"AJ Bell"},"slug":{"type":"string","example":"aj-bell"}},"description":"Provider that created this transaction"},"type":{"type":"string","example":"contribution","description":"Transaction type"},"sub_type":{"type":"string","example":"product_fees","description":"Transaction sub type"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"1099"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.99"}},"description":"Transaction amount"},"date":{"type":"string","example":"2026-05-08","description":"Transaction date"},"notes":{"type":"string","example":"Withdrawal from ISA","description":"Transaction note"},"status":{"type":"string","example":"Completed","description":"Transaction status"},"editable":{"type":"boolean","example":true,"description":"Is the transaction editable?"}},"example":{"uuid":"57634cdb-c523-48cb-9333-7664724085b5","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","plan":{"uuid":"4a3bebe1-f9cb-490b-86f5-4140add08147","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"sub_account":{"uuid":"0f2b20cf-44e8-4bbf-ab03-e5a82627ae96","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"holding":{"uuid":"a5b79d8c-6734-4a4e-a370-d7334dc69836","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","fund_name":"Fund","reference":"REF123","sector":"Europe","sedol":"ACB123","isin":"ACB123","citi":"ACB123","units":5,"unit_price":{"amount":{"example":"1000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£10.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"unit_price_raw":10,"purchase_price":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"is_active":true,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"account":{"uuid":"ab4e2e0e-9dfa-4b5f-bb4a-b1c3a8fe4b1f","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"transaction_schedule":{"uuid":"79b14590-9924-4743-a00f-34b58af617b7","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","plan":"App\\Http\\Resources\\Plans\\PlanResource","sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource","holding":"App\\Http\\Resources\\Plans\\HoldingResource","account":"App\\Http\\Resources\\AccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","provider_controlled":true,"type":"contribution","sub_type":"product_fees","amount":{"amount":"1099","currency":"GBP","formatted":"£10.99"},"frequency":"monthly","start_date":"2026-05-08","end_date":"2027-05-08","next_transaction_date":"2026-06-08","paused_until":"2026-05-08T14:41:55+01:00"},"provider":{"uuid":"da9ae76b-ffd7-44c5-87c1-78606d950204","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"AJ Bell","slug":"aj-bell"},"type":"contribution","sub_type":"product_fees","amount":{"amount":"1099","currency":"GBP","formatted":"£10.99"},"date":"2026-05-08","notes":"Withdrawal from ISA","status":"Completed","editable":true}},"App_Http_Resources_TransactionScheduleSummaryResource":{"type":"object","properties":{"daily":{"type":"object","properties":{"incoming":{"type":"object","properties":{"amount":{"type":"string","example":"1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.00"}}},"outgoing":{"type":"object","properties":{"amount":{"type":"string","example":"-1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"-£10.00"}}}},"description":"The transaction schedules daily estimate."},"weekly":{"type":"object","properties":{"incoming":{"type":"object","properties":{"amount":{"type":"string","example":"1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.00"}}},"outgoing":{"type":"object","properties":{"amount":{"type":"string","example":"-1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"-£10.00"}}}},"description":"The transaction schedules weekly estimate."},"monthly":{"type":"object","properties":{"incoming":{"type":"object","properties":{"amount":{"type":"string","example":"1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.00"}}},"outgoing":{"type":"object","properties":{"amount":{"type":"string","example":"-1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"-£10.00"}}}},"description":"The transaction schedules monthly estimate."},"quarterly":{"type":"object","properties":{"incoming":{"type":"object","properties":{"amount":{"type":"string","example":"1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.00"}}},"outgoing":{"type":"object","properties":{"amount":{"type":"string","example":"-1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"-£10.00"}}}},"description":"The transaction schedules quarterly estimate."},"annually":{"type":"object","properties":{"incoming":{"type":"object","properties":{"amount":{"type":"string","example":"1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.00"}}},"outgoing":{"type":"object","properties":{"amount":{"type":"string","example":"-1000"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"-£10.00"}}}},"description":"The transaction schedules annual estimate."}},"example":{"daily":{"incoming":{"amount":"1000","currency":"GBP","formatted":"£10.00"},"outgoing":{"amount":"-1000","currency":"GBP","formatted":"-£10.00"}},"weekly":{"incoming":{"amount":"1000","currency":"GBP","formatted":"£10.00"},"outgoing":{"amount":"-1000","currency":"GBP","formatted":"-£10.00"}},"monthly":{"incoming":{"amount":"1000","currency":"GBP","formatted":"£10.00"},"outgoing":{"amount":"-1000","currency":"GBP","formatted":"-£10.00"}},"quarterly":{"incoming":{"amount":"1000","currency":"GBP","formatted":"£10.00"},"outgoing":{"amount":"-1000","currency":"GBP","formatted":"-£10.00"}},"annually":{"incoming":{"amount":"1000","currency":"GBP","formatted":"£10.00"},"outgoing":{"amount":"-1000","currency":"GBP","formatted":"-£10.00"}}}},"App_Http_Resources_TransactionScheduleResource":{"type":"object","properties":{"uuid":{"type":"string","example":"2c9a5dfc-37a1-4d9a-8e75-c75fdc706064","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"ac19b83d-edac-40d9-bd92-704513d3e0d2"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:55+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Plan of the transaction"},"sub_account":{"type":"object","properties":{"uuid":{"type":"string","example":"6f985b6f-4125-4913-8bd0-868f0c9dd2db"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}},"description":"Sub account of the transaction"},"holding":{"type":"object","properties":{"uuid":{"type":"string","example":"4f59fa40-364a-4f69-bc28-e4efb78fce88"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"fund_name":{"type":"string","example":"Fund"},"reference":{"type":"string","example":"REF123"},"sector":{"type":"string","example":"Europe"},"sedol":{"type":"string","example":"ACB123"},"isin":{"type":"string","example":"ACB123"},"citi":{"type":"string","example":"ACB123"},"units":{"type":"integer","example":5},"unit_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£10.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"unit_price_raw":{"type":"integer","example":10},"purchase_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"is_active":{"type":"boolean","example":true},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Holding of the subaccount"},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"7d4fc34b-fe2e-4545-83e7-e19037023ca7"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:55"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"Account that added the transaction"},"provider":{"type":"object","properties":{"uuid":{"type":"string","example":"82f4718e-5f06-4912-82e2-53d70376cc1c"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"AJ Bell"},"slug":{"type":"string","example":"aj-bell"}},"description":"Provider that created this transaction"},"provider_controlled":{"type":"boolean","example":true,"description":"Boolean to denote whether the provider feeds (if available) are responsible for creating the recurring transactions. If false then Plannr will create these recurring transactions using this transaction schedule"},"type":{"type":"string","example":"contribution","description":"Transaction type"},"sub_type":{"type":"string","example":"product_fees","description":"Transaction sub type"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"1099"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.99"}},"description":"Transaction amount"},"frequency":{"type":"string","example":"monthly","description":"How often this schedule will create transactions"},"start_date":{"type":"string","example":"2026-05-08","description":"Automatically create transactions from this date"},"end_date":{"type":"string","example":"2027-05-08","description":"Stop automatically creating transactions after this date"},"next_transaction_date":{"type":"string","example":"2026-06-08","description":"Date the next transaction will be created from this schedule"},"paused_until":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"Pause creating transactions up until this date"}},"example":{"uuid":"2c9a5dfc-37a1-4d9a-8e75-c75fdc706064","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","plan":{"uuid":"ac19b83d-edac-40d9-bd92-704513d3e0d2","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","opened_at":"2026-05-08T14:41:55+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:55+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:55+01:00","original_valued_at":"2026-05-07T14:41:55+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"sub_account":{"uuid":"6f985b6f-4125-4913-8bd0-868f0c9dd2db","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"holding":{"uuid":"4f59fa40-364a-4f69-bc28-e4efb78fce88","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","fund_name":"Fund","reference":"REF123","sector":"Europe","sedol":"ACB123","isin":"ACB123","citi":"ACB123","units":5,"unit_price":{"amount":{"example":"1000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£10.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"unit_price_raw":10,"purchase_price":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"is_active":true,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"account":{"uuid":"7d4fc34b-fe2e-4545-83e7-e19037023ca7","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:55+01:00","next_review_date":"2026-05-08T14:41:55+01:00","previous_review_date":"2026-05-08T14:41:55+01:00","anniversary_review_date":"2026-05-08T14:41:55+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:55","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"provider":{"uuid":"82f4718e-5f06-4912-82e2-53d70376cc1c","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"AJ Bell","slug":"aj-bell"},"provider_controlled":true,"type":"contribution","sub_type":"product_fees","amount":{"amount":"1099","currency":"GBP","formatted":"£10.99"},"frequency":"monthly","start_date":"2026-05-08","end_date":"2027-05-08","next_transaction_date":"2026-06-08","paused_until":"2026-05-08T14:41:55+01:00"}},"App_Http_Resources_V2_TransactionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"fd506639-2d95-4ce9-9376-a01e892a1c24"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"type":{"type":"string","example":"transfer"},"sub_type":{"type":"string","example":"consolidations"},"amount":{"type":"integer","example":10000},"date":{"type":"string","example":"2026-05-08"},"notes":{"type":"string","example":"My interesting note"},"status":{"type":"string","example":"Completed"},"editable":{"type":"boolean","example":true},"plan":{"type":"object","properties":{"uuid":{"type":"string","example":"d231c104-91e4-4954-a125-32201264fd48"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"opened_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"Johns ISA"},"type":{"type":"string","example":"cash_account"},"sub_type":{"type":"string","example":"lifetime isa"},"abstract_type":{"type":"string","example":"asset"},"policy_number":{"type":"string","example":"AVIVA-123"},"proposal_reference":{"type":"string","example":"AB123456"},"status":{"type":"string","example":"inactive"},"inactive_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"inactive_reason":{"type":"string","example":"claimed"},"agency_in_your_name":{"type":"boolean","example":true},"agency_in_your_name_from":{"type":"string","example":"2025-05-08"},"originally_sold_by_firm":{"type":"boolean","example":true},"under_advice":{"type":"boolean","example":true},"visible_on_client_portal":{"type":"boolean","example":true},"include_in_client_valuation":{"type":"boolean","example":true},"show_on_joint":{"type":"boolean","example":true},"shown_on_circles":{"type":"boolean","example":true},"review_date":{"type":"string","example":"2025-05-08"},"on_panel":{"type":"boolean","example":true},"is_group_scheme":{"type":"boolean","example":false},"is_sub_group_scheme":{"type":"boolean","example":false},"is_group_scheme_member":{"type":"boolean","example":false},"advice_area":{"type":"string","example":"non_investment_insurance"},"main_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"sub_accounts":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"covers":{"type":"string","example":"App\\Http\\Resources\\Plans\\CoverResource"},"claims":{"type":"string","example":"App\\Http\\Resources\\Plans\\ClaimResource"},"total_benefit_amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"25000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£250,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"total_benefits":{"type":"object","properties":{"critical_illness":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"15000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£150,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"family_income_benefit":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"10000000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£100,000.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}}},"latest_valuations":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"valued_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"original_valued_at":{"type":"string","example":"2026-05-07T14:41:56+01:00"},"client":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"accounts":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"seller":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"linked_plans":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"visible_to_circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}},"cases":{"type":"string","example":"App\\Http\\Resources\\CasesResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"is_wrap_product":{"type":"boolean","example":false},"is_wrap_child":{"type":"boolean","example":false},"wrap":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"wrap_children":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"linked_policy_numbers":{"type":"string","example":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource"},"can_be_deleted":{"type":"string","example":"false"},"contract_enquiry_account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"sub_account":{"type":"object","properties":{"uuid":{"type":"string","example":"02b24d16-218f-4bf6-9b5c-c3ee73326434"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}},"holding":{"type":"object","properties":{"uuid":{"type":"string","example":"52c3135c-8cfe-49b5-92a9-7eb468860ef0"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"fund_name":{"type":"string","example":"Fund"},"reference":{"type":"string","example":"REF123"},"sector":{"type":"string","example":"Europe"},"sedol":{"type":"string","example":"ACB123"},"isin":{"type":"string","example":"ACB123"},"citi":{"type":"string","example":"ACB123"},"units":{"type":"integer","example":5},"unit_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"1000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£10.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"unit_price_raw":{"type":"integer","example":10},"purchase_price":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"is_active":{"type":"boolean","example":true},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}}},"transaction_schedule":{"type":"object","properties":{"uuid":{"type":"string","example":"f3664b58-52b6-44df-b64e-b0948014fe73"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"plan":{"type":"string","example":"App\\Http\\Resources\\Plans\\PlanResource"},"sub_account":{"type":"string","example":"App\\Http\\Resources\\Plans\\SubAccountResource"},"holding":{"type":"string","example":"App\\Http\\Resources\\Plans\\HoldingResource"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"provider":{"type":"string","example":"App\\Http\\Resources\\Plans\\ProviderResource"},"provider_controlled":{"type":"boolean","example":true},"type":{"type":"string","example":"contribution"},"sub_type":{"type":"string","example":"product_fees"},"amount":{"type":"object","properties":{"amount":{"type":"string","example":"1099"},"currency":{"type":"string","example":"GBP"},"formatted":{"type":"string","example":"£10.99"}}},"frequency":{"type":"string","example":"monthly"},"start_date":{"type":"string","example":"2026-05-08"},"end_date":{"type":"string","example":"2027-05-08"},"next_transaction_date":{"type":"string","example":"2026-06-08"},"paused_until":{"type":"string","example":"2026-05-08T14:41:56+01:00"}}}},"example":[{"uuid":"fd506639-2d95-4ce9-9376-a01e892a1c24","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","type":"transfer","sub_type":"consolidations","amount":10000,"date":"2026-05-08","notes":"My interesting note","status":"Completed","editable":true,"plan":{"uuid":"d231c104-91e4-4954-a125-32201264fd48","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","opened_at":"2026-05-08T14:41:56+01:00","name":"Johns ISA","type":"cash_account","sub_type":"lifetime isa","abstract_type":"asset","policy_number":"AVIVA-123","proposal_reference":"AB123456","status":"inactive","inactive_at":"2026-05-08T14:41:56+01:00","inactive_reason":"claimed","agency_in_your_name":true,"agency_in_your_name_from":"2025-05-08","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":true,"review_date":"2025-05-08","on_panel":true,"is_group_scheme":false,"is_sub_group_scheme":false,"is_group_scheme_member":false,"advice_area":"non_investment_insurance","main_account":"App\\Http\\Resources\\Plans\\SubAccountResource","sub_accounts":"App\\Http\\Resources\\Plans\\SubAccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","covers":"App\\Http\\Resources\\Plans\\CoverResource","claims":"App\\Http\\Resources\\Plans\\ClaimResource","total_benefit_amount":{"amount":{"example":"25000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£250,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"total_benefits":{"critical_illness":{"amount":{"example":"15000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£150,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"family_income_benefit":{"amount":{"example":"10000000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£100,000.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}},"latest_valuations":"App\\Http\\Resources\\Plans\\ValuationResource","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"valued_at":"2026-05-08T14:41:56+01:00","original_valued_at":"2026-05-07T14:41:56+01:00","client":"App\\Http\\Resources\\AccountResource","accounts":"App\\Http\\Resources\\AccountResource","seller":"App\\Http\\Resources\\AccountResource","linked_owners":"App\\Http\\Resources\\AccountResource","linked_plans":"App\\Http\\Resources\\Plans\\PlanResource","visible_to_circles":"App\\Http\\Resources\\CircleResource","statistics":{"recent_growth":100},"cases":"App\\Http\\Resources\\CasesResource","tags":"App\\Http\\Resources\\TagResource","is_wrap_product":false,"is_wrap_child":false,"wrap":"App\\Http\\Resources\\Plans\\PlanResource","wrap_children":"App\\Http\\Resources\\Plans\\PlanResource","linked_policy_numbers":"App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource","can_be_deleted":"false","contract_enquiry_account":"App\\Http\\Resources\\AccountResource","custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"sub_account":{"uuid":"02b24d16-218f-4bf6-9b5c-c3ee73326434","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}},"holding":{"uuid":"52c3135c-8cfe-49b5-92a9-7eb468860ef0","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","fund_name":"Fund","reference":"REF123","sector":"Europe","sedol":"ACB123","isin":"ACB123","citi":"ACB123","units":5,"unit_price":{"amount":{"example":"1000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£10.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"unit_price_raw":10,"purchase_price":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"is_active":true,"value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"transaction_schedule":{"uuid":"f3664b58-52b6-44df-b64e-b0948014fe73","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","plan":"App\\Http\\Resources\\Plans\\PlanResource","sub_account":"App\\Http\\Resources\\Plans\\SubAccountResource","holding":"App\\Http\\Resources\\Plans\\HoldingResource","account":"App\\Http\\Resources\\AccountResource","provider":"App\\Http\\Resources\\Plans\\ProviderResource","provider_controlled":true,"type":"contribution","sub_type":"product_fees","amount":{"amount":"1099","currency":"GBP","formatted":"£10.99"},"frequency":"monthly","start_date":"2026-05-08","end_date":"2027-05-08","next_transaction_date":"2026-06-08","paused_until":"2026-05-08T14:41:56+01:00"}}]},"App_Http_Resources_UnipassCertificateResource":{"type":"object","properties":{"uuid":{"type":"string","example":"d546648b-cf1c-4aae-a093-413731718757","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"expires_at":{"type":"string","example":"2027-05-08T14:41:54+01:00","description":"The expiry date of the certificate"},"certificate_email":{"type":"string","example":"example@example.com","description":"The email address associated with the certificate"},"certificate_serial_number":{"type":"string","example":"132777832123178720399127681141946521234","description":"The serial number of the certificate"}},"example":{"uuid":"d546648b-cf1c-4aae-a093-413731718757","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2027-05-08T14:41:54+01:00","certificate_email":"example@example.com","certificate_serial_number":"132777832123178720399127681141946521234"}},"App_Http_Resources_UserResource":{"type":"object","properties":{"uuid":{"type":"string","example":"43d6e0a8-9001-4836-902f-e95573548583","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"type":{"type":"string","example":"standard","description":"The user type"},"first_name":{"type":"string","example":"Gareth","description":"First name of the user"},"last_name":{"type":"string","example":"Thompson","description":"Last name of the user"},"name":{"type":"string","example":"Gareth Thompson","description":"Name of the user"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email of the user"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","description":"The photo URL of the user."},"current_account":{"type":"object","properties":{"uuid":{"type":"string","example":"82e69590-4a58-4227-9c95-0c46e5e12863"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The current account log in of the user (if included)"},"current_login":{"type":"object","properties":{"uuid":{"type":"string","example":"4c89d85e-c9af-4a3d-96bd-8dacc09fbd03"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"expires_at":{"type":"string","example":"2026-08-16T14:41:54+01:00"},"has_write_permission":{"type":"boolean","example":false},"has_delete_permission":{"type":"boolean","example":false},"primary":{"type":"boolean","example":false},"receives_unread_notifications_email":{"type":"boolean","example":true},"wealth_enabled":{"type":"boolean","example":true},"goals_enabled":{"type":"boolean","example":true},"factfind_enabled":{"type":"boolean","example":true},"tasks_enabled":{"type":"boolean","example":true},"welcome_enabled":{"type":"boolean","example":true},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"email":{"type":"string","example":"gareth@plannrcrm.com"},"user_type":{"type":"string","example":"standard"},"account":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"is_impersonated":{"type":"boolean","example":false}},"description":"The current account log in of the user (if included)"},"two_factor_enabled":{"type":"boolean","example":true,"description":"Denotes if the two factor authentication has been enabled."},"two_factor_type":{"type":"string","example":"sms","description":"The type of two factor enabled."},"otp_confirmed_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The date when OTP two factor was confirmed"},"otp_pending":{"type":"boolean","example":false,"description":"Denotes if the OTP two factor is pending"},"sms_two_factor_enabled":{"type":"boolean","example":true,"description":"Denotes if the SMS two factor is enabled"},"two_factor_mobile":{"type":"boolean","example":true,"description":"The E.164 mobile phone used for two factor authentication."},"two_factor_mobile_meta":{"type":"object","properties":{"country":{"type":"string","example":"GB"},"formatted":{"type":"string","example":"0333 090 3630"}},"description":"If the two_factor_mobile is present, this additional field will be displayed giving you information about the phone number."},"current_time_entry":{"type":"object","properties":{"uuid":{"type":"string","example":"ee0f5663-0b0f-4e8c-b509-f5b0808425d8"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"name":{"type":"string","example":"Research"},"description":{"type":"string","example":"This is a description."},"trackable_type":{"type":"string","example":"Client"},"trackable":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"},"start_date":{"type":"string","example":"2026-05-08T13:51:54+01:00"},"end_date":{"type":"string","example":"2026-05-08T14:19:54+01:00"},"is_active":{"type":"boolean","example":true},"total_time_in_minutes":{"type":"integer","example":28},"computed_time_elapsed_in_seconds":{"type":"integer","example":1680},"account":{"type":"string","example":"App\\Http\\Resources\\MinimalAccountResource"}},"description":"The current time entry if a timer is running"},"session_expires_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The session expiry time if signed in via the front-end."},"remember_token_expires_at":{"type":"boolean","example":true,"description":"Denotes when the users \"remember me\" token expires."},"should_auto_save_notes":{"type":"boolean","example":true,"description":"Denotes if the user wants to use the auto-save notes feature. Can reduce browser performance on low-powered machines."}},"example":{"uuid":"43d6e0a8-9001-4836-902f-e95573548583","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"standard","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","current_account":{"uuid":"82e69590-4a58-4227-9c95-0c46e5e12863","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=gareth+thompson","firm":"App\\Http\\Resources\\FirmResource","primary_phone_number":"App\\Http\\Resources\\ContactDetailResource","primary_email":"App\\Http\\Resources\\ContactDetailResource","current_time_entry":"App\\Http\\Resources\\TimeEntryResource","assigned_adviser":"App\\Http\\Resources\\AccountResource","assigned_administrator":"App\\Http\\Resources\\AccountResource","assigned_paraplanner":"App\\Http\\Resources\\AccountResource","introduced_by":"App\\Http\\Resources\\AccountResource","business_unit":"App\\Http\\Resources\\BusinessUnitResource","groups":"App\\Http\\Resources\\GroupResource","tags":"App\\Http\\Resources\\TagResource","owners":"App\\Http\\Resources\\AccountResource","first_contact_date":"2026-05-08T14:41:54+01:00","next_review_date":"2026-05-08T14:41:54+01:00","previous_review_date":"2026-05-08T14:41:54+01:00","anniversary_review_date":"2026-05-08T14:41:54+01:00","with_login":true,"has_joint_account":true,"can_be_deleted":"false","joint_account_circle":"App\\Http\\Resources\\CircleResource","circles":"App\\Http\\Resources\\CircleResource","ownership_percentage":100,"inactive_at":"2026-05-08","last_interaction_at":"2026-05-08 14:41:54","referral_code":"ABC12345","permissions":{"firm:read":["firm"],"network:read":["network:uuid"]},"custom_fields":"App\\Http\\Resources\\CustomFieldValueResource","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"current_login":{"uuid":"4c89d85e-c9af-4a3d-96bd-8dacc09fbd03","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","expires_at":"2026-08-16T14:41:54+01:00","has_write_permission":false,"has_delete_permission":false,"primary":false,"receives_unread_notifications_email":true,"wealth_enabled":true,"goals_enabled":true,"factfind_enabled":true,"tasks_enabled":true,"welcome_enabled":true,"first_name":"Gareth","last_name":"Thompson","email":"gareth@plannrcrm.com","user_type":"standard","account":"App\\Http\\Resources\\AccountResource","firm":"App\\Http\\Resources\\FirmResource","is_impersonated":false},"two_factor_enabled":true,"two_factor_type":"sms","otp_confirmed_at":"2026-05-08T14:41:54+01:00","otp_pending":false,"sms_two_factor_enabled":true,"two_factor_mobile":true,"two_factor_mobile_meta":{"country":"GB","formatted":"0333 090 3630"},"current_time_entry":{"uuid":"ee0f5663-0b0f-4e8c-b509-f5b0808425d8","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","name":"Research","description":"This is a description.","trackable_type":"Client","trackable":"App\\Http\\Resources\\MinimalAccountResource","start_date":"2026-05-08T13:51:54+01:00","end_date":"2026-05-08T14:19:54+01:00","is_active":true,"total_time_in_minutes":28,"computed_time_elapsed_in_seconds":1680,"account":"App\\Http\\Resources\\MinimalAccountResource"},"session_expires_at":"2026-05-08T14:41:54+01:00","remember_token_expires_at":true,"should_auto_save_notes":true}},"App_Http_Resources_FactFindPassResource":{"type":"object","properties":{"uuid":{"type":"string","example":"32c653d7-2a47-4749-be36-19c883f3b7a3","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The timestamp of when the resource was updated."},"firm":{"type":"object","properties":{"uuid":{"type":"string","example":"9e2072c9-0bdf-46c5-ae79-57a5ed76b119"},"name":{"type":"string","example":"Codepotato Ltd"}},"description":"The name of the firm the fact find pass is for."},"account":{"type":"object","properties":{"uuid":{"type":"string","example":"c6738836-6562-4d73-bee7-23e95e3be930"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"The account the fact find pass is for."},"circle":{"type":"object","properties":{"uuid":{"type":"string","example":"46c5256d-603b-4499-9a28-5c552dfabc3a"},"name":{"type":"string","example":"The Codepotato Gang"}},"description":"The circle the fact find is for."},"expires_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The expiry date of the fact find pass. When blank, the fact find pass will not expire."},"progress":{"type":"integer","example":50,"description":"The progress of the fact find pass on the fact find."},"is_complete":{"type":"boolean","example":false,"description":"Determines if the fact find pass has completed the fact find."},"completed_sections":{"type":"integer","example":2,"description":"The number of sections the fact find pass has completed on the fact find."}},"example":{"uuid":"32c653d7-2a47-4749-be36-19c883f3b7a3","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","firm":{"uuid":"9e2072c9-0bdf-46c5-ae79-57a5ed76b119","name":"Codepotato Ltd"},"account":{"uuid":"c6738836-6562-4d73-bee7-23e95e3be930","created_at":"2026-05-08T14:41:54+01:00","updated_at":"2026-05-08T14:41:54+01:00","type":"client","role":"client","first_name":"Gareth","last_name":"Thompson","name":"Gareth Thompson","email":"gareth@codepotato.co.uk","photo_url":"https://eu.ui-avatars.com/api/?name=Gareth+Thompson","external_references":"App\\Http\\Resources\\ExternalReferenceResource"},"circle":{"uuid":"46c5256d-603b-4499-9a28-5c552dfabc3a","name":"The Codepotato Gang"},"expires_at":"2026-05-08T14:41:54+01:00","progress":50,"is_complete":false,"completed_sections":2}},"App_Http_Resources_WelcomeWidgetTasksResource":{"type":"object","properties":{"id":{"type":"string","example":"branding","description":"The ID of the welcome widget item."},"title":{"type":"string","example":"Personalise your branding","description":"The title of the welcome widget item."},"description":{"type":"string","example":"Let's make Plannr look like the rest of your company","description":"The description of the welcome widget item."},"type":{"type":"string","example":"video","description":"The type of welcome widget item. Available values: video and document"},"resource_url":{"type":"string","example":"https://www.youtube.com/embed/7siXdMId640","description":"The URL of the resource depending on the type."},"is_complete":{"type":"boolean","example":false,"description":"Denotes if the welcome widget task has been completed by the authenticated user."}},"example":{"id":"branding","title":"Personalise your branding","description":"Let's make Plannr look like the rest of your company","type":"video","resource_url":"https://www.youtube.com/embed/7siXdMId640","is_complete":false}},"App_Http_Resources_Plans_ValuationResource":{"type":"object","properties":{"uuid":{"type":"string","example":"ef634961-421d-48fc-8163-7eb076d209c3"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"valued_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}},"sub_account":{"type":"object","properties":{"uuid":{"type":"string","example":"6f88dee8-f43c-4f3c-9839-986202856af6"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"name":{"type":"string","example":"John's ISA"},"policy_number":{"type":"string","example":"AVI-4837"},"latest_valuation":{"type":"string","example":"App\\Http\\Resources\\Plans\\ValuationResource"},"is_main_account":{"type":"boolean","example":false},"active_portfolio":{"type":"string","example":"App\\Http\\Resources\\Plans\\PortfolioResource"},"statistics":{"type":"object","properties":{"recent_growth":{"type":"integer","example":100}}}}}},"example":[{"uuid":"ef634961-421d-48fc-8163-7eb076d209c3","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","valued_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}},"sub_account":{"uuid":"6f88dee8-f43c-4f3c-9839-986202856af6","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"John's ISA","policy_number":"AVI-4837","latest_valuation":"App\\Http\\Resources\\Plans\\ValuationResource","is_main_account":false,"active_portfolio":"App\\Http\\Resources\\Plans\\PortfolioResource","statistics":{"recent_growth":100}}}]},"App_Http_Resources_WebhookSubscriptionResource":{"type":"object","properties":{"uuid":{"type":"string","example":"01491ea5-56b7-4c70-8bc1-7e633cd65cc5","description":"The UUID of the resource."},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The timestamp of when the resource was updated."},"signing_secret":{"type":"string","example":"MOkZXDMNXndCHNUeuV7iiemHjkTs2qTZrYJOhnVqm07RboAlcfNCe3dEKmX2","description":"The signing secret of the webhook. You can use this to create your own signature of the webhook body and compare it against the X-Signature header Plannr sends. This ensures that the payload has not been modified."},"url":{"type":"string","example":"https://api.example.com/webhooks","description":"The URL of the webhook Plannr will send events to."},"events":{"type":"array","example":["account.deleted","circle.created"],"description":"The events the webhook subscription is subscribed to.","items":{"type":"string"}},"last_outgoing_webhook_call_at":{"type":"string","example":"2026-05-08T14:41:56+01:00","description":"The last time Plannr sent a request to this webhook."}},"example":{"uuid":"01491ea5-56b7-4c70-8bc1-7e633cd65cc5","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","signing_secret":"MOkZXDMNXndCHNUeuV7iiemHjkTs2qTZrYJOhnVqm07RboAlcfNCe3dEKmX2","url":"https://api.example.com/webhooks","events":["account.deleted","circle.created"],"last_outgoing_webhook_call_at":"2026-05-08T14:41:56+01:00"}},"App_Http_Resources_OutgoingWebhookCallResource":{"type":"object","properties":{"uuid":{"type":"string","example":"0cc6e549-719b-4d9e-be43-027881814262"},"created_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"request_body":{"type":"object","properties":{"event":{"type":"string","example":"account.created"},"sent_at":{"type":"string","example":"2026-05-08T14:41:56+01:00"},"data":{"type":"array","example":[]}}},"response_status":{"type":"integer","example":200},"response_body":{"type":"object","properties":{"message":{"type":"string","example":"ok"}}},"successful":{"type":"boolean","example":true},"fatal_error":{"type":"string","example":"Unable to connect"},"is_retry":{"type":"boolean","example":false}},"example":[{"uuid":"0cc6e549-719b-4d9e-be43-027881814262","created_at":"2026-05-08T14:41:56+01:00","updated_at":"2026-05-08T14:41:56+01:00","request_body":{"event":"account.created","sent_at":"2026-05-08T14:41:56+01:00","data":[]},"response_status":200,"response_body":{"message":"ok"},"successful":true,"fatal_error":"Unable to connect","is_retry":false}]},"App_Http_Resources_Plans_WithdrawalResource":{"type":"object","properties":{"uuid":{"type":"string","example":"b72fc2ef-1163-488d-8146-249a685c5f97"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"withdrawn_at":{"type":"string","example":"2026-05-08T14:41:55+01:00"},"value":{"type":"object","properties":{"amount":{"type":"object","properties":{"example":{"type":"string","example":"4000"},"description":{"type":"string","example":"Money amount at their lowest denominator (for example: pennies)"}}},"formatted":{"type":"object","properties":{"example":{"type":"string","example":"£40.00"},"description":{"type":"string","example":"Money amount formatted with currency"}}},"currency":{"type":"object","properties":{"example":{"type":"string","example":"GBP"},"description":{"type":"string","example":"Currency of the money"}}}}}},"example":[{"uuid":"b72fc2ef-1163-488d-8146-249a685c5f97","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","withdrawn_at":"2026-05-08T14:41:55+01:00","value":{"amount":{"example":"4000","description":"Money amount at their lowest denominator (for example: pennies)"},"formatted":{"example":"£40.00","description":"Money amount formatted with currency"},"currency":{"example":"GBP","description":"Currency of the money"}}}]},"App_Http_Resources_Board_WorkflowResource":{"type":"object","properties":{"uuid":{"type":"string","example":"ae389ec0-7d7b-4c72-873b-6a204be4d5d8","description":"UUID of the account"},"created_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was created."},"updated_at":{"type":"string","example":"2026-05-08T14:41:55+01:00","description":"The timestamp of when the resource was updated."},"name":{"type":"string","example":"Pension Transfer","description":"Name of the workflow"},"type":{"type":"string","example":"simple","description":"The type of workflow."},"tasks_count":{"type":"integer","example":5,"description":"The number of tasks on the workflow."}},"example":{"uuid":"ae389ec0-7d7b-4c72-873b-6a204be4d5d8","created_at":"2026-05-08T14:41:55+01:00","updated_at":"2026-05-08T14:41:55+01:00","name":"Pension Transfer","type":"simple","tasks_count":5}},"App_Http_Resources_Board_WorkflowTreeResource":{"type":"object","properties":{"uuid":{"type":"string","example":"3dedb12f-e936-49b3-a8c2-b7f6ae503030","description":"The UUID of the resource."},"name":{"type":"string","example":"Task With Children","description":"The name of the task."},"sub_tasks":{"type":"array","example":[{"uuid":"5495b651-0844-45a2-aaaf-1d42c937c443","name":"Task With Children","sub_tasks":"App\\Http\\Resources\\Board\\WorkflowTreeResource","trigger_tasks_count":5}],"description":"The sub tasks of the workflow task.","items":{"type":"object","properties":{"uuid":{"type":"string","example":"5495b651-0844-45a2-aaaf-1d42c937c443"},"name":{"type":"string","example":"Task With Children"},"sub_tasks":{"type":"string","example":"App\\Http\\Resources\\Board\\WorkflowTreeResource"},"trigger_tasks_count":{"type":"integer","example":5}}}},"trigger_tasks_count":{"type":"integer","example":5,"description":"The number of tasks this task will trigger when it is added to the workflow."}},"example":{"uuid":"3dedb12f-e936-49b3-a8c2-b7f6ae503030","name":"Task With Children","sub_tasks":[{"uuid":"5495b651-0844-45a2-aaaf-1d42c937c443","name":"Task With Children","sub_tasks":"App\\Http\\Resources\\Board\\WorkflowTreeResource","trigger_tasks_count":5}],"trigger_tasks_count":5}},"App_Http_Resources_Board_WorkflowBreadcrumbsResource":{"type":"object","properties":{"uuid":{"type":"string","example":"5df3da33-8c0d-450d-98ae-7bb82f0bad52","description":"The UUID of the resource."},"name":{"type":"string","example":"Example Task","description":"The name of the task"},"breadcrumbs":{"type":"string","example":"Parent Task \u003e Example Task","description":"The breadcrumbs of the tasks"}},"example":{"uuid":"5df3da33-8c0d-450d-98ae-7bb82f0bad52","name":"Example Task","breadcrumbs":"Parent Task \u003e Example Task"}},"BasicAddress":{"type":"object","properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"},"move_in_date":{"type":"string","example":"2024-06-20","description":"Move in date"},"moved_in_month":{"type":"integer","example":6,"description":"The month the client moved into this address."},"moved_in_year":{"type":"integer","example":2022,"description":"The year the client moved into this address."},"moved_out_month":{"type":"integer","example":1,"description":"The month the client moved out of this address."},"moved_out_year":{"type":"integer","example":2024,"description":"The year the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","description":"|\n\nThe client's residential status when living at the address.\n\n| Value | Description |\n| ----- | ----------- |\n|homeowner|Homeowner|\n|renting|Renting|\n|living_with_parents|Living With Parents|\n|other|Other|","enum":["homeowner","renting","living_with_parents","other"]},"residential_status_other":{"type":"string","example":"Non-tenant occupier","description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."}}},"SimpleAddress":{"type":"object","properties":{"address_1":{"type":"string","example":"Work Address","description":"Name of the address"},"address_2":{"type":"string","example":"Suite E, 5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"}}},"DefaultFoldersStructure":{"type":"object","required":["name","children"],"properties":{"uuid":{"type":"string","example":"4ef713fc-c95f-4113-afaa-4112e59d25fa","description":"The UUID of the folder. This is only required when updating an existing folder in the structure.","format":"uuid"},"name":{"type":"string","example":"Documents","description":"The name of the folder."},"children":{"type":"array","example":[],"description":"The child folders of this folder.","items":{"$ref":"#/components/schemas/DefaultFoldersStructure"}},"clients_read":{"type":"boolean","example":false,"description":"Whether clients have read access to this folder."},"clients_write":{"type":"boolean","example":false,"description":"Whether clients have write access to this folder."}}},"TurnoverHistoryItem":{"type":"object","required":["year","value"],"properties":{"year":{"type":"string","example":"2020","description":"The year of the turnover entry.","format":"date"},"value":{"type":"integer","example":1000000,"description":"The turnover value in pennies for the given year.","minimum":0}}},"ExternalReference":{"type":"object","required":["third_party","reference"],"properties":{"third_party":{"type":"string","example":"adviser_office","description":"|\n\nThe third party that the reference is from.\n\n| Value | Description |\n| ----- | ----------- |\n|adviser_office|Adviser Office|\n|aj_bell|Aj Bell|\n|be_iq_organisation|Be Iq Organisation|\n|cash_calc|Cash Calc|\n|conquest|Conquest|\n|filehaven|Filehaven|\n|finio|Finio|\n|fundment|Fundment|\n|intelliflo_office|Intelliflo Office|\n|nucleus|Nucleus|\n|octopus_money|Octopus Money|\n|p1|P1|\n|parmenion|Parmenion|\n|seccl|Seccl|\n|smartsearch|Smartsearch|\n|soderberg|Soderberg|\n|transact_remuneration|Transact Remuneration|","enum":["adviser_office","aj_bell","be_iq_organisation","cash_calc","conquest","filehaven","finio","fundment","intelliflo_office","nucleus","octopus_money","p1","parmenion","seccl","smartsearch","soderberg","transact_remuneration"]},"reference":{"type":"string","example":"AB123456","description":"The reference value."}}},"SubAccountHolding":{"type":"object","required":["fund_name","units"],"properties":{"fund_name":{"type":"string","example":"My Fund","description":"The name of the fund for the holding."},"reference":{"type":"string","example":"C4$4","description":"The reference of the holding/fund.","nullable":true,"maxLength":255},"provider":{"type":"string","example":"Transact","description":"The Provider of the holding/fund.","nullable":true,"maxLength":255},"sector":{"type":"string","example":"Europe","description":"The sector of the holding/fund.","nullable":true,"maxLength":255},"sedol":{"type":"string","example":"ABC12345","description":"The sedol of the holding/fund.","nullable":true,"maxLength":255},"isin":{"type":"string","example":"ABC12345","description":"The isin of the holding/fund.","nullable":true,"maxLength":255},"citi":{"type":"string","example":"ABC12345","description":"The citi of the holding/fund.","nullable":true,"maxLength":255},"units":{"type":"number","example":10,"description":"The units of the holding"},"unit_price":{"type":"integer","example":50000,"description":"The current price of the units in pennies.","minimum":0},"unit_price_raw":{"type":"number","example":500.2345,"description":"The current price of the units in it's raw format with decimals."},"purchase_price":{"type":"integer","example":25000,"description":"The original purchase price of the holding in pennies.","minimum":0,"nullable":true},"currency":{"type":"string","example":"GBP","description":"The currency of the holding/fund.","minLength":3,"maxLength":3},"is_active":{"type":"boolean","example":true,"description":"Whether the holding is active or not."},"portfolio_uuid":{"type":"string","example":"45dba758-b89e-45f3-a688-55f66e61fb77","description":"The portfolio UUID this holding belongs to.","format":"uuid","nullable":true}}},"Create_Client_Account":{"type":"object","description":"Client route for Create an account","nullable":false,"title":"Create Client Account","required":["type","role","first_name","last_name","business_details"],"properties":{"type":{"type":"string","example":"client","description":"The type of the account being created. For creating a client, this type must be `client`."},"role":{"type":"string","example":"individual","description":"The role of the account being created. For creating a client, the available roles are: individual, joint, trust and business"},"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Gareth","description":"First Name"},"middle_name":{"type":"string","example":"Alex","description":"Middle Name"},"last_name":{"type":"string","example":"Thompson","description":"Last Name"},"maiden_name":{"type":"string","example":"Thompson","description":"Maiden Name"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email address"},"send_welcome_email":{"type":"boolean","example":true,"description":"Send an email on account creation and create a login"},"phone":{"type":"string","example":"443330509960","description":"Phone number"},"address":{"$ref":"#/components/schemas/BasicAddress"},"assigned_adviser_uuid":{"type":"string","example":"c5edbfe0-e884-478c-8da0-073a8bb3c8d7","description":"The UUID of the employee that the client directly reports to","format":"uuid"},"assigned_administrator_uuid":{"type":"string","example":"af6eefe5-66e9-4682-8a37-43127783769f","description":"The UUID of the adviser employee that the client has been assigned","format":"uuid"},"assigned_paraplanner_uuid":{"type":"string","example":"a2b67cb9-b218-4a7b-b50f-43b5023512ad","description":"The UUID of the paraplanner employee that the client has been assigned","format":"uuid"},"introduced_by_uuid":{"type":"string","example":"c2ac2f7d-1b46-4c0a-a17d-105990dd5f54","description":"The UUID of the introducer for this client","format":"uuid"},"date_of_birth":{"type":"string","example":"1976-05-08","description":"Date of birth","format":"date"},"gender":{"type":"string","example":"male","description":"|\n\nGender.\n\n| Value | Description |\n| ----- | ----------- |\n|male|male|\n|female|female|\n|non-binary|non-binary|\n|transgender|transgender|\n|intersex|intersex|\n|other|other|\n|unknown|unknown|","enum":["male","female","non-binary","transgender","intersex","other","unknown"]},"ni_number":{"type":"string","example":"AB 12 34 56 C","description":"National Insurance Number"},"nickname":{"type":"string","example":"G","description":"preferred nickname of the client"},"target_retirement_age":{"type":"integer","example":60,"description":"Target retirement age."},"pronouns":{"type":"string","example":"he/him","description":"Pronouns"},"smoker_status":{"type":"string","example":"non-smoker","description":"Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"},"last_used_nicotine_products_date":{"type":"string","example":"2025-05-08","description":"The date of the last time the client used nicotine products.","format":"date"},"residential_status":{"type":"string","example":"settled","description":"Residential status"},"country_of_residence":{"type":"string","example":"United Kingdom","description":"Country of residence"},"marital_status":{"type":"string","example":"married","description":"Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"},"is_vulnerable":{"type":"string","example":"possibly","description":"whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\""},"is_prospect":{"type":"boolean","example":false,"description":"Denotes if the client is a prospect or not."},"prospect_converted_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The datetime when the prospect was converted into a client.","format":"date"},"value":{"type":"integer","example":500000,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"is_uk_resident":{"type":"boolean","example":true,"description":"Whether the client is a UK resident or not."},"is_uk_domicile":{"type":"boolean","example":true,"description":"Whether the client is a UK domicile or not."},"expected_retirement_age":{"type":"integer","example":60,"description":"The expected retirement age."},"state_retirement_age":{"type":"integer","example":60,"description":"The state retirement age."},"nationalities":{"type":"array","example":["British","Romanian"],"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","description":"Any details regarding the client's vulnerabilities."},"third_party_offered":{"type":"boolean","example":true,"description":"Whether the client has been offered any third party."},"procedure_adaptation":{"type":"boolean","example":true,"description":"Whether any procedures need to be adapted to the client."},"adaption_details_notes":{"type":"boolean","example":true,"description":"Any notes regarding adaptations"},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","description":"Any client preferences."},"current_state_of_health":{"type":"string","example":"Fit and healthy","description":"The client's current state of health."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","description":"Explanation of the current state of health."},"cigarettes_daily":{"type":"integer","example":6,"description":"The amount of cigarettes the client smokes a day."},"smoker_since":{"type":"string","example":"2016-05-08","description":"The date of when the client started smoking.","format":"date"},"long_term_care_needed":{"type":"boolean","example":false,"description":"Whether the client required long term care."},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","description":"Notes on the client's long term care."},"has_will":{"type":"boolean","example":false,"description":"Whether the client has a will or not."},"will_notes":{"type":"string","example":"Notes on the client's will.","description":"Notes on the client's will."},"will_last_reviewed":{"type":"string","example":"2026-05-07","description":"The date of the last time the will's been reviewed.","format":"date"},"has_power_of_attorney":{"type":"boolean","example":true,"description":"Whether the client has power of attorney."},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","description":"Notes on the client's power of attorney."},"first_contact_date":{"type":"string","example":"2026-04-08","description":"The date of the first contact.","format":"date"},"units_of_alcohol_weekly":{"type":"integer","example":28,"description":"The units of alcohol digested weekly."},"height":{"type":"integer","example":186,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"description":"The weight of the client in pounds."},"health_notes":{"type":"string","example":"Notes on the client's health.","description":"Notes on the client's health."},"has_iht_planning":{"type":"boolean","example":true,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","description":"Notes on the client's Inheritance Tax (IHT) planning."},"has_gifted_family":{"type":"boolean","example":true,"description":"Whether the client has gifted the family."},"gift_notes":{"type":"string","example":"Notes on the gifts.","description":"Notes on the gifts."},"is_anticipating_inheritance":{"type":"boolean","example":true,"description":"Whether the client is anticipating/ expecting any inheritance."},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","description":"Notes on the client's inheritance anticipation/ expectations."},"next_review_date":{"type":"string","example":"2026-06-08","description":"Date of next review","format":"date"},"previous_review_date":{"type":"string","example":"2026-04-08","description":"Date of previous review","format":"date"},"anniversary_review_date":{"type":"string","example":"2026-05-08","description":"Anniversary review date","format":"date"},"is_will_accurate":{"type":"boolean","example":true,"description":"Does your current will reflect your wishes?"},"will_executors":{"type":"string","example":"","description":"Who are the executors?"},"will_location":{"type":"string","example":"","description":"Where is the will stored?"},"will_bequests_detail":{"type":"string","example":"","description":"Details of any Bequests"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","description":"Is the Power of Attorney Registered as a EPA or LPA"},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","description":"Are the Attorneys appointed for Health, Wealth or Both?"},"poa_attorney_appointed_at":{"type":"string","example":"2026-05-08T00:00:00+01:00","description":"When were the Attorney’s appointed?","format":"date"},"will_poa_details":{"type":"string","example":"","description":"Who are the Attorney’s?"},"are_poa_documents_registered":{"type":"boolean","example":true,"description":"Are the documents registered?"},"will_gifts_details":{"type":"string","example":"","description":"Notes of gifts"},"groups":{"type":"array","example":["19a8cdb5-152c-4729-b2de-4f5cb699a735","f71f5e1e-cb68-44e9-a428-a17641e3e84a"],"description":"Group UUIDs to sync client to."},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"description":"Are you in receipt of your State Pension"},"has_obtained_a_forecast":{"type":"boolean","example":true,"description":"Have you recently obtained a forecast"},"date_of_forecast":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"What is the date of the obtained forecast","format":"date"},"projected_state_pension":{"type":"integer","example":50000,"description":"What is the projected State Pension"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"description":"How many years have you made Nation Insurance Contributions"},"pension_notes":{"type":"string","example":"","description":"Notes on the pension"},"status_uuid":{"type":"string","example":"df5cadd2-4595-4f97-8c3b-e1a975fb7349","description":"The status of the client.","format":"uuid"},"current_life_stage_uuid":{"type":"string","example":"3e1606cd-332c-4477-a323-ff90dd9ba16f","description":"The clients current life stage for expenditure. Defaults to first available to firm if not provided.","format":"uuid"},"date_of_marriage":{"type":"string","example":"2026-05-08","description":"Date of marriage","format":"date"},"is_deceased":{"type":"boolean","example":false,"description":"Denotes if the client is deceased"},"deceased_at":{"type":"string","example":"2026-05-08","description":"Date of death","format":"date"},"is_married_to_partner":{"type":"boolean","example":true,"description":"Denotes if the client is married to their partner"},"checked_sanctions_at":{"type":"string","example":"2026-05-08","description":"Date the client was checked for sanctions","format":"date"},"lead_source":{"type":"string","example":"LeadGen Company","description":"Marks the lead source of the client"},"write_to_whom":{"type":"string","example":"Gareth","description":"Marks the name of the client to write to"},"passport_number":{"type":"string","example":"123456","description":"The passport number of the client"},"do_not_contact_via_fax":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_mail":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via mail"},"do_not_contact_via_sms":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via SMS"},"do_not_contact_via_email":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via email"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via telephone"},"do_not_visit":{"type":"boolean","example":false,"description":"Denotes if the client can be visited"},"do_not_market":{"type":"boolean","example":false,"description":"Denotes if the client can be marketed to"},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date","format":"date"},"circles":{"type":"array","example":[],"description":"Circles to associate the client to on creation with a login access level that controls what the client would see if they have a login.","items":{"type":"object","example":{"uuid":"32623f4a-991f-49cc-9545-5ea484f3b2e5","login_access_level":"read"},"properties":{"uuid":{"type":"string","example":"32623f4a-991f-49cc-9545-5ea484f3b2e5","description":"uuid of the circle","format":"uuid"},"login_access_level":{"type":"string","example":"read","description":"|\n\nLogin Access level\n\n| Value | Description |\n| ----- | ----------- |\n|read|Read|\n|write|Write|","enum":["read","write"]}}}},"business_unit":{"type":"string","example":"8621f584-40de-40cc-badc-70a237ccb146","description":"UUID of the business unit to associate this account to","format":"uuid","nullable":true},"external_reference":{"$ref":"#/components/schemas/ExternalReference"},"owners":{"type":"array","example":["6169d26a-db74-42f5-bc3d-cbc91c6182b5","33f6a893-1f9a-4b48-b46b-ff3805e919d4","0569a4cb-6433-4d7c-a096-ad67ad228227"],"description":"Array of client account UUIDs that are owners","items":{"type":"string","example":"dda2c66e-2a8a-49dd-8e4d-63c00a63d363","format":"uuid"}},"shareholders":{"type":"array","example":[],"description":"Array of shareholders details","items":{"type":"object","example":{"full_name":"John Smith","role":"Director","appointed_at":"2026-05-08","address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"percentage":60,"shares_owned":20,"voting_rights":"Right to appoint or remove directors"},"properties":{"full_name":{"type":"string","example":"John Smith","description":"The shareholder's full name."},"role":{"type":"string","example":"Director","description":"The shareholder's role."},"appointed_at":{"type":"string","example":"2026-05-08","description":"Date the shareholder was appointed","format":"date"},"address":{"type":"object","description":"Shareholder's address","example":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"}}},"percentage":{"type":"integer","example":60,"description":"Shareholder's percentage"},"shares_owned":{"type":"integer","example":20,"description":"Shareholder's amount of shares owned"},"voting_rights":{"type":"string","example":"Right to appoint or remove directors","description":"The shareholder's voting rights."}}}},"incomes":{"type":"array","example":[],"description":"Array of incomes","items":{"type":"object","example":{"name":"State Pension","type":"pension","amount":20000,"amount_type":"net","start_date":"2026-05-08","end_date":"2026-05-08","frequency":"monthly","is_taxable":false},"properties":{"name":{"type":"string","example":"State Pension","description":"The income's name."},"type":{"type":"string","example":"pension","description":"The income's type."},"amount":{"type":"integer","example":20000,"description":"The amount of the income"},"amount_type":{"type":"string","example":"net","description":"The income's type (net/gross)."},"start_date":{"type":"string","example":"2026-05-08","description":"Date the income started","format":"date"},"end_date":{"type":"string","example":"2026-05-08","description":"Date the income ended","format":"date"},"frequency":{"type":"string","example":"monthly","description":"The income's frequency."},"is_taxable":{"type":"boolean","example":false,"description":"Denotes if the income is taxable"}}}},"business_details":{"type":"object","description":"Business details","example":{"status":"Insolvent","status_comments":"This was due to an accounting error","type":"Public Limited Company","type_comments":"They became a Public Limited Company after May 2025","incorporated_on":"2026-05-08","business_registered_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"nature":"Construction","uk_sic_code":"12345","companies_house_number":"OC999999","year_end_day":11,"year_end_month":7,"firm_website":"www.google.com","employee_count":30,"self_employed_staff_count":30,"business_value":45000000,"is_registered_vat":false,"vat_number":"12345","accountant_company":"Accurate Accounting","accountant_name":"Andy Accountant","business_accountant_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"legal_adviser_name":"Lenny Legal","business_legal_adviser_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"auditor_name":"Andy Audit","business_auditor_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"data_protection_officer":"Dave Data","primary_contacts":[]},"properties":{"status":{"type":"string","example":"Insolvent","description":"The status of the business."},"status_comments":{"type":"string","example":"This was due to an accounting error","description":"The comments related to the status of the business."},"type":{"type":"string","example":"Public Limited Company","description":"The type of business."},"type_comments":{"type":"string","example":"They became a Public Limited Company after May 2025","description":"The type of business."},"incorporated_on":{"type":"string","example":"2026-05-08","description":"The Date the business was incorporated on","format":"date"},"business_registered_address":{"type":"object","description":"the business registered address details","example":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"}}},"nature":{"type":"string","example":"Construction","description":"The nature of the business"},"uk_sic_code":{"type":"string","example":"12345","description":"The uk SIC code of the business"},"companies_house_number":{"type":"string","example":"OC999999","description":"The companies house number of the business"},"year_end_day":{"type":"integer","example":11,"description":"The day of the month the business uses for their year end date"},"year_end_month":{"type":"integer","example":7,"description":"The month the business uses for their year end date"},"firm_website":{"type":"string","example":"www.google.com","description":"The website of the business"},"employee_count":{"type":"integer","example":30,"description":"The number of employees the business has"},"self_employed_staff_count":{"type":"integer","example":30,"description":"The number of self employed staff the business has"},"business_value":{"type":"integer","example":45000000,"description":"The value of the business"},"is_registered_vat":{"type":"boolean","example":false,"description":"Denotes if the business is registered for VAT"},"vat_number":{"type":"string","example":"12345","description":"The VAT number of the business"},"accountant_company":{"type":"string","example":"Accurate Accounting","description":"The name of the accounting firm used by the business"},"accountant_name":{"type":"string","example":"Andy Accountant","description":"The name of the accountant used by the business"},"business_accountant_address":{"type":"object","description":"The accountant's address details","example":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"}}},"legal_adviser_name":{"type":"string","example":"Lenny Legal","description":"The name of the legal adviser used by the business"},"business_legal_adviser_address":{"type":"object","description":"The legal adviser's address details","example":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"}}},"auditor_name":{"type":"string","example":"Andy Audit","description":"The name of the auditor used by the business"},"business_auditor_address":{"type":"object","description":"The auditor's address details","example":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"}}},"data_protection_officer":{"type":"string","example":"Dave Data","description":"The name of the data protection officer used by the business"},"primary_contacts":{"type":"array","example":[],"description":"Array of the business's primary contacts","items":{"type":"object","example":{"uuid":"85a18f25-2937-415e-a59a-a9ccc8a3740f","name":"Jane Doe","email":"janedoe@primarycontact.com","address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"}},"properties":{"uuid":{"type":"string","example":"85a18f25-2937-415e-a59a-a9ccc8a3740f","description":"The uuid of the primary contact.","format":"uuid"},"name":{"type":"string","example":"Jane Doe","description":"Name of the primary contact"},"email":{"type":"string","example":"janedoe@primarycontact.com","description":"Email of the primary contact"},"address":{"type":"object","description":"The primary contact's address details","example":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"properties":{"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"}}}}}}}}}},"Create_Employee_Account":{"type":"object","description":"Employee route for Create an account","nullable":false,"title":"Create Employee Account","required":["type","role","first_name","last_name","send_welcome_email","departments"],"properties":{"type":{"type":"string","example":"employee","description":"The type of the account being created. For creating an employee, this type must be `employee`."},"role":{"type":"string","example":"member","description":"The role of the account being created. For creating an employee, the available roles are: owner, admin and member"},"first_name":{"type":"string","example":"Gareth","description":"The first name of the employee."},"last_name":{"type":"string","example":"Thompson","description":"The last name of the employee."},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email address"},"send_welcome_email":{"type":"boolean","example":true,"description":"Send an email on account creation and create a login"},"phone":{"type":"string","example":"443330509960","description":"Phone number"},"address":{"$ref":"#/components/schemas/BasicAddress"},"assigned_adviser_uuid":{"type":"string","example":"ab4640d2-6473-44ce-8a1b-26cc0c261154","description":"d1ef7a16-d398-40a2-96ba-6dc5561eaed7","format":"uuid"},"departments":{"type":"array","example":["paraplanner","adviser"],"description":"The departments the employee is part of"},"groups":{"type":"array","example":["7b56d01b-5407-4b25-afdb-78fd2f645228","e90f9d27-4885-45e4-a994-8fc0f89d8494"],"description":"Group uuids belonging to the firm."},"adviser_split_uuid":{"type":"string","example":"0654006a-90df-4851-8ba3-ab796eff0487","description":"The uuid of the the adviser split that will be applied when this adviser adds charges","format":"uuid"},"advice_type":{"type":"string","example":"independent","description":"Employee's RMAR advice type"},"next_review_date":{"type":"string","example":"2026-06-08","description":"Date of next review","format":"date"},"previous_review_date":{"type":"string","example":"2026-04-08","description":"Date of previous review","format":"date"},"anniversary_review_date":{"type":"string","example":"2026-05-08","description":"Anniversary review date","format":"date"},"meeting_booking_url":{"type":"string","example":"https://calendly.com/gareth-codepotato","description":"Employee's meeting booking URL"},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date","format":"date"},"business_unit":{"type":"string","example":"5123b2c7-f191-4efb-9c5b-58278ce8bde1","description":"UUID of the business unit to associate this account to","format":"uuid","nullable":true}}},"Create_Introducer_Account":{"type":"object","description":"Introducer route for Create an account","nullable":false,"title":"Create Introducer Account","required":["type","role","first_name","last_name","entity_name"],"properties":{"type":{"type":"string","example":"introducer","description":"The type of the account being created. For creating an introducer, this type must be `introducer`."},"role":{"type":"string","example":"introducer","description":"The role of the account being created. For creating an introducer, this role must be `introducer`."},"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Patrick","description":"First name"},"last_name":{"type":"string","example":"Stanton","description":"Last name"},"entity_name":{"type":"string","example":"PatrickCo","description":"Entity/business name"},"email":{"type":"string","example":"gareth@codepotato.co.uk","description":"Email address"},"send_welcome_email":{"type":"boolean","example":true,"description":"Send an email on account creation and create a login"},"phone":{"type":"string","example":"443330509960","description":"Phone number"},"address":{"$ref":"#/components/schemas/BasicAddress"},"assigned_adviser_uuid":{"type":"string","example":"7c7d38aa-7796-441b-a63a-bd06f34c6ee7","description":"UUID of the account that this account reports to","format":"uuid"},"groups":{"type":"array","example":["fd59c291-60bc-43fa-9d79-346970e49200","8ca49248-e2f6-4a7c-a905-050bc54e179f"],"description":"Group uuids belonging to the firm."},"charge_split_schema_uuid":{"type":"string","example":"02426df3-81ac-4530-8c18-fda808f09bf7","description":"Charge split schema that is always used when adding a charge split for this introducer","format":"uuid"},"business_unit":{"type":"string","example":"4ef7dbc1-31c8-4a2b-ae73-436c9598735f","description":"UUID of the business unit to associate this account to","format":"uuid","nullable":true},"next_review_date":{"type":"string","example":"2026-06-08","description":"Date of next review","format":"date"},"previous_review_date":{"type":"string","example":"2026-04-08","description":"Date of previous review","format":"date"},"anniversary_review_date":{"type":"string","example":"2026-05-08","description":"Anniversary review date","format":"date"},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date","format":"date"}}},"Update_Client_Account":{"type":"object","description":"Client route for Update an account","nullable":false,"title":"Update Client Account","required":["business_details"],"properties":{"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Gareth","description":"First name"},"middle_name":{"type":"string","example":"Alex","description":"Middle name."},"last_name":{"type":"string","example":"Thompson","description":"Last name"},"maiden_name":{"type":"string","example":"Thompson","description":"Maiden name."},"entity_name":{"type":"string","example":"Plannr Ltd","description":"Entity name for shared account types"},"assigned_adviser_uuid":{"type":"string","example":"b31f5fda-b030-479f-8d24-b8151f6e1266","description":"The UUID of the employee that the client directly reports to","format":"uuid"},"assigned_administrator_uuid":{"type":"string","example":"cb7c725c-1d3c-48b9-af4b-62dcd224b5cd","description":"The UUID of the adviser employee that the client has been assigned","format":"uuid"},"assigned_paraplanner_uuid":{"type":"string","example":"2b657bf4-be00-48fc-97e7-c149ece301d7","description":"The UUID of the paraplanner employee that the client has been assigned","format":"uuid"},"introduced_by_uuid":{"type":"string","example":"80f6bff3-df37-45c3-bb93-2597efb639aa","description":"The UUID of the introducer for this client","format":"uuid"},"date_of_birth":{"type":"string","example":"1976-05-08","description":"Date of birth","format":"date"},"gender":{"type":"string","example":"Male","description":"Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"},"ni_number":{"type":"string","example":"AB 12 34 56 C","description":"National Insurance Number"},"nickname":{"type":"string","example":"Garth","description":"preferred nickname of the client"},"target_retirement_age":{"type":"integer","example":60,"description":"Targest retirement age."},"pronouns":{"type":"string","example":"he/him","description":"Pronouns"},"smoker_status":{"type":"string","example":"non-smoker","description":"Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"},"residential_status":{"type":"string","example":"settled","description":"Residential status"},"country_of_residence":{"type":"string","example":"United Kingdom","description":"Country of residence"},"marital_status":{"type":"string","example":"married","description":"Marital status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"},"is_vulnerable":{"type":"string","example":"possibly","description":"whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\""},"is_prospect":{"type":"boolean","example":false,"description":"Denotes if the client is a prospect or not."},"prospect_converted_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"The datetime when the prospect was converted into a client.","format":"date"},"value":{"type":"integer","example":500000,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"is_uk_resident":{"type":"boolean","example":true,"description":"Whether the client is a UK resident or not."},"is_uk_domicile":{"type":"boolean","example":true,"description":"Whether the client is a UK domicile or not."},"expected_retirement_age":{"type":"integer","example":60,"description":"The expected retirement age."},"state_retirement_age":{"type":"integer","example":60,"description":"The state retirement age."},"nationalities":{"type":"array","example":["British","Romanian"],"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","description":"Any details regarding the client's vulnerabilities."},"third_party_offered":{"type":"boolean","example":true,"description":"Whether the client has been offered any third party."},"procedure_adaptation":{"type":"boolean","example":false,"description":"Whether any procedures need to be adapted to the client."},"adaption_details_notes":{"type":"boolean","example":true,"description":"Any notes regarding adaptations"},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","description":"Any client preferences."},"current_state_of_health":{"type":"string","example":"Fit and healthy","description":"The client's current state of health."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","description":"Explanation of the current state of health."},"cigarettes_daily":{"type":"integer","example":6,"description":"The amount of cigarettes the client smokes a day."},"smoker_since":{"type":"string","example":"2016-05-08","description":"The date of when the client started smoking.","format":"date"},"last_used_nicotine_products_date":{"type":"string","example":"2025-05-08","description":"The date of the last time the client used nicotine products.","format":"date"},"long_term_care_needed":{"type":"boolean","example":false,"description":"Whether the client required long term care."},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","description":"Notes on the client's long term care."},"has_will":{"type":"boolean","example":true,"description":"Whether the client has a will or not."},"will_notes":{"type":"string","example":"Notes on the client's will.","description":"Notes on the client's will."},"will_last_reviewed":{"type":"string","example":"2026-05-08","description":"The date of the last time the will's been reviewed.","format":"date"},"has_power_of_attorney":{"type":"boolean","example":true,"description":"Whether the client has power of attorney."},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","description":"Notes on the client's power of attorney."},"first_contact_date":{"type":"string","example":"2026-04-08","description":"The date of the first contact.","format":"date"},"units_of_alcohol_weekly":{"type":"integer","example":28,"description":"The units of alcohol digested weekly."},"height":{"type":"integer","example":186,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"description":"The weight of the client in pounds."},"health_notes":{"type":"string","example":"Notes on the client's health.","description":"Notes on the client's health."},"has_iht_planning":{"type":"boolean","example":true,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","description":"Notes on the client's Inheritance Tax (IHT) planning."},"has_gifted_family":{"type":"boolean","example":true,"description":"Whether the client has gifted the family."},"gift_notes":{"type":"string","example":"Notes on the gifts.","description":"Notes on the gifts."},"is_anticipating_inheritance":{"type":"boolean","example":true,"description":"Whether the client is anticipating/ expecting any inheritance."},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","description":"Notes on the client's inheritance anticipation/ expectations."},"next_review_date":{"type":"string","example":"2026-06-08","description":"Date of next review","format":"date"},"previous_review_date":{"type":"string","example":"2026-04-08","description":"Date of previous review","format":"date"},"anniversary_review_date":{"type":"string","example":"2026-05-08","description":"Anniversary review date","format":"date"},"is_will_accurate":{"type":"boolean","example":true,"description":"Does your current will reflect your wishes?"},"will_executors":{"type":"string","example":"","description":"Who are the executors?"},"will_location":{"type":"string","example":"","description":"Where is the will stored?"},"will_bequests_detail":{"type":"string","example":"","description":"Details of any Bequests"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","description":"Is the Power of Attorney Registered as a EPA or LPA"},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","description":"Are the Attorneys appointed for Health, Wealth or Both?"},"poa_attorney_appointed_at":{"type":"string","example":"2026-05-08T00:00:00+01:00","description":"When were the Attorney’s appointed?","format":"date"},"will_poa_details":{"type":"string","example":"","description":"Who are the Attorney’s?"},"are_poa_documents_registered":{"type":"boolean","example":true,"description":"Are the documents registered?"},"will_gifts_details":{"type":"string","example":"","description":"Notes of gifts"},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"description":"Are you in receipt of your State Pension"},"has_obtained_a_forecast":{"type":"boolean","example":true,"description":"Have you recently obtained a forecast"},"date_of_forecast":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"What is the date of the obtained forecast","format":"date"},"projected_state_pension":{"type":"integer","example":50000,"description":"What is the projected State Pension"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"description":"How many years have you made Nation Insurance Contributions"},"pension_notes":{"type":"string","example":"","description":"Notes on the pension"},"date_of_marriage":{"type":"string","example":"2026-05-08","description":"Date of marriage","format":"date"},"is_deceased":{"type":"boolean","example":false,"description":"Denotes if the client is deceased"},"deceased_at":{"type":"string","example":"2026-05-08","description":"Date of death","format":"date"},"is_married_to_partner":{"type":"boolean","example":true,"description":"Denotes if the client is married to their partner"},"checked_sanctions_at":{"type":"string","example":"2026-05-08","description":"Date the client was checked for sanctions","format":"date"},"lead_source":{"type":"string","example":"LeadGen Company","description":"Marks the lead source of the client"},"write_to_whom":{"type":"string","example":"Gareth","description":"Marks the name of the client to write to"},"passport_number":{"type":"string","example":"123456","description":"The passport number of the client"},"do_not_contact_via_fax":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_mail":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via mail"},"do_not_contact_via_sms":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via SMS"},"do_not_contact_via_email":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via email"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"description":"Denotes if the client can be contacted via telephone"},"do_not_visit":{"type":"boolean","example":false,"description":"Denotes if the client can be visited"},"do_not_market":{"type":"boolean","example":false,"description":"Denotes if the client can be visited"},"current_life_stage_uuid":{"type":"string","example":"e13873c7-c043-44b1-ba89-fe03247bda1c","description":"The clients current life stage for expenditure.","format":"uuid"},"status_uuid":{"type":"string","example":"166126f6-4e41-4ebb-bc7b-9078e11de840","description":"The status of the client.","format":"uuid"},"primary_address_uuid":{"type":"string","example":"ae089b0e-ac74-458d-b72f-5ec3ce71a974","description":"uuid of the primary address","format":"uuid"},"primary_email_uuid":{"type":"string","example":"7c2525e3-c337-475b-a34c-9ab537c6fbed","description":"uuid of the primary email contact detail","format":"uuid"},"primary_phone_number_uuid":{"type":"string","example":"d55ea2fc-79ca-4b56-afe7-eaf3935ce86a","description":"uuid of the primary phone number contact detail","format":"uuid"},"groups":{"type":"array","example":["610b7745-1609-4da3-bc58-cda14774a061","1d0b7539-e8fb-4376-a140-9bb0e5a9bb95"],"description":"Group UUIDs to sync client to. Null can be provided to clear a clients groups."},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date","format":"date"},"business_unit":{"type":"string","example":"0676bff3-13d2-4b47-87bb-19b60b91fa8d","description":"UUID of the business unit to associate this account to","format":"uuid","nullable":true},"circles":{"type":"array","example":[{"uuid":null,"login_access_level":"write"}],"description":"Circles to associate the client to on update with a login access level that controls what the client would see if they have a login. Available login_access_level values: read and write"},"business_details":{"type":"object","description":"Array of business details","example":{"status":"Insolvent","status_comments":"This was due to an accounting error","type":"Public Limited Company","type_comments":"They became a Public Limited Company after May 2025","incorporated_on":"2026-05-08","business_registered_address":{"uuid":"74aebd5c-6907-47ae-8ad1-2c4ef031b0ee","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"nature":"Construction","uk_sic_code":"12345","companies_house_number":"OC999999","year_end_day":11,"year_end_month":7,"firm_website":"www.google.com","employee_count":30,"self_employed_staff_count":30,"business_value":45000000,"is_registered_vat":false,"vat_number":"12345","accountant_company":"Accurate Accounting","accountant_name":"Andy Accountant","business_accountant_address":{"uuid":"30628e0d-7b95-4ad4-abb0-8303da285817","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"legal_adviser_name":"Lenny Legal","business_legal_adviser_address":{"uuid":"3bc51f72-3bcb-44ae-811e-ce3ab061d998","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"auditor_name":"Andy Audit","business_auditor_address":{"uuid":"3ffc266b-93c7-44ef-ba9a-d76f11d45b06","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"data_protection_officer":"Dave Data","primary_contacts":[]},"properties":{"status":{"type":"string","example":"Insolvent","description":"The status of the business."},"status_comments":{"type":"string","example":"This was due to an accounting error","description":"The comments related to the status of the business."},"type":{"type":"string","example":"Public Limited Company","description":"The type of business."},"type_comments":{"type":"string","example":"They became a Public Limited Company after May 2025","description":"The type of business."},"incorporated_on":{"type":"string","example":"2026-05-08","description":"The Date the business was incorporated on","format":"date"},"business_registered_address":{"type":"object","description":"Array of business registered address details","example":{"uuid":"74aebd5c-6907-47ae-8ad1-2c4ef031b0ee","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"properties":{"uuid":{"type":"string","example":"74aebd5c-6907-47ae-8ad1-2c4ef031b0ee","description":"The uuid of the registered address.","format":"uuid"},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"}}},"nature":{"type":"string","example":"Construction","description":"The nature of the business"},"uk_sic_code":{"type":"string","example":"12345","description":"The uk SIC code of the business"},"companies_house_number":{"type":"string","example":"OC999999","description":"The companies house number of the business"},"year_end_day":{"type":"integer","example":11,"description":"The day of the month the business uses for their year end date"},"year_end_month":{"type":"integer","example":7,"description":"The month the business uses for their year end date"},"firm_website":{"type":"string","example":"www.google.com","description":"The website of the business"},"employee_count":{"type":"integer","example":30,"description":"The number of employees the business has"},"self_employed_staff_count":{"type":"integer","example":30,"description":"The number of self employed staff the business has"},"business_value":{"type":"integer","example":45000000,"description":"The value of the business"},"is_registered_vat":{"type":"boolean","example":false,"description":"Denotes if the business is registered for VAT"},"vat_number":{"type":"string","example":"12345","description":"The VAT number of the business"},"accountant_company":{"type":"string","example":"Accurate Accounting","description":"The name of the accounting firm used by the business"},"accountant_name":{"type":"string","example":"Andy Accountant","description":"The name of the accountant used by the business"},"business_accountant_address":{"type":"object","description":"Array of the accountant's address details","example":{"uuid":"30628e0d-7b95-4ad4-abb0-8303da285817","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"properties":{"uuid":{"type":"string","example":"30628e0d-7b95-4ad4-abb0-8303da285817","description":"The uuid of the accountant's address.","format":"uuid"},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"}}},"legal_adviser_name":{"type":"string","example":"Lenny Legal","description":"The name of the legal adviser used by the business"},"business_legal_adviser_address":{"type":"object","description":"Array of the legal adviser's address details","example":{"uuid":"3bc51f72-3bcb-44ae-811e-ce3ab061d998","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"properties":{"uuid":{"type":"string","example":"3bc51f72-3bcb-44ae-811e-ce3ab061d998","description":"The uuid of the legal adviser's address.","format":"uuid"},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"}}},"auditor_name":{"type":"string","example":"Andy Audit","description":"The name of the auditor used by the business"},"business_auditor_address":{"type":"object","description":"Array of the auditor's address details","example":{"uuid":"3ffc266b-93c7-44ef-ba9a-d76f11d45b06","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"properties":{"uuid":{"type":"string","example":"3ffc266b-93c7-44ef-ba9a-d76f11d45b06","description":"The uuid of the auditor's address.","format":"uuid"},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"}}},"data_protection_officer":{"type":"string","example":"Dave Data","description":"The name of the data protection officer used by the business"},"primary_contacts":{"type":"array","example":[],"description":"Array of the business's primary contacts","items":{"type":"object","example":{"uuid":"7acb6bbd-e807-423b-9308-020e0e60176b","name":"Jane Doe","email":"janedoe@primarycontact.com","address":{"uuid":"f9cae0c1-d50e-4d6e-8b62-2c16edce9d79","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"}},"properties":{"uuid":{"type":"string","example":"7acb6bbd-e807-423b-9308-020e0e60176b","description":"The uuid of the primary contact.","format":"uuid"},"name":{"type":"string","example":"Jane Doe","description":"Name of the primary contact"},"email":{"type":"string","example":"janedoe@primarycontact.com","description":"Email of the primary contact"},"address":{"type":"object","description":"Array of the primary contact's address details","example":{"uuid":"f9cae0c1-d50e-4d6e-8b62-2c16edce9d79","name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"properties":{"uuid":{"type":"string","example":"f9cae0c1-d50e-4d6e-8b62-2c16edce9d79","description":"The uuid of the primary contact's address.","format":"uuid"},"name":{"type":"string","example":"Work Address","description":"Name of the address"},"address_1":{"type":"string","example":"Suite E","description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","description":"Town/City"},"county":{"type":"string","example":"Hampshire","description":"County"},"postcode":{"type":"string","example":"PO7 7YH","description":"Postcode"},"country":{"type":"string","example":"United Kingdom","description":"Country"}}}}}}}}}},"Update_Employee_Account":{"type":"object","description":"Employee route for Update an account","nullable":false,"title":"Update Employee Account","properties":{"first_name":{"type":"string","example":"Gareth","description":"The first name of the employee."},"last_name":{"type":"string","example":"Thompson","description":"The last name of the employee."},"email":{"type":"string","example":"gareth.thompson@plannrcrm.com","description":"The email of the employee. Required when with_login is present."},"assigned_adviser_uuid":{"type":"string","example":"ebb56b15-842f-4110-bebe-c519464c89bd","description":"The uuid of the senior employee that the employee directly reports to","format":"uuid"},"role":{"type":"string","example":"owner","description":"The role of the employee."},"departments":{"type":"array","example":["paraplanner","adviser"],"description":"The departments the employee is part of"},"adviser_split_uuid":{"type":"string","example":"0248abde-e3e0-47df-9003-7e3ec0dd79e2","description":"Adviser split","format":"uuid"},"groups":{"type":"array","example":["9acfdfd2-9a0b-4273-bd54-c46c3b7ed356","47f1d36a-d3dc-417e-878d-c8b451f6ab17"],"description":"Group UUIDs to sync employee to. Null can be provided to clear an employees groups"},"advice_type":{"type":"string","example":"independent","description":"Employee's RMAR advice type"},"meeting_booking_url":{"type":"string","example":"https://calendly.com/gareth-codepotato","description":"Employee's meeting booking URL"},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date","format":"date"},"business_unit":{"type":"string","example":"e56fb179-d20f-4a92-8287-4e3a4971e1c7","description":"UUID of the business unit to associate this account to","format":"uuid","nullable":true}}},"Update_Introducer_Account":{"type":"object","description":"Introducer route for Update an account","nullable":false,"title":"Update Introducer Account","properties":{"title":{"type":"string","example":"Mr","description":"Title"},"first_name":{"type":"string","example":"Patrick","description":"First name"},"last_name":{"type":"string","example":"Stanton","description":"Last name"},"entity_name":{"type":"string","example":"PatrickCo","description":"Entity/business name"},"assigned_adviser_uuid":{"type":"string","example":"c38d7c15-94ca-4542-9c72-ab4c48a429ff","description":"UUID of the account that this account reports to","format":"uuid"},"charge_split_schema_uuid":{"type":"string","example":"a6612074-b1f5-480a-83ad-b0582308f4f9","description":"Charge split schema that is always used when adding a charge split for this introducer","format":"uuid"},"groups":{"type":"array","example":["c3239df0-ac03-41ae-9f71-94d860f98715","8523a245-cc41-42ff-9763-28587290b67e"],"description":"Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups"},"inactive_at":{"type":"string","example":"2026-05-08","description":"Inactive from date","format":"date"},"business_unit":{"type":"string","example":"f59c05cf-c532-453d-b1c2-a033a58bf375","description":"UUID of the business unit to associate this account to","format":"uuid","nullable":true}}}}},"security":[{"PersonalAccessToken":[],"OAuth2":[]}],"paths":{"/api/v1/account/{account_uuid}/check":{"get":{"summary":"Get all checks","operationId":"getApiV1AccountAccount_uuidCheck","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter checks by uuid.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter checks by uuid.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[provider]","description":"Filter checks by provider.","example":"smartsearch","required":false,"schema":{"type":"string","description":"Filter checks by provider.","example":"smartsearch"}},{"in":"query","name":"filter[type]","description":"Filter checks by type.","example":"aml","required":false,"schema":{"type":"string","description":"Filter checks by type.","example":"aml"}},{"in":"query","name":"filter[status]","description":"Filter checks by status.","example":"failed","required":false,"schema":{"type":"string","description":"Filter checks by status.","example":"failed"}},{"in":"query","name":"filter[via_integration]","description":"true","example":false,"required":false,"schema":{"type":"boolean","description":"true","example":false}},{"in":"query","name":"filter[date_run_from]","description":"Date to filter when the check was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the check was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[date_run_to]","description":"Date to filter when the check was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the check was created before.","example":"2022-05-31"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, provider, type, status, last_webhook_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, provider, type, status, last_webhook_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CheckResource"}}}}}}}},"tags":["AML Checks"]},"post":{"summary":"Create a check","operationId":"postApiV1AccountAccount_uuidCheck","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CheckResource"}}}}},"tags":["AML Checks"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Check_StoreCheckRequest"}}}}},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/check/{uuid}":{"get":{"summary":"Show a check","operationId":"getApiV1AccountAccount_uuidCheckUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CheckResource"}}}}},"tags":["AML Checks"]},"put":{"summary":"Update a check","operationId":"putApiV1AccountAccount_uuidCheckUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CheckResource"}}}}},"tags":["AML Checks"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Check_UpdateCheckRequest"}}}}},"delete":{"summary":"Destroy a check","operationId":"deleteApiV1AccountAccount_uuidCheckUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["AML Checks"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account":{"get":{"summary":"Get all accounts","operationId":"getApiV1Account","description":"","parameters":[{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, inactive_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date, status_changed_at]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, inactive_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date, status_changed_at]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number, primary_email, primary_address, assigned_adviser, assigned_administrator, assigned_paraplanner, groups, tags, owners, custom_fields, external_references, charge_split_schema, circles, seccl_lookup, soderberg_lookup, octopus_money_lookup, p1_lookup, business_unit].","example":"?include=groups,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number, primary_email, primary_address, assigned_adviser, assigned_administrator, assigned_paraplanner, groups, tags, owners, custom_fields, external_references, charge_split_schema, circles, seccl_lookup, soderberg_lookup, octopus_money_lookup, p1_lookup, business_unit].","example":"?include=groups,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter accounts by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter accounts by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exclude_uuid]","description":"Exclude accounts by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Exclude accounts by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter accounts by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter accounts by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[ni_number]","description":"Comma separated list of partial National Insurance Numbers to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of partial National Insurance Numbers to filter by.","example":"architecto"}},{"in":"query","name":"filter[date_of_birth]","description":"Filter by date of birth with an operator.","example":"?filter[date_of_birth]=\u003e=1987-09-20 or range ?filter[date_of_birth]=\u003e=1987-09-20,\u003c=2000-01-01 or exact ?filter[date_of_birth]=1987-09-20","required":false,"schema":{"type":"string","description":"Filter by date of birth with an operator.","example":"?filter[date_of_birth]=\u003e=1987-09-20 or range ?filter[date_of_birth]=\u003e=1987-09-20,\u003c=2000-01-01 or exact ?filter[date_of_birth]=1987-09-20"}},{"in":"query","name":"filter[email]","description":"Filter accounts that have an email with a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter accounts that have an email with a partial match.","example":"architecto"}},{"in":"query","name":"filter[primary_email]","description":"Filter accounts with a given primary email. Performs a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter accounts with a given primary email. Performs a partial match.","example":"architecto"}},{"in":"query","name":"filter[primary_phone_number]","description":"Filter accounts with a given primary phone number. Performs a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter accounts with a given primary phone number. Performs a partial match.","example":"architecto"}},{"in":"query","name":"filter[status]","description":"Filter client status by partial names or uuid's","example":"active,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Filter client status by partial names or uuid's","example":"active,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[status_changed_at_from]","description":"Date to filter accounts by when their status was changed from.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter accounts by when their status was changed from.","example":"2022-04-05"}},{"in":"query","name":"filter[status_changed_at_to]","description":"Date to filter accounts by when their status was changed fup until.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter accounts by when their status was changed fup until.","example":"2022-05-31"}},{"in":"query","name":"filter[is_prospect]","description":"Get accounts with this is_prospect value","example":false,"required":false,"schema":{"type":"boolean","description":"Get accounts with this is_prospect value","example":false}},{"in":"query","name":"filter[is_child]","description":"affects whether to include accounts based on the child account flag. Valid options are \"exclude\", \"include\", \"only\". (default: \"include\")","example":"architecto","required":false,"schema":{"type":"string","description":"affects whether to include accounts based on the child account flag. Valid options are \"exclude\", \"include\", \"only\". (default: \"include\")","example":"architecto"}},{"in":"query","name":"filter[inactive_after]","description":"Get accounts set to inactive after this date","example":"architecto","required":false,"schema":{"type":"string","description":"Get accounts set to inactive after this date","example":"architecto"}},{"in":"query","name":"filter[inactive_before]","description":"Get accounts set to inactive before this date","example":"architecto","required":false,"schema":{"type":"string","description":"Get accounts set to inactive before this date","example":"architecto"}},{"in":"query","name":"filter[role]","description":"Comma separated string to filter by different account roles.  Valid types are [individual, joint, trust, business,member,owner,admin,introducer].","example":"?filter[role]=individual,joint","required":false,"schema":{"type":"string","description":"Comma separated string to filter by different account roles.  Valid types are [individual, joint, trust, business,member,owner,admin,introducer].","example":"?filter[role]=individual,joint"}},{"in":"query","name":"filter[type]","description":"Comma separated string to filter by different account types.  Valid types are [client,employee,external].","example":"?filter[type]=client,employee","required":false,"schema":{"type":"string","description":"Comma separated string to filter by different account types.  Valid types are [client,employee,external].","example":"?filter[type]=client,employee"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the accounts was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the accounts was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the accounts was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the accounts was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a accounts custom field. Example filter[custom_field:pet_name]='Doug'","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a accounts custom field. Example filter[custom_field:pet_name]='Doug'","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[groups]","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs.","example":"e995263e-7477-4118-8860-de295bafbe0b,f123456e-7890-1234-5678-abcdef123456","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs.","example":"e995263e-7477-4118-8860-de295bafbe0b,f123456e-7890-1234-5678-abcdef123456"}},{"in":"query","name":"filter[departments]","description":"Comma separated list of departments the employee is in.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of departments the employee is in.","example":"architecto"}},{"in":"query","name":"filter[exclude_groups]","description":"Provide a group UUID (or multiple as a comma-separated string) to filter accounts within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Provide a group UUID (or multiple as a comma-separated string) to filter accounts within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[introduced_by]","description":"filter clients that have been introduced by this introducer account, expects introducer account uuid, can accept multiple,","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"filter clients that have been introduced by this introducer account, expects introducer account uuid, can accept multiple,","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[linked_to]","description":"Filter to clients that have been linked to the account given. This will also return the requested account.","example":"df240fd1-784d-47e8-8874-f779a35847ca","required":false,"schema":{"type":"string","description":"Filter to clients that have been linked to the account given. This will also return the requested account.","example":"df240fd1-784d-47e8-8874-f779a35847ca"}},{"in":"query","name":"filter[include]","description":"Comma separated list of employee account UUIDs that should always be returned no matter what other filters are applied.","example":"a1d8eb7b-bcef-4321-b245-f00efd823e6a","required":false,"schema":{"type":"string","description":"Comma separated list of employee account UUIDs that should always be returned no matter what other filters are applied.","example":"a1d8eb7b-bcef-4321-b245-f00efd823e6a"}},{"in":"query","name":"filter[has_login]","description":"Filter accounts that have an active login","example":false,"required":false,"schema":{"type":"boolean","description":"Filter accounts that have an active login","example":false}},{"in":"query","name":"filter[assigned_adviser_uuids]","description":"Comma separated list of UUIDS to filter accounts who have the provided adviser account UUIDs","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of UUIDS to filter accounts who have the provided adviser account UUIDs","example":"architecto"}},{"in":"query","name":"filter[assigned_administrator_uuids]","description":"Comma separated list of UUIDS to filter accounts who have the provided administrator account UUIDs","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of UUIDS to filter accounts who have the provided administrator account UUIDs","example":"architecto"}},{"in":"query","name":"filter[assigned_paraplanner_uuids]","description":"Comma separated list of UUIDS to filter accounts who have the provided paraplanner account UUIDs","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of UUIDS to filter accounts who have the provided paraplanner account UUIDs","example":"architecto"}},{"in":"query","name":"filter[role_uuids]","description":"Comma separated list of RBAC role UUIDs. Returns accounts that have a role assignment to any of the provided roles.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of RBAC role UUIDs. Returns accounts that have a role assignment to any of the provided roles.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[has_advisor]","description":"Filter accounts by whether they have an assigned adviser. true returns accounts with an adviser, false returns accounts without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter accounts by whether they have an assigned adviser. true returns accounts with an adviser, false returns accounts without.","example":false}},{"in":"query","name":"filter[has_administrator]","description":"Filter accounts by whether they have an assigned administrator. true returns accounts with an administrator, false returns accounts without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter accounts by whether they have an assigned administrator. true returns accounts with an administrator, false returns accounts without.","example":false}},{"in":"query","name":"filter[has_paraplanner]","description":"Filter accounts by whether they have an assigned paraplanner. true returns accounts with a paraplanner, false returns accounts without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter accounts by whether they have an assigned paraplanner. true returns accounts with a paraplanner, false returns accounts without.","example":false}},{"in":"query","name":"filter[next_review_date]","description":"Filter by next review date with an operator.","example":"?filter[next_review_date]=\u003e=2026-01-01 or range ?filter[next_review_date]=\u003e=2026-01-01,\u003c=2026-12-31","required":false,"schema":{"type":"string","description":"Filter by next review date with an operator.","example":"?filter[next_review_date]=\u003e=2026-01-01 or range ?filter[next_review_date]=\u003e=2026-01-01,\u003c=2026-12-31"}},{"in":"query","name":"filter[previous_review_date]","description":"Filter by previous review date with an operator.","example":"?filter[previous_review_date]=\u003e=2025-01-01","required":false,"schema":{"type":"string","description":"Filter by previous review date with an operator.","example":"?filter[previous_review_date]=\u003e=2025-01-01"}},{"in":"query","name":"filter[is_pending_fact_find_account]","description":"Filter accounts that are pending a fact find. Defaults to false.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter accounts that are pending a fact find. Defaults to false.","example":false}},{"in":"query","name":"filter[has_third_party_reference]","description":"Filter accounts that have an external reference with the provided third party.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter accounts that have an external reference with the provided third party.","example":"architecto"}},{"in":"query","name":"filter[business_unit]","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}}}}},"tags":["Account"]},"post":{"summary":"Create an account","operationId":"postApiV1Account","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Account"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Create_Client_Account"},{"$ref":"#/components/schemas/Create_Employee_Account"},{"$ref":"#/components/schemas/Create_Introducer_Account"}]}}}}}},"/api/v1/account/{uuid}":{"get":{"summary":"Get an account","operationId":"getApiV1AccountUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Account"]},"put":{"summary":"Update an account","operationId":"putApiV1AccountUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Account"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Update_Client_Account"},{"$ref":"#/components/schemas/Update_Employee_Account"},{"$ref":"#/components/schemas/Update_Introducer_Account"}]}}}}},"delete":{"summary":"Delete an account","operationId":"deleteApiV1AccountUuid","description":"","parameters":[],"responses":{},"tags":["Account"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/portal/actions":{"get":{"summary":"Get all Actions belonging to an account","operationId":"getApiV2PortalActions","description":"Get all related actions for the referenced account uuid (see header)","parameters":[{"in":"query","name":"filter[completed]","description":"affects whether to include actions which have been completed. Valid options are \"exclude\", \"include\", \"only\". (default: \"exclude\")","example":"architecto","required":false,"schema":{"type":"string","description":"affects whether to include actions which have been completed. Valid options are \"exclude\", \"include\", \"only\". (default: \"exclude\")","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_ActionsResource"}}}}}}}},"tags":["Actions"]}},"/api/v1/addon-subscriptions":{"get":{"summary":"Get all addon subscriptions","operationId":"getApiV1AddonSubscriptions","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[addon_id]","description":"Filter by a comma separated list of addon IDs.","example":"aberdeen,aegon-arc","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of addon IDs.","example":"aberdeen,aegon-arc"}},{"in":"query","name":"per_page","description":"the amount of addon subscriptions per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of addon subscriptions per page (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'created_at'.","example":"-created_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}}}}},"tags":["Addon Subscriptions"]}},"/api/v1/subscribe":{"post":{"summary":"Subscribe to an addon","operationId":"postApiV1Subscribe","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}},"tags":["Addon Subscriptions"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_SubscribeToAddonRequest"}}}}}},"/api/v1/addon-subscriptions/{addonSubscription_uuid}":{"get":{"summary":"Get an addon subscription","operationId":"getApiV1AddonSubscriptionsAddonSubscription_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}},"tags":["Addon Subscriptions"]},"put":{"summary":"Update the configuration on an addon subscription","operationId":"putApiV1AddonSubscriptionsAddonSubscription_uuid","description":"","parameters":[],"responses":{},"tags":["Addon Subscriptions"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_UpdateAddonSubscriptionConfigRequest"}}}}},"parameters":[{"in":"path","name":"addonSubscription_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addon-subscriptions/{addonSubscription_uuid}/unsubscribe":{"delete":{"summary":"Unsubscribe from an addon","operationId":"deleteApiV1AddonSubscriptionsAddonSubscription_uuidUnsubscribe","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}},"tags":["Addon Subscriptions"]},"parameters":[{"in":"path","name":"addonSubscription_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addon-subscriptions/{addonSubscription_uuid}/enable":{"post":{"summary":"Enable an addon","operationId":"postApiV1AddonSubscriptionsAddonSubscription_uuidEnable","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}},"tags":["Addon Subscriptions"]},"parameters":[{"in":"path","name":"addonSubscription_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addon-subscriptions/{addonSubscription_uuid}/disable":{"post":{"summary":"Disable an addon","operationId":"postApiV1AddonSubscriptionsAddonSubscription_uuidDisable","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}},"tags":["Addon Subscriptions"]},"parameters":[{"in":"path","name":"addonSubscription_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addon-subscriptions/{addonSubscription_uuid}/confirm-payment":{"post":{"summary":"Confirm an addon payment","operationId":"postApiV1AddonSubscriptionsAddonSubscription_uuidConfirmPayment","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonSubscriptionResource"}}}}},"tags":["Addon Subscriptions"]},"parameters":[{"in":"path","name":"addonSubscription_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addon":{"get":{"summary":"Get all available addons","operationId":"getApiV1Addon","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[category]","description":"Filter by addon category (accepts both enum value and display name).","example":"adviser_tools or Adviser Tools","required":false,"schema":{"type":"string","description":"Filter by addon category (accepts both enum value and display name).","example":"adviser_tools or Adviser Tools"}},{"in":"query","name":"per_page","description":"the amount of addon subscriptions per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of addon subscriptions per page (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [name]. Negative sign to denote DESC. Defaults to 'name'.","example":"-name","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [name]. Negative sign to denote DESC. Defaults to 'name'.","example":"-name"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_AddonResource"}}}}}}}},"tags":["Addons"]}},"/api/v1/addons/nucleus/sync-clients":{"post":{"summary":"Initiate a sync to pull all clients from Nucleus","operationId":"postApiV1AddonsNucleusSyncClients","description":"The firm must have the Nucleus addon enabled for this to work.","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]}},"/api/v1/addons/nucleus/sync-plans":{"post":{"summary":"Initiate a sync to pull all plans from Nucleus","operationId":"postApiV1AddonsNucleusSyncPlans","description":"The firm must have the Nucleus addon enabled for this to work.","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]}},"/api/v1/addons/seccl/{addon}/sync-clients":{"post":{"summary":"Seccl - Sync all the clients","operationId":"postApiV1AddonsSecclAddonSyncClients","description":"","parameters":[{"in":"query","name":"new_records_only","description":"Only sync new records. Defaults to true.","example":false,"required":false,"schema":{"type":"boolean","description":"Only sync new records. Defaults to true.","example":false}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/sync-plans":{"post":{"summary":"Seccl - Sync all the plans","operationId":"postApiV1AddonsSecclAddonSyncPlans","description":"","parameters":[{"in":"query","name":"new_records_only","description":"Only sync new records. Defaults to true.","example":false,"required":false,"schema":{"type":"boolean","description":"Only sync new records. Defaults to true.","example":false}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/nodes":{"get":{"summary":"Seccl - Get a list of Seccl Nodes for the firm","operationId":"getApiV1AddonsSecclAddonNodes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclNodeResource"}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/associate-node":{"post":{"summary":"Seccl - Store an adviser node association","operationId":"postApiV1AddonsSecclAddonAssociateNode","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LookupResource"}}}}},"tags":["Addons"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_Seccl_StoreAdviserSecclNodeAssociationRequest"}}}}},"parameters":[{"in":"path","name":"addon","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/search-assets":{"get":{"summary":"Seccl - Search assets on Seccl","operationId":"getApiV1AddonsSecclAddonSearchAssets","description":"","parameters":[{"in":"query","name":"search","description":"Name,ID or ISIN of asset to be returned from the platform universe. Use commas to separate terms.","example":"Vanguard","required":true,"schema":{"type":"string","description":"Name,ID or ISIN of asset to be returned from the platform universe. Use commas to separate terms.","example":"Vanguard"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclAssetResource"}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"The addon ID.","example":"soderberg","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/client":{"post":{"summary":"Seccl - Create a new Seccl client and sync them into Plannr","operationId":"postApiV1AddonsSecclAddonClient","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclClientResource"}}}}},"tags":["Addons"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_Seccl_CreateSecclClientRequest"}}}}},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/client/{id}":{"get":{"summary":"Seccl - Get the seccl client associated with the account","operationId":"getApiV1AddonsSecclAddonClientId","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclClientResource"}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"The ID of the client.","example":"VJR","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/client/{account_uuid}":{"patch":{"summary":"Seccl - Update the seccl client","operationId":"patchApiV1AddonsSecclAddonClientAccount_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclClientResource"}}}}},"tags":["Addons"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_Seccl_UpdateSecclClientRequest"}}}}},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/schema-products":{"get":{"summary":"Seccl - List scheme products on Seccl","operationId":"getApiV1AddonsSecclAddonSchemaProducts","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclSchemeProductResource"}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/direct-debit-mandate":{"get":{"summary":"","operationId":"getApiV1AddonsSecclAddonDirectDebitMandate","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]},"post":{"summary":"","operationId":"postApiV1AddonsSecclAddonDirectDebitMandate","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/client/{account_uuid}/products/{clientProductId}/accept":{"post":{"summary":"Seccl - Accept product terms for a client product","operationId":"postApiV1AddonsSecclAddonClientAccount_uuidProductsClientProductIdAccept","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclClientProductResource"}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"clientProductId","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/sync-client/{account_uuid}":{"post":{"summary":"","operationId":"postApiV1AddonsSecclAddonSyncClientAccount_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/sync-plan/{plan_uuid}":{"post":{"summary":"","operationId":"postApiV1AddonsSecclAddonSyncPlanPlan_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}},{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/seccl/{addon}/client-products/{account_uuid}":{"get":{"summary":"Seccl - Get a list of client products for the given account","operationId":"getApiV1AddonsSecclAddonClientProductsAccount_uuid","description":"","parameters":[{"in":"query","name":"wrapper_type","description":"Filter by wrapper type.","example":"ISA","required":false,"schema":{"type":"string","description":"Filter by wrapper type.","example":"ISA"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Addons_SecclClientProductResource"}}}}},"tags":["Addons"]},"parameters":[{"in":"path","name":"addon","description":"","example":"octopus_money","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/smartsearch/ukaml/{client_uuid}/run":{"post":{"summary":"SmartSearch - Run a UKAML Check","operationId":"postApiV1AddonsSmartsearchUkamlClient_uuidRun","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_SmartSearch_RunSmartSearchUKAMLCheckRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/transact/account-opening":{"post":{"summary":"Transact - Account Opening","operationId":"postApiV1AddonsTransactAccountOpening","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_Transact_TransactAccountOpeningRequest"}}}}}},"/api/v1/addons/transact/advisers":{"get":{"summary":"Get list of advisers","operationId":"getApiV1AddonsTransactAdvisers","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Addons"]}},"/api/v1/account/{account_uuid}/address":{"get":{"summary":"Get all account addresses","operationId":"getApiV1AccountAccount_uuidAddress","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, address_1, postcode]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, address_1, postcode]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AddressResource"}}}}}}}},"tags":["Addresses (v1)"]},"post":{"summary":"Create an address","operationId":"postApiV1AccountAccount_uuidAddress","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AddressResource"}}}}},"tags":["Addresses (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Address_StoreAddressRequest"}}}}},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/address/{uuid}":{"get":{"summary":"Get an address","operationId":"getApiV1AccountAccount_uuidAddressUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AddressResource"}}}}},"tags":["Addresses (v1)"]},"put":{"summary":"Update an address","operationId":"putApiV1AccountAccount_uuidAddressUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AddressResource"}}}}},"tags":["Addresses (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Address_UpdateAddressRequest"}}}}},"delete":{"summary":"Delete an address","operationId":"deleteApiV1AccountAccount_uuidAddressUuid","description":"","parameters":[],"responses":{},"tags":["Addresses (v1)"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/addresses":{"get":{"summary":"Get all addresses","operationId":"getApiV2Addresses","description":"This endpoint will return all addresses in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, primary_accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, primary_accounts].","example":"?include=accounts"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, address_1, postcode]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, address_1, postcode]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_AddressResource"}}}}}}}},"tags":["Addresses (v2)"]},"post":{"summary":"Create an address","operationId":"postApiV2Addresses","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_AddressResource"}}}}},"tags":["Addresses (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Addresses_StoreAddressRequest"}}}}}},"/api/v2/addresses/{uuid}":{"get":{"summary":"Get an address","operationId":"getApiV2AddressesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_AddressResource"}}}}},"tags":["Addresses (v2)"]},"put":{"summary":"Update an address","operationId":"putApiV2AddressesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_AddressResource"}}}}},"tags":["Addresses (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Addresses_UpdateAddressRequest"}}}}},"delete":{"summary":"Delete an address","operationId":"deleteApiV2AddressesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Addresses (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/my/audits":{"get":{"summary":"Get all audits made by authenticated employee","operationId":"getApiV1MyAudits","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"the amount of audits per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of audits per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AuditResource"}}}}}}}},"tags":["Audits"]}},"/api/v1/employee/{employee_uuid}/audits":{"get":{"summary":"Get all audits made by an employee","operationId":"getApiV1EmployeeEmployee_uuidAudits","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"the amount of audits per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of audits per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AuditResource"}}}}}}}},"tags":["Audits"]},"parameters":[{"in":"path","name":"employee_uuid","description":"the account uuid who's authored audits you want to get.","example":0,"required":true,"schema":{"type":"integer"}}]},"/api/v1/audits":{"get":{"summary":"Get all audits for the firm","operationId":"getApiV1Audits","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"the amount of audits per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of audits per page (Default 15. Max 500).","example":50}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AuditResource"}}}}}}}},"tags":["Audits"]}},"/api/v1/audits/{model}/{modelUuid}":{"get":{"summary":"Get all audits attached to a model","operationId":"getApiV1AuditsModelModelUuid","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"the amount of audits per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of audits per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AuditResource"}}}}}}}},"tags":["Audits"]},"parameters":[{"in":"path","name":"model","description":"the model type, valid types are ['firm','account','group','case','board_task','plan','bank_statement','bank_transaction','provider_statement','statement_transaction','expectation','statement']","example":"group","required":true,"schema":{"type":"string"}},{"in":"path","name":"modelUuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blocks":{"get":{"summary":"Get all Automation block information that can be used for blueprint steps","operationId":"getApiV1AutomationBlocks","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationBlockResource"}}}}}}}},"tags":["Automation Blocks"]}},"/api/v1/automation-blocks/triggers":{"get":{"summary":"Get all trigger types for automation blocks","operationId":"getApiV1AutomationBlocksTriggers","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationTriggerResource"}}}}}}}},"tags":["Automation Blocks"]}},"/api/v1/webhooks/{webhookTarget_uuid}":{"post":{"summary":"Trigger automations through webhook","operationId":"postApiV1WebhooksWebhookTarget_uuid","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Automation Blueprints"]},"parameters":[{"in":"path","name":"webhookTarget_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blueprints":{"get":{"summary":"Get all Automation Blueprints","operationId":"getApiV1AutomationBlueprints","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [account,steps,webhook_targets].","example":"?include=account,steps","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [account,steps,webhook_targets].","example":"?include=account,steps"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[is_active]","description":"Filter automation blueprints by which are active or not.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter automation blueprints by which are active or not.","example":false}},{"in":"query","name":"filter[trigger]","description":"Filter automation blueprints by a certain trigger type.","example":"client.created","required":false,"schema":{"type":"string","description":"Filter automation blueprints by a certain trigger type.","example":"client.created"}},{"in":"query","name":"filter[name]","description":"Filter automation blueprints by a partial match to the blueprint name.","example":"Client","required":false,"schema":{"type":"string","description":"Filter automation blueprints by a partial match to the blueprint name.","example":"Client"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationBlueprintResource"}}}}}}}},"tags":["Automation Blueprints"]},"post":{"summary":"Create an Automation Blueprint","operationId":"postApiV1AutomationBlueprints","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationBlueprintResource"}}}}},"tags":["Automation Blueprints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Automation_StoreAutomationBlueprintRequest"}}}}}},"/api/v1/automation-blueprints/{automationBlueprint_uuid}":{"get":{"summary":"Get a Automation Blueprint","operationId":"getApiV1AutomationBlueprintsAutomationBlueprint_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationBlueprintResource"}}}}},"tags":["Automation Blueprints"]},"put":{"summary":"Update a Automation Blueprint","operationId":"putApiV1AutomationBlueprintsAutomationBlueprint_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationBlueprintResource"}}}}},"tags":["Automation Blueprints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Automation_UpdateAutomationBlueprintRequest"}}}}},"delete":{"summary":"Delete an Automation Blueprint","operationId":"deleteApiV1AutomationBlueprintsAutomationBlueprint_uuid","description":"","parameters":[],"responses":{},"tags":["Automation Blueprints"]},"parameters":[{"in":"path","name":"automationBlueprint_uuid","description":"The UUID of the automation","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blueprints/{automationBlueprint_uuid}/trigger":{"post":{"summary":"Trigger and start running an automation","operationId":"postApiV1AutomationBlueprintsAutomationBlueprint_uuidTrigger","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Automation Blueprints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Automation_TriggerAutomationRequest"}}}}},"parameters":[{"in":"path","name":"automationBlueprint_uuid","description":"The UUID of the automation","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blueprints/{automationBlueprint_uuid}/webhook-targets":{"post":{"summary":"Attach a webhook target to an automation blueprint","operationId":"postApiV1AutomationBlueprintsAutomationBlueprint_uuidWebhookTargets","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_WebhookTargetResource"}}}}},"tags":["Automation Blueprints"]},"parameters":[{"in":"path","name":"automationBlueprint_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blueprints/{automationBlueprint_uuid}/executions":{"get":{"summary":"Get all executions for a single automation blueprint","operationId":"getApiV1AutomationBlueprintsAutomationBlueprint_uuidExecutions","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at ]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at ]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationExecutionResource"}}}}}}}},"tags":["Automation Blueprints"]},"parameters":[{"in":"path","name":"automationBlueprint_uuid","description":"The UUID of the automation","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-step/{automationStep_uuid}/stop":{"post":{"summary":"Stop an automation step","operationId":"postApiV1AutomationStepAutomationStep_uuidStop","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Automation Execution Steps"]},"parameters":[{"in":"path","name":"automationStep_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-step/{automationStep_uuid}/start":{"post":{"summary":"Start an automation step","operationId":"postApiV1AutomationStepAutomationStep_uuidStart","description":"You may only start a step that has previously been stopped","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Automation Execution Steps"]},"parameters":[{"in":"path","name":"automationStep_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-executions":{"get":{"summary":"Get all automation executions for an automation blueprint","operationId":"getApiV1AutomationExecutions","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of client UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"include","description":"Include relationships. Valid values are [account].","example":"account","required":false,"schema":{"type":"string","description":"Include relationships. Valid values are [account].","example":"account"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at ]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at ]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationExecutionResource"}}}}}}}},"tags":["Automation Executions"]}},"/api/v1/automation-executions/{uuid}":{"get":{"summary":"Get an automation execution","operationId":"getApiV1AutomationExecutionsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_AutomationExecutionResource"}}}}},"tags":["Automation Executions"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/bank-accounts":{"get":{"summary":"Get all bank accounts","operationId":"getApiV2BankAccounts","description":"This endpoint will return all bank accounts in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_name]","description":"Filter by name.","example":"My Savings Account","required":false,"schema":{"type":"string","description":"Filter by name.","example":"My Savings Account"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, account_name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, account_name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_BankAccountResource"}}}}}}}},"tags":["Bank Accounts"]},"post":{"summary":"Create a bank account","operationId":"postApiV2BankAccounts","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_BankAccountResource"}}}}},"tags":["Bank Accounts"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_BankAccount_StoreBankAccountRequest"}}}}}},"/api/v2/bank-accounts/{uuid}":{"get":{"summary":"Get a bank account","operationId":"getApiV2BankAccountsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_BankAccountResource"}}}}},"tags":["Bank Accounts"]},"put":{"summary":"Update a bank account","operationId":"putApiV2BankAccountsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_BankAccountResource"}}}}},"tags":["Bank Accounts"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_BankAccount_UpdateBankAccountRequest"}}}}},"delete":{"summary":"Delete a bank account","operationId":"deleteApiV2BankAccountsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Bank Accounts"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/beneficiary":{"get":{"summary":"Get all beneficiaries of a plan","operationId":"getApiV1PlansPlan_uuidBeneficiary","description":"","parameters":[{"in":"query","name":"filter[created_after]","description":"Date to filter when the beneficiary was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the beneficiary was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the beneficiary was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the beneficiary was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[updated_after]","description":"Date to filter when the beneficiary was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the beneficiary was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[updated_before]","description":"Date to filter when the beneficiary was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the beneficiary was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[name]","description":"Name to filter who the beneficiary is.","example":"John Smith","required":false,"schema":{"type":"string","description":"Name to filter who the beneficiary is.","example":"John Smith"}},{"in":"query","name":"filter[percentage]","description":"Percentage to filter the nominee percentage where 1 is equal to 100%.","example":54.32,"required":false,"schema":{"type":"number","description":"Percentage to filter the nominee percentage where 1 is equal to 100%.","example":54.32}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, percentage]. Negative sign to denote DESC.  Defaults to 'name'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, percentage]. Negative sign to denote DESC.  Defaults to 'name'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_BeneficiaryResource"}}}}}}}},"tags":["Beneficiary"]},"post":{"summary":"Create beneficiary for a plan","operationId":"postApiV1PlansPlan_uuidBeneficiary","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_BeneficiaryResource"}}}}},"tags":["Beneficiary"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreBeneficiaryRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/beneficiary/{uuid}":{"get":{"summary":"Get a beneficiary of a plan","operationId":"getApiV1PlansPlan_uuidBeneficiaryUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_BeneficiaryResource"}}}}},"tags":["Beneficiary"]},"put":{"summary":"Update a beneficiary of a plan","operationId":"putApiV1PlansPlan_uuidBeneficiaryUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_BeneficiaryResource"}}}}},"tags":["Beneficiary"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateBeneficiaryRequest"}}}}},"delete":{"summary":"Delete beneficiary of a plan","operationId":"deleteApiV1PlansPlan_uuidBeneficiaryUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Beneficiary"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps":{"get":{"summary":"Get all Blueprint Steps on an automation blueprint","operationId":"getApiV1AutomationBlueprintsAutomationBlueprint_uuidBlueprintSteps","description":"","parameters":[{"in":"query","name":"include","description":"included relations","example":"parent","required":false,"schema":{"type":"string","description":"included relations","example":"parent"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"the amount of audits per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of audits per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_BlueprintStepResource"}}}}}}}},"tags":["Blueprint Steps"]},"post":{"summary":"Create a Blueprint Step","operationId":"postApiV1AutomationBlueprintsAutomationBlueprint_uuidBlueprintSteps","description":"","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_BlueprintStepResource"}}}}}}}},"tags":["Blueprint Steps"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Automation_StoreBlueprintStepRequest"}}}}},"parameters":[{"in":"path","name":"automationBlueprint_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}":{"get":{"summary":"Get a Blueprint Step","operationId":"getApiV1AutomationBlueprintsAutomationBlueprint_uuidBlueprintStepsBlueprintStep_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_BlueprintStepResource"}}}}}}}},"tags":["Blueprint Steps"]},"put":{"summary":"Update a Blueprint Step (this also moves the step if a new parent is specified)","operationId":"putApiV1AutomationBlueprintsAutomationBlueprint_uuidBlueprintStepsBlueprintStep_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_BlueprintStepResource"}}}}}}}},"tags":["Blueprint Steps"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Automation_UpdateBlueprintStepRequest"}}}}},"delete":{"summary":"Delete a Blueprint Step","operationId":"deleteApiV1AutomationBlueprintsAutomationBlueprint_uuidBlueprintStepsBlueprintStep_uuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Automation_BlueprintStepResource"}}}}},"tags":["Blueprint Steps"]},"parameters":[{"in":"path","name":"automationBlueprint_uuid","description":"The UUID of the automation blueprint.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}},{"in":"path","name":"blueprintStep_uuid","description":"The UUID of the blueprint step.","example":"aaf0-495f-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/bulk-actions":{"get":{"summary":"Get all bulk actions on the firm","operationId":"getApiV1BulkActions","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter bulk actions with specific UUIDs","example":"architecto","required":false,"schema":{"type":"string","description":"Filter bulk actions with specific UUIDs","example":"architecto"}},{"in":"query","name":"filter[name]","description":"Filter bulk actions by name.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter bulk actions by name.","example":"architecto"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BulkActionResource"}}}}}}}},"tags":["Bulk Actions"]}},"/api/v1/bulk-actions/{uuid}":{"get":{"summary":"Show a bulk action.","operationId":"getApiV1BulkActionsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BulkActionResource"}}}}},"tags":["Bulk Actions"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/bulk-actions/execute":{"post":{"summary":"Execute a bulk action","operationId":"postApiV1BulkActionsExecute","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Bulk Actions"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_ExecuteBulkActionRequest"}}}}}},"/api/v1/metrics/aum":{"get":{"summary":"Assets Under Management","operationId":"getApiV1MetricsAum","description":"Get a breakdown of the Assets Under Management for a firm.","parameters":[{"in":"query","name":"filter[agency_in_your_name]","description":"Filter the AUM to only include plans that are in the firm's name. False = all, true = only plans with agency in your name","example":true,"required":false,"schema":{"type":"boolean","description":"Filter the AUM to only include plans that are in the firm's name. False = all, true = only plans with agency in your name","example":true}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The Assets Under Management calculations for a firm on the current date or the date submitted.\u003cbr\u003e\n\u003cstrong\u003e`data.total`\u003c/strong\u003e: Total of all investment, pension, cash plans.\u003cbr\u003e\n\u003cbr\u003e\n\u003cstrong\u003e`abstract_types`\u003c/strong\u003e\u003cbr\u003e\n\u003cstrong\u003e`data.abstract_types.assets`\u003c/strong\u003e: Total of all assets.\u003cbr\u003e\n\u003cstrong\u003e`data.abstract_types.liabilities`\u003c/strong\u003e: Total of all liabilities.\u003cbr\u003e\n\u003cstrong\u003e`data.abstract_types.protection`\u003c/strong\u003e: Total of all protection.\u003cbr\u003e\n\u003cbr\u003e\n\u003cstrong\u003e`plan_types`\u003c/strong\u003e\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.annuity`\u003c/strong\u003e: Total of all annuities.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.cash_account`\u003c/strong\u003e: Total of all cash plans.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.fixed_asset`\u003c/strong\u003e: Total of all fixed asset plans.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.general_insurance`\u003c/strong\u003e: Total of all fixed general insurance assets.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.group_protection`\u003c/strong\u003e: Total of all fixed group protection assets.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.investment`\u003c/strong\u003e: Total of all investment plans.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.loan_credit`\u003c/strong\u003e: Total of all loan credit plans.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.mortgage`\u003c/strong\u003e: Total of all mortgage plans.\u003cbr\u003e\n\u003cstrong\u003e`data.plan_types.pension`\u003c/strong\u003e: Total of all pension plans.\u003cbr\u003e\n\u003cstrong\u003e`data.protection_policy.pension`\u003c/strong\u003e: Total of all protection policy plans.\u003cbr\u003e\n","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_AumMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/cases":{"get":{"summary":"Cases","operationId":"getApiV1MetricsCases","description":"Get the total number of cases for a firm on the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/cases/completed":{"get":{"summary":"Cases Completed","operationId":"getApiV1MetricsCasesCompleted","description":"Get the total number of completed cases for a firm on the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/clients":{"get":{"summary":"Clients","operationId":"getApiV1MetricsClients","description":"Get the total number of clients for a firm on the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/conversations":{"get":{"summary":"Conversations","operationId":"getApiV1MetricsConversations","description":"Get the total number of conversations for a firm on the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/documents/generated":{"get":{"summary":"Documents Generated","operationId":"getApiV1MetricsDocumentsGenerated","description":"Get the total number of documents generated for a firm on the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/fact-finds/sent":{"get":{"summary":"Fact Finds Sent","operationId":"getApiV1MetricsFactFindsSent","description":"Get the total number of fact-finds sent cases for a firm on the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/files/uploaded":{"get":{"summary":"Files Uploaded","operationId":"getApiV1MetricsFilesUploaded","description":"Get the total number of files uploaded for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/introducers":{"get":{"summary":"Introducers","operationId":"getApiV1MetricsIntroducers","description":"Get the total number of introducers for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/messages/sent":{"get":{"summary":"Messages Sent","operationId":"getApiV1MetricsMessagesSent","description":"Get the total number of messages sent for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/plans":{"get":{"summary":"Plans","operationId":"getApiV1MetricsPlans","description":"Get the total number of plans for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/signatures":{"get":{"summary":"Signatures","operationId":"getApiV1MetricsSignatures","description":"Get the total number of signatures for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/tasks":{"get":{"summary":"Tasks","operationId":"getApiV1MetricsTasks","description":"Get the total number of tasks for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/tasks/completed":{"get":{"summary":"Tasks Completed","operationId":"getApiV1MetricsTasksCompleted","description":"Get the total number of tasks completed for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/metrics/time-logged":{"get":{"summary":"Time Logged","operationId":"getApiV1MetricsTimeLogged","description":"Get the total amount of time-logged for a firm for the current date or the end of the date supplied.","parameters":[{"in":"query","name":"date","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04","required":false,"schema":{"type":"string","description":"The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).","example":"2023-07-04"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"The value of the key metric.","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Metrics_KeyMetricResource"}}}}}}}},"tags":["Business Metrics"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_KeyMetricsRequest"}}}}}},"/api/v1/business-units":{"get":{"summary":"List business units","operationId":"getApiV1BusinessUnits","description":"","parameters":[{"in":"query","name":"filter[name]","description":"Name to filter by.","example":"Wealth","required":false,"schema":{"type":"string","description":"Name to filter by.","example":"Wealth"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BusinessUnitResource"}}}}}}}},"tags":["Business Units"]},"post":{"summary":"Create a business unit","operationId":"postApiV1BusinessUnits","description":"","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BusinessUnitResource"}}}}},"tags":["Business Units"]}},"/api/v1/business-units/{uuid}":{"get":{"summary":"Get a business unit","operationId":"getApiV1BusinessUnitsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BusinessUnitResource"}}}}},"tags":["Business Units"]},"put":{"summary":"Update a business unit","operationId":"putApiV1BusinessUnitsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BusinessUnitResource"}}}}},"tags":["Business Units"]},"delete":{"summary":"Delete a business unit","operationId":"deleteApiV1BusinessUnitsUuid","description":"","parameters":[],"responses":{},"tags":["Business Units"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/business-units/{business_unit_uuid}/branding":{"get":{"summary":"Get business unit branding settings","operationId":"getApiV1BusinessUnitsBusiness_unit_uuidBranding","description":"Returns all branding settings for the given business unit.","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Business Units"]},"put":{"summary":"Update business unit branding settings","operationId":"putApiV1BusinessUnitsBusiness_unit_uuidBranding","description":"Update branding settings for a business unit. Scalar settings (colours, booleans, HTML)\nare sent as a settings array. File fields (logos, backgrounds) are sent as file uploads.","parameters":[],"responses":{},"tags":["Business Units"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_BusinessUnit_UpdateBusinessUnitBrandingRequest"}}}}},"parameters":[{"in":"path","name":"business_unit_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/business-units/{business_unit_uuid}/members/{action}":{"post":{"summary":"Add or remove members from a business unit","operationId":"postApiV1BusinessUnitsBusiness_unit_uuidMembersAction","description":"Bulk add or remove account members from a business unit. When adding, accounts already\nassigned to a different business unit are reassigned to this one.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"successful":["uuid-1","uuid-2"],"failed":[]},"properties":{"successful":{"type":"array","example":["uuid-1","uuid-2"],"items":{"type":"string"}},"failed":{"type":"array","example":[]}}}}}}},"tags":["Business Units"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_BusinessUnit_ManageBusinessUnitMembersRequest"}}}}},"parameters":[{"in":"path","name":"business_unit_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","description":"The action to perform. Allowed: add, remove.","example":"add","required":true,"schema":{"type":"string"}},{"in":"path","name":"business_unit","description":"The UUID of the business unit.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/business-units/{business_unit_uuid}/members":{"get":{"summary":"List business unit members","operationId":"getApiV1BusinessUnitsBusiness_unit_uuidMembers","description":"Returns the accounts that belong to the given business unit, using the standard account index filters.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, assigned_administrator, groups, tags, owners, external_references].","example":"?include=groups,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, assigned_administrator, groups, tags, owners, external_references].","example":"?include=groups,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter clients by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter clients by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[email]","description":"Filter clients that have an email with a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter clients that have an email with a partial match.","example":"architecto"}},{"in":"query","name":"filter[is_prospect]","description":"Get clients with this is_prospect value","example":false,"required":false,"schema":{"type":"boolean","description":"Get clients with this is_prospect value","example":false}},{"in":"query","name":"filter[status]","description":"Filter client status by partial names or uuid's","example":"active,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Filter client status by partial names or uuid's","example":"active,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[type]","description":"Comma separated string to filter by different client types.  Valid types are [individual, joint, trust, business].","example":"?filter[type]=individual,joint","required":false,"schema":{"type":"string","description":"Comma separated string to filter by different client types.  Valid types are [individual, joint, trust, business].","example":"?filter[type]=individual,joint"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the client was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the client was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the client was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the client was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a client custom field. Example filter[custom_field:pet_name]='Doug'","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a client custom field. Example filter[custom_field:pet_name]='Doug'","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[groups]","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[exclude_groups]","description":"Provide a group UUID (or multiple as a comma-separated string) to filter clients within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Provide a group UUID (or multiple as a comma-separated string) to filter clients within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[introduced_by]","description":"Filter clients that have been introduced by this account.","example":"e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Filter clients that have been introduced by this account.","example":"e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[linked_to]","description":"Filter to clients that have been linked to the account given. This will also return the requested account.","example":"df240fd1-784d-47e8-8874-f779a35847ca","required":false,"schema":{"type":"string","description":"Filter to clients that have been linked to the account given. This will also return the requested account.","example":"df240fd1-784d-47e8-8874-f779a35847ca"}},{"in":"query","name":"filter[has_advisor]","description":"Filter clients by whether they have an assigned adviser. true returns clients with an adviser, false returns clients without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter clients by whether they have an assigned adviser. true returns clients with an adviser, false returns clients without.","example":false}},{"in":"query","name":"filter[has_administrator]","description":"Filter clients by whether they have an assigned administrator. true returns clients with an administrator, false returns clients without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter clients by whether they have an assigned administrator. true returns clients with an administrator, false returns clients without.","example":false}},{"in":"query","name":"filter[has_paraplanner]","description":"Filter clients by whether they have an assigned paraplanner. true returns clients with a paraplanner, false returns clients without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter clients by whether they have an assigned paraplanner. true returns clients with a paraplanner, false returns clients without.","example":false}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}}}}},"tags":["Business Units"]},"parameters":[{"in":"path","name":"business_unit_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/cases":{"get":{"summary":"Get all client cases","operationId":"getApiV1ClientClient_uuidCases","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields, groups, assigned_to].","example":"participants,participants_count,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields, groups, assigned_to].","example":"participants,participants_count,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[completed]","description":"Filter cases by which have been completed","example":false,"required":false,"schema":{"type":"boolean","description":"Filter cases by which have been completed","example":false}},{"in":"query","name":"filter[in_progress]","description":"Filter cases by which are still in progress","example":false,"required":false,"schema":{"type":"boolean","description":"Filter cases by which are still in progress","example":false}},{"in":"query","name":"filter[type]","description":"Comma separated list of case type UUIDs. Example fc4e2fad-d4f1-5c56-a869-60edc441ae16,add547bc-6097-5339-aaba-cbea59e79ee1","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of case type UUIDs. Example fc4e2fad-d4f1-5c56-a869-60edc441ae16,add547bc-6097-5339-aaba-cbea59e79ee1","example":"architecto"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated string of tags to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of tags to filter by","example":"architecto"}},{"in":"query","name":"filter[plan_uuid]","description":"Comma separated string of plan UUIDs to filter by.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated string of plan UUIDs to filter by.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[group_uuids]","description":"Comma separated string of group UUIDs to filter by.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated string of group UUIDs to filter by.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated string of account UUIDs to filter by.","example":"801c9fe8-2b6e-58d4-a5c9-ca5cfe153455,4f0be96e-060d-55f0-8f86-2ece27ef2315","required":false,"schema":{"type":"string","description":"Comma separated string of account UUIDs to filter by.","example":"801c9fe8-2b6e-58d4-a5c9-ca5cfe153455,4f0be96e-060d-55f0-8f86-2ece27ef2315"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1","required":false,"schema":{"type":"string","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1"}},{"in":"query","name":"filter[employee_account_uuids]","description":"Comma separated string of employee accounts UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1","required":false,"schema":{"type":"string","description":"Comma separated string of employee accounts UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1"}},{"in":"query","name":"filter[completed_after]","description":"Filter cases which have a completed at date after.","example":"2025-01-25","required":false,"schema":{"type":"string","description":"Filter cases which have a completed at date after.","example":"2025-01-25"}},{"in":"query","name":"filter[completed_before]","description":"Filter cases which have a completed at date before.","example":"2025-08-06","required":false,"schema":{"type":"string","description":"Filter cases which have a completed at date before.","example":"2025-08-06"}},{"in":"query","name":"filter[review_at_after]","description":"Filter cases which have a review at date after.","example":"2025-01-02","required":false,"schema":{"type":"string","description":"Filter cases which have a review at date after.","example":"2025-01-02"}},{"in":"query","name":"filter[review_at_before]","description":"Filter cases which have a review at date before.","example":"2025-06-08","required":false,"schema":{"type":"string","description":"Filter cases which have a review at date before.","example":"2025-06-08"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at, review_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at, review_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesResource"}}}}}}}},"tags":["Cases"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/cases":{"get":{"summary":"Get all cases","operationId":"getApiV1Cases","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields,groups,assigned_to].","example":"participants,participants_count,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields,groups,assigned_to].","example":"participants,participants_count,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[completed]","description":"Filter cases by which have been completed","example":false,"required":false,"schema":{"type":"boolean","description":"Filter cases by which have been completed","example":false}},{"in":"query","name":"filter[in_progress]","description":"Filter cases by which are still in progress","example":false,"required":false,"schema":{"type":"boolean","description":"Filter cases by which are still in progress","example":false}},{"in":"query","name":"filter[type]","description":"Comma separated list of case type UUIDs. Example fc4e2fad-d4f1-5c56-a869-60edc441ae16,add547bc-6097-5339-aaba-cbea59e79ee1","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of case type UUIDs. Example fc4e2fad-d4f1-5c56-a869-60edc441ae16,add547bc-6097-5339-aaba-cbea59e79ee1","example":"architecto"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated string of tags to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of tags to filter by","example":"architecto"}},{"in":"query","name":"filter[plan_uuid]","description":"Comma separated string of plan UUIDs to filter by.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated string of plan UUIDs to filter by.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated string of account UUIDs to filter by.","example":"801c9fe8-2b6e-58d4-a5c9-ca5cfe153455,4f0be96e-060d-55f0-8f86-2ece27ef2315","required":false,"schema":{"type":"string","description":"Comma separated string of account UUIDs to filter by.","example":"801c9fe8-2b6e-58d4-a5c9-ca5cfe153455,4f0be96e-060d-55f0-8f86-2ece27ef2315"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1","required":false,"schema":{"type":"string","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1"}},{"in":"query","name":"filter[employee_account_uuids]","description":"Comma separated string of employee accounts UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1","required":false,"schema":{"type":"string","description":"Comma separated string of employee accounts UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1"}},{"in":"query","name":"filter[completed_after]","description":"Filter cases which have a completed at date after.","example":"2025-01-25","required":false,"schema":{"type":"string","description":"Filter cases which have a completed at date after.","example":"2025-01-25"}},{"in":"query","name":"filter[completed_before]","description":"Filter cases which have a completed at date before.","example":"2025-08-06","required":false,"schema":{"type":"string","description":"Filter cases which have a completed at date before.","example":"2025-08-06"}},{"in":"query","name":"filter[review_at_after]","description":"Filter cases which have a review at date after.","example":"2025-01-02","required":false,"schema":{"type":"string","description":"Filter cases which have a review at date after.","example":"2025-01-02"}},{"in":"query","name":"filter[review_at_before]","description":"Filter cases which have a review at date before.","example":"2025-06-08","required":false,"schema":{"type":"string","description":"Filter cases which have a review at date before.","example":"2025-06-08"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at, review_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at, review_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesResource"}}}}}}}},"tags":["Cases"]},"post":{"summary":"Create a case","operationId":"postApiV1Cases","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesResource"}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Cases_StoreCasesRequest"}}}}}},"/api/v1/cases/{uuid}":{"get":{"summary":"Get a case","operationId":"getApiV1CasesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesResource"}}}}},"tags":["Cases"]},"put":{"summary":"Update a case","operationId":"putApiV1CasesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesResource"}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Cases_UpdateCasesRequest"}}}}},"delete":{"summary":"Delete a case","operationId":"deleteApiV1CasesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Cases"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/cases/{case_uuid}/participants":{"post":{"summary":"Add clients to a case","operationId":"postApiV1CasesCase_uuidParticipants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Cases_AddAccountsToCasesRequest"}}}}},"delete":{"summary":"Remove clients from a case","operationId":"deleteApiV1CasesCase_uuidParticipants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Cases_RemoveAccountsFromCasesRequest"}}}}},"parameters":[{"in":"path","name":"case_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/cases-status":{"get":{"summary":"Get all case statuses","operationId":"getApiV1CasesStatus","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesStatusResource"}}}}}}}},"tags":["Cases"]},"post":{"summary":"Create a case status","operationId":"postApiV1CasesStatus","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesStatusResource"}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_CasesStatus_StoreCaseStatusRequest"}}}}}},"/api/v1/cases-status/{uuid}":{"put":{"summary":"Update a case status","operationId":"putApiV1CasesStatusUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesStatusResource"}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_CasesStatus_UpdateCaseStatusRequest"}}}}},"delete":{"summary":"Delete a case status","operationId":"deleteApiV1CasesStatusUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesStatusResource"}}}}},"tags":["Cases"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/cases-type":{"get":{"summary":"Get all case types","operationId":"getApiV1CasesType","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [name, created_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [name, created_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesTypeResource"}}}}}}}},"tags":["Cases"]},"post":{"summary":"Create a case type","operationId":"postApiV1CasesType","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesTypeResource"}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_CasesType_StoreCasesTypeRequest"}}}}}},"/api/v1/cases-type/{uuid}":{"get":{"summary":"Get a case type","operationId":"getApiV1CasesTypeUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesTypeResource"}}}}},"tags":["Cases"]},"put":{"summary":"Update a case type","operationId":"putApiV1CasesTypeUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CasesTypeResource"}}}}},"tags":["Cases"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_CasesType_UpdateCasesTypeRequest"}}}}},"delete":{"summary":"Delete a case type","operationId":"deleteApiV1CasesTypeUuid","description":"","parameters":[],"responses":{},"tags":["Cases"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/circles/{circle_uuid}/expenditures":{"get":{"summary":"Get all expenditures for a circle","operationId":"getApiV2CirclesCircle_uuidExpenditures","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"architecto"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circle Expenditures"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"circle","description":"The uuid of the circle.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}}]},"/api/v2/circles/{circle_uuid}/expenditures/{expenditure_uuid}":{"get":{"summary":"Show an individual circle expenditure","operationId":"getApiV2CirclesCircle_uuidExpendituresExpenditure_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circle Expenditures"]},"delete":{"summary":"Delete a circle expenditure","operationId":"deleteApiV2CirclesCircle_uuidExpendituresExpenditure_uuid","description":"","parameters":[],"responses":{},"tags":["Circle Expenditures"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"circle","description":"The uuid of the circle.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure","description":"The uuid of the expenditure.","example":"dc329ca6-bf88-43ad-a398-b2507569c941","required":true,"schema":{"type":"string"}}]},"/api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/{lifeStageField_uuid}":{"post":{"summary":"Create or update a circle expenditure linked to a life stage field","operationId":"postApiV2CirclesCircle_uuidExpendituresLifeStage_uuidLifeStageField_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circle Expenditures"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStageField_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"circle","description":"The uuid of the circle.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage","description":"The uuid of the parent Life Stage.","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStageField","description":"The uuid of the parent Life Stage Field.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom":{"post":{"summary":"Create a custom circle expenditure","operationId":"postApiV2CirclesCircle_uuidExpendituresLifeStage_uuidCustom","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circle Expenditures"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"circle","description":"The uuid of the circle.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage","description":"The uuid of the parent Life Stage.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom/{expenditure_uuid}":{"post":{"summary":"Update a custom circle expenditure","operationId":"postApiV2CirclesCircle_uuidExpendituresLifeStage_uuidCustomExpenditure_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circle Expenditures"]},"delete":{"summary":"Delete a custom circle expenditure","operationId":"deleteApiV2CirclesCircle_uuidExpendituresLifeStage_uuidCustomExpenditure_uuid","description":"","parameters":[],"responses":{},"tags":["Circle Expenditures"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"circle","description":"The uuid of the circle.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage","description":"The uuid of the parent Life Stage.","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure","description":"The uuid of the expenditure.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/circles":{"get":{"summary":"Get all circles","operationId":"getApiV1Circles","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"e3431c41-1d43-5b81-be0a-ca5a3ec76191,4c99e2cf-362a-59b2-96a8-12358b92b8bd","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"e3431c41-1d43-5b81-be0a-ca5a3ec76191,4c99e2cf-362a-59b2-96a8-12358b92b8bd"}},{"in":"query","name":"filter[group_uuids]","description":"Filter by a comma separated list of group UUIDs.","example":"20c2b2d3-1e46-5518-9f2d-7a8fddabfe68,75bd59d3-8d6c-59f7-9dcc-949f267616e8","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of group UUIDs.","example":"20c2b2d3-1e46-5518-9f2d-7a8fddabfe68,75bd59d3-8d6c-59f7-9dcc-949f267616e8"}},{"in":"query","name":"filter[name]","description":"Filter by the circle name.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by the circle name.","example":"architecto"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts,firm,groups]","example":"?include=accounts,firm","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts,firm,groups]","example":"?include=accounts,firm"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-name","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-name"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CircleResource"}}}}}}}},"tags":["Circles"]},"post":{"summary":"Create a circle","operationId":"postApiV1Circles","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CircleResource"}}}}},"tags":["Circles"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Circle_StoreCircleRequest"}}}}}},"/api/v1/circles/{uuid}":{"get":{"summary":"Get a circle","operationId":"getApiV1CirclesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CircleResource"}}}}},"tags":["Circles"]},"put":{"summary":"Update a circle","operationId":"putApiV1CirclesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CircleResource"}}}}},"tags":["Circles"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Circle_UpdateCircleRequest"}}}}},"delete":{"summary":"Delete a circle","operationId":"deleteApiV1CirclesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/emails":{"get":{"summary":"Get all emails for a circle","operationId":"getApiV1CirclesCircle_uuidEmails","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/notes":{"get":{"summary":"Get all notes for a circle","operationId":"getApiV1CirclesCircle_uuidNotes","description":"Includes notes for a circle or within that circle's client's plans, cases, tasks and risks.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts].","example":"?include=mentionedAccounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts].","example":"?include=mentionedAccounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Note type to filter by.  Valid types are [call, note, meeting, email]","example":"architecto","required":false,"schema":{"type":"string","description":"Note type to filter by.  Valid types are [call, note, meeting, email]","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Note created_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"Note created_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"Note created_at date to filter to from a specific date, can be used with date_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"Note created_at date to filter to from a specific date, can be used with date_from for a range.","example":"architecto"}},{"in":"query","name":"filter[contents]","description":"Filter notes by a string to see if it's contents contains that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if it's contents contains that string.","example":"architecto"}},{"in":"query","name":"filter[path]","description":"Filter notes by a string to see if the path contains that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if the path contains that string.","example":"architecto"}},{"in":"query","name":"filter[path_exact]","description":"Filter notes by a string to see if the path is that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if the path is that string.","example":"architecto"}},{"in":"query","name":"filter[notable_type]","description":"Filter notes by a specific notable model. Valid types are: client, plan, case, task, risk.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a specific notable model. Valid types are: client, plan, case, task, risk.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NoteResource"}}}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/charge-splits":{"get":{"summary":"Get circle charge splits","operationId":"getApiV1CirclesCircle_uuidChargeSplits","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitResource"}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/accounts":{"get":{"summary":"Get all Accounts for the Circle","operationId":"getApiV1CirclesCircle_uuidAccounts","description":"Gets a list of accounts for the circle with related data","parameters":[{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, email]. Negative sign to denote DESC.  Defaults to 'name'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, email]. Negative sign to denote DESC.  Defaults to 'name'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Circles_CircleAccountsResource"}}}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/form-submissions":{"get":{"summary":"Get all form submissions for accounts in a circle","operationId":"getApiV1CirclesCircle_uuidFormSubmissions","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [account]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [account]","example":"architecto"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[stage]","description":"Filter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.","example":"architecto"}},{"in":"query","name":"filter[account]","description":"Name of the account of who the submission was against.","example":"architecto","required":false,"schema":{"type":"string","description":"Name of the account of who the submission was against.","example":"architecto"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of accounts UUIDs of who the form was submitted against.","example":"940f9fe8-14cf-5674-bfe0-0554c8fa94bf,6d762f53-bfe8-5f84-b8b3-90d7beb01afe","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs of who the form was submitted against.","example":"940f9fe8-14cf-5674-bfe0-0554c8fa94bf,6d762f53-bfe8-5f84-b8b3-90d7beb01afe"}},{"in":"query","name":"filter[submitted_by_uuid]","description":"Filter by a comma separated list of account UUIDs of who submitted the form.","example":"a815517f-103d-5e31-bd09-fca00ed1d191,89bee829-900a-50e5-adca-635677137933","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs of who submitted the form.","example":"a815517f-103d-5e31-bd09-fca00ed1d191,89bee829-900a-50e5-adca-635677137933"}},{"in":"query","name":"filter[form_uuids]","description":"Filter by a comma separated list of UUIDs of the form the submission was against.","example":"6c7294bc-c782-553f-b661-cc2e1bc06a0c,6207bd5b-9053-5aaf-bfef-14dec5d5c017","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs of the form the submission was against.","example":"6c7294bc-c782-553f-b661-cc2e1bc06a0c,6207bd5b-9053-5aaf-bfef-14dec5d5c017"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionResource"}}}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/linked-clients":{"get":{"summary":"Get all linked clients for clients of a circle","operationId":"getApiV1CirclesCircle_uuidLinkedClients","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LinkedClients_CircleLinkedClientsResource"}}}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/wealth":{"get":{"summary":"Get Wealth summary of all accounts of a circle","operationId":"getApiV1CirclesCircle_uuidWealth","description":"Wealth Aggregate net worth output for all clients of a circle","parameters":[{"in":"query","name":"date","description":"Get the clients net worth at a particular date in history. Get current net worth when not provided.","example":"2023-05-15","required":false,"schema":{"type":"string","description":"Get the clients net worth at a particular date in history. Get current net worth when not provided.","example":"2023-05-15"}},{"in":"query","name":"filter[include_other_plans]","description":"If true then the net worth will also include other plans the circle clients are linked to.","example":true,"required":false,"schema":{"type":"boolean","description":"If true then the net worth will also include other plans the circle clients are linked to.","example":true}},{"in":"query","name":"filter[include_inactive]","description":"If true then the net worth will also include inactive plans.","example":true,"required":false,"schema":{"type":"boolean","description":"If true then the net worth will also include inactive plans.","example":true}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NetWorthResource"}}}}}}}},"tags":["Circles"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/fact-find-access":{"get":{"summary":"Get the fact-find access policies","operationId":"getApiV1CirclesCircle_uuidFactFindAccess","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Circles"]},"put":{"summary":"Update a fact-find policy","operationId":"putApiV1CirclesCircle_uuidFactFindAccess","description":"This updates the fact-find access for a given member.","parameters":[],"responses":{},"tags":["Circles"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Circles_UpdateCircleFactFindAccessRequest"}}}}},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/claim":{"get":{"summary":"Get all claims of a plan","operationId":"getApiV1PlansPlan_uuidClaim","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, claim_start_date, claim_start_date, claim_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, claim_start_date, claim_start_date, claim_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ClaimResource"}}}}}}}},"tags":["Claim"]},"post":{"summary":"Create claim for a plan","operationId":"postApiV1PlansPlan_uuidClaim","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ClaimResource"}}}}},"tags":["Claim"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreClaimRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/claim/{uuid}":{"get":{"summary":"Get claim of a plan","operationId":"getApiV1PlansPlan_uuidClaimUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ClaimResource"}}}}},"tags":["Claim"]},"put":{"summary":"Update claim of a plan","operationId":"putApiV1PlansPlan_uuidClaimUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ClaimResource"}}}}},"tags":["Claim"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateClaimRequest"}}}}},"delete":{"summary":"Delete claim of a plan","operationId":"deleteApiV1PlansPlan_uuidClaimUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Claim"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client-status":{"get":{"summary":"Get all client statuses","operationId":"getApiV1ClientStatus","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ClientStatusResource"}}}}}}}},"tags":["Client Statuses"]},"post":{"summary":"Create a client status","operationId":"postApiV1ClientStatus","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ClientStatusResource"}}}}},"tags":["Client Statuses"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreClientStatusRequest"}}}}}},"/api/v1/client-status/{clientStatus_uuid}":{"get":{"summary":"Get a client status","operationId":"getApiV1ClientStatusClientStatus_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ClientStatusResource"}}}}},"tags":["Client Statuses"]},"put":{"summary":"Update a client status","operationId":"putApiV1ClientStatusClientStatus_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ClientStatusResource"}}}}},"tags":["Client Statuses"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateClientStatusRequest"}}}}},"delete":{"summary":"Delete a client status","operationId":"deleteApiV1ClientStatusClientStatus_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Client Statuses"]},"parameters":[{"in":"path","name":"clientStatus_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client-status/{clientStatus}/transfer-clients":{"post":{"summary":"Transfer clients from one status to another status","operationId":"postApiV1ClientStatusClientStatusTransferClients","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Client Statuses"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_TransferClientsStatusRequest"}}}}},"parameters":[{"in":"path","name":"clientStatus","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/client":{"get":{"summary":"Get all clients [DEPRECATED: Use account route]","operationId":"getApiV1Client","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, assigned_administrator, groups, tags, owners, external_references, business_unit].","example":"?include=groups,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, assigned_administrator, groups, tags, owners, external_references, business_unit].","example":"?include=groups,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter clients by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter clients by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[email]","description":"Filter clients that have an email with a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter clients that have an email with a partial match.","example":"architecto"}},{"in":"query","name":"filter[is_prospect]","description":"Get clients with this is_prospect value","example":false,"required":false,"schema":{"type":"boolean","description":"Get clients with this is_prospect value","example":false}},{"in":"query","name":"filter[status]","description":"Filter client status by partial names or uuid's","example":"active,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Filter client status by partial names or uuid's","example":"active,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[type]","description":"Comma separated string to filter by different client types.  Valid types are [individual, joint, trust, business].","example":"?filter[type]=individual,joint","required":false,"schema":{"type":"string","description":"Comma separated string to filter by different client types.  Valid types are [individual, joint, trust, business].","example":"?filter[type]=individual,joint"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the client was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the client was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the client was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the client was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a client custom field. Example filter[custom_field:pet_name]='Doug'","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a client custom field. Example filter[custom_field:pet_name]='Doug'","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[groups]","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[exclude_groups]","description":"Provide a group UUID (or multiple as a comma-separated string) to filter clients within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Provide a group UUID (or multiple as a comma-separated string) to filter clients within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[introduced_by]","description":"Filter clients that have been introduced by this account.","example":"e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Filter clients that have been introduced by this account.","example":"e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[linked_to]","description":"Filter to clients that have been linked to the account given. This will also return the requested account.","example":"df240fd1-784d-47e8-8874-f779a35847ca","required":false,"schema":{"type":"string","description":"Filter to clients that have been linked to the account given. This will also return the requested account.","example":"df240fd1-784d-47e8-8874-f779a35847ca"}},{"in":"query","name":"filter[has_advisor]","description":"Filter clients by whether they have an assigned adviser. true returns clients with an adviser, false returns clients without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter clients by whether they have an assigned adviser. true returns clients with an adviser, false returns clients without.","example":false}},{"in":"query","name":"filter[has_administrator]","description":"Filter clients by whether they have an assigned administrator. true returns clients with an administrator, false returns clients without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter clients by whether they have an assigned administrator. true returns clients with an administrator, false returns clients without.","example":false}},{"in":"query","name":"filter[has_paraplanner]","description":"Filter clients by whether they have an assigned paraplanner. true returns clients with a paraplanner, false returns clients without.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter clients by whether they have an assigned paraplanner. true returns clients with a paraplanner, false returns clients without.","example":false}},{"in":"query","name":"filter[business_unit]","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Clients"]},"post":{"summary":"Create a client [DEPRECATED: Use create an account route]","operationId":"postApiV1Client","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Clients"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_StoreClientRequest"}}}}}},"/api/v1/client/{uuid}":{"get":{"summary":"Get a client [DEPRECATED: Use get an account route]","operationId":"getApiV1ClientUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Clients"]},"put":{"summary":"Update a client [DEPRECATED: Use update an account route]","operationId":"putApiV1ClientUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Clients"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_UpdateClientRequest"}}}}},"delete":{"summary":"Delete a client [DEPRECATED: use delete an account route]","operationId":"deleteApiV1ClientUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Clients"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/plans":{"get":{"summary":"Get all client plans","operationId":"getApiV1ClientClient_uuidPlans","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=fields,latest_valuations","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=fields,latest_valuations"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[include_other_plans]","description":"If filter is provided then we will also return any other plans the client is linked to [asset, liability, protection]","example":true,"required":false,"schema":{"type":"boolean","description":"If filter is provided then we will also return any other plans the client is linked to [asset, liability, protection]","example":true}},{"in":"query","name":"filter[abstract_type]","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection","required":false,"schema":{"type":"string","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash","required":false,"schema":{"type":"string","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash"}},{"in":"query","name":"filter[name]","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage","required":false,"schema":{"type":"string","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage"}},{"in":"query","name":"filter[client]","description":"Comma separated list of client names to search against, can include partial matches.","example":"Thompson,Gar","required":false,"schema":{"type":"string","description":"Comma separated list of client names to search against, can include partial matches.","example":"Thompson,Gar"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exact_account_uuids]","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636","required":false,"schema":{"type":"string","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834","required":false,"schema":{"type":"string","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834"}},{"in":"query","name":"filter[provider]","description":"Comma separated list of provider names or provider UUIDs to search against, can include partial matches.","example":"Nationwide","required":false,"schema":{"type":"string","description":"Comma separated list of provider names or provider UUIDs to search against, can include partial matches.","example":"Nationwide"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto"}},{"in":"query","name":"filter[seller]","description":"Comma separated list of adviser names or adviser UUIDs of who sold the plan to search against, can include partial matches.","example":"Thompson,Gar","required":false,"schema":{"type":"string","description":"Comma separated list of adviser names or adviser UUIDs of who sold the plan to search against, can include partial matches.","example":"Thompson,Gar"}},{"in":"query","name":"filter[active_adviser]","description":"Comma separated list of adviser names or adviser UUIDs of who is actively managing the plan to search against, can include partial matches.","example":"Thompson,Gar","required":false,"schema":{"type":"string","description":"Comma separated list of adviser names or adviser UUIDs of who is actively managing the plan to search against, can include partial matches.","example":"Thompson,Gar"}},{"in":"query","name":"filter[case]","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078","required":false,"schema":{"type":"string","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078"}},{"in":"query","name":"filter[valuation_from]","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000}},{"in":"query","name":"filter[valuation_to]","description":"Amount in pennies to filter where latest valuation is less than.","example":5000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is less than.","example":5000}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[is_wrap_product]","description":"filter the plans by if they are a wrap product","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they are a wrap product","example":true}},{"in":"query","name":"filter[hide_wrap_children]","description":"Used to hide the wrap children from the primary list of plans.","example":true,"required":false,"schema":{"type":"boolean","description":"Used to hide the wrap children from the primary list of plans.","example":true}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"filter[agency_in_your_name]","description":"filter the plans by if they have agency in your name","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they have agency in your name","example":true}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/linked-clients":{"get":{"summary":"Get all linked clients for a client","operationId":"getApiV1ClientClient_uuidLinkedClients","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LinkedClients_LinkedClientsResource"}}}}},"tags":["Clients"]},"post":{"summary":"Create a client link","operationId":"postApiV1ClientClient_uuidLinkedClients","description":"","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LinkedClients_LinkedClientsResource"}}}}},"tags":["Clients"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_StoreClientLinkRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/linked-clients/{uuid}":{"put":{"summary":"Update a client link","operationId":"putApiV1ClientClient_uuidLinkedClientsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LinkedClients_LinkedClientsResource"}}}}},"tags":["Clients"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_UpdateClientLinkRequest"}}}}},"delete":{"summary":"Delete a client link","operationId":"deleteApiV1ClientClient_uuidLinkedClientsUuid","description":"","parameters":[],"responses":{},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"The UUID of the client.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"The UUID of the linked client.","example":"ab09-5f4d-a0c5-099bb7e89a84-e4ba1982","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/owners":{"post":{"summary":"Manage owners for the shared client.","operationId":"postApiV1ClientClient_uuidOwners","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Clients"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_ManageClientOwnersRequest"}}}}},"get":{"summary":"Retrieve the owners of the client with their personal details.","operationId":"getApiV1ClientClient_uuidOwners","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}":{"put":{"summary":"Update the personal details of one of the owners.","operationId":"putApiV1ClientClient_uuidOwnersPersonalDetailsOwner_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Clients"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_UpdateOwnersPersonalDetailsRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"owner_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client}/shared-accounts":{"get":{"summary":"Get all shared accounts the client belongs to.","operationId":"getApiV1ClientClientSharedAccounts","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [groups, tags, owners].","example":"?include=groups,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [groups, tags, owners].","example":"?include=groups,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'last_name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'last_name'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client","description":"The client.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_id}/fact-find/requests":{"get":{"summary":"Get all fact-find requests the client owns.","operationId":"getApiV1ClientClient_idFactFindRequests","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/wealth":{"get":{"summary":"Create a wealth summary for the client.","operationId":"getApiV1ClientClient_uuidWealth","description":"","parameters":[{"in":"query","name":"date","description":"Get the clients net worth at a particular date in history. Get current net worth when not provided.","example":"2023-05-15","required":false,"schema":{"type":"string","description":"Get the clients net worth at a particular date in history. Get current net worth when not provided.","example":"2023-05-15"}},{"in":"query","name":"filter[include_other_plans]","description":"If true then the net worth will also include other plans the client is linked to.","example":true,"required":false,"schema":{"type":"boolean","description":"If true then the net worth will also include other plans the client is linked to.","example":true}},{"in":"query","name":"filter[include_inactive]","description":"If true then the net worth will also include inactive plans.","example":true,"required":false,"schema":{"type":"boolean","description":"If true then the net worth will also include inactive plans.","example":true}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NetWorthResource"}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/new-business-events":{"get":{"summary":"Get all of a client's new business events","operationId":"getApiV1ClientClient_uuidNewBusinessEvents","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [adviser, case, firm, existingPlan].","example":"adviser,firm","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [adviser, case, firm, existingPlan].","example":"adviser,firm"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Plan type to filter by.","example":"pension","required":false,"schema":{"type":"string","description":"Plan type to filter by.","example":"pension"}},{"in":"query","name":"filter[sub_type]","description":"Plan sub type to filter by.","example":"master_trust_pension","required":false,"schema":{"type":"string","description":"Plan sub type to filter by.","example":"master_trust_pension"}},{"in":"query","name":"filter[provider_uuid]","description":"Plan's provider UUID to filter by.","example":"c000d7ee-e4b5-4336-a8bd-991a1bf71b03","required":false,"schema":{"type":"string","description":"Plan's provider UUID to filter by.","example":"c000d7ee-e4b5-4336-a8bd-991a1bf71b03"}},{"in":"query","name":"filter[policy_number]","description":"Fuzzy search for plan policy number.","example":"123456","required":false,"schema":{"type":"string","description":"Fuzzy search for plan policy number.","example":"123456"}},{"in":"query","name":"filter[adviser_uuid]","description":"Adviser's UUID to filter by.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469","required":false,"schema":{"type":"string","description":"Adviser's UUID to filter by.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469"}},{"in":"query","name":"filter[advice_type]","description":"Exact search for an advice type.","example":"direct_offer","required":false,"schema":{"type":"string","description":"Exact search for an advice type.","example":"direct_offer"}},{"in":"query","name":"filter[conducted_by]","description":"Exact search for how the advice was conducted.","example":"face_to_face","required":false,"schema":{"type":"string","description":"Exact search for how the advice was conducted.","example":"face_to_face"}},{"in":"query","name":"filter[status]","description":"Current status of the event.","example":"accepted","required":false,"schema":{"type":"string","description":"Current status of the event.","example":"accepted"}},{"in":"query","name":"filter[source_of_funds]","description":"Exact search for source of funds.","example":"savings","required":false,"schema":{"type":"string","description":"Exact search for source of funds.","example":"savings"}},{"in":"query","name":"filter[is_replacing_existing_plan]","description":"Whether the plan is replacing an existing plan.","example":true,"required":false,"schema":{"type":"boolean","description":"Whether the plan is replacing an existing plan.","example":true}},{"in":"query","name":"filter[opted_out_of_pension_scheme_for_plan]","description":"Whether the client opted out of pension scheme for the plan.","example":true,"required":false,"schema":{"type":"boolean","description":"Whether the client opted out of pension scheme for the plan.","example":true}},{"in":"query","name":"filter[date_from]","description":"Started after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Started after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[date_to]","description":"Started before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Started before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[proposed_date_to]","description":"Proposed before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Proposed before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[proposed_date_from]","description":"Proposed after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Proposed after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[contribution_type]","description":"Exact search for the contribution type.","example":"decrement","required":false,"schema":{"type":"string","description":"Exact search for the contribution type.","example":"decrement"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [start_date, proposal_date, created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [start_date, proposal_date, created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NewBusinessEventResource"}}}}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/emails":{"get":{"summary":"Get all the emails the client is a participant of.","operationId":"getApiV1ClientClient_uuidEmails","description":"","parameters":[{"in":"query","name":"search","description":"Search for a message by subject, content or participant (name / email).","example":"A search term","required":false,"schema":{"type":"string","description":"Search for a message by subject, content or participant (name / email).","example":"A search term"}},{"in":"query","name":"filter[incoming]","description":"Filter by incoming or outgoing messages.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by incoming or outgoing messages.","example":true}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of message UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of message UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [firm, mailbox, participants, attachments].","example":"?include=firm,mailbox","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [firm, mailbox, participants, attachments].","example":"?include=firm,mailbox"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, message_created_at]. Negative sign to denote DESC.  Defaults to '-message_created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, message_created_at]. Negative sign to denote DESC.  Defaults to '-message_created_at'.","example":"-updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MailboxMessageResource"}}}}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/illustrations":{"get":{"summary":"Get all the illustrations for a client","operationId":"getApiV1ClientClient_uuidIllustrations","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [firm, client, plan, requestedBy].","example":"?include=firm","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [firm, client, plan, requestedBy].","example":"?include=firm"}},{"in":"query","name":"filter[created_after]","description":"Illustration created after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration created after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto"}},{"in":"query","name":"filter[created_before]","description":"Illustration created before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration created before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto"}},{"in":"query","name":"filter[generated_after]","description":"Illustration generated after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration generated after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto"}},{"in":"query","name":"filter[generated_before]","description":"Illustration generated before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration generated before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto"}},{"in":"query","name":"filter[platform]","description":"Illustration platform.","example":"'seccl'","required":false,"schema":{"type":"string","description":"Illustration platform.","example":"'seccl'"}},{"in":"query","name":"filter[requested_by_uuid]","description":"Illustration requested by account uuid.","example":"'123e4567-e89b-12d3-a456-426614174000'","required":false,"schema":{"type":"string","description":"Illustration requested by account uuid.","example":"'123e4567-e89b-12d3-a456-426614174000'"}},{"in":"query","name":"filter[name]","description":"Fuzzy search for Illustration name.","example":"'My Illustration'","required":false,"schema":{"type":"string","description":"Fuzzy search for Illustration name.","example":"'My Illustration'"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, generated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-generated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, generated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-generated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IllustrationResource"}}}}},"tags":["Clients"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/clone/{modelType}/{modelUuid}":{"post":{"summary":"Clone a model","operationId":"postApiV1CloneModelTypeModelUuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Cloning"]},"parameters":[{"in":"path","name":"modelType","description":"The short name of the item to be cloned. Valid options: \"automation_blueprint\", \"board_task\", \"workflow\", \"document_template\", \"fact_find_schema\", \"illustration\".","example":"fact_find_schema","required":true,"schema":{"type":"string"}},{"in":"path","name":"modelUuid","description":"The uuid for the item to be cloned.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/contact-detail":{"get":{"summary":"Get all account contact details","operationId":"getApiV1AccountAccount_uuidContactDetail","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types to filter by. Valid filters are [email, phone_number].","example":"?filter[type]=email","required":false,"schema":{"type":"string","description":"Comma separated list of types to filter by. Valid filters are [email, phone_number].","example":"?filter[type]=email"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, name, value]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, name, value]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v1)"]},"post":{"summary":"Create a contact detail","operationId":"postApiV1AccountAccount_uuidContactDetail","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_ContactDetails_StoreContactDetailRequest"}}}}},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/contact-detail/{uuid}":{"get":{"summary":"Get a contact detail","operationId":"getApiV1AccountAccount_uuidContactDetailUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v1)"]},"put":{"summary":"Update a contact detail","operationId":"putApiV1AccountAccount_uuidContactDetailUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_ContactDetails_UpdateContactDetailRequest"}}}}},"delete":{"summary":"Delete a contact detail","operationId":"deleteApiV1AccountAccount_uuidContactDetailUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Contact Details (v1)"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/contact-details":{"get":{"summary":"Get all contact details","operationId":"getApiV2ContactDetails","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types to filter by. Valid filters are [email, phone_number].","example":"?filter[type]=email","required":false,"schema":{"type":"string","description":"Comma separated list of types to filter by. Valid filters are [email, phone_number].","example":"?filter[type]=email"}},{"in":"query","name":"filter[value]","description":"Comma separated list of partial values to filter by.","example":"?filter[value]=@hotmail.com,07890,+44","required":false,"schema":{"type":"string","description":"Comma separated list of partial values to filter by.","example":"?filter[value]=@hotmail.com,07890,+44"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, primary_accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, primary_accounts].","example":"?include=accounts"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, value]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, value]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_ContactDetailResource"}}}}}}}},"tags":["Contact Details (v2)"]},"post":{"summary":"Create a contact detail","operationId":"postApiV2ContactDetails","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_StoreContactDetailRequest"}}}}}},"/api/v2/contact-details/{uuid}":{"get":{"summary":"Get a contact detail","operationId":"getApiV2ContactDetailsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v2)"]},"put":{"summary":"Update a contact detail","operationId":"putApiV2ContactDetailsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ContactDetailResource"}}}}},"tags":["Contact Details (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_UpdateContactDetailRequest"}}}}},"delete":{"summary":"Delete a contact detail","operationId":"deleteApiV2ContactDetailsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Contact Details (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions":{"post":{"summary":"Create a contribution [DEPRECATED: Use transaction routes]","operationId":"postApiV1PlansPlan_uuidSubAccountsSubAccount_uuidContributions","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ContributionResource"}}}}},"tags":["Contributions"],"deprecated":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Contribution_StoreContributionRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}":{"get":{"summary":"Get a contribution [DEPRECATED: Use transaction routes]","operationId":"getApiV1PlansPlan_uuidSubAccountsSubAccount_uuidContributionsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ContributionResource"}}}}},"tags":["Contributions"],"deprecated":true},"put":{"summary":"Update a contribution [DEPRECATED: Use transaction routes]","operationId":"putApiV1PlansPlan_uuidSubAccountsSubAccount_uuidContributionsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ContributionResource"}}}}},"tags":["Contributions"],"deprecated":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Contribution_UpdateContributionRequest"}}}}},"delete":{"summary":"Delete a contribution [DEPRECATED: Use transaction routes]","operationId":"deleteApiV1PlansPlan_uuidSubAccountsSubAccount_uuidContributionsUuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ContributionResource"}}}}},"tags":["Contributions"],"deprecated":true},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/contributions/{subAccount}":{"get":{"summary":"Get all contributions [DEPRECATED: Use transaction routes]","operationId":"getApiV1PlansPlan_uuidContributionsSubAccount","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, started_at, ended_at, paid_at]. Negative sign to denote DESC.  Defaults to '-paid_at,-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, started_at, ended_at, paid_at]. Negative sign to denote DESC.  Defaults to '-paid_at,-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ContributionResource"}}}}}}}},"tags":["Contributions"],"deprecated":true},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount","description":"Optional parameter. An optional sub-account to constrain the results by.","required":true,"schema":{"type":"integer"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":16}}}]},"/api/v1/conversation/{conversation_uuid}/mentions":{"post":{"summary":"Retrieve the mentionable accounts for a conversation.","operationId":"postApiV1ConversationConversation_uuidMentions","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[[[{"item":"Gareth Thompson","contents":"\u003cspan data-type=\"mention\" data-account-uuid=\"8a3688e1-e7f6-4859-9f0b-01d6e423ed29\"\u003e@Gareth Thompson\u003c/span\u003e"}]]]},"properties":{"data":{"type":"array","example":[[[{"item":"Gareth Thompson","contents":"\u003cspan data-type=\"mention\" data-account-uuid=\"8a3688e1-e7f6-4859-9f0b-01d6e423ed29\"\u003e@Gareth Thompson\u003c/span\u003e"}]]],"items":{"type":"array"}}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/conversations":{"get":{"summary":"Get all account conversations","operationId":"getApiV1AccountAccount_uuidConversations","description":"Get all conversations where the account is participating in.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[archived]","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto","required":false,"schema":{"type":"string","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/conversations":{"get":{"summary":"Get all circle conversations","operationId":"getApiV1CirclesCircle_uuidConversations","description":"Get all conversations where the circle accounts are participants.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[archived]","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto","required":false,"schema":{"type":"string","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/cases/{case_uuid}/conversations":{"get":{"summary":"Get all conversations of a case","operationId":"getApiV1CasesCase_uuidConversations","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[archived]","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto","required":false,"schema":{"type":"string","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"case_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation":{"get":{"summary":"Get all conversations.","operationId":"getApiV1Conversation","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].","example":"participants,participants_count,latest_message"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[archived]","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto","required":false,"schema":{"type":"string","description":"Return with or only archived conversations for current user.  Valid options are [with, only, false].  Default is set to false.","example":"architecto"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, latest_message, pinned_conversations]. Negative sign to denote DESC.  Defaults to 'latest_message'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}}}}},"tags":["Conversations"]},"post":{"summary":"Create a conversation.","operationId":"postApiV1Conversation","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_StoreConversationRequest"}}}}}},"/api/v1/conversation/{uuid}":{"get":{"summary":"Get a conversation.","operationId":"getApiV1ConversationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}},"tags":["Conversations"]},"put":{"summary":"Update a conversation.","operationId":"putApiV1ConversationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ConversationResource"}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_UpdateConversationRequest"}}}}},"delete":{"summary":"Delete a conversation","operationId":"deleteApiV1ConversationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Conversations"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/notifications":{"post":{"summary":"Update notification settings for a conversation","operationId":"postApiV1ConversationConversation_uuidNotifications","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_ConversationNotificationsRequest"}}}}},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/leave":{"delete":{"summary":"Leave a conversation","operationId":"deleteApiV1ConversationConversation_uuidLeave","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Conversations"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/archive":{"post":{"summary":"Archive the conversation","operationId":"postApiV1ConversationConversation_uuidArchive","description":"If user is a client it will only archive it for themselves.\nIf user is an employee it will archive it for everybody.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/unarchive":{"post":{"summary":"Unarchive the conversation","operationId":"postApiV1ConversationConversation_uuidUnarchive","description":"If user is a client it will only unarchive it for themselves.\nIf user is an employee it will unarchive it for everybody.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/pin":{"post":{"summary":"Pin the conversation","operationId":"postApiV1ConversationConversation_uuidPin","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_PinConversationRequest"}}}}},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/participants":{"post":{"summary":"Add participants to conversation","operationId":"postApiV1ConversationConversation_uuidParticipants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_AddAccountsToConversationRequest"}}}}},"delete":{"summary":"Remove participants from a conversation","operationId":"deleteApiV1ConversationConversation_uuidParticipants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_RemoveAccountsFromConversationRequest"}}}}},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/admin":{"post":{"summary":"Promote participants to conversation admins","operationId":"postApiV1ConversationConversation_uuidAdmin","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_PromoteToConversationAdminRequest"}}}}},"delete":{"summary":"Revoke admin privileges from conversation participants","operationId":"deleteApiV1ConversationConversation_uuidAdmin","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Conversation_RevokeConversationAdminRequest"}}}}},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/messages/inline":{"post":{"summary":"Create a message with inline files","operationId":"postApiV1ConversationConversation_uuidMessagesInline","description":"Used to create a message and upload files at the same time.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MessageResource"}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Message_StoreMessageWithInlineFilesRequest"}}}}},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/messages":{"get":{"summary":"Get all messages","operationId":"getApiV1ConversationConversation_uuidMessages","description":"","parameters":[{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 30. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 30. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MessageResource"}}}}}}}},"tags":["Conversations"]},"post":{"summary":"Create a message","operationId":"postApiV1ConversationConversation_uuidMessages","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MessageResource"}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Message_StoreMessageRequest"}}}}},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/messages/{uuid}":{"get":{"summary":"Get a message","operationId":"getApiV1ConversationConversation_uuidMessagesUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MessageResource"}}}}},"tags":["Conversations"]},"put":{"summary":"Update a message","operationId":"putApiV1ConversationConversation_uuidMessagesUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MessageResource"}}}}},"tags":["Conversations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Message_UpdateMessageRequest"}}}}},"delete":{"summary":"Delete a message","operationId":"deleteApiV1ConversationConversation_uuidMessagesUuid","description":"","parameters":[],"responses":{},"tags":["Conversations"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/message/{message_uuid}/edits":{"get":{"summary":"Get a messages edit history","operationId":"getApiV1ConversationConversation_uuidMessageMessage_uuidEdits","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_EditedMessageResource"}}}}}}}},"tags":["Conversations"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"message_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/cover":{"get":{"summary":"Get all covers of a plan","operationId":"getApiV1PlansPlan_uuidCover","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[cover_type]","description":"Comma separate string of cover types to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separate string of cover types to filter by.","example":"architecto"}},{"in":"query","name":"filter[benefit_status]","description":"Comma separate string of benefit statuses to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separate string of benefit statuses to filter by.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, benefit_status, benefit_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, benefit_status, benefit_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_CoverResource"}}}}}}}},"tags":["Cover"]},"post":{"summary":"Create cover for a plan","operationId":"postApiV1PlansPlan_uuidCover","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_CoverResource"}}}}},"tags":["Cover"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreCoverRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/cover/{uuid}":{"get":{"summary":"Get cover of a plan","operationId":"getApiV1PlansPlan_uuidCoverUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_CoverResource"}}}}},"tags":["Cover"]},"put":{"summary":"Update cover of a plan","operationId":"putApiV1PlansPlan_uuidCoverUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_CoverResource"}}}}},"tags":["Cover"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateCoverRequest"}}}}},"delete":{"summary":"Delete cover of a plan","operationId":"deleteApiV1PlansPlan_uuidCoverUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Cover"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/custom-default-folder":{"get":{"summary":"Get all custom default folders","operationId":"getApiV1CustomDefaultFolder","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[model]","description":"Filter by model type. Valid types are [client, case, plan]","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by model type. Valid types are [client, case, plan]","example":"architecto"}},{"in":"query","name":"filter[is_active]","description":"Filter only active custom default folders","example":false,"required":false,"schema":{"type":"boolean","description":"Filter only active custom default folders","example":false}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomDefaultFoldersResource"}}}}}}}},"tags":["Custom Default Folders"]},"post":{"summary":"Create a custom default folder","operationId":"postApiV1CustomDefaultFolder","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomDefaultFoldersResource"}}}}},"tags":["Custom Default Folders"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreCustomDefaultFoldersRequest"}}}}}},"/api/v1/custom-default-folder/{customDefaultFolder_uuid}":{"get":{"summary":"Get a custom default folder","operationId":"getApiV1CustomDefaultFolderCustomDefaultFolder_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomDefaultFoldersResource"}}}}},"tags":["Custom Default Folders"]},"put":{"summary":"Update a custom default folder","operationId":"putApiV1CustomDefaultFolderCustomDefaultFolder_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomDefaultFoldersResource"}}}}},"tags":["Custom Default Folders"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateCustomDefaultFoldersRequest"}}}}},"delete":{"summary":"Delete a custom default folder","operationId":"deleteApiV1CustomDefaultFolderCustomDefaultFolder_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Custom Default Folders"]},"parameters":[{"in":"path","name":"customDefaultFolder_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/custom-field":{"get":{"summary":"Get all custom fields","operationId":"getApiV1CustomField","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[model_type]","description":"Filter the custom fields by a specific model type. For example: ?filter[model_type]=client","example":"architecto","required":false,"schema":{"type":"string","description":"Filter the custom fields by a specific model type. For example: ?filter[model_type]=client","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, model_type, position]. Negative sign to denote DESC.  Defaults to 'position'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, model_type, position]. Negative sign to denote DESC.  Defaults to 'position'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomFieldResource"}}}}},"tags":["Custom Fields"]},"post":{"summary":"Create a custom field","operationId":"postApiV1CustomField","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomFieldResource"}}}}},"tags":["Custom Fields"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_CustomFields_StoreCustomFieldRequest"}}}}}},"/api/v1/custom-field/{customField_uuid}":{"get":{"summary":"Get a custom field","operationId":"getApiV1CustomFieldCustomField_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomFieldResource"}}}}},"tags":["Custom Fields"]},"put":{"summary":"Update a custom field","operationId":"putApiV1CustomFieldCustomField_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_CustomFieldResource"}}}}},"tags":["Custom Fields"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_CustomFields_UpdateCustomFieldRequest"}}}}},"delete":{"summary":"Delete a custom field","operationId":"deleteApiV1CustomFieldCustomField_uuid","description":"","parameters":[],"responses":{},"tags":["Custom Fields"]},"parameters":[{"in":"path","name":"customField_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"customField","description":"Optional parameter. UUID The UUID of the custom field","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/client/{client_uuid}/dependant":{"get":{"summary":"Get all dependants","operationId":"getApiV1ClientClient_uuidDependant","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, shared_owner].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, shared_owner].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}}}}},"tags":["Dependants (v1)"]},"post":{"summary":"Create a dependant","operationId":"postApiV1ClientClient_uuidDependant","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}},"tags":["Dependants (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Dependants_StoreDependantRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/dependant/{uuid}":{"get":{"summary":"Get a dependant","operationId":"getApiV1ClientClient_uuidDependantUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}},"tags":["Dependants (v1)"]},"put":{"summary":"Update a dependant","operationId":"putApiV1ClientClient_uuidDependantUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}},"tags":["Dependants (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Dependants_UpdateDependantRequest"}}}}},"delete":{"summary":"Delete a dependant","operationId":"deleteApiV1ClientClient_uuidDependantUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Dependants (v1)"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/dependants":{"get":{"summary":"Get all dependants","operationId":"getApiV2Dependants","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_DependantResource"}}}}}}}},"tags":["Dependants (v2)"]},"post":{"summary":"Create a dependant","operationId":"postApiV2Dependants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}},"tags":["Dependants (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Dependants_StoreDependantRequest"}}}}}},"/api/v2/dependants/{uuid}":{"get":{"summary":"Get a dependant","operationId":"getApiV2DependantsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}},"tags":["Dependants (v2)"]},"put":{"summary":"Update a dependant","operationId":"putApiV2DependantsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DependantResource"}}}}},"tags":["Dependants (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Dependants_UpdateDependantRequest"}}}}},"delete":{"summary":"Delete a dependant","operationId":"deleteApiV2DependantsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Dependants (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document/variables":{"get":{"summary":"Get available variables","operationId":"getApiV1DocumentVariables","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentVariablesResource"}}}}},"tags":["Document Builder"]}},"/api/v1/document-template":{"get":{"summary":"Get document templates","operationId":"getApiV1DocumentTemplate","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentTemplateResource"}}}}}}}},"tags":["Document Builder"]},"post":{"summary":"Create a document template","operationId":"postApiV1DocumentTemplate","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentTemplateResource"}}}}},"tags":["Document Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_StoreDocumentTemplateRequest"}}}}}},"/api/v1/document-template/{documentTemplate_uuid}":{"get":{"summary":"Get a document template","operationId":"getApiV1DocumentTemplateDocumentTemplate_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentTemplateResource"}}}}},"tags":["Document Builder"]},"put":{"summary":"Update a document template","operationId":"putApiV1DocumentTemplateDocumentTemplate_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentTemplateResource"}}}}},"tags":["Document Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_UpdateDocumentTemplateRequest"}}}}},"delete":{"summary":"Delete a template","operationId":"deleteApiV1DocumentTemplateDocumentTemplate_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"documentTemplate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document-template/{documentTemplate_uuid}/content/docx":{"get":{"summary":"Download Template as DOCX","operationId":"getApiV1DocumentTemplateDocumentTemplate_uuidContentDocx","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Document Builder"]},"post":{"summary":"Update the DOCX content of a template","operationId":"postApiV1DocumentTemplateDocumentTemplate_uuidContentDocx","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Document Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_UploadTemplateDocxContentRequest"}}}}},"parameters":[{"in":"path","name":"documentTemplate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document-template/{documentTemplate_uuid}/content/sfdt":{"get":{"summary":"Download Template as SFDT","operationId":"getApiV1DocumentTemplateDocumentTemplate_uuidContentSfdt","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"documentTemplate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document-template/{documentTemplate_uuid}/content/pdf":{"get":{"summary":"Download Template as PDF","operationId":"getApiV1DocumentTemplateDocumentTemplate_uuidContentPdf","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"documentTemplate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document-template/{documentTemplate_uuid}/content/preview":{"get":{"summary":"Generate Document Preview","operationId":"getApiV1DocumentTemplateDocumentTemplate_uuidContentPreview","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"documentTemplate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document":{"get":{"summary":"Get all documents","operationId":"getApiV1Document","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [clients, file].","example":"?include=clients","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [clients, file].","example":"?include=clients"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter by partial document title","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial document title","example":"architecto"}},{"in":"query","name":"filter[created_before]","description":"date Filter documents created before a given date. Format: YYYY-MM-DD","example":"architecto","required":false,"schema":{"type":"string","description":"date Filter documents created before a given date. Format: YYYY-MM-DD","example":"architecto"}},{"in":"query","name":"filter[created_after]","description":"date Filter documents created after a given date. Format: YYYY-MM-DD","example":"architecto","required":false,"schema":{"type":"string","description":"date Filter documents created after a given date. Format: YYYY-MM-DD","example":"architecto"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of client UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1","required":false,"schema":{"type":"string","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'updated_at'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'updated_at'.","example":"created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentResource"}}}}}}}},"tags":["Document Builder"]},"post":{"summary":"Create a document","operationId":"postApiV1Document","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentResource"}}}}},"tags":["Document Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_StoreDocumentRequest"}}}}}},"/api/v1/document/{uuid}":{"get":{"summary":"Get a document","operationId":"getApiV1DocumentUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentResource"}}}}},"tags":["Document Builder"]},"put":{"summary":"Update a document","operationId":"putApiV1DocumentUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentResource"}}}}},"tags":["Document Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_UpdateDocumentRequest"}}}}},"delete":{"summary":"Delete a document","operationId":"deleteApiV1DocumentUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document/{document_uuid}/content/docx":{"get":{"summary":"Download Document as DOCX","operationId":"getApiV1DocumentDocument_uuidContentDocx","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Document Builder"]},"post":{"summary":"Update the DOCX content of a document","operationId":"postApiV1DocumentDocument_uuidContentDocx","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Document Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_UploadDocumentDocxContentRequest"}}}}},"parameters":[{"in":"path","name":"document_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document/{document_uuid}/content/sfdt":{"get":{"summary":"Download Document as SFDT","operationId":"getApiV1DocumentDocument_uuidContentSfdt","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"document_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document/{document_uuid}/content/pdf":{"get":{"summary":"Download Document as PDF","operationId":"getApiV1DocumentDocument_uuidContentPdf","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"document_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document/{document_uuid}/content/preview":{"get":{"summary":"Generate Document Preview","operationId":"getApiV1DocumentDocument_uuidContentPreview","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"document_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document/{document_uuid}/publish":{"post":{"summary":"Publish a document","operationId":"postApiV1DocumentDocument_uuidPublish","description":"This will make the document un-editable and will upload a DOCX and PDF file to the client.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentBuilder_DocumentResource"}}}}},"tags":["Document Builder"]},"parameters":[{"in":"path","name":"document_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document-pack/document-pack":{"get":{"summary":"Get all document packs","operationId":"getApiV1DocumentPackDocumentPack","description":"","parameters":[{"in":"query","name":"filter[name]","description":"Filter by name. This is a fuzzy search.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by name. This is a fuzzy search.","example":"architecto"}},{"in":"query","name":"filter[is_template]","description":"Filter document packs that are templates","example":false,"required":false,"schema":{"type":"boolean","description":"Filter document packs that are templates","example":false}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, is_template]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, is_template]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentPackResource"}}}}}}}},"tags":["Document Packs"]},"post":{"summary":"Create a document pack","operationId":"postApiV1DocumentPackDocumentPack","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_DocumentPackResource"}}}}}}}},"tags":["Document Packs"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentSigning_StoreDocumentPackRequest"}}}}}},"/api/v1/document-pack/document-pack/{uuid}":{"get":{"summary":"Get a document pack","operationId":"getApiV1DocumentPackDocumentPackUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}}}}},"tags":["Document Packs"]},"put":{"summary":"Update a document pack","operationId":"putApiV1DocumentPackDocumentPackUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}}}}},"tags":["Document Packs"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentSigning_UpdateDocumentPackRequest"}}}}},"delete":{"summary":"Delete a document pack","operationId":"deleteApiV1DocumentPackDocumentPackUuid","description":"","parameters":[],"responses":{},"tags":["Document Packs"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/signatures":{"get":{"summary":"Get all client signature transactions","operationId":"getApiV1ClientClient_uuidSignatures","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[date_from]","description":"Get signatures launched from a certain date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get signatures launched from a certain date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_to]","description":"Get signatures launched to a certain date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get signatures launched to a certain date.","example":"2022-03-27"}},{"in":"query","name":"filter[status]","description":"Filter by transaction status.  Valid options are [created, pending, complete, email_sent, closed, cancelled, expired, voided, failed].","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by transaction status.  Valid options are [created, pending, complete, email_sent, closed, cancelled, expired, voided, failed].","example":"architecto"}},{"in":"query","name":"filter[clients]","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"a9cfd38f-a88e-5ec0-a4c2-5135e53b9c20,f1a0a611-3403-5dec-885f-8f3b156975d3","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"a9cfd38f-a88e-5ec0-a4c2-5135e53b9c20,f1a0a611-3403-5dec-885f-8f3b156975d3"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"name","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"name"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_SignatureTransactionResource"}}}}}}}},"tags":["Document Signing"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/document-signing":{"get":{"summary":"Get all signature transactions","operationId":"getApiV1DocumentSigning","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[date_from]","description":"Get signatures launched from a certain date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get signatures launched from a certain date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_to]","description":"Get signatures launched to a certain date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get signatures launched to a certain date.","example":"2022-03-27"}},{"in":"query","name":"filter[status]","description":"Filter by transaction status.  Valid options are [created, pending, complete, email_sent, closed, cancelled, expired, voided, failed].","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by transaction status.  Valid options are [created, pending, complete, email_sent, closed, cancelled, expired, voided, failed].","example":"architecto"}},{"in":"query","name":"filter[clients]","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"a9cfd38f-a88e-5ec0-a4c2-5135e53b9c20,f1a0a611-3403-5dec-885f-8f3b156975d3","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"a9cfd38f-a88e-5ec0-a4c2-5135e53b9c20,f1a0a611-3403-5dec-885f-8f3b156975d3"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"name","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"name"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_SignatureTransactionResource"}}}}}}}},"tags":["Document Signing"]},"post":{"summary":"Launch document signing","operationId":"postApiV1DocumentSigning","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_SignatureTransactionResource"}}}}},"tags":["Document Signing"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_DocumentBuilder_LaunchDocumentSigningRequest"}}}}}},"/api/v1/document-signing/{signatureTransaction_uuid}":{"get":{"summary":"Get a signature transaction","operationId":"getApiV1DocumentSigningSignatureTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_SignatureTransactionResource"}}}}},"tags":["Document Signing"]},"parameters":[{"in":"path","name":"signatureTransaction_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/employee":{"get":{"summary":"Get all employees","operationId":"getApiV1Employee","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number, primary_email, assigned_adviser, tags, groups, business_unit].","example":"?include=groups,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number, primary_email, assigned_adviser, tags, groups, business_unit].","example":"?include=groups,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[email]","description":"Filter employees that have an email with a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter employees that have an email with a partial match.","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated string to filter by different employee types.  Valid types are [owner, admin, member].","example":"?filter[type]=member","required":false,"schema":{"type":"string","description":"Comma separated string to filter by different employee types.  Valid types are [owner, admin, member].","example":"?filter[type]=member"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the client was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the client was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the client was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the client was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[groups]","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[exclude_groups]","description":"Provide a group UUID (or multiple as a comma-separated string) to filter employees within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Provide a group UUID (or multiple as a comma-separated string) to filter employees within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[departments]","description":"Comma separated list of departments the employee is in.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of departments the employee is in.","example":"architecto"}},{"in":"query","name":"filter[include]","description":"Comma separated list of employee UUIDs that should always be returned no matter what other filters are applied.","example":"a1d8eb7b-bcef-4321-b245-f00efd823e6a","required":false,"schema":{"type":"string","description":"Comma separated list of employee UUIDs that should always be returned no matter what other filters are applied.","example":"a1d8eb7b-bcef-4321-b245-f00efd823e6a"}},{"in":"query","name":"filter[business_unit]","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Employee"]},"post":{"summary":"Create an employee [DEPRECATED: Use create an account route]","operationId":"postApiV1Employee","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Employee"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Employee_StoreEmployeeRequest"}}}}}},"/api/v1/employee/{uuid}":{"get":{"summary":"Get an employee [DEPRECATED: Use get an account route]","operationId":"getApiV1EmployeeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Employee"]},"put":{"summary":"Update an employee [DEPRECATED: Use update an account route]","operationId":"putApiV1EmployeeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Employee"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Employee_UpdateEmployeeRequest"}}}}},"delete":{"summary":"Delete an employee [DEPRECATED: use delete an account route]","operationId":"deleteApiV1EmployeeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Employee"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/employments":{"get":{"summary":"List Employments","operationId":"getApiV2Employments","description":"List of all","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[status]","description":"Filter by a comma separated list of statuses.","example":"retired,unemployed","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of statuses.","example":"retired,unemployed"}},{"in":"query","name":"filter[employer]","description":"Filter by employer name.","example":"Plannr","required":false,"schema":{"type":"string","description":"Filter by employer name.","example":"Plannr"}},{"in":"query","name":"filter[job_title]","description":"Filter by job title.","example":"Web Developer","required":false,"schema":{"type":"string","description":"Filter by job title.","example":"Web Developer"}},{"in":"query","name":"filter[started_at]","description":"Filter by start date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[started_at]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by start date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[started_at]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[ended_at]","description":"Filter by end date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[ended_at]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by end date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[ended_at]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[email_address]","description":"Filter by job title.","example":"my.client@example.org","required":false,"schema":{"type":"string","description":"Filter by job title.","example":"my.client@example.org"}},{"in":"query","name":"filter[phone_number]","description":"Filter pby hone number - must have international code.","example":"+441234567890","required":false,"schema":{"type":"string","description":"Filter pby hone number - must have international code.","example":"+441234567890"}},{"in":"query","name":"include","description":"A comma separated list of items to include. Possible values are [address, income, email_address, phone_number, turnover_history].","example":"email_address,phone_number","required":false,"schema":{"type":"string","description":"A comma separated list of items to include. Possible values are [address, income, email_address, phone_number, turnover_history].","example":"email_address,phone_number"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_EmploymentResource"}}}}}}}},"tags":["Employment (V2)"]},"post":{"summary":"Create an Employment","operationId":"postApiV2Employments","description":"Creates an employment record","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_EmploymentResource"}}}}},"tags":["Employment (V2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Employment_StoreEmploymentRequest"}}}}}},"/api/v2/employments/{uuid}":{"get":{"summary":"Get an employment","operationId":"getApiV2EmploymentsUuid","description":"Display an employment record","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_EmploymentResource"}}}}},"tags":["Employment (V2)"]},"put":{"summary":"Update an Employment","operationId":"putApiV2EmploymentsUuid","description":"Update an existing Employment record","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/_App_Http_Resources_V2_EmploymentResource"}}}}},"tags":["Employment (V2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Employment_UpdateEmploymentRequest"}}}}},"delete":{"summary":"Delete an employment","operationId":"deleteApiV2EmploymentsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Employment (V2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/employment":{"get":{"summary":"Get all employments","operationId":"getApiV1ClientClient_uuidEmployment","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, address, email_address, phone_number, income].","example":"?include=shared_owner,income","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, address, email_address, phone_number, income].","example":"?include=shared_owner,income"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, employer]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, employer]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_EmploymentResource"}}}}}}}},"tags":["Employments"]},"post":{"summary":"Create an employment","operationId":"postApiV1ClientClient_uuidEmployment","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_EmploymentResource"}}}}},"tags":["Employments"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Employments_StoreEmploymentRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/employment/{uuid}":{"get":{"summary":"Get an employment","operationId":"getApiV1ClientClient_uuidEmploymentUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_EmploymentResource"}}}}},"tags":["Employments"]},"put":{"summary":"Update an employment","operationId":"putApiV1ClientClient_uuidEmploymentUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_EmploymentResource"}}}}},"tags":["Employments"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Employments_UpdateEmploymentRequest"}}}}},"delete":{"summary":"Delete an employment","operationId":"deleteApiV1ClientClient_uuidEmploymentUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Employments"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/personal-access-tokens":{"get":{"summary":"Get all personal access tokens","operationId":"getApiV1PersonalAccessTokens","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]},"post":{"summary":"Create a personal access token","operationId":"postApiV1PersonalAccessTokens","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_StorePersonalAccessTokenRequest"}}}}}},"/api/v1/personal-access-tokens/{id}":{"delete":{"summary":"Delete a personal access token","operationId":"deleteApiV1PersonalAccessTokensId","description":"","parameters":[],"responses":{},"tags":["Endpoints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_DeletePersonalAccessTokenRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The ID of the personal access token.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/migrate-joint-logins":{"get":{"summary":"","operationId":"getApiV1MigrateJointLogins","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]}},"/api/v1/migrate-joint-logins/{jointAccountLogin_uuid}":{"post":{"summary":"","operationId":"postApiV1MigrateJointLoginsJointAccountLogin_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"jointAccountLogin_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/migrate-joint-documents-to-circle":{"post":{"summary":"","operationId":"postApiV1MigrateJointDocumentsToCircle","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]}},"/api/v1/referral-connections":{"get":{"summary":"Returns referral connections for the current firm with direction indicated.","operationId":"getApiV1ReferralConnections","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma-separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a comma-separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"filter[status]","description":"Filter by status. Valid values: pending, accepted, denied.","example":"pending","required":false,"schema":{"type":"string","description":"Filter by status. Valid values: pending, accepted, denied.","example":"pending"}},{"in":"query","name":"filter[direction]","description":"Filter by direction. Valid values: sent, received.","example":"sent","required":false,"schema":{"type":"string","description":"Filter by direction. Valid values: sent, received.","example":"sent"}},{"in":"query","name":"filter[recipient_uuid]","description":"Filter by recipient account UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by recipient account UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, status, expires_at]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, status, expires_at]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"-created_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]},"post":{"summary":"Creates a new referral connection request to another adviser using their referral code.","operationId":"postApiV1ReferralConnections","description":"An email notification will be sent to the recipient with accept/deny links.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReferralConnectionResource"}}}}},"tags":["Endpoints"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_ReferralConnection_StoreReferralConnectionRequest"}}}}}},"/api/v1/referral-connections/{referralConnection_uuid}":{"get":{"summary":"","operationId":"getApiV1ReferralConnectionsReferralConnection_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReferralConnectionResource"}}}}},"tags":["Endpoints"]},"delete":{"summary":"Deletes a pending referral connection. Only the sender can delete a connection request.","operationId":"deleteApiV1ReferralConnectionsReferralConnection_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"referralConnection_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/referrals":{"get":{"summary":"Returns referrals for the current firm with direction indicated.","operationId":"getApiV1Referrals","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma-separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a comma-separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"filter[status]","description":"Filter by status. Valid values: pending, accepted, rejected, expired.","example":"pending","required":false,"schema":{"type":"string","description":"Filter by status. Valid values: pending, accepted, rejected, expired.","example":"pending"}},{"in":"query","name":"filter[direction]","description":"Filter by direction. Valid values: sent, received.","example":"sent","required":false,"schema":{"type":"string","description":"Filter by direction. Valid values: sent, received.","example":"sent"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, status, expires_at]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, status, expires_at]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"-created_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]},"post":{"summary":"Creates a new referral to share client data with a connected firm.","operationId":"postApiV1Referrals","description":"The connection must be accepted before referrals can be sent.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReferralResource"}}}}},"tags":["Endpoints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Referral_StoreReferralRequest"}}}}}},"/api/v1/referrals/{uuid}":{"get":{"summary":"","operationId":"getApiV1ReferralsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReferralResource"}}}}},"tags":["Endpoints"]},"delete":{"summary":"Deletes a pending referral. Only the sender can delete a referral.","operationId":"deleteApiV1ReferralsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/referrals/{referral_uuid}/accept":{"post":{"summary":"Accepts a pending referral. Only the recipient firm can accept.","operationId":"postApiV1ReferralsReferral_uuidAccept","description":"Client data is cloned to the recipient firm upon acceptance.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReferralResource"}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"referral_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/referrals/{referral_uuid}/reject":{"post":{"summary":"Rejects a pending referral. Only the recipient firm can reject.","operationId":"postApiV1ReferralsReferral_uuidReject","description":"A rejection reason is required. Cloned client data will be cleaned up.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReferralResource"}}}}},"tags":["Endpoints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Referral_RejectReferralRequest"}}}}},"parameters":[{"in":"path","name":"referral_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/conquest/client/{client}":{"post":{"summary":"Create Plan in Conquest and return URL to view Conquest Client.","operationId":"postApiV1AddonsConquestClientClient","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]},"put":{"summary":"Update Client in Conquest and redirect to Conquest\nto view client","operationId":"putApiV1AddonsConquestClientClient","description":"","parameters":[],"responses":{},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"client","description":"The client.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/be-iq/profiler/invite":{"post":{"summary":"Create Be-IQ Risk Profile Invitation","operationId":"postApiV1AddonsBeIqProfilerInvite","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Addons_CreateBeIQInvitationRequest"}}}}}},"/api/v1/addons/be-iq/client/{client_uuid}":{"get":{"summary":"Show the Be-IQ client","operationId":"getApiV1AddonsBeIqClientClient_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/be-iq/token":{"get":{"summary":"Retrieve a front-end access token to retrieve the Be-IQ front-end data","operationId":"getApiV1AddonsBeIqToken","description":"This is only allowed to be accessed by our own front-end.","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]}},"/api/v1/addons/pensionlab/launch-widget":{"post":{"summary":"Get the Microsoft Entra token from the PensionLabs SDK","operationId":"postApiV1AddonsPensionlabLaunchWidget","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"]}},"/api/v2/flux":{"get":{"summary":"","operationId":"getApiV2Flux","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Endpoints"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Controllers_V2_IndexFluxRequest"}}}}}},"/api/v2/fact-find-session/{factFindSession_uuid}/account/{account_uuid}":{"get":{"summary":"Launch a fact-find session as an adviser on behalf of a client.","operationId":"getApiV2FactFindSessionFactFindSession_uuidAccountAccount_uuid","description":"This endpoint allows an adviser to launch a fact-find session for one of their clients.\nOn success, a 6-hour authenticated session is established for the fact-find and the session\ndata is returned so the frontend can render the fact-find page. The session data will include\na `launched_by_account_uuid` to identify the adviser.","parameters":[],"responses":{"200":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"The fact-find session was launched successfully and is returned in the response body."}},"application/json":{"schema":null}}},"403":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"The adviser does not have access to this client or the account is not on the session."}},"application/json":{"schema":null}}},"404":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"The fact-find session or account UUID does not exist."}},"application/json":{"schema":null}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"factFindSession","description":"The UUID of the fact-find session.","example":"c33eea50-795b-4bb0-ac3e-925ab620147a","required":true,"schema":{"type":"string"}},{"in":"path","name":"account","description":"The UUID of the client account to launch on behalf of.","example":"0d5fbbe3-e65a-440a-84d1-4a0bece8f839","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-session/{factFindSession_uuid}/launch":{"get":{"summary":"Launch a fact-find session as the client.","operationId":"getApiV2FactFindSessionFactFindSession_uuidLaunch","description":"This endpoint allows a client — or an adviser impersonating that client — to launch\nthe client's fact-find session from the portal. On success, a 6-hour authenticated\nsession is established for the fact-find and the session data is returned so the\nfrontend can render the fact-find page.\n\nWhen the request is authenticated via the mobile app, no session cookie is set.\nInstead, a `X-Fact-Find-Session-Token` header is returned containing a bearer token\nthat must be included on all subsequent fact-find requests in place of the session cookie.","parameters":[],"responses":{"200":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"The fact-find session was launched successfully and is returned in the response body."}},"application/json":{"schema":null}}},"401":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"No authenticated login was found on the request."}},"application/json":{"schema":null}}},"403":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"The client does not have access to this fact-find session."}},"application/json":{"schema":null}}},"404":{"description":"","content":{"text/plain":{"schema":{"type":"string","example":"The fact-find session UUID does not exist."}},"application/json":{"schema":null}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"factFindSession","description":"The UUID of the fact-find session.","example":"c33eea50-795b-4bb0-ac3e-925ab620147a","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-launch/{factFindSession_uuid}":{"get":{"summary":"","operationId":"getApiV2FactFindLaunchFactFindSession_uuid","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-circle-expenditures/{factFindSession_uuid}":{"get":{"summary":"Get all expenditures for the session's circle.","operationId":"getApiV2FactFindCircleExpendituresFactFindSession_uuid","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/{lifeStageField_uuid}":{"post":{"summary":"Create or update a circle expenditure linked to a life stage field.","operationId":"postApiV2FactFindCircleExpendituresFactFindSession_uuidLifeStage_uuidLifeStageField_uuid","description":"","parameters":[],"responses":{"419":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"CSRF token mismatch."},"properties":{"message":{"type":"string","example":"CSRF token mismatch."}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStageField_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom":{"post":{"summary":"Create a custom circle expenditure.","operationId":"postApiV2FactFindCircleExpendituresFactFindSession_uuidLifeStage_uuidCustom","description":"","parameters":[],"responses":{"419":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"CSRF token mismatch."},"properties":{"message":{"type":"string","example":"CSRF token mismatch."}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-circle-expenditures/{factFindSession_uuid}/{lifeStage_uuid}/custom/{expenditure_uuid}":{"post":{"summary":"Update a custom circle expenditure.","operationId":"postApiV2FactFindCircleExpendituresFactFindSession_uuidLifeStage_uuidCustomExpenditure_uuid","description":"","parameters":[],"responses":{"419":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"CSRF token mismatch."},"properties":{"message":{"type":"string","example":"CSRF token mismatch."}}}}}}},"tags":["Endpoints"]},"delete":{"summary":"Delete a custom circle expenditure.","operationId":"deleteApiV2FactFindCircleExpendituresFactFindSession_uuidLifeStage_uuidCustomExpenditure_uuid","description":"","parameters":[],"responses":{},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/addons/be-iq/profiler/invite-fact-find/{factFindSession_uuid}/{account_uuid}":{"post":{"summary":"Create Be-IQ Risk Profile Invitation for a Fact Find","operationId":"postApiV2AddonsBeIqProfilerInviteFactFindFactFindSession_uuidAccount_uuid","description":"","parameters":[],"responses":{"419":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"CSRF token mismatch."},"properties":{"message":{"type":"string","example":"CSRF token mismatch."}}}}}}},"tags":["Endpoints"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/life-stage":{"get":{"summary":"Get all Life Stages for a Firm","operationId":"getApiV1LifeStage","description":"Response includes all expenditure life stages for a firm along with their associated expenditure fields in a JSON object.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageResource"}}}}}}}},"tags":["Expenditures"]},"post":{"summary":"Create a Life Stage for a Firm","operationId":"postApiV1LifeStage","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_StoreLifeStageRequest"}}}}}},"/api/v1/life-stage/{lifeStage_uuid}":{"get":{"summary":"Retrieve a Life Stage for a Firm","operationId":"getApiV1LifeStageLifeStage_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageResource"}}}}},"tags":["Expenditures"]},"put":{"summary":"Update a Life Stage for a Firm","operationId":"putApiV1LifeStageLifeStage_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_UpdateLifeStageRequest"}}}}},"delete":{"summary":"Delete a Life Stages for a firm","operationId":"deleteApiV1LifeStageLifeStage_uuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"lifeStage_uuid","description":"The uuid of the life stage.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/life-stage/reorder":{"post":{"summary":"Reorder Life Stages for a firm","operationId":"postApiV1LifeStageReorder","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_ReorderLifeStageRequest"}}}}}},"/api/v1/expenditure-structure/section":{"get":{"summary":"Get Sections for Life Stages for a Firm","operationId":"getApiV1ExpenditureStructureSection","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageSectionResource"}}}}}}}},"tags":["Expenditures"]},"post":{"summary":"Create a Section for a Life Stage for a Firm","operationId":"postApiV1ExpenditureStructureSection","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageSectionResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_StoreLifeStageSectionRequest"}}}}}},"/api/v1/expenditure-structure/section/{lifeStageSection_uuid}":{"get":{"summary":"Get a Section for a Life Stage for a Firm","operationId":"getApiV1ExpenditureStructureSectionLifeStageSection_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageSectionResource"}}}}},"tags":["Expenditures"]},"put":{"summary":"Update a Section for a Life Stage for a Firm","operationId":"putApiV1ExpenditureStructureSectionLifeStageSection_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageSectionResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_UpdateLifeStageSectionRequest"}}}}},"delete":{"summary":"Delete a Section for a Life Stage for a Firm","operationId":"deleteApiV1ExpenditureStructureSectionLifeStageSection_uuid","description":"","parameters":[],"responses":{},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"lifeStageSection_uuid","description":"The uuid of the life stage section.","example":"dc329ca6-bf88-43ad-a398-b2507569c941","required":true,"schema":{"type":"string"}}]},"/api/v1/expenditure-structure/section/reorder":{"post":{"summary":"Reorder Life Stage Sections for a firm","operationId":"postApiV1ExpenditureStructureSectionReorder","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_ReorderLifeStageSectionRequest"}}}}}},"/api/v1/expenditure-structure/section/set-custom-expenditure":{"post":{"summary":"Update the custom expenditures setting across all uuids","operationId":"postApiV1ExpenditureStructureSectionSetCustomExpenditure","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_MassSetCustomExpendituresRequest"}}}}}},"/api/v1/expenditure-structure/field":{"get":{"summary":"Get all the Fields for a Life Stage Section for a Firm","operationId":"getApiV1ExpenditureStructureField","description":"The Fields are ordered by their position values in ascending order","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageFieldResource"}}}}}}}},"tags":["Expenditures"]},"post":{"summary":"Create a Field for a Life Stage Section for a Firm","operationId":"postApiV1ExpenditureStructureField","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageFieldResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_StoreLifeStageFieldRequest"}}}}},"parameters":[{"in":"path","name":"firm_uuid","description":"The uuid of the Firm.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStageSection_uuid","description":"The uuid of the Life Stage Section.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}}]},"/api/v1/expenditure-structure/field/{lifeStageField_uuid}":{"get":{"summary":"Get a Field for a Life Stage Section for a Firm","operationId":"getApiV1ExpenditureStructureFieldLifeStageField_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageFieldResource"}}}}},"tags":["Expenditures"]},"put":{"summary":"Update a Field for a Life Stage Section for a Firm","operationId":"putApiV1ExpenditureStructureFieldLifeStageField_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_LifeStageFieldResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_UpdateLifeStageFieldRequest"}}}}},"delete":{"summary":"Delete a Field for a Life Stage Section for a Firm","operationId":"deleteApiV1ExpenditureStructureFieldLifeStageField_uuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"lifeStageField_uuid","description":"The uuid of the Life Stage Field.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/expenditure-structure/field/reorder":{"post":{"summary":"Reorder Life Stage Section Fields for a firm","operationId":"postApiV1ExpenditureStructureFieldReorder","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_LifeStages_ReorderLifeStageFieldRequest"}}}}}},"/api/v1/client/{client_uuid}/expenditure":{"get":{"summary":"Get all expenditures including totals for a client","operationId":"getApiV1ClientClient_uuidExpenditure","description":"Response includes all expenditures for a client along with their calculated income and disposal income","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_ExpenditureResource"}}}}}}}},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"client_uuid","description":"The uuid of the client.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/expenditure/{id}":{"get":{"summary":"Show an individual Expenditure","operationId":"getApiV1ClientClient_uuidExpenditureId","description":"This endpoint allows you to view an individual expenditure.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_ExpenditureResource"}}}}},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"client_uuid","description":"The uuid of the client.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"The ID of the expenditure.","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure_uuid","description":"The uuid of the expenditure.","example":"dc329ca6-bf88-43ad-a398-b2507569c941","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/expenditure/{uuid}":{"delete":{"summary":"Delete an Expenditure","operationId":"deleteApiV1ClientClient_uuidExpenditureUuid","description":"This endpoint allows you to delete an expenditure.","parameters":[],"responses":{},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"client_uuid","description":"The uuid of the client.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"The uuid of the expenditure.","example":"dc329ca6-bf88-43ad-a398-b2507569c941","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}":{"post":{"summary":"Create or Update an Expenditure","operationId":"postApiV1ClientClient_uuidExpenditureLifeStage_uuidLifeStageField_uuid","description":"This endpoint creates an individual expenditure for a client.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_ExpenditureResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Expenditure_StoreOrUpdateExpenditureRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"The uuid of the client.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"The uuid of the parent Life Stage.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStageField_uuid","description":"The uuid of the parent Life Stage Field.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom":{"post":{"summary":"Create an Expenditure","operationId":"postApiV1ClientClient_uuidExpenditureLifeStage_uuidCustom","description":"This endpoint creates an individual custom expenditure for a client.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_CustomExpenditureFieldResource"}}}}},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"client_uuid","description":"The uuid of the client.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"The uuid of the parent Life Stage.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}":{"post":{"summary":"Update an Expenditure","operationId":"postApiV1ClientClient_uuidExpenditureLifeStage_uuidCustomExpenditure_uuid","description":"This endpoint creates an individual expenditure for a client.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Expenditure_ExpenditureResource"}}}}},"tags":["Expenditures"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Expenditure_StoreOrUpdateExpenditureRequest"}}}}},"delete":{"summary":"","operationId":"deleteApiV1ClientClient_uuidExpenditureLifeStage_uuidCustomExpenditure_uuid","description":"","parameters":[],"responses":{},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"client_uuid","description":"The uuid of the client.","example":"f6aa1670-dcf0-484e-a0c5-08590fe89a84","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifeStage_uuid","description":"The uuid of the parent Life Stage.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}},{"in":"path","name":"expenditure_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/life-stage/{factFindSession_uuid}":{"get":{"summary":"","operationId":"getApiV2LifeStageFactFindSession_uuid","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Expenditures"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/firm/{firm}/fca":{"get":{"summary":"Get all FCA Numbers for a Firm","operationId":"getApiV1FirmFirmFca","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FcaNumberResource"}}}}}}}},"tags":["FCA Numbers"]},"post":{"summary":"Create an FCA Number for a Firm","operationId":"postApiV1FirmFirmFca","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FcaNumberResource"}}}}},"tags":["FCA Numbers"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FcaNumber_StoreFcaNumberRequest"}}}}},"parameters":[{"in":"path","name":"firm","description":"The firm.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/firm/{firm_uuid}/fca/{uuid}":{"delete":{"summary":"Delete an unverified FCA Number for a Firm","operationId":"deleteApiV1FirmFirm_uuidFcaUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["FCA Numbers"]},"parameters":[{"in":"path","name":"firm_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/fact-find-employments/{factFindSession_uuid}":{"get":{"summary":"Get employments for a session","operationId":"getApiV2FactFindEmploymentsFactFindSession_uuid","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[status]","description":"Filter by a comma separated list of statuses.","example":"retired,unemployed","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of statuses.","example":"retired,unemployed"}},{"in":"query","name":"filter[employer]","description":"Filter by employer name.","example":"Plannr","required":false,"schema":{"type":"string","description":"Filter by employer name.","example":"Plannr"}},{"in":"query","name":"filter[job_title]","description":"Filter by job title.","example":"Web Developer","required":false,"schema":{"type":"string","description":"Filter by job title.","example":"Web Developer"}},{"in":"query","name":"filter[started_at]","description":"Filter by start date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[started_at]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by start date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[started_at]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[ended_at]","description":"Filter by end date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[ended_at]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by end date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[ended_at]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[email_address]","description":"Filter by job title.","example":"my.client@example.org","required":false,"schema":{"type":"string","description":"Filter by job title.","example":"my.client@example.org"}},{"in":"query","name":"filter[phone_number]","description":"Filter pby hone number - must have international code.","example":"+441234567890","required":false,"schema":{"type":"string","description":"Filter pby hone number - must have international code.","example":"+441234567890"}},{"in":"query","name":"include","description":"A comma separated list of items to include. Possible values are [address, income, email_address, phone_number, turnover_history].","example":"email_address,phone_number","required":false,"schema":{"type":"string","description":"A comma separated list of items to include. Possible values are [address, income, email_address, phone_number, turnover_history].","example":"email_address,phone_number"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_EmploymentResource"}}}}}}}},"tags":["Fact-Find Employment"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/submissions/add-user/{factFindSession_uuid}":{"post":{"summary":"Add a user to a fact-find session","operationId":"postApiV2SubmissionsAddUserFactFindSession_uuid","description":"Creates a prospect account with the provided email address and attaches\nthem to the specified fact-find session.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MinimalAccountResource"}}}}},"tags":["Fact-Find Sessions"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}":{"get":{"summary":"Get single fact-find submissions","operationId":"getApiV2SubmissionsFactFindSession_uuidAccountAccount_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSubmissionResource"}}}}},"tags":["Fact-Find Submission"]},"put":{"summary":"Create or update a fact-find submission","operationId":"putApiV2SubmissionsFactFindSession_uuidAccountAccount_uuid","description":"","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSubmissionResource"}}}}},"tags":["Fact-Find Submission"]},"delete":{"summary":"Delete a fact-find submission","operationId":"deleteApiV2SubmissionsFactFindSession_uuidAccountAccount_uuid","description":"","parameters":[],"responses":{},"tags":["Fact-Find Submission"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/complete":{"post":{"summary":"","operationId":"postApiV2SubmissionsFactFindSession_uuidAccountAccount_uuidComplete","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Fact-Find Submission"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/approve":{"post":{"summary":"","operationId":"postApiV2SubmissionsFactFindSession_uuidAccountAccount_uuidApprove","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Fact-Find Submission"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/reject":{"post":{"summary":"","operationId":"postApiV2SubmissionsFactFindSession_uuidAccountAccount_uuidReject","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Fact-Find Submission"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/submissions/{factFindSession_uuid}/account/{account_uuid}/diff":{"get":{"summary":"","operationId":"getApiV2SubmissionsFactFindSession_uuidAccountAccount_uuidDiff","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Fact-Find Submission"]},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/fact-find-requests":{"get":{"summary":"Get all fact find requests for accounts in a circle","operationId":"getApiV1CirclesCircle_uuidFactFindRequests","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}}}}},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/schema":{"get":{"summary":"Get all fact-find schemas","operationId":"getApiV1FactFindSchema","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[archived]","description":"Filter archived fact-find schemas. E.g filter[archived]=include, filter[archived]=exclude, filter[archived]=only","example":"architecto","required":false,"schema":{"type":"string","description":"Filter archived fact-find schemas. E.g filter[archived]=include, filter[archived]=exclude, filter[archived]=only","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaResource"}}}}}}}},"tags":["Fact-Finds"]},"post":{"summary":"Create a fact-find schema","operationId":"postApiV1FactFindSchema","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaResource"}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_StoreFactFindSchemaRequest"}}}}}},"/api/v1/fact-find/schema/{factFindSchema_uuid}":{"get":{"summary":"Get a fact-find schema","operationId":"getApiV1FactFindSchemaFactFindSchema_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaResource"}}}}},"tags":["Fact-Finds"]},"put":{"summary":"Update a fact-find schema","operationId":"putApiV1FactFindSchemaFactFindSchema_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaResource"}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_UpdateFactFindSchemaRequest"}}}}},"delete":{"summary":"Delete a fact-find schema","operationId":"deleteApiV1FactFindSchemaFactFindSchema_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/schema/{factFindSchema_uuid}/archive":{"post":{"summary":"Archive a fact-find schema","operationId":"postApiV1FactFindSchemaFactFindSchema_uuidArchive","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaResource"}}}}},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/schema/{factFindSchema_uuid}/unarchive":{"post":{"summary":"Archive a fact-find schema","operationId":"postApiV1FactFindSchemaFactFindSchema_uuidUnarchive","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaResource"}}}}},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/schema/{factFindSchema_uuid}/section":{"get":{"summary":"Get all sections for a fact-find schema","operationId":"getApiV1FactFindSchemaFactFindSchema_uuidSection","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, position]. Negative sign to denote DESC.  Defaults to 'position'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, position]. Negative sign to denote DESC.  Defaults to 'position'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaSectionResource"}}}}}}}},"tags":["Fact-Finds"]},"post":{"summary":"Create a schema section","operationId":"postApiV1FactFindSchemaFactFindSchema_uuidSection","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaSectionResource"}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_StoreFactFindSchemaSectionRequest"}}}}},"parameters":[{"in":"path","name":"factFindSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}":{"get":{"summary":"Get a section for a schema","operationId":"getApiV1FactFindSchemaFactFindSchema_uuidSectionFactFindSchemaSection_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaSectionResource"}}}}},"tags":["Fact-Finds"]},"put":{"summary":"Update a schema section","operationId":"putApiV1FactFindSchemaFactFindSchema_uuidSectionFactFindSchemaSection_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaSectionResource"}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_UpdateFactFindSchemaSectionRequest"}}}}},"delete":{"summary":"Delete a schema section","operationId":"deleteApiV1FactFindSchemaFactFindSchema_uuidSectionFactFindSchemaSection_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"factFindSchemaSection_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/schema/{factFindSchema_uuid}/generate-pdf":{"post":{"summary":"Generate the PDF for a fact-find schema and save it to the client's documents.","operationId":"postApiV1FactFindSchemaFactFindSchema_uuidGeneratePdf","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_GenerateFactFindPdfRequest"}}}}},"parameters":[{"in":"path","name":"factFindSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/request/{factFindRequest_uuid}/section":{"get":{"summary":"Retrieve all the sections for the request","operationId":"getApiV1FactFindRequestFactFindRequest_uuidSection","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindSchemaSectionResource"}}}}}}}},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress":{"post":{"summary":"Update a given section progress","operationId":"postApiV1FactFindRequestFactFindRequest_uuidSectionFactFindSchemaSection_uuidProgress","description":"Requires a fact-find pass to be passed in.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_UpdateSectionProgressRequest"}}}}},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"factFindSchemaSection_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/request":{"get":{"summary":"Get all fact-find requests for the user.","operationId":"getApiV1FactFindRequest","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}}}}},"tags":["Fact-Finds"]},"post":{"summary":"Create a fact-find request","operationId":"postApiV1FactFindRequest","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_StoreFactFindRequestRequest"}}}}}},"/api/v1/fact-find/request/{factFindRequest_uuid}":{"get":{"summary":"Get a fact-find request","operationId":"getApiV1FactFindRequestFactFindRequest_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}},"tags":["Fact-Finds"]},"delete":{"summary":"Delete a fact-find request","operationId":"deleteApiV1FactFindRequestFactFindRequest_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/request/{factFindRequest_uuid}/complete":{"post":{"summary":"Complete a fact-find request for a given fact-find pass","operationId":"postApiV1FactFindRequestFactFindRequest_uuidComplete","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_CompleteFactFindRequest"}}}}},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/request/{factFindRequest_uuid}/finish":{"post":{"summary":"Finish the fact-find request","operationId":"postApiV1FactFindRequestFactFindRequest_uuidFinish","description":"Will mark the fact-find request as completed overall regardless of fact-find pass progress.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFind_FactFindRequestResource"}}}}},"tags":["Fact-Finds"]},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/fact-find/request/{factFindRequest_uuid}/create-account":{"post":{"summary":"Create an additional account on a client's fact-find","operationId":"postApiV1FactFindRequestFactFindRequest_uuidCreateAccount","description":"This route is for client's only - this allows them to add accounts to their fact-find","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Fact-Finds"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FactFind_CreateAccountOnFactFindRequest"}}}}},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/upload-files/create":{"post":{"summary":"Create the file records for all files added to the Filepond queue.","operationId":"postApiV1UploadFilesCreate","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["File Uploading"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_File_FileUploadRequest"}}}}}},"/api/v1/upload-files":{"post":{"summary":"Upload the file","operationId":"postApiV1UploadFiles","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["File Uploading"]},"delete":{"summary":"Revert the file uploading","operationId":"deleteApiV1UploadFiles","description":"","parameters":[],"responses":{},"tags":["File Uploading"]}},"/api/v1/file/direct-upload":{"post":{"summary":"Directly upload a file.","operationId":"postApiV1FileDirectUpload","description":"Must be of Content-Type multipart/form-data","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/_App_Http_Resources_FileResource"}}}}},"tags":["File Uploading"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_File_DirectFileUploadRequest"}}}}}},"/api/v1/file/create-file-record":{"post":{"summary":"Create a file record for a given Folder","operationId":"postApiV1FileCreateFileRecord","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["File Uploading"]}},"/api/v1/firm/{firm_uuid}/documents":{"get":{"summary":"Get root folder for a firm","operationId":"getApiV1FirmFirm_uuidDocuments","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"firm_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/documents":{"get":{"summary":"Get root folder for a client","operationId":"getApiV1AccountAccount_uuidDocuments","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/documents":{"get":{"summary":"Get root folder for a circle","operationId":"getApiV1CirclesCircle_uuidDocuments","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/illustration/{illustration_uuid}/documents":{"get":{"summary":"Get root folder for an illustration","operationId":"getApiV1IllustrationIllustration_uuidDocuments","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"illustration_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/cases/{case_uuid}/documents":{"get":{"summary":"Get root folder for a case","operationId":"getApiV1CasesCase_uuidDocuments","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"case_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/conversation/{conversation_uuid}/documents":{"get":{"summary":"Get conversation files","operationId":"getApiV1ConversationConversation_uuidDocuments","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"conversation_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/folder":{"post":{"summary":"Create a folder","operationId":"postApiV1Folder","description":"To create a subfolder pass the parent folder UUID under parent key.\nThis subfolder will inherit the documentable_type and documentable_uuid of its parent folder.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Folder_StoreFolderRequest"}}}}}},"/api/v1/folder/{uuid}":{"get":{"summary":"Get a folder","operationId":"getApiV1FolderUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"put":{"summary":"Update and/or move folders","operationId":"putApiV1FolderUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Folder_UpdateFolderRequest"}}}}},"delete":{"summary":"Delete a folder","operationId":"deleteApiV1FolderUuid","description":"This will also delete all of the folders contents.","parameters":[],"responses":{},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/folder/{folder_uuid}/files":{"get":{"summary":"Get all files in a folder","operationId":"getApiV1FolderFolder_uuidFiles","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].","example":"?include=documentable,folder","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].","example":"?include=documentable,folder"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[include_subfolders]","description":"Denotes whether to include files from the requested folders recursive sub folders if the account can view them.","example":true,"required":false,"schema":{"type":"boolean","description":"Denotes whether to include files from the requested folders recursive sub folders if the account can view them.","example":true}},{"in":"query","name":"filter[folder_uuid]","description":"Filter by a comma separated list of folder UUIDs that belong to the folder in the URL.","example":"ceffbc98-1849-52f8-b6f9-f8ae0ef12886,ad6ad0a4-2a89-52a9-93c7-d6df0f0a6582","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of folder UUIDs that belong to the folder in the URL.","example":"ceffbc98-1849-52f8-b6f9-f8ae0ef12886,ad6ad0a4-2a89-52a9-93c7-d6df0f0a6582"}},{"in":"query","name":"filter[name]","description":"File name to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"File name to filter by.","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"File uploaded_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File uploaded_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"File uploaded_at date to filter to a specific date, can be used with date_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File uploaded_at date to filter to a specific date, can be used with date_from for a range.","example":"architecto"}},{"in":"query","name":"filter[extension]","description":"File extension to filter by.","example":"png","required":false,"schema":{"type":"string","description":"File extension to filter by.","example":"png"}},{"in":"query","name":"filter[uploaded_by_uuid]","description":"Filter by a comma separated list of account UUIDs of who uploaded the file.","example":"50d585db-54cd-5a34-ae24-fb2929537535","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs of who uploaded the file.","example":"50d585db-54cd-5a34-ae24-fb2929537535"}},{"in":"query","name":"filter[size]","description":"The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.","example":"0,25000","required":false,"schema":{"type":"string","description":"The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.","example":"0,25000"}},{"in":"query","name":"filter[last_modified_from]","description":"File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.","example":"architecto"}},{"in":"query","name":"filter[last_modified_to]","description":"File last_modified date to filter to a specific date, can be used with last_modified_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File last_modified date to filter to a specific date, can be used with last_modified_from for a range.","example":"architecto"}},{"in":"query","name":"filter[original_created_from]","description":"File original_created_at date to filter from a specific date, can be used with original_created_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File original_created_at date to filter from a specific date, can be used with original_created_to for a range.","example":"architecto"}},{"in":"query","name":"filter[original_created_to]","description":"File original_created_at date to filter to a specific date, can be used with original_created_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File original_created_at date to filter to a specific date, can be used with original_created_from for a range.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-updated_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"folder_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/folder/{folder_uuid}/permissions":{"post":{"summary":"Update folder permissions","operationId":"postApiV1FolderFolder_uuidPermissions","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Filesystem"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Folder_UpdateFolderPermissionRequest"}}}}},"parameters":[{"in":"path","name":"folder_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/folder/{folder_uuid}/tree":{"get":{"summary":"Get a folder structure","operationId":"getApiV1FolderFolder_uuidTree","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"folder_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/file/bin":{"get":{"summary":"View deleted files","operationId":"getApiV1FileBin","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].","example":"?include=documentable,folder","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].","example":"?include=documentable,folder"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"File name to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"File name to filter by.","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"File uploaded_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File uploaded_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"File uploaded_at date to filter to a specific date, can be used with date_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File uploaded_at date to filter to a specific date, can be used with date_from for a range.","example":"architecto"}},{"in":"query","name":"filter[extension]","description":"File extension to filter by.","example":"png","required":false,"schema":{"type":"string","description":"File extension to filter by.","example":"png"}},{"in":"query","name":"filter[uploaded_by_uuid]","description":"Filter by a comma separated list of account UUIDs of who uploaded the file.","example":"50d585db-54cd-5a34-ae24-fb2929537535","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs of who uploaded the file.","example":"50d585db-54cd-5a34-ae24-fb2929537535"}},{"in":"query","name":"filter[size]","description":"The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.","example":"0,25000","required":false,"schema":{"type":"string","description":"The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.","example":"0,25000"}},{"in":"query","name":"filter[last_modified_from]","description":"File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.","example":"architecto"}},{"in":"query","name":"filter[last_modified_to]","description":"File last_modified date to filter to a specific date, can be used with last_modified_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File last_modified date to filter to a specific date, can be used with last_modified_from for a range.","example":"architecto"}},{"in":"query","name":"filter[original_created_from]","description":"File original_created_at date to filter from a specific date, can be used with original_created_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File original_created_at date to filter from a specific date, can be used with original_created_to for a range.","example":"architecto"}},{"in":"query","name":"filter[original_created_to]","description":"File original_created_at date to filter to a specific date, can be used with original_created_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File original_created_at date to filter to a specific date, can be used with original_created_from for a range.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}}}}},"tags":["Filesystem"]}},"/api/v1/file":{"post":{"summary":"Assign file","operationId":"postApiV1File","description":"Set the unassigned files to belong to a documentable item and folder.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}},"tags":["Filesystem"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_File_StoreFileRequest"}}}}}},"/api/v1/file/{uuid}":{"get":{"summary":"Get a file","operationId":"getApiV1FileUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}},"tags":["Filesystem"]},"put":{"summary":"Update and/or move a file","operationId":"putApiV1FileUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}},"tags":["Filesystem"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_File_UpdateFileRequest"}}}}},"delete":{"summary":"Delete a file","operationId":"deleteApiV1FileUuid","description":"","parameters":[],"responses":{},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/files/{model}/{modelUuid}":{"get":{"summary":"Get all files on a documentable model","operationId":"getApiV1FilesModelModelUuid","description":"Provide a documentable model as a string ('account', 'case', 'firm', or 'plan') and the UUID for the model.\nThis index will get all files within the folder tree starting from the root folder of the provided model.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].","example":"?include=documentable,folder","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].","example":"?include=documentable,folder"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"File name to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"File name to filter by.","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"File uploaded_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File uploaded_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"File uploaded_at date to filter to a specific date, can be used with date_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File uploaded_at date to filter to a specific date, can be used with date_from for a range.","example":"architecto"}},{"in":"query","name":"filter[extension]","description":"File extension to filter by.","example":"png","required":false,"schema":{"type":"string","description":"File extension to filter by.","example":"png"}},{"in":"query","name":"filter[uploaded_by_uuid]","description":"Filter by a comma separated list of account UUIDs of who uploaded the file.","example":"50d585db-54cd-5a34-ae24-fb2929537535","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs of who uploaded the file.","example":"50d585db-54cd-5a34-ae24-fb2929537535"}},{"in":"query","name":"filter[uploaded_by]","description":"[DEPRECATED] Use uploaded_by_uuid instead. The account the uploaded the file to filter by. Takes a UUID.","example":16,"required":false,"schema":{"type":"integer","description":"[DEPRECATED] Use uploaded_by_uuid instead. The account the uploaded the file to filter by. Takes a UUID.","example":16}},{"in":"query","name":"filter[size]","description":"The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.","example":"0,25000","required":false,"schema":{"type":"string","description":"The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.","example":"0,25000"}},{"in":"query","name":"filter[last_modified_from]","description":"File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.","example":"architecto"}},{"in":"query","name":"filter[last_modified_to]","description":"File last_modified date to filter to a specific date, can be used with last_modified_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File last_modified date to filter to a specific date, can be used with last_modified_from for a range.","example":"architecto"}},{"in":"query","name":"filter[original_created_from]","description":"File original_created_at date to filter from a specific date, can be used with original_created_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File original_created_at date to filter from a specific date, can be used with original_created_to for a range.","example":"architecto"}},{"in":"query","name":"filter[original_created_to]","description":"File original_created_at date to filter to a specific date, can be used with original_created_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"File original_created_at date to filter to a specific date, can be used with original_created_from for a range.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-updated_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"model","description":"","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"modelUuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/file/{file}/restore":{"put":{"summary":"Restore a file","operationId":"putApiV1FileFileRestore","description":"","parameters":[],"responses":{},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"file","description":"The file.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/file/{file_uuid}/copy":{"put":{"summary":"Copy a file","operationId":"putApiV1FileFile_uuidCopy","description":"Copy a file to the current directory or to the given folder.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FileResource"}}}}},"tags":["Filesystem"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_File_CopyFileRequest"}}}}},"parameters":[{"in":"path","name":"file_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/file/{file_uuid}/download":{"get":{"summary":"Download a file.","operationId":"getApiV1FileFile_uuidDownload","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"file_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/file/{file_uuid}/download/temporary-url":{"get":{"summary":"Download a file via a temporary URL","operationId":"getApiV1FileFile_uuidDownloadTemporaryUrl","description":"Making a GET request to this endpoint will generate a temporary URL which will\nexpire five minutes from creation.","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"file_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/file/{file}/forceDelete":{"delete":{"summary":"Force delete a file","operationId":"deleteApiV1FileFileForceDelete","description":"","parameters":[],"responses":{},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"file","description":"The file.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/documents":{"get":{"summary":"Get root folder for a plan","operationId":"getApiV1PlansPlan_uuidDocuments","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FolderResource"}}}}},"tags":["Filesystem"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/firm":{"get":{"summary":"Get all firms","operationId":"getApiV1Firm","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Firms"]}},"/api/v1/firm/{uuid}":{"get":{"summary":"Get a firm","operationId":"getApiV1FirmUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FirmResource"}}}}},"tags":["Firms"]},"put":{"summary":"Update a firm","operationId":"putApiV1FirmUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FirmResource"}}}}},"tags":["Firms"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Firm_UpdateFirmRequest"}}}}},"delete":{"summary":"Delete a firm","operationId":"deleteApiV1FirmUuid","description":"","parameters":[],"responses":{},"tags":["Firms"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/firm/{firm_uuid}/branding":{"post":{"summary":"Update firm branding","operationId":"postApiV1FirmFirm_uuidBranding","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FirmResource"}}}}},"tags":["Firms"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Firm_UpdateFirmBrandingRequest"}}}}},"parameters":[{"in":"path","name":"firm_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/firm/{firm_uuid}/settings":{"post":{"summary":"Update firm settings","operationId":"postApiV1FirmFirm_uuidSettings","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FirmResource"}}}}},"tags":["Firms"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Firm_UpdateFirmSettingsRequest"}}}}},"parameters":[{"in":"path","name":"firm_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form":{"get":{"summary":"Get all forms","operationId":"getApiV1Form","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[live]","description":"Get forms that have or have not been published.","example":true,"required":false,"schema":{"type":"boolean","description":"Get forms that have or have not been published.","example":true}},{"in":"query","name":"filter[visibility]","description":"Get forms of this visibility value, Available types are 'hidden', 'public', 'private', and 'internal'.","example":"'hidden'","required":false,"schema":{"type":"string","description":"Get forms of this visibility value, Available types are 'hidden', 'public', 'private', and 'internal'.","example":"'hidden'"}},{"in":"query","name":"filter[title]","description":"Get forms with a title that match this filter.","example":"'Annual review'","required":false,"schema":{"type":"string","description":"Get forms with a title that match this filter.","example":"'Annual review'"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, title]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, title]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormResource"}}}}}}}},"tags":["Form Builder"]},"post":{"summary":"Create a form","operationId":"postApiV1Form","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_StoreFormRequest"}}}}}},"/api/v1/form/{uuid}":{"get":{"summary":"Get a form","operationId":"getApiV1FormUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormResource"}}}}},"tags":["Form Builder"]},"put":{"summary":"Update a form","operationId":"putApiV1FormUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_UpdateFormRequest"}}}}},"delete":{"summary":"Delete a form","operationId":"deleteApiV1FormUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/linked-form-questions":{"get":{"summary":"Get all Linked Questions","operationId":"getApiV1LinkedFormQuestions","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Get all questions of this form question type","example":"architecto","required":false,"schema":{"type":"string","description":"Get all questions of this form question type","example":"architecto"}},{"in":"query","name":"filter[field]","description":"Get questions that match this field","example":"architecto","required":false,"schema":{"type":"string","description":"Get questions that match this field","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [type, field]. Negative sign to denote DESC.  Defaults to 'field'.","example":"-field","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [type, field]. Negative sign to denote DESC.  Defaults to 'field'.","example":"-field"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormBuilder_LinkedFormQuestionResource"}}}}}}}},"tags":["Form Builder"]}},"/api/v1/custom-linked-form-questions":{"get":{"summary":"Get all linked custom field questions","operationId":"getApiV1CustomLinkedFormQuestions","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormBuilder_LinkedFormQuestionResource"}}}}}}}},"tags":["Form Builder"]}},"/api/v1/submission-request/received/{account}":{"get":{"summary":"Get all received form submission requests","operationId":"getApiV1SubmissionRequestReceivedAccount","description":"Get all form submission requests that were received by the authenticated account, or by the account given in the URL.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[form.title]","description":"@deprecated Please use filter[form_title] instead.","example":"architecto","required":false,"schema":{"type":"string","description":"@deprecated Please use filter[form_title] instead.","example":"architecto"}},{"in":"query","name":"filter[form_title]","description":"Filter by partial form titles.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial form titles.","example":"architecto"}},{"in":"query","name":"filter[sender_uuids]","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb"}},{"in":"query","name":"filter[receiver_uuids]","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"account","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/submission-request/sent":{"get":{"summary":"Get all sent form submission requests","operationId":"getApiV1SubmissionRequestSent","description":"Get all form submission requests that were sent by the authenticated account.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[form.title]","description":"@deprecated Please use filter[form_title] instead.","example":"architecto","required":false,"schema":{"type":"string","description":"@deprecated Please use filter[form_title] instead.","example":"architecto"}},{"in":"query","name":"filter[form_title]","description":"Filter by partial form titles.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial form titles.","example":"architecto"}},{"in":"query","name":"filter[sender_uuids]","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb"}},{"in":"query","name":"filter[receiver_uuids]","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}}}}},"tags":["Form Builder"]}},"/api/v1/submission-request":{"get":{"summary":"Get all submission requests on a form","operationId":"getApiV1SubmissionRequest","description":"This endpoint can only be hit by senior employees\nIt will show every form submission request created for this form\nIncluding whom sent the request and the recipient","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[form.title]","description":"@deprecated Please use filter[form_title] instead.","example":"architecto","required":false,"schema":{"type":"string","description":"@deprecated Please use filter[form_title] instead.","example":"architecto"}},{"in":"query","name":"filter[form_title]","description":"Filter by partial form titles.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial form titles.","example":"architecto"}},{"in":"query","name":"filter[sender_uuids]","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb"}},{"in":"query","name":"filter[receiver_uuids]","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}}}}},"tags":["Form Builder"]}},"/api/v1/submission-request/{uuid}":{"get":{"summary":"Get a submission request","operationId":"getApiV1SubmissionRequestUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}},"tags":["Form Builder"]},"delete":{"summary":"Delete a submission request","operationId":"deleteApiV1SubmissionRequestUuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/duplicate":{"post":{"summary":"Make a duplicate of an existing form","operationId":"postApiV1FormForm_uuidDuplicate","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormResource"}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/publish":{"post":{"summary":"Make a form live","operationId":"postApiV1FormForm_uuidPublish","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/unpublish":{"post":{"summary":"Make a live form no longer live (only works on forms with no submissions)","operationId":"postApiV1FormForm_uuidUnpublish","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/section":{"post":{"summary":"Create a section for a form","operationId":"postApiV1FormForm_uuidSection","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSectionResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_StoreFormSectionRequest"}}}}},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/section/{uuid}":{"get":{"summary":"Get a form's section","operationId":"getApiV1FormForm_uuidSectionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSectionResource"}}}}},"tags":["Form Builder"]},"put":{"summary":"Update a form's section","operationId":"putApiV1FormForm_uuidSectionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSectionResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_UpdateFormSectionRequest"}}}}},"delete":{"summary":"Delete a form's section","operationId":"deleteApiV1FormForm_uuidSectionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/question":{"post":{"summary":"Create a question for a section","operationId":"postApiV1FormForm_uuidQuestion","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormQuestionResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_StoreFormQuestionRequest"}}}}},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/question/{uuid}":{"get":{"summary":"Get a question","operationId":"getApiV1FormForm_uuidQuestionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormQuestionResource"}}}}},"tags":["Form Builder"]},"put":{"summary":"Update a section's question","operationId":"putApiV1FormForm_uuidQuestionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormQuestionResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_UpdateFormQuestionRequest"}}}}},"delete":{"summary":"Delete a section's question","operationId":"deleteApiV1FormForm_uuidQuestionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission":{"get":{"summary":"Get all submissions for a form","operationId":"getApiV1FormForm_uuidSubmission","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [account]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [account]","example":"architecto"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[stage]","description":"Filter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.","example":"architecto"}},{"in":"query","name":"filter[account]","description":"Name of the account of who the submission was against.","example":"architecto","required":false,"schema":{"type":"string","description":"Name of the account of who the submission was against.","example":"architecto"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of accounts UUIDs of who the form was submitted against.","example":"940f9fe8-14cf-5674-bfe0-0554c8fa94bf,6d762f53-bfe8-5f84-b8b3-90d7beb01afe","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs of who the form was submitted against.","example":"940f9fe8-14cf-5674-bfe0-0554c8fa94bf,6d762f53-bfe8-5f84-b8b3-90d7beb01afe"}},{"in":"query","name":"filter[submitted_by_uuid]","description":"Filter by a comma separated list of account UUIDs of who submitted the form.","example":"a815517f-103d-5e31-bd09-fca00ed1d191,89bee829-900a-50e5-adca-635677137933","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs of who submitted the form.","example":"a815517f-103d-5e31-bd09-fca00ed1d191,89bee829-900a-50e5-adca-635677137933"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs belonging to accounts of who the form was submitted against.","example":"6c7294bc-c782-553f-b661-cc2e1bc06a0c,6207bd5b-9053-5aaf-bfef-14dec5d5c017","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs belonging to accounts of who the form was submitted against.","example":"6c7294bc-c782-553f-b661-cc2e1bc06a0c,6207bd5b-9053-5aaf-bfef-14dec5d5c017"}},{"in":"query","name":"filter[hide_null_accounts]","description":"Hide form submissions  that are not linked to an account, this could be submissions on public forms.","example":false,"required":false,"schema":{"type":"boolean","description":"Hide form submissions  that are not linked to an account, this could be submissions on public forms.","example":false}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionResource"}}}}}}}},"tags":["Form Builder"]},"post":{"summary":"Create a submission to a form","operationId":"postApiV1FormForm_uuidSubmission","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_StoreFormSubmissionRequest"}}}}},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission/{uuid}":{"get":{"summary":"Get a submission","operationId":"getApiV1FormForm_uuidSubmissionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionResource"}}}}},"tags":["Form Builder"]},"delete":{"summary":"Delete a submission","operationId":"deleteApiV1FormForm_uuidSubmissionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}":{"get":{"summary":"Get all submission for a form authored by a specific account","operationId":"getApiV1FormForm_uuidSubmissionAuthoredByAuthor_uuid","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [account]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [account]","example":"architecto"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[stage]","description":"Flter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.","example":"architecto","required":false,"schema":{"type":"string","description":"Flter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.","example":"architecto"}},{"in":"query","name":"filter[account]","description":"Name of the account of who the submission was against.","example":"architecto","required":false,"schema":{"type":"string","description":"Name of the account of who the submission was against.","example":"architecto"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of accounts UUIDs of who the form was submitted against.","example":"940f9fe8-14cf-5674-bfe0-0554c8fa94bf,6d762f53-bfe8-5f84-b8b3-90d7beb01afe","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of accounts UUIDs of who the form was submitted against.","example":"940f9fe8-14cf-5674-bfe0-0554c8fa94bf,6d762f53-bfe8-5f84-b8b3-90d7beb01afe"}},{"in":"query","name":"filter[submitted_by_uuid]","description":"Filter by a comma separated list of account UUIDs of who submitted the form.","example":"a815517f-103d-5e31-bd09-fca00ed1d191,89bee829-900a-50e5-adca-635677137933","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs of who submitted the form.","example":"a815517f-103d-5e31-bd09-fca00ed1d191,89bee829-900a-50e5-adca-635677137933"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs belonging to accounts of who the form was submitted against.","example":"6c7294bc-c782-553f-b661-cc2e1bc06a0c,6207bd5b-9053-5aaf-bfef-14dec5d5c017","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs belonging to accounts of who the form was submitted against.","example":"6c7294bc-c782-553f-b661-cc2e1bc06a0c,6207bd5b-9053-5aaf-bfef-14dec5d5c017"}},{"in":"query","name":"filter[hide_null_accounts]","description":"Hide form submissions  that are not linked to an account, this could be submissions on public forms.","example":false,"required":false,"schema":{"type":"boolean","description":"Hide form submissions  that are not linked to an account, this could be submissions on public forms.","example":false}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionResource"}}}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"author_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission/{submission_uuid}/answer":{"get":{"summary":"Get all answers for a submission","operationId":"getApiV1FormForm_uuidSubmissionSubmission_uuidAnswer","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, value]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, value]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormAnswerResource"}}}}}}}},"tags":["Form Builder"]},"post":{"summary":"Submit answers to a submission","operationId":"postApiV1FormForm_uuidSubmissionSubmission_uuidAnswer","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_AnswerFormSubmissionRequest"}}}}},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"submission_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission/{submission_uuid}/submit":{"post":{"summary":"Change the form status to submitted","operationId":"postApiV1FormForm_uuidSubmissionSubmission_uuidSubmit","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"submission_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission-request":{"get":{"summary":"Get all submission requests on a form","operationId":"getApiV1FormForm_uuidSubmissionRequest","description":"This endpoint can only be hit by senior employees\nIt will show every form submission request created for this form\nIncluding whom sent the request and the recipient","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[form.title]","description":"@deprecated Please use filter[form_title] instead.","example":"architecto","required":false,"schema":{"type":"string","description":"@deprecated Please use filter[form_title] instead.","example":"architecto"}},{"in":"query","name":"filter[form_title]","description":"Filter by partial form titles.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial form titles.","example":"architecto"}},{"in":"query","name":"filter[sender_uuids]","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of employee account UUIDs of who sent the form requests.","example":"989849a4-8c38-52b9-a8c0-362aad8865f6,b392ab07-0d68-52ec-8e30-6d1344f533cb"}},{"in":"query","name":"filter[receiver_uuids]","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client account UUIDs of who received the form requests.","example":"c51db3ca-423c-5437-a6f9-63cbb3468a3c,3657a8c7-36df-5096-aee3-46d5c26978b0"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.","example":"62873e7b-1036-5690-bee8-d119753c1aac,fd32a1aa-6250-56d5-99f7-553f3d3f44c7"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, description]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}":{"put":{"summary":"Update a form submission request","operationId":"putApiV1FormForm_uuidSubmissionRequestSubmissionRequest_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_UpdateFormSubmissionRequestRequest"}}}}},"delete":{"summary":"Delete a submission request","operationId":"deleteApiV1FormForm_uuidSubmissionRequestSubmissionRequest_uuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Form Builder"]},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"submissionRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/form/{form_uuid}/submission-request/{account_uuid}":{"post":{"summary":"Store a submission request","operationId":"postApiV1FormForm_uuidSubmissionRequestAccount_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FormSubmissionRequestResource"}}}}},"tags":["Form Builder"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_FormBuilder_StoreFormSubmissionRequestRequest"}}}}},"parameters":[{"in":"path","name":"form_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/goal":{"get":{"summary":"Get all goals","operationId":"getApiV1ClientClient_uuidGoal","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [shared_owner].","example":"?include=shared_owner","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [shared_owner].","example":"?include=shared_owner"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, progress, complete_goal_by, priority]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-complete_goal_by","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, progress, complete_goal_by, priority]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-complete_goal_by"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}}}}},"tags":["Goals (v1)"]},"post":{"summary":"Create a goal","operationId":"postApiV1ClientClient_uuidGoal","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}},"tags":["Goals (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreGoalRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/goal/{uuid}":{"get":{"summary":"Show a goal","operationId":"getApiV1ClientClient_uuidGoalUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}},"tags":["Goals (v1)"]},"put":{"summary":"Update a goal","operationId":"putApiV1ClientClient_uuidGoalUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}},"tags":["Goals (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateGoalRequest"}}}}},"delete":{"summary":"Destroy a goal","operationId":"deleteApiV1ClientClient_uuidGoalUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Goals (v1)"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/goals":{"get":{"summary":"Get all goals","operationId":"getApiV2Goals","description":"This endpoint will return all goals in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, visibleToCircles].","example":"?include=accounts,visibleToCircles","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, visibleToCircles].","example":"?include=accounts,visibleToCircles"}},{"in":"query","name":"include_circle_goals","description":"When authenticated as a client, you can opt to include other goals belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true,"required":false,"schema":{"type":"boolean","description":"When authenticated as a client, you can opt to include other goals belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter by name.","example":"My Goal","required":false,"schema":{"type":"string","description":"Filter by name.","example":"My Goal"}},{"in":"query","name":"filter[description]","description":"Filter by description.","example":"My goal description","required":false,"schema":{"type":"string","description":"Filter by description.","example":"My goal description"}},{"in":"query","name":"filter[progress]","description":"Filter by progress. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[progress]=\u003e=20,\u003c=80","required":false,"schema":{"type":"string","description":"Filter by progress. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[progress]=\u003e=20,\u003c=80"}},{"in":"query","name":"filter[complete_goal_by]","description":"Filter by Complete Goal By. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[progress]=\u003e=2024-03-05,\u003c=2024-03-10","required":false,"schema":{"type":"string","description":"Filter by Complete Goal By. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[progress]=\u003e=2024-03-05,\u003c=2024-03-10"}},{"in":"query","name":"filter[priority]","description":"Filter by priority. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[priority]=\u003e=2,\u003c=5","required":false,"schema":{"type":"string","description":"Filter by priority. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[priority]=\u003e=2,\u003c=5"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, progress, complete_goal_by, priority]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-complete_goal_by","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, progress, complete_goal_by, priority]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-complete_goal_by"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}}}}},"tags":["Goals (v2)"]},"post":{"summary":"Create a goal","operationId":"postApiV2Goals","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}},"tags":["Goals (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Goals_StoreGoalRequest"}}}}}},"/api/v2/goals/{uuid}":{"get":{"summary":"Show a goal","operationId":"getApiV2GoalsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}},"tags":["Goals (v2)"]},"put":{"summary":"Update a goal","operationId":"putApiV2GoalsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GoalResource"}}}}},"tags":["Goals (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Goals_UpdateGoalRequest"}}}}},"delete":{"summary":"Delete a goal","operationId":"deleteApiV2GoalsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Goals (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/groups":{"get":{"summary":"Get all account groups","operationId":"getApiV1AccountAccount_uuidGroups","description":"Get all the groups where the account is participating in.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count].","example":"participants,participants_count","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count].","example":"participants,participants_count"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Name to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Name to filter by","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GroupResource"}}}}}}}},"tags":["Groups"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/business-units/{business_unit_uuid}/groups":{"get":{"summary":"Get all business unit groups","operationId":"getApiV1BusinessUnitsBusiness_unit_uuidGroups","description":"Get all the groups where the account is participating in.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Name to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Name to filter by","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GroupResource"}}}}}}}},"tags":["Groups"]},"parameters":[{"in":"path","name":"business_unit_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/group":{"get":{"summary":"Get all groups","operationId":"getApiV1Group","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Name to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Name to filter by","example":"architecto"}},{"in":"query","name":"filter[business_unit]","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include. Valid relationships are [business_unit, participants].","example":"business_unit,participants","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include. Valid relationships are [business_unit, participants].","example":"business_unit,participants"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GroupResource"}}}}}}}},"tags":["Groups"]},"post":{"summary":"Create a group","operationId":"postApiV1Group","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GroupResource"}}}}},"tags":["Groups"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Group_StoreGroupRequest"}}}}}},"/api/v1/group/{uuid}":{"get":{"summary":"Get a group","operationId":"getApiV1GroupUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GroupResource"}}}}},"tags":["Groups"]},"put":{"summary":"Update a group","operationId":"putApiV1GroupUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_GroupResource"}}}}},"tags":["Groups"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Group_UpdateGroupRequest"}}}}},"delete":{"summary":"Delete a group","operationId":"deleteApiV1GroupUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Groups"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/group/{group_uuid}/participants":{"post":{"summary":"Add participants to a group","operationId":"postApiV1GroupGroup_uuidParticipants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Groups"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Group_AddAccountsToGroupRequest"}}}}},"get":{"summary":"Get a group's participants","operationId":"getApiV1GroupGroup_uuidParticipants","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Name to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Name to filter by","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Account type to filter by. Valid fields are [employee, client, external].","example":"architecto","required":false,"schema":{"type":"string","description":"Account type to filter by. Valid fields are [employee, client, external].","example":"architecto"}},{"in":"query","name":"filter[role]","description":"Account role to filter by. Valid fields are [owner, admin, member, individual, trust, business, joint, introducer].","example":"architecto","required":false,"schema":{"type":"string","description":"Account role to filter by. Valid fields are [owner, admin, member, individual, trust, business, joint, introducer].","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, first_name, last_name, updated_at, type]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, first_name, last_name, updated_at, type]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"the amount of addon subscriptions per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of addon subscriptions per page (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}}}}},"tags":["Groups"]},"delete":{"summary":"Remove participants from a group","operationId":"deleteApiV1GroupGroup_uuidParticipants","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Groups"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Group_RemoveAccountsFromGroupRequest"}}}}},"parameters":[{"in":"path","name":"group_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings":{"post":{"summary":"Create a holding","operationId":"postApiV1PlansPlan_uuidSubAccountsSubAccount_uuidHoldings","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_HoldingResource"}}}}},"tags":["Holdings"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreHoldingRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}":{"get":{"summary":"Get a holding","operationId":"getApiV1PlansPlan_uuidSubAccountsSubAccount_uuidHoldingsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_HoldingResource"}}}}},"tags":["Holdings"]},"put":{"summary":"Update a holding","operationId":"putApiV1PlansPlan_uuidSubAccountsSubAccount_uuidHoldingsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_HoldingResource"}}}}},"tags":["Holdings"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateHoldingRequest"}}}}},"delete":{"summary":"Delete a holding","operationId":"deleteApiV1PlansPlan_uuidSubAccountsSubAccount_uuidHoldingsUuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_HoldingResource"}}}}},"tags":["Holdings"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings":{"post":{"summary":"Sync Holdings on a Sub Account","operationId":"postApiV1PlansPlan_uuidSubAccountsSubAccount_uuidSyncHoldings","description":"","parameters":[],"responses":{"202":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Holdings"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_SyncHoldingsRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/holdings/{subAccount}":{"get":{"summary":"Get all holdings","operationId":"getApiV1PlansPlan_uuidHoldingsSubAccount","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [sub_account, portfolio].","example":"?include=sub_account,portfolio","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [sub_account, portfolio].","example":"?include=sub_account,portfolio"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[is_active]","description":"Filter holdings to only active or only inactive holdings. Defaults to true.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter holdings to only active or only inactive holdings. Defaults to true.","example":false}},{"in":"query","name":"filter[portfolio_uuid]","description":"Filter holdings by a given portfolio_uuid. Defaults to showing holdings from the active portfolio or all holdings.","example":"51b6f3d0-2eaa-4947-904b-aa1bf72d0849","required":false,"schema":{"type":"string","description":"Filter holdings by a given portfolio_uuid. Defaults to showing holdings from the active portfolio or all holdings.","example":"51b6f3d0-2eaa-4947-904b-aa1bf72d0849"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, units, unit_price, is_active]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, units, unit_price, is_active]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_HoldingResource"}}}}}}}},"tags":["Holdings"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount","description":"Optional parameter. An optional sub-account to constrain the results by.","required":true,"schema":{"type":"integer"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":16}}}]},"/api/v1/illustration":{"post":{"summary":"Store an illustration","operationId":"postApiV1Illustration","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IllustrationResource"}}}}},"tags":["Illustrations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Illustration_StoreIllustrationRequest"}}}}}},"/api/v1/illustration/{uuid}":{"get":{"summary":"Show an illustration","operationId":"getApiV1IllustrationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IllustrationResource"}}}}},"tags":["Illustrations"]},"put":{"summary":"Update an Illustration","operationId":"putApiV1IllustrationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IllustrationResource"}}}}},"tags":["Illustrations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Illustration_UpdateIllustrationRequest"}}}}},"delete":{"summary":"Delete an illustration","operationId":"deleteApiV1IllustrationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Illustrations"]},"parameters":[{"in":"path","name":"uuid","description":"The uuid of the illustration which to update.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/illustration/{illustration_uuid}/proceed":{"post":{"summary":"Proceed an illustration to account opening application","operationId":"postApiV1IllustrationIllustration_uuidProceed","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Illustrations"]},"parameters":[{"in":"path","name":"illustration_uuid","description":"The uuid of the illustration to proceed with","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/illustration/{illustration_uuid}/generate":{"post":{"summary":"Generate an Illustration","operationId":"postApiV1IllustrationIllustration_uuidGenerate","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IllustrationResource"}}}}},"tags":["Illustrations"]},"parameters":[{"in":"path","name":"illustration_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"The uuid of the illustration which to generate.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/import":{"get":{"summary":"Get all imports","operationId":"getApiV1Import","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [initiatedBy].","example":"?include=initiatedBy","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [initiatedBy].","example":"?include=initiatedBy"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[types]","description":"Filter by a comma separated list of import types.","example":"charges,clients","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of import types.","example":"charges,clients"}},{"in":"query","name":"filter[statuses]","description":"Filter by a comma separated list of import statuses.","example":"mapping,complete","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of import statuses.","example":"mapping,complete"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportResource"}}}}}}}},"tags":["Imports"]},"post":{"summary":"Create the import","operationId":"postApiV1Import","description":"Fist step of the import process, must be mapped before it can be started\nMust be of Content-Type multipart/form-data","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportResource"}}}}},"tags":["Imports"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Import_StoreImportRequest"}}}}}},"/api/v1/import/{uuid}":{"get":{"summary":"Get an import","operationId":"getApiV1ImportUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportResource"}}}}},"tags":["Imports"]},"delete":{"summary":"Delete an import","operationId":"deleteApiV1ImportUuid","description":"","parameters":[],"responses":{},"tags":["Imports"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/import/keys/{importer}/{mode}":{"get":{"summary":"Get importer keys","operationId":"getApiV1ImportKeysImporterMode","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportKeysResource"}}}}},"tags":["Imports"]},"parameters":[{"in":"path","name":"importer","description":"the importer type to get keys for, valid types are ['plans','client','valuations']","example":"plans","required":true,"schema":{"type":"string"}},{"in":"path","name":"mode","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/import/modes/{importer}":{"get":{"summary":"Get available modes for import type","operationId":"getApiV1ImportModesImporter","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportModesResource"}}}}},"tags":["Imports"]},"parameters":[{"in":"path","name":"importer","description":"the importer type to get modes for, valid types are ['plans','client','valuations']","example":"plans","required":true,"schema":{"type":"string"}}]},"/api/v1/import/map/{import_uuid}":{"post":{"summary":"Map headers on an import","operationId":"postApiV1ImportMapImport_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportResource"}}}}},"tags":["Imports"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Import_MapImportRequest"}}}}},"parameters":[{"in":"path","name":"import_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/import/start/{import_uuid}":{"post":{"summary":"Start an import","operationId":"postApiV1ImportStartImport_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportResource"}}}}},"tags":["Imports"]},"parameters":[{"in":"path","name":"import_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/income":{"get":{"summary":"Get all incomes","operationId":"getApiV1ClientClient_uuidIncome","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, employment].","example":"?include=shared_owner,employment","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, employment].","example":"?include=shared_owner,employment"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, amount]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, amount]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IncomeResource"}}}}}}}},"tags":["Income (v1)"]},"post":{"summary":"Create an income","operationId":"postApiV1ClientClient_uuidIncome","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IncomeResource"}}}}},"tags":["Income (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreIncomeRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/income/{uuid}":{"get":{"summary":"Get an income","operationId":"getApiV1ClientClient_uuidIncomeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IncomeResource"}}}}},"tags":["Income (v1)"]},"put":{"summary":"Update an income","operationId":"putApiV1ClientClient_uuidIncomeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IncomeResource"}}}}},"tags":["Income (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateIncomeRequest"}}}}},"delete":{"summary":"Delete an income","operationId":"deleteApiV1ClientClient_uuidIncomeUuid","description":"","parameters":[],"responses":{},"tags":["Income (v1)"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/income":{"get":{"summary":"Get all incomes","operationId":"getApiV2Income","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"a6c7ef16-59bc-565e-8dc2-5bcd252efb99,9540661e-cabf-5d52-b4a4-76a3a0b592c1","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"a6c7ef16-59bc-565e-8dc2-5bcd252efb99,9540661e-cabf-5d52-b4a4-76a3a0b592c1"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"f7d32255-2db6-5112-987a-2b3e322c0a8e,d4d3b75d-88cd-5be9-852c-ddaceca98a86","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"f7d32255-2db6-5112-987a-2b3e322c0a8e,d4d3b75d-88cd-5be9-852c-ddaceca98a86"}},{"in":"query","name":"filter[employment_uuids]","description":"Filter by a comma separated list of employment UUIDs that are linked to incomes.","example":"e9e584dd-f525-59b0-94d1-abbef0cd0585,54a44630-b21d-5843-8e8b-bc1fb6c3ecbd","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of employment UUIDs that are linked to incomes.","example":"e9e584dd-f525-59b0-94d1-abbef0cd0585,54a44630-b21d-5843-8e8b-bc1fb6c3ecbd"}},{"in":"query","name":"filter[type]","description":"Filter by comma separate list of income types. Possible values are [salary, dividend, bonus, benefit, other, investment, rental, pension].","example":"?filter[type]=salary,investment","required":false,"schema":{"type":"string","description":"Filter by comma separate list of income types. Possible values are [salary, dividend, bonus, benefit, other, investment, rental, pension].","example":"?filter[type]=salary,investment"}},{"in":"query","name":"filter[frequency]","description":"Filter by comma separate list of frequencies.","example":"?filter[frequency]=weekly,monthly","required":false,"schema":{"type":"string","description":"Filter by comma separate list of frequencies.","example":"?filter[frequency]=weekly,monthly"}},{"in":"query","name":"filter[amount_type]","description":"Filter by comma separate list of amount types. Possible values are [net,gross].","example":"?filter[amount_type]=net,gross","required":false,"schema":{"type":"string","description":"Filter by comma separate list of amount types. Possible values are [net,gross].","example":"?filter[amount_type]=net,gross"}},{"in":"query","name":"filter[start_date]","description":"Filter income by start date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[start_date]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter income by start date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[start_date]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[end_date]","description":"Filter income by end date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[end_date]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter income by end date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[end_date]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[amount]","description":"Filter income by amount in pennies. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[amount]=\u003e=10000000,\u003c=15000000","required":false,"schema":{"type":"string","description":"Filter income by amount in pennies. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[amount]=\u003e=10000000,\u003c=15000000"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [account, employment].","example":"?include=account,employment","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [account, employment].","example":"?include=account,employment"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, amount, start_date, end_date]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, amount, start_date, end_date]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_IncomeResource"}}}}}}}},"tags":["Income (v2)"]},"post":{"summary":"Create an income","operationId":"postApiV2Income","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_IncomeResource"}}}}},"tags":["Income (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Income_StoreIncomeRequest"}}}}}},"/api/v2/income/{uuid}":{"get":{"summary":"Get an income","operationId":"getApiV2IncomeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_IncomeResource"}}}}},"tags":["Income (v2)"]},"put":{"summary":"Update an income","operationId":"putApiV2IncomeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_IncomeResource"}}}}},"tags":["Income (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Income_UpdateIncomeRequest"}}}}},"delete":{"summary":"Delete an income","operationId":"deleteApiV2IncomeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/charges":{"get":{"summary":"Get all charges for a circle","operationId":"getApiV1CirclesCircle_uuidCharges","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0"}},{"in":"query","name":"filter[group_uuids]","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[plan_uuids]","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c"}},{"in":"query","name":"filter[provider_uuids]","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0"}},{"in":"query","name":"filter[policy_number]","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002","required":false,"schema":{"type":"string","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002"}},{"in":"query","name":"filter[seller_uuids]","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed"}},{"in":"query","name":"filter[payment_origin]","description":"Filter by comma separated list of payment origins.","example":"client,provider","required":false,"schema":{"type":"string","description":"Filter by comma separated list of payment origins.","example":"client,provider"}},{"in":"query","name":"filter[type]","description":"Filter by comma separated list of charge types.","example":"fee,commission","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge types.","example":"fee,commission"}},{"in":"query","name":"filter[category]","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee"}},{"in":"query","name":"filter[recurring]","description":"Filter by recurring charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by recurring charges or not.","example":true}},{"in":"query","name":"filter[frequency]","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly","required":false,"schema":{"type":"string","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly"}},{"in":"query","name":"filter[start_date_after]","description":"Filter by charge start dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[start_date_before]","description":"Filter by charge start dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_after]","description":"Filter by charge end dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_before]","description":"Filter by charge end dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_after]","description":"Filter by charge next expectation dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_before]","description":"Filter by charge next expectation dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[amount_from]","description":"Filter by charge fixed amounts from in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts from in pennies.","example":10000}},{"in":"query","name":"filter[amount_to]","description":"Filter by charge fixed amounts to  in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts to  in pennies.","example":10000}},{"in":"query","name":"filter[percentage_from]","description":"Filter by charge percentages from.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages from.","example":0.75}},{"in":"query","name":"filter[percentage_to]","description":"Filter by charge percentages to.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages to.","example":0.75}},{"in":"query","name":"filter[tax_exempt]","description":"Filter by tax exempt charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by tax exempt charges or not.","example":true}},{"in":"query","name":"filter[exclude_from_rmar]","description":"Filter by charges excluded from RMAR or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by charges excluded from RMAR or not.","example":true}},{"in":"query","name":"filter[rmar_type]","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback","required":false,"schema":{"type":"string","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback"}},{"in":"query","name":"filter[advice_type]","description":"Filter by comma separated list of advice types.","example":"independent,restricted","required":false,"schema":{"type":"string","description":"Filter by comma separated list of advice types.","example":"independent,restricted"}},{"in":"query","name":"filter[service_type]","description":"Filter by comma separated list of service types.","example":"initial,ongoing","required":false,"schema":{"type":"string","description":"Filter by comma separated list of service types.","example":"initial,ongoing"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/expectations":{"get":{"summary":"Get all expectations of circle","operationId":"getApiV1CirclesCircle_uuidExpectations","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[status]","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto"}},{"in":"query","name":"filter[statement_uuids]","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[date_after]","description":"Get charges from an expectation date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get charges from an expectation date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_before]","description":"Get charges to an expectation date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get charges to an expectation date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000"}},{"in":"query","name":"filter[client_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[group_uuids]","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086","required":false,"schema":{"type":"string","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086"}},{"in":"query","name":"filter[category]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[plan_uuids]","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[payment_origin]","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[reconciliation]","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto"}},{"in":"query","name":"filter[reconciliation_percentage_between]","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100"}},{"in":"query","name":"filter[reconciliation_amount_between]","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationWithReconciliationResource"}}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/charges":{"get":{"summary":"Get all charges for a client","operationId":"getApiV1ClientClient_uuidCharges","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0"}},{"in":"query","name":"filter[group_uuids]","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[plan_uuids]","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c"}},{"in":"query","name":"filter[provider_uuids]","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0"}},{"in":"query","name":"filter[policy_number]","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002","required":false,"schema":{"type":"string","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002"}},{"in":"query","name":"filter[seller_uuids]","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed"}},{"in":"query","name":"filter[payment_origin]","description":"Filter by comma separated list of payment origins.","example":"client,provider","required":false,"schema":{"type":"string","description":"Filter by comma separated list of payment origins.","example":"client,provider"}},{"in":"query","name":"filter[type]","description":"Filter by comma separated list of charge types.","example":"fee,commission","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge types.","example":"fee,commission"}},{"in":"query","name":"filter[category]","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee"}},{"in":"query","name":"filter[recurring]","description":"Filter by recurring charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by recurring charges or not.","example":true}},{"in":"query","name":"filter[frequency]","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly","required":false,"schema":{"type":"string","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly"}},{"in":"query","name":"filter[start_date_after]","description":"Filter by charge start dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[start_date_before]","description":"Filter by charge start dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_after]","description":"Filter by charge end dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_before]","description":"Filter by charge end dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_after]","description":"Filter by charge next expectation dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_before]","description":"Filter by charge next expectation dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[amount_from]","description":"Filter by charge fixed amounts from in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts from in pennies.","example":10000}},{"in":"query","name":"filter[amount_to]","description":"Filter by charge fixed amounts to  in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts to  in pennies.","example":10000}},{"in":"query","name":"filter[percentage_from]","description":"Filter by charge percentages from.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages from.","example":0.75}},{"in":"query","name":"filter[percentage_to]","description":"Filter by charge percentages to.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages to.","example":0.75}},{"in":"query","name":"filter[tax_exempt]","description":"Filter by tax exempt charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by tax exempt charges or not.","example":true}},{"in":"query","name":"filter[exclude_from_rmar]","description":"Filter by charges excluded from RMAR or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by charges excluded from RMAR or not.","example":true}},{"in":"query","name":"filter[rmar_type]","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback","required":false,"schema":{"type":"string","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback"}},{"in":"query","name":"filter[advice_type]","description":"Filter by comma separated list of advice types.","example":"independent,restricted","required":false,"schema":{"type":"string","description":"Filter by comma separated list of advice types.","example":"independent,restricted"}},{"in":"query","name":"filter[service_type]","description":"Filter by comma separated list of service types.","example":"initial,ongoing","required":false,"schema":{"type":"string","description":"Filter by comma separated list of service types.","example":"initial,ongoing"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/expectations":{"get":{"summary":"Get all expectations of client","operationId":"getApiV1ClientClient_uuidExpectations","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[status]","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto"}},{"in":"query","name":"filter[statement_uuids]","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[date_after]","description":"Get charges from an expectation date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get charges from an expectation date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_before]","description":"Get charges to an expectation date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get charges to an expectation date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000"}},{"in":"query","name":"filter[client_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[group_uuids]","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086","required":false,"schema":{"type":"string","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086"}},{"in":"query","name":"filter[category]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[plan_uuids]","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[payment_origin]","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[reconciliation]","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto"}},{"in":"query","name":"filter[reconciliation_percentage_between]","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100"}},{"in":"query","name":"filter[reconciliation_amount_between]","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationWithReconciliationResource"}}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/charges":{"get":{"summary":"Get all charges for a plan","operationId":"getApiV1PlansPlan_uuidCharges","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0"}},{"in":"query","name":"filter[group_uuids]","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[plan_uuids]","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c"}},{"in":"query","name":"filter[provider_uuids]","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0"}},{"in":"query","name":"filter[policy_number]","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002","required":false,"schema":{"type":"string","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002"}},{"in":"query","name":"filter[seller_uuids]","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed"}},{"in":"query","name":"filter[payment_origin]","description":"Filter by comma separated list of payment origins.","example":"client,provider","required":false,"schema":{"type":"string","description":"Filter by comma separated list of payment origins.","example":"client,provider"}},{"in":"query","name":"filter[type]","description":"Filter by comma separated list of charge types.","example":"fee,commission","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge types.","example":"fee,commission"}},{"in":"query","name":"filter[category]","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee"}},{"in":"query","name":"filter[recurring]","description":"Filter by recurring charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by recurring charges or not.","example":true}},{"in":"query","name":"filter[frequency]","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly","required":false,"schema":{"type":"string","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly"}},{"in":"query","name":"filter[start_date_after]","description":"Filter by charge start dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[start_date_before]","description":"Filter by charge start dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_after]","description":"Filter by charge end dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_before]","description":"Filter by charge end dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_after]","description":"Filter by charge next expectation dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_before]","description":"Filter by charge next expectation dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[amount_from]","description":"Filter by charge fixed amounts from in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts from in pennies.","example":10000}},{"in":"query","name":"filter[amount_to]","description":"Filter by charge fixed amounts to  in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts to  in pennies.","example":10000}},{"in":"query","name":"filter[percentage_from]","description":"Filter by charge percentages from.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages from.","example":0.75}},{"in":"query","name":"filter[percentage_to]","description":"Filter by charge percentages to.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages to.","example":0.75}},{"in":"query","name":"filter[tax_exempt]","description":"Filter by tax exempt charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by tax exempt charges or not.","example":true}},{"in":"query","name":"filter[exclude_from_rmar]","description":"Filter by charges excluded from RMAR or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by charges excluded from RMAR or not.","example":true}},{"in":"query","name":"filter[rmar_type]","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback","required":false,"schema":{"type":"string","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback"}},{"in":"query","name":"filter[advice_type]","description":"Filter by comma separated list of advice types.","example":"independent,restricted","required":false,"schema":{"type":"string","description":"Filter by comma separated list of advice types.","example":"independent,restricted"}},{"in":"query","name":"filter[service_type]","description":"Filter by comma separated list of service types.","example":"initial,ongoing","required":false,"schema":{"type":"string","description":"Filter by comma separated list of service types.","example":"initial,ongoing"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/expectations":{"get":{"summary":"Get all expectations of plan","operationId":"getApiV1PlansPlan_uuidExpectations","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[status]","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto"}},{"in":"query","name":"filter[statement_uuids]","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[date_after]","description":"Get charges from an expectation date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get charges from an expectation date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_before]","description":"Get charges to an expectation date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get charges to an expectation date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000"}},{"in":"query","name":"filter[client_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[group_uuids]","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086","required":false,"schema":{"type":"string","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086"}},{"in":"query","name":"filter[category]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[plan_uuids]","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[payment_origin]","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[reconciliation]","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto"}},{"in":"query","name":"filter[reconciliation_percentage_between]","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100"}},{"in":"query","name":"filter[reconciliation_amount_between]","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationWithReconciliationResource"}}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/provider-statement/upload":{"post":{"summary":"Upload a provider statement CSV.","operationId":"postApiV1ProviderStatementUpload","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UploadProviderStatementRequest"}}}}}},"/api/v1/provider-statement/import":{"post":{"summary":"Import a provider statement CSV.","operationId":"postApiV1ProviderStatementImport","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ImportResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_ImportProviderStatementRequest"}}}}}},"/api/v1/provider-statement":{"get":{"summary":"Get all provider statements","operationId":"getApiV1ProviderStatement","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[statement_uuids]","description":"Comma separated list of payment period statement UUIDs.  e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of payment period statement UUIDs.  e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea","example":"architecto"}},{"in":"query","name":"filter[name]","description":"Comma separated list of partial provider statement names.  e.g. Scottish Widows","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of partial provider statement names.  e.g. Scottish Widows","example":"architecto"}},{"in":"query","name":"filter[reference]","description":"Comma separated list of partial provider statement references.  e.g. SW#324","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of partial provider statement references.  e.g. SW#324","example":"architecto"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated list of exact provider UUIDs.  e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of exact provider UUIDs.  e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Statement date from in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto","required":false,"schema":{"type":"string","description":"Statement date from in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"Statement date from in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto","required":false,"schema":{"type":"string","description":"Statement date from in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto"}},{"in":"query","name":"filter[amount_from]","description":"Total amount of transactions within provider statement to, in pennies e.g. 5000","example":16,"required":false,"schema":{"type":"integer","description":"Total amount of transactions within provider statement to, in pennies e.g. 5000","example":16}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ProviderStatementResource"}}}}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create a provider statement","operationId":"postApiV1ProviderStatement","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ProviderStatementResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreProviderStatementRequest"}}}}}},"/api/v1/provider-statement/{providerStatement_uuid}":{"get":{"summary":"Get a provider statement","operationId":"getApiV1ProviderStatementProviderStatement_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ProviderStatementResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update a provider statement","operationId":"putApiV1ProviderStatementProviderStatement_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ProviderStatementResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateProviderStatementRequest"}}}}},"delete":{"summary":"Delete a provider statement","operationId":"deleteApiV1ProviderStatementProviderStatement_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"providerStatement_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/bank-statement/upload":{"post":{"summary":"Upload a bank statement CSV.","operationId":"postApiV1BankStatementUpload","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UploadBankStatementRequest"}}}}}},"/api/v1/bank-statement":{"get":{"summary":"Get all bank statements","operationId":"getApiV1BankStatement","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[statement_uuids]","description":"Comma separated list of payment period statement UUIDs.  e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of payment period statement UUIDs.  e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea","example":"architecto"}},{"in":"query","name":"filter[name]","description":"Comma separated list of partial bank statement names.  e.g. Natwest","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of partial bank statement names.  e.g. Natwest","example":"architecto"}},{"in":"query","name":"filter[reference]","description":"Comma separated list of partial bank statement references.  e.g. SW#324","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of partial bank statement references.  e.g. SW#324","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Statement date from in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto","required":false,"schema":{"type":"string","description":"Statement date from in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"Statement date from in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto","required":false,"schema":{"type":"string","description":"Statement date from in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto"}},{"in":"query","name":"filter[amount_from]","description":"Total amount of transactions within bank statement to, in pennies e.g. 5000","example":16,"required":false,"schema":{"type":"integer","description":"Total amount of transactions within bank statement to, in pennies e.g. 5000","example":16}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankStatementResource"}}}}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create a bank statement","operationId":"postApiV1BankStatement","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankStatementResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreBankStatementRequest"}}}}}},"/api/v1/bank-statement/{bankStatement_uuid}":{"get":{"summary":"Get a bank statement","operationId":"getApiV1BankStatementBankStatement_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankStatementResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update a bank statement","operationId":"putApiV1BankStatementBankStatement_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankStatementResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateBankStatementRequest"}}}}},"delete":{"summary":"Delete a bank statement","operationId":"deleteApiV1BankStatementBankStatement_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"bankStatement_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/charge":{"get":{"summary":"Get all charges","operationId":"getApiV1Charge","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_uuids]","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of client UUIDs.","example":"3d7ef03d-d926-5dc5-b316-d7a0bd7538eb,55967af6-997c-5442-a20d-e78d89435ae0"}},{"in":"query","name":"filter[group_uuids]","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of group UUIDs.","example":"4f332e8a-a236-5cc1-bd7f-a2121759afdb,7504ab61-883d-5059-813d-5c60a8b31a8d"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[plan_uuids]","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs.","example":"71c44f85-cd7a-560c-b963-c64e7c09beb8,d3675ee5-dc03-54d6-bfef-441edd4b181c"}},{"in":"query","name":"filter[provider_uuids]","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of provider UUIDs.","example":"15735912-f8a6-5570-902c-e594bf3c445a,9f7d98d8-8ef2-58f7-98db-39b2ec9deea0"}},{"in":"query","name":"filter[policy_number]","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002","required":false,"schema":{"type":"string","description":"Filter by policy numbers.","example":"AVIVA_0001,AVIVA_0002"}},{"in":"query","name":"filter[seller_uuids]","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of seller account UUIDs.","example":"829284bf-109d-5102-b6b0-36a7a1995e80,4932967b-8f8a-530e-b06a-349ee7de5bed"}},{"in":"query","name":"filter[payment_origin]","description":"Filter by comma separated list of payment origins.","example":"client,provider","required":false,"schema":{"type":"string","description":"Filter by comma separated list of payment origins.","example":"client,provider"}},{"in":"query","name":"filter[type]","description":"Filter by comma separated list of charge types.","example":"fee,commission","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge types.","example":"fee,commission"}},{"in":"query","name":"filter[category]","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee","required":false,"schema":{"type":"string","description":"Filter by comma separated list of charge categories.","example":"initial_fee,ongoing_fee"}},{"in":"query","name":"filter[recurring]","description":"Filter by recurring charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by recurring charges or not.","example":true}},{"in":"query","name":"filter[frequency]","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly","required":false,"schema":{"type":"string","description":"Filter by comma separated list of frequencies.","example":"weekly,monthly"}},{"in":"query","name":"filter[start_date_after]","description":"Filter by charge start dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[start_date_before]","description":"Filter by charge start dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge start dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_after]","description":"Filter by charge end dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[end_date_before]","description":"Filter by charge end dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge end dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_after]","description":"Filter by charge next expectation dates after.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates after.","example":"2023-09-30"}},{"in":"query","name":"filter[next_expectation_date_before]","description":"Filter by charge next expectation dates before.","example":"2023-09-30","required":false,"schema":{"type":"string","description":"Filter by charge next expectation dates before.","example":"2023-09-30"}},{"in":"query","name":"filter[amount_from]","description":"Filter by charge fixed amounts from in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts from in pennies.","example":10000}},{"in":"query","name":"filter[amount_to]","description":"Filter by charge fixed amounts to  in pennies.","example":10000,"required":false,"schema":{"type":"integer","description":"Filter by charge fixed amounts to  in pennies.","example":10000}},{"in":"query","name":"filter[percentage_from]","description":"Filter by charge percentages from.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages from.","example":0.75}},{"in":"query","name":"filter[percentage_to]","description":"Filter by charge percentages to.","example":0.75,"required":false,"schema":{"type":"number","description":"Filter by charge percentages to.","example":0.75}},{"in":"query","name":"filter[tax_exempt]","description":"Filter by tax exempt charges or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by tax exempt charges or not.","example":true}},{"in":"query","name":"filter[exclude_from_rmar]","description":"Filter by charges excluded from RMAR or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter by charges excluded from RMAR or not.","example":true}},{"in":"query","name":"filter[rmar_type]","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback","required":false,"schema":{"type":"string","description":"Filter by comma separated list of RMAR types.","example":"adviser_type,clawback"}},{"in":"query","name":"filter[advice_type]","description":"Filter by comma separated list of advice types.","example":"independent,restricted","required":false,"schema":{"type":"string","description":"Filter by comma separated list of advice types.","example":"independent,restricted"}},{"in":"query","name":"filter[service_type]","description":"Filter by comma separated list of service types.","example":"initial,ongoing","required":false,"schema":{"type":"string","description":"Filter by comma separated list of service types.","example":"initial,ongoing"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"-next_expectation_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeResource"}}}}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create a charge","operationId":"postApiV1Charge","description":"Create recurring charge for a given plan or client.\nAmount can be a fixed amount or a percentage of a plans value.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreChargeRequest"}}}}}},"/api/v1/charge/{uuid}":{"get":{"summary":"Get a charge","operationId":"getApiV1ChargeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update a charge","operationId":"putApiV1ChargeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateChargeRequest"}}}}},"delete":{"summary":"Delete a charge","operationId":"deleteApiV1ChargeUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/expectation/calculate":{"post":{"summary":"Calculate the income splits of an expectation","operationId":"postApiV1ExpectationCalculate","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_CalculateExpectationRequest"}}}}}},"/api/v1/expectation":{"get":{"summary":"Get all firm expectations","operationId":"getApiV1Expectation","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[status]","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their status. Available options: expecting,ready_for_reconciliation","example":"architecto"}},{"in":"query","name":"filter[statement_uuids]","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Filter expectations by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[date_after]","description":"Get charges from an expectation date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get charges from an expectation date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_before]","description":"Get charges to an expectation date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get charges to an expectation date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get charges greater than or equal to an expected amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get charges less than or equal to an expected amount in pennies.","example":"20000"}},{"in":"query","name":"filter[client_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"99e535dc-433e-5448-b828-f987f04698a4,8648d854-2c74-5945-81b6-e60ef385418a"}},{"in":"query","name":"filter[group_uuids]","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086","required":false,"schema":{"type":"string","description":"Comma separated string group UUIDs to filter by.","example":"f402153f-e4ff-478f-9591-fa160ac955fd,3fcd0358-4bb8-4d51-abfb-70f0ba5a2086"}},{"in":"query","name":"filter[category]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial policy numbers to filter by.","example":"architecto"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial provider names or exact provider UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[plan_uuids]","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of partial plan names or exact plan UUIDs to filter by.","example":"architecto"}},{"in":"query","name":"filter[payment_origin]","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations to client or provider paid.  Valid options are [client, provider]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Comma separated string of partial names or exact account UUIDs to filter by.","example":"Barry,7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[reconciliation]","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto"}},{"in":"query","name":"filter[reconciliation_percentage_between]","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values as a percentage.","example":"50,100"}},{"in":"query","name":"filter[reconciliation_amount_between]","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000","required":false,"schema":{"type":"string","description":"Filter expectations based on their reconciliation amount between two values in pennies.","example":"5000,10000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC.  Defaults to 'expected_payment_date'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationWithReconciliationResource"}}}}}}}},"tags":["Income Reconciliation"]}},"/api/v1/expectation/{uuid}":{"get":{"summary":"Get an expectation","operationId":"getApiV1ExpectationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationWithReconciliationResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update an expectation","operationId":"putApiV1ExpectationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationWithReconciliationResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateExpectationRequest"}}}}},"delete":{"summary":"Delete an expectation","operationId":"deleteApiV1ExpectationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/statement-transaction":{"get":{"summary":"Get all statement transactions","operationId":"getApiV1StatementTransaction","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement, providerStatement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement, providerStatement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[statement_uuids]","description":"Filter provider statement transactions by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Filter provider statement transactions by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[provider_statement_uuids]","description":"Filter provider statement transactions by an exact provider statement UUID.","example":"05dad2ed-2d20-4546-b0ff-5b806e24ae70","required":false,"schema":{"type":"string","description":"Filter provider statement transactions by an exact provider statement UUID.","example":"05dad2ed-2d20-4546-b0ff-5b806e24ae70"}},{"in":"query","name":"filter[date_from]","description":"Get provider statement transactions from a certain date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get provider statement transactions from a certain date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_to]","description":"Get provider statement transactions to a certain date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get provider statement transactions to a certain date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get provider statement transactions greater than or equal to a certain amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get provider statement transactions greater than or equal to a certain amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get provider statement transactions less than or equal to a certain amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get provider statement transactions less than or equal to a certain amount in pennies.","example":"20000"}},{"in":"query","name":"filter[client]","description":"Filter by partial client name given on provider statement.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial client name given on provider statement.","example":"architecto"}},{"in":"query","name":"filter[policy_number]","description":"Filter by partial policy number given on provider statement.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial policy number given on provider statement.","example":"architecto"}},{"in":"query","name":"filter[reference]","description":"Filter by partial transaction reference.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial transaction reference.","example":"architecto"}},{"in":"query","name":"filter[agency_number]","description":"Filter by partial agency number.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial agency number.","example":"architecto"}},{"in":"query","name":"filter[product_reference]","description":"Filter by partial product reference.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial product reference.","example":"architecto"}},{"in":"query","name":"filter[provider_uuids]","description":"Filter provider statement transactions by exact provider UUID.","example":"05dad2ed-2d20-4546-b0ff-5b806e24ae70","required":false,"schema":{"type":"string","description":"Filter provider statement transactions by exact provider UUID.","example":"05dad2ed-2d20-4546-b0ff-5b806e24ae70"}},{"in":"query","name":"filter[payment_origin]","description":"Filter provider statement transactions to client or provider paid.  Valid options are [client, provider]","example":"architecto","required":false,"schema":{"type":"string","description":"Filter provider statement transactions to client or provider paid.  Valid options are [client, provider]","example":"architecto"}},{"in":"query","name":"filter[category]","description":"Comma separated string of categories to filter by.","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of categories to filter by.","example":"architecto"}},{"in":"query","name":"filter[adviser]","description":"Filter by partial adviser name given on provider statement.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial adviser name given on provider statement.","example":"architecto"}},{"in":"query","name":"filter[reconciliation]","description":"Filter provider statement transactions by their reconciliation status.  Valid statuses are reconciled,unreconciled,reconciled_with_expectations,reconciled_with_bank_transactions,unreconciled_with_expectations,unreconciled_with_bank_transactions,partially_reconciled_with_expectations,partially_reconciled_with_bank_transactions","example":"reconciled","required":false,"schema":{"type":"string","description":"Filter provider statement transactions by their reconciliation status.  Valid statuses are reconciled,unreconciled,reconciled_with_expectations,reconciled_with_bank_transactions,unreconciled_with_expectations,unreconciled_with_bank_transactions,partially_reconciled_with_expectations,partially_reconciled_with_bank_transactions","example":"reconciled"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, date, policy_number, client_name, gross_amount]. Negative sign to denote DESC.  Defaults to '-updated_at'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, date, policy_number, client_name, gross_amount]. Negative sign to denote DESC.  Defaults to '-updated_at'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create an statement transaction","operationId":"postApiV1StatementTransaction","description":"Add transactions to an already existing provider statement or add extra client paid\ntransactions to a payment period.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreStatementTransactionRequest"}}}}}},"/api/v1/statement-transaction/{statementTransaction_uuid}":{"get":{"summary":"Get an statement transaction","operationId":"getApiV1StatementTransactionStatementTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update an statement transaction","operationId":"putApiV1StatementTransactionStatementTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateStatementTransactionRequest"}}}}},"delete":{"summary":"Delete an statement transaction","operationId":"deleteApiV1StatementTransactionStatementTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"statementTransaction_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation":{"post":{"summary":"Unreconcile the expectation","operationId":"postApiV1StatementTransactionStatementTransaction_uuidUnreconcileExpectation","description":"Will remove the expectation from the statement transaction.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementTransactionResource"}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"statementTransaction_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/bank-transaction":{"get":{"summary":"Get all bank transactions","operationId":"getApiV1BankTransaction","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [statement].","example":"?include=statement"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[statement_uuids]","description":"Filter bank transaction by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6","required":false,"schema":{"type":"string","description":"Filter bank transaction by a statement UUID.","example":"7967e2f8-bfeb-4eac-98fd-f2945c4f08a6"}},{"in":"query","name":"filter[bank_statement_uuids]","description":"Filter bank statement transactions by an exact bank statement UUID.","example":"05dad2ed-2d20-4546-b0ff-5b806e24ae70","required":false,"schema":{"type":"string","description":"Filter bank statement transactions by an exact bank statement UUID.","example":"05dad2ed-2d20-4546-b0ff-5b806e24ae70"}},{"in":"query","name":"filter[date_from]","description":"Get bank transactions from a certain date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get bank transactions from a certain date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_to]","description":"Get bank transactions to a certain date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get bank transactions to a certain date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get bank transactions greater than or equal to a certain amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get bank transactions greater than or equal to a certain amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get bank transactions less than or equal to a certain amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get bank transactions less than or equal to a certain amount in pennies.","example":"20000"}},{"in":"query","name":"filter[reference]","description":"Filter bank transactions by a partial transaction reference","example":"architecto","required":false,"schema":{"type":"string","description":"Filter bank transactions by a partial transaction reference","example":"architecto"}},{"in":"query","name":"filter[reconciliation]","description":"Filter bank transactions based on their reconciliation status. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto","required":false,"schema":{"type":"string","description":"Filter bank transactions based on their reconciliation status. Available options: reconciled,unreconciled,partially_reconciled","example":"architecto"}},{"in":"query","name":"filter[reconciliation_percentage_between]","description":"Filter bank transactions based on their reconciliation amount between two values as a percentage.","example":"50,100","required":false,"schema":{"type":"string","description":"Filter bank transactions based on their reconciliation amount between two values as a percentage.","example":"50,100"}},{"in":"query","name":"filter[reconciliation_amount_between]","description":"Filter bank transactions based on their reconciliation amount between two values in pennies.","example":"5000,10000","required":false,"schema":{"type":"string","description":"Filter bank transactions based on their reconciliation amount between two values in pennies.","example":"5000,10000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, payment_date, reference, amount]. Negative sign to denote DESC.  Defaults to 'date'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, payment_date, reference, amount]. Negative sign to denote DESC.  Defaults to 'date'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankTransactionWithReconciliationResource"}}}}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create a bank transaction","operationId":"postApiV1BankTransaction","description":"Incoming transactions from a bank statement.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreBankTransactionRequest"}}}}}},"/api/v1/bank-transaction/{bankTransaction_uuid}":{"get":{"summary":"Get a bank transaction","operationId":"getApiV1BankTransactionBankTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update a bank transaction","operationId":"putApiV1BankTransactionBankTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_BankTransactionWithReconciliationResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateBankTransactionRequest"}}}}},"delete":{"summary":"Delete a bank transaction","operationId":"deleteApiV1BankTransactionBankTransaction_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"bankTransaction_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/expectation/reconcile":{"post":{"summary":"Reconcile an expectation to statement transactions","operationId":"postApiV1ExpectationReconcile","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ExpectationResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_ReconcileExpectationsRequest"}}}}}},"/api/v1/expectation/balance":{"post":{"summary":"Balance partially reconciled expectations","operationId":"postApiV1ExpectationBalance","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_BalanceExpectationsRequest"}}}}}},"/api/v1/expectation/unbalance":{"post":{"summary":"Unbalance the expectation","operationId":"postApiV1ExpectationUnbalance","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UnbalanceExpectationRequest"}}}}}},"/api/v1/bank-transaction/reconcile":{"post":{"summary":"Reconcile bank payments to statement transactions","operationId":"postApiV1BankTransactionReconcile","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_ReconcileBankTransactionsRequest"}}}}}},"/api/v1/reconciliation/{uuid}":{"delete":{"summary":"Delete a reconciliation","operationId":"deleteApiV1ReconciliationUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/statement-transaction/create-expectations":{"post":{"summary":"Create expectations","operationId":"postApiV1StatementTransactionCreateExpectations","description":"Bulk action create expectations for incoming statement transactions.\nUseful when a provider statement has historic transactions which Plannr has not generated the expectations for.\nThe client and policy for this transactions must exist within Plannr.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_BulkCreateExpectationsRequest"}}}}}},"/api/v1/statement-transaction/auto-reconcile":{"post":{"summary":"Auto reconcile statement transactions","operationId":"postApiV1StatementTransactionAutoReconcile","description":"Run statement transactions through the auto reconciliation to expectations action again.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_AutoReconcileStatementTransactionsRequest"}}}}}},"/api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations":{"get":{"summary":"Get all reconciliations on a bank transaction","operationId":"getApiV1BankTransactionBankTransaction_uuidReconciliations","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IncomeReconciliation_ReconciliationResource"}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"bankTransaction_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations":{"get":{"summary":"Get all reconciliations on an statement transaction","operationId":"getApiV1StatementTransactionStatementTransaction_uuidReconciliations","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"amount","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"amount"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IncomeReconciliation_ReconciliationResource"}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"statementTransaction_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/charge-split/{splitableType}/{splitableUuid}":{"get":{"summary":"Get all charge splits","operationId":"getApiV1ChargeSplitSplitableTypeSplitableUuid","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitResource"}}}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"splitableType","description":"","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"splitableUuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/charge-split":{"post":{"summary":"Create a charge split","operationId":"postApiV1ChargeSplit","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreChargeSplitRequest"}}}}}},"/api/v1/charge-split/{chargeSplit_uuid}":{"get":{"summary":"Get a charge split","operationId":"getApiV1ChargeSplitChargeSplit_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update a charge split","operationId":"putApiV1ChargeSplitChargeSplit_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateChargeSplitRequest"}}}}},"delete":{"summary":"Delete a charge split","operationId":"deleteApiV1ChargeSplitChargeSplit_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"chargeSplit_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/adviser-split":{"get":{"summary":"Get all adviser splits","operationId":"getApiV1AdviserSplit","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Name to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Name to filter by","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Type to filter by. Valid options are adviser, plan","example":"architecto","required":false,"schema":{"type":"string","description":"Type to filter by. Valid options are adviser, plan","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AdviserSplitResource"}}}}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create an adviser split","operationId":"postApiV1AdviserSplit","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AdviserSplitResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreAdviserSplitRequest"}}}}}},"/api/v1/adviser-split/{adviserSplit_uuid}":{"get":{"summary":"Get an adviser split","operationId":"getApiV1AdviserSplitAdviserSplit_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AdviserSplitResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update an adviser split","operationId":"putApiV1AdviserSplitAdviserSplit_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AdviserSplitResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateAdviserSplitRequest"}}}}},"delete":{"summary":"Delete an adviser split","operationId":"deleteApiV1AdviserSplitAdviserSplit_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"adviserSplit_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/charge-split-schema":{"get":{"summary":"Get all charge split schemas","operationId":"getApiV1ChargeSplitSchema","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Name to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Name to filter by","example":"architecto"}},{"in":"query","name":"filter[valid_for_advisers]","description":"Only include charge split schemas which are valid for advisers","example":false,"required":false,"schema":{"type":"boolean","description":"Only include charge split schemas which are valid for advisers","example":false}},{"in":"query","name":"filter[valid_for_clients]","description":"Only include charge split schemas which are valid for clients","example":false,"required":false,"schema":{"type":"boolean","description":"Only include charge split schemas which are valid for clients","example":false}},{"in":"query","name":"filter[valid_for_introducers]","description":"Only include charge split schemas which are valid for introducers","example":false,"required":false,"schema":{"type":"boolean","description":"Only include charge split schemas which are valid for introducers","example":false}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitSchemaResource"}}}}}}}},"tags":["Income Reconciliation"]},"post":{"summary":"Create a charge split schema","operationId":"postApiV1ChargeSplitSchema","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitSchemaResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_StoreChargeSplitSchemaRequest"}}}}}},"/api/v1/charge-split-schema/{chargeSplitSchema_uuid}":{"get":{"summary":"Get a charge split schema","operationId":"getApiV1ChargeSplitSchemaChargeSplitSchema_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitSchemaResource"}}}}},"tags":["Income Reconciliation"]},"put":{"summary":"Update a charge split schema","operationId":"putApiV1ChargeSplitSchemaChargeSplitSchema_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ChargeSplitSchemaResource"}}}}},"tags":["Income Reconciliation"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_IncomeReconciliation_UpdateChargeSplitSchemaRequest"}}}}},"delete":{"summary":"Delete a charge split schema","operationId":"deleteApiV1ChargeSplitSchemaChargeSplitSchema_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Income Reconciliation"]},"parameters":[{"in":"path","name":"chargeSplitSchema_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/introducer":{"get":{"summary":"Get all introducers","operationId":"getApiV1Introducer","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, charge_split_schema, tags, groups, business_unit].","example":"?include=groups,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, charge_split_schema, tags, groups, business_unit].","example":"?include=groups,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[email]","description":"Filter employees that have an email with a partial match.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter employees that have an email with a partial match.","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated string to filter by different employee types.  Valid types are [owner, admin, member].","example":"?filter[type]=member","required":false,"schema":{"type":"string","description":"Comma separated string to filter by different employee types.  Valid types are [owner, admin, member].","example":"?filter[type]=member"}},{"in":"query","name":"filter[created_after]","description":"Date to filter when the client was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date to filter when the client was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[created_before]","description":"Date to filter when the client was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date to filter when the client was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[groups]","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of partial groups names or group UUIDs.","example":"Prospects,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[exclude_groups]","description":"Provide a group UUID (or multiple as a comma-separated string) to filter introducers within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Provide a group UUID (or multiple as a comma-separated string) to filter introducers within the provided groups out from the response.","example":"e995263e-7477-4118-8860-de295bafbe0b,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[business_unit]","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a business unit UUID.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}}}}},"tags":["Introducer"]},"post":{"summary":"Create an introducer [Deprecated: Use create an account route]","operationId":"postApiV1Introducer","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Introducer"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_External_StoreIntroducerRequest"}}}}}},"/api/v1/introducer/{uuid}":{"get":{"summary":"View an introducer [Deprecated: Use get an account route]","operationId":"getApiV1IntroducerUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Introducer"]},"put":{"summary":"Update an introducer [Deprecated: Use update an account route]","operationId":"putApiV1IntroducerUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_AccountResource"}}}}},"tags":["Introducer"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateIntroducerRequest"}}}}},"delete":{"summary":"Delete an introducer [Deprecated: use delete an account route]","operationId":"deleteApiV1IntroducerUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Introducer"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/loa":{"post":{"summary":"Generate Letter of Authority","operationId":"postApiV1Loa","description":"Generates a Letter of Authority document for a client with the specified plans.\nGroups plans by provider and sends a separate LoA for each provider with only\nthat provider's policy numbers.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":{"transactions":[{"transaction_uuid":"abc123-def456-ghi789","provider":"Aviva","policy_numbers":"POL123, POL456"},{"transaction_uuid":"xyz789-abc123-def456","provider":"Legal \u0026 General","policy_numbers":"POL789"}]}},"properties":{"data":{"type":"object","properties":{"transactions":{"type":"array","example":[{"transaction_uuid":"abc123-def456-ghi789","provider":"Aviva","policy_numbers":"POL123, POL456"},{"transaction_uuid":"xyz789-abc123-def456","provider":"Legal \u0026 General","policy_numbers":"POL789"}],"items":{"type":"object","properties":{"transaction_uuid":{"type":"string","example":"abc123-def456-ghi789"},"provider":{"type":"string","example":"Aviva"},"policy_numbers":{"type":"string","example":"POL123, POL456"}}}}}}}}}}}},"tags":["Letter of Authority"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"client_uuid":{"type":"string","description":"The UUID of the client.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"},"plan_uuids":{"type":"array","description":"Array of plan UUIDs to include in the LoA.","example":["6a6a176d-52bc-47f2-88c3-141d44059bcf"],"items":{"type":"string"}},"document_template_uuid":{"type":"string","description":"The UUID of the document template to use.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0"}},"required":["client_uuid","plan_uuids","document_template_uuid"]}}}}}},"/api/v1/account/{account_uuid}/login":{"get":{"summary":"Get all logins of an account.","operationId":"getApiV1AccountAccount_uuidLogin","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"created_at"}},{"in":"query","name":"per_page","description":"the amount of logs per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of logs per page (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LoginResource"}}}}}}}},"tags":["Logins"]},"post":{"summary":"Create a login","operationId":"postApiV1AccountAccount_uuidLogin","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LoginResource"}}}}},"tags":["Logins"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Login_StoreLoginRequest"}}}}},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account","description":"The uuid of the account which the login belongs to.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/login/{uuid}":{"put":{"summary":"Update a login","operationId":"putApiV1AccountAccount_uuidLoginUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LoginResource"}}}}},"tags":["Logins"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Login_UpdateLoginRequest"}}}}},"delete":{"summary":"Revoke a login","operationId":"deleteApiV1AccountAccount_uuidLoginUuid","description":"","parameters":[],"responses":{},"tags":["Logins"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account","description":"The uuid of the account which the login belongs to.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}},{"in":"path","name":"login","description":"The uuid of the login to display.","example":"72c44fe4-2323-49dc-ab10-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/login/{login_uuid}/expire":{"post":{"summary":"Expire a login","operationId":"postApiV1AccountAccount_uuidLoginLogin_uuidExpire","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LoginResource"}}}}},"tags":["Logins"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"login_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/account/{account_uuid}/login/{login_uuid}/make-primary":{"post":{"summary":"Make a login the primary for the account","operationId":"postApiV1AccountAccount_uuidLoginLogin_uuidMakePrimary","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LoginResource"}}}}},"tags":["Logins"]},"parameters":[{"in":"path","name":"account_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"login_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"account","description":"The uuid of the account which the login belongs to.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}},{"in":"path","name":"login","description":"The uuid of the login to display.","example":"72c44fe4-2323-49dc-ab10-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/employee/{employee}/logs":{"get":{"summary":"Get logs authored by another account","operationId":"getApiV1EmployeeEmployeeLogs","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Filter log type.","example":"generic","required":false,"schema":{"type":"string","description":"Filter log type.","example":"generic"}},{"in":"query","name":"filter[level]","description":"Filter log level.","example":"info","required":false,"schema":{"type":"string","description":"Filter log level.","example":"info"}},{"in":"query","name":"filter[modelable_type]","description":"Filter logs by modelable type.","example":"client","required":false,"schema":{"type":"string","description":"Filter logs by modelable type.","example":"client"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at"}},{"in":"query","name":"per_page","description":"the amount of logs per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of logs per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LogResource"}}}}}}}},"tags":["Logs"]},"parameters":[{"in":"path","name":"employee","description":"The employee.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/logs/{modelType}/{modelUuid}":{"get":{"summary":"Get all logs for a model","operationId":"getApiV1LogsModelTypeModelUuid","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Filter log type.","example":"generic","required":false,"schema":{"type":"string","description":"Filter log type.","example":"generic"}},{"in":"query","name":"filter[level]","description":"Filter log level.","example":"info","required":false,"schema":{"type":"string","description":"Filter log level.","example":"info"}},{"in":"query","name":"filter[modelable_type]","description":"Filter logs by modelable type.","example":"client","required":false,"schema":{"type":"string","description":"Filter logs by modelable type.","example":"client"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at"}},{"in":"query","name":"per_page","description":"the amount of logs per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of logs per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LogResource"}}}}}}}},"tags":["Logs"]},"parameters":[{"in":"path","name":"modelType","description":"The type of model to get logs for","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"modelUuid","description":"UUID of the model to get logs for","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/me/logs":{"get":{"summary":"Get all logs created by Authenticated Account","operationId":"getApiV1MeLogs","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Filter log type.","example":"generic","required":false,"schema":{"type":"string","description":"Filter log type.","example":"generic"}},{"in":"query","name":"filter[level]","description":"Filter log level.","example":"info","required":false,"schema":{"type":"string","description":"Filter log level.","example":"info"}},{"in":"query","name":"filter[modelable_type]","description":"Filter logs by modelable type.","example":"client","required":false,"schema":{"type":"string","description":"Filter logs by modelable type.","example":"client"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"created_at"}},{"in":"query","name":"per_page","description":"the amount of logs per page (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"the amount of logs per page (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LogResource"}}}}}}}},"tags":["Logs"]}},"/api/v1/lookups":{"get":{"summary":"Get all lookups","operationId":"getApiV1Lookups","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[types]","description":"Filter by a comma separated list of lookup types.","example":"provider_statement_mapping,statement_transaction_autoreconciling","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of lookup types.","example":"provider_statement_mapping,statement_transaction_autoreconciling"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LookupResource"}}}}}}}},"tags":["Lookups"]}},"/api/v1/lookups/{uuid}":{"delete":{"summary":"Delete a lookup","operationId":"deleteApiV1LookupsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Lookups"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/lookups/{type}/{lookup}":{"get":{"summary":"Retrieve a lookup","operationId":"getApiV1LookupsTypeLookup","description":"Try to find a Lookup value for a specific type.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LookupResource"}}}}}}}},"tags":["Lookups"]},"parameters":[{"in":"path","name":"type","description":"","example":"provider_statement_mapping","required":true,"schema":{"type":"string"}},{"in":"path","name":"lookup","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/mailboxes":{"get":{"summary":"Display a list of mailboxes for the current firm.","operationId":"getApiV1Mailboxes","description":"Normal employees can only see their own mailboxes.\nOwners and Senior Employees can see all mailboxes.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MailboxResource"}}}}}}}},"tags":["Mailboxes"]},"post":{"summary":"Store a new mailbox for the current firm\nand return the form link to authenticate the mailbox.","operationId":"postApiV1Mailboxes","description":"","parameters":[{"in":"query","name":"type","description":"The type of mailbox to create. Possible values are: imap, gmail and outlook","example":"architecto","required":false,"schema":{"type":"string","description":"The type of mailbox to create. Possible values are: imap, gmail and outlook","example":"architecto"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Mailboxes"]}},"/api/v1/mailboxes/{uuid}":{"put":{"summary":"Update the specified mailbox.","operationId":"putApiV1MailboxesUuid","description":"If the mailbox is disabled, we will disable the IMAP connection,\nwhich will stop webhooks being received for new messages.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MailboxResource"}}}}},"tags":["Mailboxes"]},"delete":{"summary":"Remove the specified mailbox.","operationId":"deleteApiV1MailboxesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Mailboxes"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/mailboxes/{mailbox_uuid}/folders":{"get":{"summary":"Display the mailbox folders.","operationId":"getApiV1MailboxesMailbox_uuidFolders","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Mailboxes"]},"parameters":[{"in":"path","name":"mailbox_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/mailboxes/{mailbox_uuid}/reauthenticate":{"get":{"summary":"Re-authenticate a mailbox.","operationId":"getApiV1MailboxesMailbox_uuidReauthenticate","description":"This will return the form link to authenticate the mailbox.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Mailboxes"]},"parameters":[{"in":"path","name":"mailbox_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/mailboxes/message/{uuid}":{"get":{"summary":"Display the specified email.","operationId":"getApiV1MailboxesMessageUuid","description":"","parameters":[{"in":"query","name":"per_page","description":"Number of ancestor/descendant messages to return per page (Default 25. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of ancestor/descendant messages to return per page (Default 25. Max 500).","example":50}},{"in":"query","name":"page[ancestors]","description":"Page number for ancestor messages.","example":2,"required":false,"schema":{"type":"integer","description":"Page number for ancestor messages.","example":2}},{"in":"query","name":"page[descendants]","description":"Page number for descendant messages.","example":3,"required":false,"schema":{"type":"integer","description":"Page number for descendant messages.","example":3}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MailboxMessageResource"}}}}},"tags":["Mailboxes"]},"delete":{"summary":"Delete the specified mailbox message.","operationId":"deleteApiV1MailboxesMessageUuid","description":"","parameters":[{"in":"query","name":"include_descendants","description":"If true, deletes descendant messages as well. Defaults to false.","example":false,"required":false,"schema":{"type":"boolean","description":"If true, deletes descendant messages as well. Defaults to false.","example":false}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Mailboxes"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/mailboxes/message/{message_uuid}/thread":{"delete":{"summary":"Delete the specified mailbox message thread.","operationId":"deleteApiV1MailboxesMessageMessage_uuidThread","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Mailboxes"]},"parameters":[{"in":"path","name":"message_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/state":{"get":{"summary":"Get the application's state.","operationId":"getApiV1State","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Miscellaneous"]}},"/api/v2/direct-debit-mandates":{"get":{"summary":"Get all firm's direct debit mandates","operationId":"getApiV2DirectDebitMandates","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_date]","description":"Filter by created date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[created_date]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by created date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[created_date]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[updated_date]","description":"Filter by last updated date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[updated_date]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by last updated date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[updated_date]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[completed_date]","description":"Filter by completed date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[generated_date]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by completed date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[generated_date]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[is_completed]","description":"affects whether to include direct debit mandates based on the completed state. Valid options are \"exclude\", \"include\", \"only\". (default: \"include\")","example":"architecto","required":false,"schema":{"type":"string","description":"affects whether to include direct debit mandates based on the completed state. Valid options are \"exclude\", \"include\", \"only\". (default: \"include\")","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, completed_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, completed_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_DirectDebitMandateResource"}}}}}}}},"tags":["Model"]}},"/api/v2/direct-debit-mandates/{uuid}":{"get":{"summary":"Get a single direct debit mandate","operationId":"getApiV2DirectDebitMandatesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_DirectDebitMandateResource"}}}}},"tags":["Model"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"direct_debit_mandate","description":"The uuid of the direct debit mandate to show.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/view":{"get":{"summary":"Get a single direct debit mandate view","operationId":"getApiV2DirectDebitMandatesDirect_debit_mandate_uuidView","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Model"]},"parameters":[{"in":"path","name":"direct_debit_mandate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"direct_debit_mandate","description":"The uuid of the direct debit mandate to show.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/complete":{"post":{"summary":"","operationId":"postApiV2DirectDebitMandatesDirect_debit_mandate_uuidComplete","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_DirectDebitMandateResource"}}}}},"tags":["Model"]},"parameters":[{"in":"path","name":"direct_debit_mandate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"direct_debit_mandate","description":"The uuid of the direct debit mandate to show.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":true,"schema":{"type":"string"}}]},"/api/v1/options/custom-fields":{"get":{"summary":"Custom field models","operationId":"getApiV1OptionsCustomFields","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"0":"client","2":"case","3":"plan","4":"task"},"properties":{"0":{"type":"string","example":"client"},"2":{"type":"string","example":"case"},"3":{"type":"string","example":"plan"},"4":{"type":"string","example":"task"}}}}}}},"tags":["Model Types"]}},"/api/v1/options/time-trackable":{"get":{"summary":"Time trackable models","operationId":"getApiV1OptionsTimeTrackable","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"example":["client","board_task","case","circle","firm","task"]}}}}},"tags":["Model Types"]}},"/api/v2/mortgage-searches":{"get":{"summary":"Get all mortgage searches","operationId":"getApiV2MortgageSearches","description":"This endpoint will return all mortgage searches in the firm.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs (through applicants).","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs (through applicants).","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"filter[case_uuids]","description":"Filter by a comma separated list of case UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of case UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52"}},{"in":"query","name":"filter[status]","description":"Filter by status.","example":"pending","required":false,"schema":{"type":"string","description":"Filter by status.","example":"pending"}},{"in":"query","name":"filter[provider]","description":"Filter by provider.","example":"mortgage_brain","required":false,"schema":{"type":"string","description":"Filter by provider.","example":"mortgage_brain"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [applicants, cases].","example":"?include=applicants","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [applicants, cases].","example":"?include=applicants"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, status, provider]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, status, provider]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MortgageSearchResource"}}}}}}}},"tags":["Mortgage Searches (v2)"]}},"/api/v2/mortgage-searches/{uuid}":{"get":{"summary":"Get a mortgage search","operationId":"getApiV2MortgageSearchesUuid","description":"This endpoint will return a single mortgage search with its relationships.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MortgageSearchResource"}}}}},"tags":["Mortgage Searches (v2)"]},"put":{"summary":"Update a mortgage search","operationId":"putApiV2MortgageSearchesUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MortgageSearchResource"}}}}},"tags":["Mortgage Searches (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_MortgageSearches_UpdateMortgageSearch"}}}}},"delete":{"summary":"Delete a mortgage search","operationId":"deleteApiV2MortgageSearchesUuid","description":"This endpoint will delete a mortgage search.\nOnly employees can delete mortgage searches.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Mortgage Searches (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/addons/mortgagebrain/ready":{"get":{"summary":"Determine if the authenticated account can use the MortgageBrain addon for sourcing.","operationId":"getApiV1AddonsMortgagebrainReady","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Mortgage Sourcing"]}},"/api/v1/addons/mortgagebrain/mortgage-search":{"post":{"summary":"Create a mortgage search with the Mortgage Brain provider","operationId":"postApiV1AddonsMortgagebrainMortgageSearch","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_MortgageSearchResource"}}}}},"tags":["Mortgage Sourcing"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_MortgageBrain_StoreMortgageSearchRequest"}}}}}},"/api/v1/navigator/{modelType}/{modelUuid}":{"get":{"summary":"Return the data needed to build up the URL for front end for a given model and UUID.","operationId":"getApiV1NavigatorModelTypeModelUuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Navigation"]},"parameters":[{"in":"path","name":"modelType","description":"","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"modelUuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/networth":{"get":{"summary":"Get net worth","operationId":"getApiV2Networth","description":"Returns the total net worth of the plans that would be returned in the /v2/plans endpoint, broken down in to abstract types and types.","parameters":[{"in":"query","name":"date","description":"Date in format Y-m-d to get the net worth at the date. Defaults to current date if not provided.","example":"2025-07-11","required":false,"schema":{"type":"string","description":"Date in format Y-m-d to get the net worth at the date. Defaults to current date if not provided.","example":"2025-07-11"}},{"in":"query","name":"include_circle_plans","description":"When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true,"required":false,"schema":{"type":"boolean","description":"When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, cases, tags, sub_accounts, wrap, wrap_children, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts, cases, tags, sub_accounts, wrap, wrap_children, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[abstract_type]","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection","required":false,"schema":{"type":"string","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash","required":false,"schema":{"type":"string","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash"}},{"in":"query","name":"filter[sub_type]","description":"Comma separated list of sub types.","example":"national_savings,term_protection.","required":false,"schema":{"type":"string","description":"Comma separated list of sub types.","example":"national_savings,term_protection."}},{"in":"query","name":"filter[name]","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage","required":false,"schema":{"type":"string","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exact_account_uuids]","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636","required":false,"schema":{"type":"string","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834","required":false,"schema":{"type":"string","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2","required":false,"schema":{"type":"string","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[active_adviser_uuids]","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[case_uuids]","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078","required":false,"schema":{"type":"string","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078"}},{"in":"query","name":"filter[valuation_from]","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000}},{"in":"query","name":"filter[valuation_to]","description":"Amount in pennies to filter where latest valuation is less than.","example":5000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is less than.","example":5000}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[is_wrap_product]","description":"filter the plans by if they are a wrap product","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they are a wrap product","example":true}},{"in":"query","name":"filter[hide_wrap_children]","description":"Used to hide the wrap children from the primary list of plans.","example":true,"required":false,"schema":{"type":"boolean","description":"Used to hide the wrap children from the primary list of plans.","example":true}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NetworthResource"}}}}},"tags":["Networth"]}},"/api/v2/networth/line-graph":{"get":{"summary":"Get net worth line graph","operationId":"getApiV2NetworthLineGraph","description":"Returns the net worth as a line graph of the plans that would be returned in the /v2/plans endpoint.","parameters":[{"in":"query","name":"date_after","description":"Date in format Y-m-d to start the net worth line graph at the date.","example":"architecto","required":false,"schema":{"type":"string","description":"Date in format Y-m-d to start the net worth line graph at the date.","example":"architecto"}},{"in":"query","name":"date_before","description":"Date in format Y-m-d to end the the net worth at the date. Defaults to current date if not provided.","example":"2025-07-11","required":false,"schema":{"type":"string","description":"Date in format Y-m-d to end the the net worth at the date. Defaults to current date if not provided.","example":"2025-07-11"}},{"in":"query","name":"include_circle_plans","description":"When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true,"required":false,"schema":{"type":"boolean","description":"When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[abstract_type]","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection","required":false,"schema":{"type":"string","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash","required":false,"schema":{"type":"string","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash"}},{"in":"query","name":"filter[sub_type]","description":"Comma separated list of sub types.","example":"national_savings,term_protection.","required":false,"schema":{"type":"string","description":"Comma separated list of sub types.","example":"national_savings,term_protection."}},{"in":"query","name":"filter[name]","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage","required":false,"schema":{"type":"string","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exact_account_uuids]","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636","required":false,"schema":{"type":"string","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834","required":false,"schema":{"type":"string","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2","required":false,"schema":{"type":"string","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[active_adviser_uuids]","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[case_uuids]","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078","required":false,"schema":{"type":"string","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078"}},{"in":"query","name":"filter[valuation_from]","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000}},{"in":"query","name":"filter[valuation_to]","description":"Amount in pennies to filter where latest valuation is less than.","example":5000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is less than.","example":5000}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[is_wrap_product]","description":"filter the plans by if they are a wrap product","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they are a wrap product","example":true}},{"in":"query","name":"filter[hide_wrap_children]","description":"Used to hide the wrap children from the primary list of plans.","example":true,"required":false,"schema":{"type":"boolean","description":"Used to hide the wrap children from the primary list of plans.","example":true}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NetworthResource"}}}}},"tags":["Networth"]}},"/api/v1/new-business-event":{"get":{"summary":"Get all new business events","operationId":"getApiV1NewBusinessEvent","description":"This endpoint will return all new business events in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[group_uuids]","description":"Filter by a comma separated list of group UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of group UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[plan_uuids]","description":"Filter by a comma separated list of plan UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[case_uuids]","description":"Filter by a comma separated list of case UUIDs.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of case UUIDs.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469"}},{"in":"query","name":"filter[adviser_uuids]","description":"Filter by a comma separated list of Adviser (account) UUIDs.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of Adviser (account) UUIDs.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469"}},{"in":"query","name":"filter[existing_plan_uuids]","description":"Filter by a comma separated list of Existing Plan UUIDs.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of Existing Plan UUIDs.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"f7d32255-2db6-5112-987a-2b3e322c0a8e,d4d3b75d-88cd-5be9-852c-ddaceca98a86","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"f7d32255-2db6-5112-987a-2b3e322c0a8e,d4d3b75d-88cd-5be9-852c-ddaceca98a86"}},{"in":"query","name":"filter[type]","description":"Plan type to filter by.","example":"pension","required":false,"schema":{"type":"string","description":"Plan type to filter by.","example":"pension"}},{"in":"query","name":"filter[sub_type]","description":"Plan sub type to filter by.","example":"master_trust_pension","required":false,"schema":{"type":"string","description":"Plan sub type to filter by.","example":"master_trust_pension"}},{"in":"query","name":"filter[provider_uuid]","description":"Plan's provider UUID to filter by.","example":"c000d7ee-e4b5-4336-a8bd-991a1bf71b03","required":false,"schema":{"type":"string","description":"Plan's provider UUID to filter by.","example":"c000d7ee-e4b5-4336-a8bd-991a1bf71b03"}},{"in":"query","name":"filter[policy_number]","description":"Fuzzy search for plan policy number.","example":"123456","required":false,"schema":{"type":"string","description":"Fuzzy search for plan policy number.","example":"123456"}},{"in":"query","name":"filter[advice_type]","description":"Exact search for an advice type.","example":"direct_offer","required":false,"schema":{"type":"string","description":"Exact search for an advice type.","example":"direct_offer"}},{"in":"query","name":"filter[conducted_by]","description":"Exact search for how the advice was conducted.","example":"face_to_face","required":false,"schema":{"type":"string","description":"Exact search for how the advice was conducted.","example":"face_to_face"}},{"in":"query","name":"filter[status]","description":"Current status of the event.","example":"accepted","required":false,"schema":{"type":"string","description":"Current status of the event.","example":"accepted"}},{"in":"query","name":"filter[source_of_funds]","description":"Exact search for source of funds.","example":"savings","required":false,"schema":{"type":"string","description":"Exact search for source of funds.","example":"savings"}},{"in":"query","name":"filter[is_replacing_existing_plan]","description":"Whether the plan is replacing an existing plan.","example":true,"required":false,"schema":{"type":"boolean","description":"Whether the plan is replacing an existing plan.","example":true}},{"in":"query","name":"filter[opted_out_of_pension_scheme_for_plan]","description":"Whether the client opted out of pension scheme for the plan.","example":true,"required":false,"schema":{"type":"boolean","description":"Whether the client opted out of pension scheme for the plan.","example":true}},{"in":"query","name":"filter[date_from]","description":"Started after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Started after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[date_to]","description":"Started before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Started before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[proposed_date_from]","description":"Proposed after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Proposed after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[proposed_date_to]","description":"Proposed before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Proposed before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[created_from]","description":"Created after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Created after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[created_to]","description":"Created before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Created before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[updated_from]","description":"Updated after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Updated after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[updated_to]","description":"Updated before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Updated before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[contribution_type]","description":"Exact search for the contribution type.","example":"decrement","required":false,"schema":{"type":"string","description":"Exact search for the contribution type.","example":"decrement"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [existing_plan].","example":"?include=existing_plan","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [existing_plan].","example":"?include=existing_plan"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [start_date, proposal_date, created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [start_date, proposal_date, created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NewBusinessEventResource"}}}}}}}},"tags":["New Business Events"]},"post":{"summary":"Create a new business event","operationId":"postApiV1NewBusinessEvent","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_newBusinessEventResource"}}}}},"tags":["New Business Events"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreNewBusinessEventRequest"}}}}}},"/api/v1/new-business-event/{newBusinessEvent_uuid}":{"get":{"summary":"Get a new business event","operationId":"getApiV1NewBusinessEventNewBusinessEvent_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NewBusinessEventResource"}}}}},"tags":["New Business Events"]},"put":{"summary":"Update a new business event","operationId":"putApiV1NewBusinessEventNewBusinessEvent_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_newBusinessEventResource"}}}}},"tags":["New Business Events"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateNewBusinessEventRequest"}}}}},"delete":{"summary":"Delete a new business event","operationId":"deleteApiV1NewBusinessEventNewBusinessEvent_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["New Business Events"]},"parameters":[{"in":"path","name":"newBusinessEvent_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/note/{notableType}/{notableUuid}/mentions":{"post":{"summary":"Get accounts available to be mentioned","operationId":"postApiV1NoteNotableTypeNotableUuidMentions","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notes"]},"parameters":[{"in":"path","name":"notableType","description":"","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"notableUuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/all-notes":{"get":{"summary":"Get all notes for a client","operationId":"getApiV1ClientClient_uuidAllNotes","description":"Includes notes within a client's plans, cases, tasks and risks.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts].","example":"?include=mentionedAccounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts].","example":"?include=mentionedAccounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Note type to filter by.  Valid types are [call, note, meeting, email]","example":"architecto","required":false,"schema":{"type":"string","description":"Note type to filter by.  Valid types are [call, note, meeting, email]","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Note created_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"Note created_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"Note created_at date to filter to from a specific date, can be used with date_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"Note created_at date to filter to from a specific date, can be used with date_from for a range.","example":"architecto"}},{"in":"query","name":"filter[contents]","description":"Filter notes by a string to see if it's contents contains that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if it's contents contains that string.","example":"architecto"}},{"in":"query","name":"filter[path]","description":"Filter notes by a string to see if the path contains that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if the path contains that string.","example":"architecto"}},{"in":"query","name":"filter[path_exact]","description":"Filter notes by a string to see if the path is that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if the path is that string.","example":"architecto"}},{"in":"query","name":"filter[notable_type]","description":"Filter notes by a specific notable model. Valid types are: client, plan, case, task, risk.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a specific notable model. Valid types are: client, plan, case, task, risk.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NoteResource"}}}}}}}},"tags":["Notes"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/note":{"post":{"summary":"Create a note","operationId":"postApiV1Note","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notes"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Note_StoreNoteRequest"}}}}}},"/api/v1/note/{uuid}":{"get":{"summary":"Get a note","operationId":"getApiV1NoteUuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notes"]},"put":{"summary":"Update a note","operationId":"putApiV1NoteUuid","description":"","parameters":[],"responses":{},"tags":["Notes"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Note_UpdateNoteRequest"}}}}},"delete":{"summary":"Delete a note","operationId":"deleteApiV1NoteUuid","description":"","parameters":[],"responses":{},"tags":["Notes"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/note/{notableType}/{notableUuid}":{"get":{"summary":"Get all notes","operationId":"getApiV1NoteNotableTypeNotableUuid","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts,notable].","example":"?include=mentionedAccounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts,notable].","example":"?include=mentionedAccounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Note type to filter by.  Valid types are [call, note, meeting, email]","example":"architecto","required":false,"schema":{"type":"string","description":"Note type to filter by.  Valid types are [call, note, meeting, email]","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Note created_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"Note created_at date to filter from a specific date, can be used with date_to for a range.","example":"architecto"}},{"in":"query","name":"filter[date_to]","description":"Note created_at date to filter to from a specific date, can be used with date_from for a range.","example":"architecto","required":false,"schema":{"type":"string","description":"Note created_at date to filter to from a specific date, can be used with date_from for a range.","example":"architecto"}},{"in":"query","name":"filter[contents]","description":"Filter notes by a string to see if it's contents contains that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if it's contents contains that string.","example":"architecto"}},{"in":"query","name":"filter[path]","description":"Filter notes by a string to see if the path contains that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if the path contains that string.","example":"architecto"}},{"in":"query","name":"filter[path_exact]","description":"Filter notes by a string to see if the path is that string.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter notes by a string to see if the path is that string.","example":"architecto"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-updated_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NoteResource"}}}}}}}},"tags":["Notes"]},"parameters":[{"in":"path","name":"notableType","description":"","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"notableUuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"notable_type","description":"Optional parameter. The type of model to look for. Make sure it is a valid model type that can have notes. Valid types are: ['account', 'board_task', 'case', 'conversation', 'illustration'] .","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"case"}}},{"in":"path","name":"notable_uuid","description":"Optional parameter. The UUID of the notable model.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"6ff8f7f6-1eb3-3525-be4a-3932c805afed"}}}]},"/api/v1/notifications/subscribe/{subscribeableType}/{subscribeableUuid}":{"post":{"summary":"Subscribe to an item's notifications","operationId":"postApiV1NotificationsSubscribeSubscribeableTypeSubscribeableUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_SubscribeableResource"}}}}},"tags":["Notifications"]},"parameters":[{"in":"path","name":"subscribeableType","description":"Optional parameter. the model type","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}},{"in":"path","name":"subscribeableUuid","description":"Optional parameter. the model uuid","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"6ff8f7f6-1eb3-3525-be4a-3932c805afed"}}}]},"/api/v1/notifications/unsubscribe/{subscribeableType}/{subscribeableUuid}":{"post":{"summary":"Unsubscribe from an item's notifications","operationId":"postApiV1NotificationsUnsubscribeSubscribeableTypeSubscribeableUuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notifications"]},"parameters":[{"in":"path","name":"subscribeableType","description":"Optional parameter. the model type","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}},{"in":"path","name":"subscribeableUuid","description":"Optional parameter. the model uuid","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"6ff8f7f6-1eb3-3525-be4a-3932c805afed"}}}]},"/api/v1/notifications/read-all":{"post":{"summary":"Mark all notification as read","operationId":"postApiV1NotificationsReadAll","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notifications"]}},"/api/v1/notifications/read/{notification_id}":{"post":{"summary":"Mark a notification as read","operationId":"postApiV1NotificationsReadNotification_id","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notifications"]},"parameters":[{"in":"path","name":"notification_id","description":"The ID of the notification.","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"notification","description":"Optional parameter. the id of the notification to mark as read","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/notifications/unread/{notification_id}":{"post":{"summary":"Mark a notification as unread","operationId":"postApiV1NotificationsUnreadNotification_id","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Notifications"]},"parameters":[{"in":"path","name":"notification_id","description":"The ID of the notification.","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"notification","description":"Optional parameter. the id of the notification to mark as unread","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/notifications":{"get":{"summary":"Get all notifications","operationId":"getApiV1Notifications","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[read]","description":"Filter notifications by if they have been marked as read or not. leave blank to get both read and unread notifications","example":false,"required":false,"schema":{"type":"boolean","description":"Filter notifications by if they have been marked as read or not. leave blank to get both read and unread notifications","example":false}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","example":"ac9a1dca-dc5c-440a-a4f4-dfc9ccac0ce0","description":"Notification UUID"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the notification was created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the notification was updated"},"read_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the notification was read"},"data":{"type":"object","properties":{"title":{"type":"string","example":"notification-title"},"description":{"type":"string","example":"notification-description"},"model_uuid":{"type":"string","example":"b70d5878-32ba-40f7-a10e-7fe3f0a41ea3"},"model_type":{"type":"string","example":"firm"}},"description":"array of data that was sent on the notification","$ref":"#/components/schemas/App_Http_Resources_NotificationResource"},"type":{"type":"string","example":"App/Notifications/AppNotification","description":"type of notification sent"},"notifiable":{"type":"object","properties":{"uuid":{"type":"string","example":"b910dea3-9cba-4fcb-8f20-32e4f3b3224e"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"the notifiable model to notification is attached to, in most cases an Account"},"triggered_by":{"type":"object","properties":{"uuid":{"type":"string","example":"6941fba7-ce23-4479-8453-3b2d2a967d80"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"the account that triggered this notification"}}}}}}},"tags":["Notifications"]}},"/api/v1/notifications/{id}":{"get":{"summary":"Get a notification","operationId":"getApiV1NotificationsId","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","example":"cc3f6012-2f46-40d4-bbb9-337f17895077","description":"Notification UUID"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the notification was created"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the notification was updated"},"read_at":{"type":"string","example":"2026-05-08T14:41:54+01:00","description":"Timestamp of when the notification was read"},"data":{"type":"object","properties":{"title":{"type":"string","example":"notification-title"},"description":{"type":"string","example":"notification-description"},"model_uuid":{"type":"string","example":"73d40a7c-0cd6-43ed-806f-532ceb10327e"},"model_type":{"type":"string","example":"firm"}},"description":"array of data that was sent on the notification","$ref":"#/components/schemas/App_Http_Resources_NotificationResource"},"type":{"type":"string","example":"App/Notifications/AppNotification","description":"type of notification sent"},"notifiable":{"type":"object","properties":{"uuid":{"type":"string","example":"411663be-7679-49de-aa77-1c0a7d7904af"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"the notifiable model to notification is attached to, in most cases an Account"},"triggered_by":{"type":"object","properties":{"uuid":{"type":"string","example":"337f3f36-f637-4e4e-a9e4-5260eb0c9581"},"created_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"updated_at":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"type":{"type":"string","example":"client"},"role":{"type":"string","example":"client"},"first_name":{"type":"string","example":"Gareth"},"last_name":{"type":"string","example":"Thompson"},"name":{"type":"string","example":"Gareth Thompson"},"email":{"type":"string","example":"gareth@codepotato.co.uk"},"photo_url":{"type":"string","example":"https://eu.ui-avatars.com/api/?name=gareth+thompson"},"firm":{"type":"string","example":"App\\Http\\Resources\\FirmResource"},"primary_phone_number":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"primary_email":{"type":"string","example":"App\\Http\\Resources\\ContactDetailResource"},"current_time_entry":{"type":"string","example":"App\\Http\\Resources\\TimeEntryResource"},"assigned_adviser":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_administrator":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"assigned_paraplanner":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"introduced_by":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"business_unit":{"type":"string","example":"App\\Http\\Resources\\BusinessUnitResource"},"groups":{"type":"string","example":"App\\Http\\Resources\\GroupResource"},"tags":{"type":"string","example":"App\\Http\\Resources\\TagResource"},"owners":{"type":"string","example":"App\\Http\\Resources\\AccountResource"},"first_contact_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"next_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"previous_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"anniversary_review_date":{"type":"string","example":"2026-05-08T14:41:54+01:00"},"with_login":{"type":"boolean","example":true},"has_joint_account":{"type":"boolean","example":true},"can_be_deleted":{"type":"string","example":"false"},"joint_account_circle":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"circles":{"type":"string","example":"App\\Http\\Resources\\CircleResource"},"ownership_percentage":{"type":"integer","example":100},"inactive_at":{"type":"string","example":"2026-05-08"},"last_interaction_at":{"type":"string","example":"2026-05-08 14:41:54"},"referral_code":{"type":"string","example":"ABC12345"},"permissions":{"type":"object","properties":{"firm:read":{"type":"array","example":["firm"],"items":{"type":"string"}},"network:read":{"type":"array","example":["network:uuid"],"items":{"type":"string"}}}},"custom_fields":{"type":"string","example":"App\\Http\\Resources\\CustomFieldValueResource"},"external_references":{"type":"string","example":"App\\Http\\Resources\\ExternalReferenceResource"}},"description":"the account that triggered this notification"}}}}}}},"tags":["Notifications"]},"delete":{"summary":"Permanently delete a notification","operationId":"deleteApiV1NotificationsId","description":"","parameters":[],"responses":{},"tags":["Notifications"]},"parameters":[{"in":"path","name":"id","description":"The ID of the notification.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/oauth/providers":{"get":{"summary":"List all the available OAuth2 providers","operationId":"getApiV1OauthProviders","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_OAuth_OAuthProviderResource"}}}}}}}},"tags":["OAuth2 Connections (External Only)"]}},"/api/v1/oauth/connections":{"get":{"summary":"List all OAuth2 connections","operationId":"getApiV1OauthConnections","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_OAuth_OAuthConnectionResource"}}}}}}}},"tags":["OAuth2 Connections (External Only)"]}},"/api/v1/oauth/connections/{oauthConnection_uuid}":{"put":{"summary":"Update an OAuth2 connection","operationId":"putApiV1OauthConnectionsOauthConnection_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_OAuth_OAuthConnectionResource"}}}}},"tags":["OAuth2 Connections (External Only)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_OAuth2_UpdateOAuthConnectionRequest"}}}}},"delete":{"summary":"Delete an OAuth2 connection","operationId":"deleteApiV1OauthConnectionsOauthConnection_uuid","description":"This will remove the connection entirely between the account and the third party.\nPlease be cautious using this API endpoint as it can potentially damage the\nreliability of addons that depend on the connection.","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["OAuth2 Connections (External Only)"]},"parameters":[{"in":"path","name":"oauthConnection_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/plans/{plan_uuid}/returns":{"get":{"summary":"Calculate returns for a plan within a date range","operationId":"getApiV2PlansPlan_uuidReturns","description":"\u003caside class=\"notice\"\u003e\n\u003cstrong\u003eFeature Required:\u003c/strong\u003e The Performance Reporting feature must be enabled for your firm to access this endpoint.\nContact support if you need this feature enabled.\n\u003c/aside\u003e","parameters":[{"in":"query","name":"filter[date_from]","description":"Date to filter the start of the calculations.","example":"2025-08-15","required":false,"schema":{"type":"string","description":"Date to filter the start of the calculations.","example":"2025-08-15"}},{"in":"query","name":"filter[date_to]","description":"Date to filter the start of the calculations.","example":"2025-08-30","required":false,"schema":{"type":"string","description":"Date to filter the start of the calculations.","example":"2025-08-30"}},{"in":"query","name":"includePlan","description":"Include plan data with valuations and transactions.","example":true,"required":false,"schema":{"type":"boolean","description":"Include plan data with valuations and transactions.","example":true}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_PlanReturnResource"}}}}}}}},"tags":["Plan Returns"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans":{"get":{"summary":"Get all plans","operationId":"getApiV1Plans","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=fields,latest_valuations","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=fields,latest_valuations"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[abstract_type]","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection","required":false,"schema":{"type":"string","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash","required":false,"schema":{"type":"string","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash"}},{"in":"query","name":"filter[name]","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage","required":false,"schema":{"type":"string","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage"}},{"in":"query","name":"filter[client]","description":"Comma separated list of client names to search against, can include partial matches.","example":"Thompson,Gar","required":false,"schema":{"type":"string","description":"Comma separated list of client names to search against, can include partial matches.","example":"Thompson,Gar"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exact_account_uuids]","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636","required":false,"schema":{"type":"string","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834","required":false,"schema":{"type":"string","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834"}},{"in":"query","name":"filter[provider]","description":"Comma separated list of provider names or provider UUIDs to search against, can include partial matches.","example":"Nationwide","required":false,"schema":{"type":"string","description":"Comma separated list of provider names or provider UUIDs to search against, can include partial matches.","example":"Nationwide"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto"}},{"in":"query","name":"filter[seller]","description":"Comma separated list of adviser names or adviser UUIDs of who sold the plan to search against, can include partial matches.","example":"Thompson,Gar","required":false,"schema":{"type":"string","description":"Comma separated list of adviser names or adviser UUIDs of who sold the plan to search against, can include partial matches.","example":"Thompson,Gar"}},{"in":"query","name":"filter[active_adviser]","description":"Comma separated list of adviser names or adviser UUIDs of who is actively managing the plan to search against, can include partial matches.","example":"Thompson,Gar","required":false,"schema":{"type":"string","description":"Comma separated list of adviser names or adviser UUIDs of who is actively managing the plan to search against, can include partial matches.","example":"Thompson,Gar"}},{"in":"query","name":"filter[case]","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078","required":false,"schema":{"type":"string","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078"}},{"in":"query","name":"filter[valuation_from]","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000}},{"in":"query","name":"filter[valuation_to]","description":"Amount in pennies to filter where latest valuation is less than.","example":5000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is less than.","example":5000}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[is_wrap_product]","description":"filter the plans by if they are a wrap product","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they are a wrap product","example":true}},{"in":"query","name":"filter[agency_in_your_name]","description":"filter the plans by if they have agency in your name","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they have agency in your name","example":true}},{"in":"query","name":"filter[hide_wrap_children]","description":"Used to hide the wrap children from the primary list of plans.","example":true,"required":false,"schema":{"type":"boolean","description":"Used to hide the wrap children from the primary list of plans.","example":true}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}}}}},"tags":["Plans"]},"post":{"summary":"Create a plan","operationId":"postApiV1Plans","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StorePlanRequest"}}}}}},"/api/v1/plans/{uuid}":{"get":{"summary":"Get a plan","operationId":"getApiV1PlansUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}},"tags":["Plans"]},"delete":{"summary":"Delete a plan","operationId":"deleteApiV1PlansUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}},"tags":["Plans"]},"put":{"summary":"Update a plan","operationId":"putApiV1PlansUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdatePlanRequest"}}}}},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"plan","description":"The UUID of the plan","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/ownership":{"put":{"summary":"Update a plan's ownership without updating the rest of the plan","operationId":"putApiV1PlansPlan_uuidOwnership","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdatePlanOwnershipRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"plan","description":"The UUID of the plan","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}":{"get":{"summary":"Get the valuations formatted for a graph","operationId":"getApiV1PlansPlan_uuidReportingValuationsSubAccount","description":"","parameters":[{"in":"query","name":"start_date","description":"date Optional date to constrain only valuations from this date. For example: ?start_date=2022-06-12","example":"architecto","required":false,"schema":{"type":"string","description":"date Optional date to constrain only valuations from this date. For example: ?start_date=2022-06-12","example":"architecto"}},{"in":"query","name":"end_date","description":"date Optional date to constrain only valuations up until this date. For example: ?end_date=2022-06-18","example":"architecto","required":false,"schema":{"type":"string","description":"date Optional date to constrain only valuations up until this date. For example: ?end_date=2022-06-18","example":"architecto"}},{"in":"query","name":"limit","description":"Optional limit to constrain the number of unique days returned","example":16,"required":false,"schema":{"type":"integer","description":"Optional limit to constrain the number of unique days returned","example":16}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ValuationGraphResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_ShowValuationsGraphRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/plans/{plan_uuid}/new-business-events":{"get":{"summary":"Get all plan's new business events","operationId":"getApiV1PlansPlan_uuidNewBusinessEvents","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=fields,latest_valuations","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=fields,latest_valuations"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[type]","description":"Plan type to filter by.","example":"pension","required":false,"schema":{"type":"string","description":"Plan type to filter by.","example":"pension"}},{"in":"query","name":"filter[sub_type]","description":"Plan sub type to filter by.","example":"master_trust_pension","required":false,"schema":{"type":"string","description":"Plan sub type to filter by.","example":"master_trust_pension"}},{"in":"query","name":"filter[provider_uuid]","description":"Plan's provider UUID to filter by.","example":"c000d7ee-e4b5-4336-a8bd-991a1bf71b03","required":false,"schema":{"type":"string","description":"Plan's provider UUID to filter by.","example":"c000d7ee-e4b5-4336-a8bd-991a1bf71b03"}},{"in":"query","name":"filter[policy_number]","description":"Fuzzy search for plan policy number.","example":"123456","required":false,"schema":{"type":"string","description":"Fuzzy search for plan policy number.","example":"123456"}},{"in":"query","name":"filter[adviser_uuid]","description":"Adviser's UUID to filter by.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469","required":false,"schema":{"type":"string","description":"Adviser's UUID to filter by.","example":"3c96a26c-4ac3-4805-b1bb-cc08abd95469"}},{"in":"query","name":"filter[advice_type]","description":"Exact search for an advice type.","example":"direct_offer","required":false,"schema":{"type":"string","description":"Exact search for an advice type.","example":"direct_offer"}},{"in":"query","name":"filter[conducted_by]","description":"Exact search for how the advice was conducted.","example":"face_to_face","required":false,"schema":{"type":"string","description":"Exact search for how the advice was conducted.","example":"face_to_face"}},{"in":"query","name":"filter[status]","description":"Current status of the event.","example":"accepted","required":false,"schema":{"type":"string","description":"Current status of the event.","example":"accepted"}},{"in":"query","name":"filter[source_of_funds]","description":"Exact search for source of funds.","example":"savings","required":false,"schema":{"type":"string","description":"Exact search for source of funds.","example":"savings"}},{"in":"query","name":"filter[is_replacing_existing_plan]","description":"Whether the plan is replacing an existing plan.","example":true,"required":false,"schema":{"type":"boolean","description":"Whether the plan is replacing an existing plan.","example":true}},{"in":"query","name":"filter[opted_out_of_pension_scheme_for_plan]","description":"Whether the client opted out of pension scheme for the plan.","example":true,"required":false,"schema":{"type":"boolean","description":"Whether the client opted out of pension scheme for the plan.","example":true}},{"in":"query","name":"filter[date_from]","description":"Started after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Started after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[date_to]","description":"Started before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Started before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[proposed_date_from]","description":"Proposed after this date.","example":"2020-01-01","required":false,"schema":{"type":"string","description":"Proposed after this date.","example":"2020-01-01"}},{"in":"query","name":"filter[proposed_date_to]","description":"Proposed before this date.","example":"2020-12-31","required":false,"schema":{"type":"string","description":"Proposed before this date.","example":"2020-12-31"}},{"in":"query","name":"filter[contribution_type]","description":"Exact search for the contribution type.","example":"decrement","required":false,"schema":{"type":"string","description":"Exact search for the contribution type.","example":"decrement"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [start_date,created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [start_date,created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_NewBusinessEventResource"}}}}}}}},"tags":["Plans"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/group-scheme-members":{"get":{"summary":"Get all group scheme members","operationId":"getApiV1PlansPlan_uuidGroupSchemeMembers","description":"Retrieve the group scheme members for a plan","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_name]","description":"Filter members by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter members by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[status]","description":"Filter members by their status. Options: active, inactive, proposed","example":"architecto","required":false,"schema":{"type":"string","description":"Filter members by their status. Options: active, inactive, proposed","example":"architecto"}},{"in":"query","name":"filter[on_risk_at]","description":"date Filter staff members by their on_risk_at. This can be a single value for one date or use a comma to search between. E.g 2021-01-01,2023-12-31","example":"architecto","required":false,"schema":{"type":"string","description":"date Filter staff members by their on_risk_at. This can be a single value for one date or use a comma to search between. E.g 2021-01-01,2023-12-31","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, premium, status]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, premium, status]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_GroupSchemeMemberResource"}}}}}}}},"tags":["Plans"]},"post":{"summary":"Create a group scheme member","operationId":"postApiV1PlansPlan_uuidGroupSchemeMembers","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_GroupSchemeMemberResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreGroupSchemeMemberRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"uuid The UUID of the group scheme plan.","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-group-schemes":{"get":{"summary":"Get all sub schemes for a group scheme","operationId":"getApiV1PlansPlan_uuidSubGroupSchemes","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[client_name]","description":"Filter members by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter members by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[status]","description":"Filter members by their status. Options: active, inactive, proposed","example":"architecto","required":false,"schema":{"type":"string","description":"Filter members by their status. Options: active, inactive, proposed","example":"architecto"}},{"in":"query","name":"filter[on_risk_at]","description":"date Filter staff members by their on_risk_at. This can be a single value for one date or use a comma to search between. E.g 2021-01-01,2023-12-31","example":"architecto","required":false,"schema":{"type":"string","description":"date Filter staff members by their on_risk_at. This can be a single value for one date or use a comma to search between. E.g 2021-01-01,2023-12-31","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, premium, status]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, premium, status]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_GroupSchemeMemberResource"}}}}}}}},"tags":["Plans"]},"post":{"summary":"Create a sub-scheme for a group scheme plan","operationId":"postApiV1PlansPlan_uuidSubGroupSchemes","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubGroupSchemeResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreSubGroupSchemeRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"uuid The UUID of the group scheme plan.","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/provider-feed-sync":{"post":{"summary":"Request Plan Data From Provider (Beta)","operationId":"postApiV1PlansPlan_uuidProviderFeedSync","description":"Only works if the corresponding addon has been enabled in Plannr. The process is queued.\nOnly works with specific providers.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"202":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Plans"]},"parameters":[{"in":"path","name":"plan_uuid","description":"uuid The UUID of the group scheme plan.","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/provider-feed-logs":{"get":{"summary":"Get all the provider feed logs for a given plan","operationId":"getApiV1PlansPlan_uuidProviderFeedLogs","description":"","parameters":[{"in":"query","name":"filter[sub_account_uuids]","description":"Filter by a comma separated list of sub account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of sub account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, level]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, level]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ProviderFeedLogResource"}}}}},"tags":["Plans"]},"parameters":[{"in":"path","name":"plan_uuid","description":"uuid The UUID of the group scheme plan.","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/illustrations":{"get":{"summary":"Get all the illustrations for a plan","operationId":"getApiV1PlansPlan_uuidIllustrations","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [firm, client, plan, requestedBy].","example":"?include=firm","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [firm, client, plan, requestedBy].","example":"?include=firm"}},{"in":"query","name":"filter[created_after]","description":"Illustration created after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration created after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto"}},{"in":"query","name":"filter[created_before]","description":"Illustration created before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration created before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto"}},{"in":"query","name":"filter[generated_after]","description":"Illustration generated after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration generated after in format YYYY-MM-DD e.g. 2022-10-15","example":"architecto"}},{"in":"query","name":"filter[generated_before]","description":"Illustration generated before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto","required":false,"schema":{"type":"string","description":"Illustration generated before in format YYYY-MM-DD e.g. 2022-12-30","example":"architecto"}},{"in":"query","name":"filter[platform]","description":"Illustration platform.","example":"'seccl'","required":false,"schema":{"type":"string","description":"Illustration platform.","example":"'seccl'"}},{"in":"query","name":"filter[requested_by_uuid]","description":"Illustration requested by account uuid.","example":"'123e4567-e89b-12d3-a456-426614174000'","required":false,"schema":{"type":"string","description":"Illustration requested by account uuid.","example":"'123e4567-e89b-12d3-a456-426614174000'"}},{"in":"query","name":"filter[name]","description":"Fuzzy search for Illustration name.","example":"'My Illustration'","required":false,"schema":{"type":"string","description":"Fuzzy search for Illustration name.","example":"'My Illustration'"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, generated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-generated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, generated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-generated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IllustrationResource"}}}}},"tags":["Plans"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/plans/linked-policy-numbers":{"get":{"summary":"Get all linked policy numbers","operationId":"getApiV2PlansLinkedPolicyNumbers","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[linked_policy_number]","description":"Filter by a comma separated list of partial linked policy numbers of the linked policy numbers.","example":"ABC123-X","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of partial linked policy numbers of the linked policy numbers.","example":"ABC123-X"}},{"in":"query","name":"filter[policy_number]","description":"Filter by a comma separated list of partial policy numbers of the plans the linked policy numbers belong to.","example":"ABC123-X","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of partial policy numbers of the plans the linked policy numbers belong to.","example":"ABC123-X"}},{"in":"query","name":"filter[plan_uuid]","description":"Filter by a comma separated list of plan UUIDs the linked policy numbers belong to.","example":"d8d33353-54bb-58ca-afc7-4b346e89bfa8,2765c3d5-529e-5537-98cb-bf920ad77481","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs the linked policy numbers belong to.","example":"d8d33353-54bb-58ca-afc7-4b346e89bfa8,2765c3d5-529e-5537-98cb-bf920ad77481"}},{"in":"query","name":"filter[provider_uuids]","description":"Filter by a comma separated list provider UUIDS.","example":"576ef4cf-cfad-5739-b34a-86184fae65a2,dc10e613-0e3b-5d38-8701-5f7bd5114945","required":false,"schema":{"type":"string","description":"Filter by a comma separated list provider UUIDS.","example":"576ef4cf-cfad-5739-b34a-86184fae65a2,dc10e613-0e3b-5d38-8701-5f7bd5114945"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list account UUIDS.","example":"53e578f7-af24-5f39-a960-1a069aba7252,38ac923c-6ade-525c-ba20-6f148f10c5c7","required":false,"schema":{"type":"string","description":"Filter by a comma separated list account UUIDS.","example":"53e578f7-af24-5f39-a960-1a069aba7252,38ac923c-6ade-525c-ba20-6f148f10c5c7"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, linked_policy_number, policy_number, provider]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"policy_number","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, linked_policy_number, policy_number, provider]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"policy_number"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_LinkedPolicyNumberResource"}}}}}}}},"tags":["Plans"]}},"/api/v2/plans/{plan_uuid}/linked-policy-numbers":{"post":{"summary":"Create an linked policy number","operationId":"postApiV2PlansPlan_uuidLinkedPolicyNumbers","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_LinkedPolicyNumberResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreLinkedPolicyNumberRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}":{"put":{"summary":"Update an linked policy number","operationId":"putApiV2PlansPlan_uuidLinkedPolicyNumbersUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_LinkedPolicyNumberResource"}}}}},"tags":["Plans"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateLinkedPolicyNumberRequest"}}}}},"delete":{"summary":"Delete an linked policy number","operationId":"deleteApiV2PlansPlan_uuidLinkedPolicyNumbersUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Plans"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/plans":{"get":{"summary":"Get all plans","operationId":"getApiV2Plans","description":"This endpoint will return all plans in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"date","description":"Date in format Y-m-d to get the plan's value at the date. Defaults to current date if not provided.","example":"2025-07-11","required":false,"schema":{"type":"string","description":"Date in format Y-m-d to get the plan's value at the date. Defaults to current date if not provided.","example":"2025-07-11"}},{"in":"query","name":"include_circle_plans","description":"When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true,"required":false,"schema":{"type":"boolean","description":"When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.","example":true}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [cases, tags, sub_accounts, wrap, wrap_children, wrap_children.provider, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [cases, tags, sub_accounts, wrap, wrap_children, wrap_children.provider, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[abstract_type]","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection","required":false,"schema":{"type":"string","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash","required":false,"schema":{"type":"string","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash"}},{"in":"query","name":"filter[sub_type]","description":"Comma separated list of sub types.","example":"national_savings,term_protection.","required":false,"schema":{"type":"string","description":"Comma separated list of sub types.","example":"national_savings,term_protection."}},{"in":"query","name":"filter[name]","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage","required":false,"schema":{"type":"string","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exact_account_uuids]","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636","required":false,"schema":{"type":"string","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834","required":false,"schema":{"type":"string","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2","required":false,"schema":{"type":"string","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[active_adviser_uuids]","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[case_uuids]","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078","required":false,"schema":{"type":"string","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078"}},{"in":"query","name":"filter[valuation_from]","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000}},{"in":"query","name":"filter[valuation_to]","description":"Amount in pennies to filter where latest valuation is less than.","example":5000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is less than.","example":5000}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[is_wrap_product]","description":"filter the plans by if they are a wrap product","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they are a wrap product","example":true}},{"in":"query","name":"filter[hide_wrap_children]","description":"Used to hide the wrap children from the primary list of plans.","example":true,"required":false,"schema":{"type":"boolean","description":"Used to hide the wrap children from the primary list of plans.","example":true}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}}}}},"tags":["Plans (v2)"]}},"/api/v2/plans/line-graph":{"get":{"summary":"Get line graph of plans valuations","operationId":"getApiV2PlansLineGraph","description":"This endpoint will return the plans in the firm relevant to the user accessing them with the plans values at the requested dates.","parameters":[{"in":"query","name":"date_after","description":"Date in Y-m-d format to request plan values starting from.","example":"architecto","required":false,"schema":{"type":"string","description":"Date in Y-m-d format to request plan values starting from.","example":"architecto"}},{"in":"query","name":"date_before","description":"string|null Date in Y-m-d format to request plan values up until. Will default to today if not provided.","example":"architecto","required":false,"schema":{"type":"string","description":"string|null Date in Y-m-d format to request plan values up until. Will default to today if not provided.","example":"architecto"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [accounts].","example":"?include=accounts"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[abstract_type]","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection","required":false,"schema":{"type":"string","description":"Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]","example":"protection"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash","required":false,"schema":{"type":"string","description":"Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]","example":"mortgage,cash"}},{"in":"query","name":"filter[sub_type]","description":"Comma separated list of sub types.","example":"national_savings,term_protection.","required":false,"schema":{"type":"string","description":"Comma separated list of sub types.","example":"national_savings,term_protection."}},{"in":"query","name":"filter[name]","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage","required":false,"schema":{"type":"string","description":"Comma separated list of plan names to search against, can include partial matches.","example":"Savings ISA,Jacks Mortgage"}},{"in":"query","name":"filter[account_uuids]","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of client UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[exact_account_uuids]","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636","required":false,"schema":{"type":"string","description":"Comma separated list of accounts UUIDs that are all the owners of a plan.","example":"0092d1d5-385e-5845-8a55-7734cb04247b,e5acf64b-2552-5f77-abfb-ee61edca7636"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Comma separated list of circle UUIDs to search against.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[policy_number]","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834","required":false,"schema":{"type":"string","description":"Comma separated list of policy numbers to search against, can include partial matches.","example":"AV7834"}},{"in":"query","name":"filter[provider_uuids]","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2","required":false,"schema":{"type":"string","description":"Comma separated list of provider provider UUIDs to search against.","example":"78fed82a-4e82-5afe-a97f-d9ff97c11c4b,2a43f1dc-53af-5ba2-aee7-fdc6b65f86d2"}},{"in":"query","name":"filter[status]","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]","example":"architecto"}},{"in":"query","name":"filter[seller_uuids]","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who sold the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[active_adviser_uuids]","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5","required":false,"schema":{"type":"string","description":"Comma separated list of adviser UUIDs of who is actively managing the plan to search against.","example":"0eeb565c-88c4-5cea-8cc4-d814a8e60216,fa12f333-6a19-5955-baa9-1389073934c5"}},{"in":"query","name":"filter[case_uuids]","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078","required":false,"schema":{"type":"string","description":"Comma separated list of case UUIDs","example":"9881c05b-eeb3-4520-9232-d6d33fe0ad6b,f9f0bd15-1af0-4113-9f3d-ebdeea6c2078"}},{"in":"query","name":"filter[valuation_from]","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is greater than.","example":1000}},{"in":"query","name":"filter[valuation_to]","description":"Amount in pennies to filter where latest valuation is less than.","example":5000,"required":false,"schema":{"type":"integer","description":"Amount in pennies to filter where latest valuation is less than.","example":5000}},{"in":"query","name":"filter[custom_field:REFERENCE]","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin","example":"architecto"}},{"in":"query","name":"filter[tags]","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b","required":false,"schema":{"type":"string","description":"Comma separated list of tag names or tag UUIDs.","example":"Review,e995263e-7477-4118-8860-de295bafbe0b"}},{"in":"query","name":"filter[is_wrap_product]","description":"filter the plans by if they are a wrap product","example":true,"required":false,"schema":{"type":"boolean","description":"filter the plans by if they are a wrap product","example":true}},{"in":"query","name":"filter[hide_wrap_children]","description":"Used to hide the wrap children from the primary list of plans.","example":true,"required":false,"schema":{"type":"boolean","description":"Used to hide the wrap children from the primary list of plans.","example":true}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PlanResource"}}}}}}}},"tags":["Plans (v2)"]}},"/api/v1/platform/{id}":{"get":{"summary":"Show Platform Detail","operationId":"getApiV1PlatformId","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_PlatformDetailResource"}}}}}}}},"tags":["Platform"]},"parameters":[{"in":"path","name":"id","description":"The ID of the platform.","example":"architecto","required":true,"schema":{"type":"string"}},{"in":"path","name":"platform","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"octopus_money"}}}]},"/api/v1/platform/{platform}/models":{"get":{"summary":"Get all models for a supported platform.","operationId":"getApiV1PlatformPlatformModels","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Platform_PlatformModelResource"}}}}}}}},"tags":["Platform"]},"parameters":[{"in":"path","name":"platform","description":"The platform.","example":"octopus_money","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/premiums":{"get":{"summary":"Get all premiums","operationId":"getApiV1PlansPlan_uuidPremiums","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [created_by,plan,transferred_from_plan]","example":"?include=created_by,plan,transferred_from_plan","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [created_by,plan,transferred_from_plan]","example":"?include=created_by,plan,transferred_from_plan"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[transfer_type]","description":"Filter by comma separated list of transfer type values.","example":"switch,transfer","required":false,"schema":{"type":"string","description":"Filter by comma separated list of transfer type values.","example":"switch,transfer"}},{"in":"query","name":"filter[date_advice_given_after]","description":"date Filter by date advice given after.","example":"2023-01-05","required":false,"schema":{"type":"string","description":"date Filter by date advice given after.","example":"2023-01-05"}},{"in":"query","name":"filter[date_advice_given_before]","description":"date Filter by date advice given before.","example":"2023-11-25","required":false,"schema":{"type":"string","description":"date Filter by date advice given before.","example":"2023-11-25"}},{"in":"query","name":"filter[amount_from]","description":"Filter by premium amount from in pennies.","example":"395525","required":false,"schema":{"type":"string","description":"Filter by premium amount from in pennies.","example":"395525"}},{"in":"query","name":"filter[amount_to]","description":"Filter by premium amount to in pennies.","example":"861436","required":false,"schema":{"type":"string","description":"Filter by premium amount to in pennies.","example":"861436"}},{"in":"query","name":"filter[frequency]","description":"Filter by comma separated list of frequency values.","example":"monthly,annually","required":false,"schema":{"type":"string","description":"Filter by comma separated list of frequency values.","example":"monthly,annually"}},{"in":"query","name":"filter[recurring]","description":"Filter by recurring premiums when true, or non recurring premiums when false.","example":false,"required":false,"schema":{"type":"boolean","description":"Filter by recurring premiums when true, or non recurring premiums when false.","example":false}},{"in":"query","name":"filter[source]","description":"Filter by comma separated list of source of premium values.","example":"employee,employer","required":false,"schema":{"type":"string","description":"Filter by comma separated list of source of premium values.","example":"employee,employer"}},{"in":"query","name":"filter[payment_method]","description":"Filter by comma separated list of payment method values.","example":"salary_sacrifice,bank_transfer","required":false,"schema":{"type":"string","description":"Filter by comma separated list of payment method values.","example":"salary_sacrifice,bank_transfer"}},{"in":"query","name":"filter[start_date_after]","description":"date Filter by start date after.","example":"2023-02-13","required":false,"schema":{"type":"string","description":"date Filter by start date after.","example":"2023-02-13"}},{"in":"query","name":"filter[start_date_before]","description":"date Filter by start date before.","example":"2023-08-10","required":false,"schema":{"type":"string","description":"date Filter by start date before.","example":"2023-08-10"}},{"in":"query","name":"filter[end_date_after]","description":"date Filter by end date after.","example":"2023-04-27","required":false,"schema":{"type":"string","description":"date Filter by end date after.","example":"2023-04-27"}},{"in":"query","name":"filter[end_date_before]","description":"date Filter by end date before.","example":"2023-01-14","required":false,"schema":{"type":"string","description":"date Filter by end date before.","example":"2023-01-14"}},{"in":"query","name":"filter[start_date]","description":"date Filter by start date. This supports operators.","example":"\u003e=2023-01-14","required":false,"schema":{"type":"string","description":"date Filter by start date. This supports operators.","example":"\u003e=2023-01-14"}},{"in":"query","name":"filter[end_date]","description":"date Filter by end date. This supports operators.","example":"\u003c=2023-01-14","required":false,"schema":{"type":"string","description":"date Filter by end date. This supports operators.","example":"\u003c=2023-01-14"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, date_advice_given, premium, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, date_advice_given, premium, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PremiumResource"}}}}}}}},"tags":["Premiums"]},"post":{"summary":"Create a premium","operationId":"postApiV1PlansPlan_uuidPremiums","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PremiumResource"}}}}},"tags":["Premiums"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StorePremiumRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/premiums/{uuid}":{"get":{"summary":"Get a premium","operationId":"getApiV1PlansPlan_uuidPremiumsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PremiumResource"}}}}},"tags":["Premiums"]},"put":{"summary":"Update a premium","operationId":"putApiV1PlansPlan_uuidPremiumsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PremiumResource"}}}}},"tags":["Premiums"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdatePremiumRequest"}}}}},"delete":{"summary":"Delete a premium","operationId":"deleteApiV1PlansPlan_uuidPremiumsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Premiums"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/providers":{"get":{"summary":"List all providers","operationId":"getApiV1Providers","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter by a comma separated list of partial provider names.","example":"Aviva,Standard Life","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of partial provider names.","example":"Aviva,Standard Life"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ProviderResource"}}}}}}}},"tags":["Providers"]}},"/api/v1/providers/{uuid}":{"get":{"summary":"Get an individual provider","operationId":"getApiV1ProvidersUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ProviderResource"}}}}},"tags":["Providers"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/reaction":{"post":{"summary":"Create a reaction","operationId":"postApiV1Reaction","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Reactions"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Reaction_StoreReactionRequest"}}}}}},"/api/v1/reaction/{uuid}":{"delete":{"summary":"Delete a reaction","operationId":"deleteApiV1ReactionUuid","description":"","parameters":[],"responses":{},"tags":["Reactions"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/report-template":{"get":{"summary":"Get all Report Templates","operationId":"getApiV1ReportTemplate","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[report_type_id]","description":"Exact filter for type of report to return","example":"architecto","required":false,"schema":{"type":"string","description":"Exact filter for type of report to return","example":"architecto"}},{"in":"query","name":"filter[created_by]","description":"Comma separated list of adviser uuids to filter reports created by these accounts","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of adviser uuids to filter reports created by these accounts","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [updated_at,created_at,name,report_type_id]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [updated_at,created_at,name,report_type_id]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportTemplateResource"}}}}}}}},"tags":["Report Templates"]},"post":{"summary":"Create a Report Template","operationId":"postApiV1ReportTemplate","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportTemplateResource"}}}}},"tags":["Report Templates"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreReportTemplateRequest"}}}}}},"/api/v1/report-template/{reportTemplate_uuid}":{"get":{"summary":"Get a Report Template","operationId":"getApiV1ReportTemplateReportTemplate_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportTemplateResource"}}}}},"tags":["Report Templates"]},"put":{"summary":"Update a Report Template","operationId":"putApiV1ReportTemplateReportTemplate_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportTemplateResource"}}}}},"tags":["Report Templates"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateReportTemplateRequest"}}}}},"delete":{"summary":"Delete a Report Template","operationId":"deleteApiV1ReportTemplateReportTemplate_uuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Report Templates"]},"parameters":[{"in":"path","name":"reportTemplate_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/report-type":{"get":{"summary":"Get all Report Types","operationId":"getApiV1ReportType","description":"","parameters":[{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportTemplateResource"}}}}}}}},"tags":["Report Types"]}},"/api/v1/report":{"get":{"summary":"Get All Reports","operationId":"getApiV1Report","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[report_type_id]","description":"Exact filter for type of report to return","example":"architecto","required":false,"schema":{"type":"string","description":"Exact filter for type of report to return","example":"architecto"}},{"in":"query","name":"filter[created_by]","description":"list of adviser uuids to filter reports created by these accounts","example":"architecto","required":false,"schema":{"type":"string","description":"list of adviser uuids to filter reports created by these accounts","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [updated_at, created_at, name, report_type_id]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [updated_at, created_at, name, report_type_id]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportResource"}}}}}}}},"tags":["Reports"]},"post":{"summary":"Generate a new Report","operationId":"postApiV1Report","description":"","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportResource"}}}}},"tags":["Reports"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Reports_StoreReportRequest"}}}}}},"/api/v1/report/{uuid}":{"get":{"summary":"Get Report","operationId":"getApiV1ReportUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ReportResource"}}}}},"tags":["Reports"]},"delete":{"summary":"Delete a Report","operationId":"deleteApiV1ReportUuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Reports"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/risk":{"get":{"summary":"Get all risks for Client","operationId":"getApiV1ClientClient_uuidRisk","description":"View all risks for a client","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [completed_by].","example":"?include=completed_by","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [completed_by].","example":"?include=completed_by"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-completed_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-completed_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_RiskResource"}}}}}}}},"tags":["Risks (v1)"]},"post":{"summary":"Create a risk assessment","operationId":"postApiV1ClientClient_uuidRisk","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_RiskResource"}}}}},"tags":["Risks (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Risk_StoreRiskRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/risk/{uuid}":{"get":{"summary":"Show a risk assessment","operationId":"getApiV1ClientClient_uuidRiskUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_RiskResource"}}}}},"tags":["Risks (v1)"]},"put":{"summary":"Update a risk assessment","operationId":"putApiV1ClientClient_uuidRiskUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_RiskResource"}}}}},"tags":["Risks (v1)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Risk_UpdateRiskRequest"}}}}},"delete":{"summary":"Delete a risk assessment","operationId":"deleteApiV1ClientClient_uuidRiskUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Risks (v1)"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/risks":{"get":{"summary":"Get all risks","operationId":"getApiV2Risks","description":"This endpoint will return all risks in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[level]","description":"Filter by the numeric level value. Whole number between 1 and 1,000.","example":612,"required":false,"schema":{"type":"integer","description":"Filter by the numeric level value. Whole number between 1 and 1,000.","example":612}},{"in":"query","name":"filter[level_string]","description":"Filter by the string/text version of risk level of the client.","example":"High Risk","required":false,"schema":{"type":"string","description":"Filter by the string/text version of risk level of the client.","example":"High Risk"}},{"in":"query","name":"filter[completed_after]","description":"Date (with optional time) to filter when the record was created after.","example":"2022-04-05","required":false,"schema":{"type":"string","description":"Date (with optional time) to filter when the record was created after.","example":"2022-04-05"}},{"in":"query","name":"filter[completed_before]","description":"Date (with optional time) to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date (with optional time) to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[risk_assessment_provider]","description":"Filter by the name of provider for the risk assessment.","example":"Defaqto","required":false,"schema":{"type":"string","description":"Filter by the name of provider for the risk assessment.","example":"Defaqto"}},{"in":"query","name":"filter[time_horizon_set_after]","description":"Date (with optional time) to filter when the record was created after.","example":"2022-04-05 07:45","required":false,"schema":{"type":"string","description":"Date (with optional time) to filter when the record was created after.","example":"2022-04-05 07:45"}},{"in":"query","name":"filter[time_horizon_set_before]","description":"Date (with optional time) to filter when the record was created before.","example":"2022-05-31","required":false,"schema":{"type":"string","description":"Date (with optional time) to filter when the record was created before.","example":"2022-05-31"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of circle UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [account, completed_by].","example":"?include=account","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [account, completed_by].","example":"?include=account"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-completed_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_at]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"-completed_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_RiskResource"}}}}}}}},"tags":["Risks (v2)"]},"post":{"summary":"Create a risk","operationId":"postApiV2Risks","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_RiskResource"}}}}},"tags":["Risks (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Risks_StoreRiskRequest"}}}}}},"/api/v2/risks/{uuid}":{"get":{"summary":"Get a risk","operationId":"getApiV2RisksUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_RiskResource"}}}}},"tags":["Risks (v2)"]},"put":{"summary":"Update a risk","operationId":"putApiV2RisksUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_RiskResource"}}}}},"tags":["Risks (v2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Risks_UpdateRiskRequest"}}}}},"delete":{"summary":"Delete a risk","operationId":"deleteApiV2RisksUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Risks (v2)"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/search":{"get":{"summary":"Typesense multi searching","operationId":"getApiV1Search","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_SearchRequest"}}}}}},"/api/v1/postcode/search":{"post":{"summary":"Postcode Searching","operationId":"postApiV1PostcodeSearch","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_PostcodeSearchRequest"}}}}}},"/api/v2/postcode/{factFindSession_uuid}/search":{"post":{"summary":"Postcode Searching","operationId":"postApiV2PostcodeFactFindSession_uuidSearch","description":"","parameters":[],"responses":{"500":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Server Error"},"properties":{"message":{"type":"string","example":"Server Error"}}}}}}},"tags":["Search"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_PostcodeSearchRequest"}}}}},"parameters":[{"in":"path","name":"factFindSession_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/shareholder":{"get":{"summary":"Get all shareholders","operationId":"getApiV2Shareholder","description":"","parameters":[{"in":"query","name":"include","description":"Comma-separated list of relationships to include in the response. Valid relationships are [account].","example":"?include=account","required":false,"schema":{"type":"string","description":"Comma-separated list of relationships to include in the response. Valid relationships are [account].","example":"?include=account"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma-separated list of UUIDs.","example":"123e4567-e89b-12d3-a456-426614174000","required":false,"schema":{"type":"string","description":"Filter by a comma-separated list of UUIDs.","example":"123e4567-e89b-12d3-a456-426614174000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, ownership_percentage]. Negative sign to denote DESC. Defaults to 'created_at'.","example":"-name","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, ownership_percentage]. Negative sign to denote DESC. Defaults to 'created_at'.","example":"-name"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ShareholderResource"}}}}}}}},"tags":["Shareholders"]},"post":{"summary":"Create a shareholder","operationId":"postApiV2Shareholder","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ShareholderResource"}}}}},"tags":["Shareholders"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreShareholderRequest"}}}}}},"/api/v2/shareholder/{uuid}":{"get":{"summary":"Show a shareholder","operationId":"getApiV2ShareholderUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ShareholderResource"}}}}},"tags":["Shareholders"]},"put":{"summary":"Update a shareholder","operationId":"putApiV2ShareholderUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_ShareholderResource"}}}}},"tags":["Shareholders"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateShareholderRequest"}}}}},"delete":{"summary":"Destroy a shareholder","operationId":"deleteApiV2ShareholderUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Shareholders"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/staff-members":{"get":{"summary":"Get all staff members","operationId":"getApiV1ClientClient_uuidStaffMembers","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter staff members by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter staff members by name. This is a partial match against first_name, last_name, and entity_name together.","example":"architecto"}},{"in":"query","name":"filter[active]","description":"Filter active staff members. Use \"true\" to only show active staff members and \"false\" to only show inactive staff members.","example":"architecto","required":false,"schema":{"type":"string","description":"Filter active staff members. Use \"true\" to only show active staff members and \"false\" to only show inactive staff members.","example":"architecto"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, hired_at, left_at, first_name, last_name]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, hired_at, left_at, first_name, last_name]. Negative sign to denote DESC.  Defaults to 'first_name'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StaffMemberResource"}}}}}}}},"tags":["Staff Members"]},"post":{"summary":"Create a staff member","operationId":"postApiV1ClientClient_uuidStaffMembers","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Staff Members"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_StoreStaffMemberRequest"}}}}},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/client/{client_uuid}/staff-members/{uuid}":{"get":{"summary":"Get a staff member","operationId":"getApiV1ClientClient_uuidStaffMembersUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StaffMemberResource"}}}}},"tags":["Staff Members"]},"put":{"summary":"Update a staff member","operationId":"putApiV1ClientClient_uuidStaffMembersUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{},"tags":["Staff Members"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Client_UpdateStaffMemberRequest"}}}}},"delete":{"summary":"Delete a staff member","operationId":"deleteApiV1ClientClient_uuidStaffMembersUuid","description":"This will not delete the client record, it will simply detach the staff member link.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Staff Members"]},"parameters":[{"in":"path","name":"client_uuid","description":"uuid The UUID of the business client.","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","description":"uuid The UUID of the client that is a staff member.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/statement":{"get":{"summary":"Get all statements","operationId":"getApiV1Statement","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [start_date, end_date, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-name","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [start_date, end_date, created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"-name"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementResource"}}}}}}}},"tags":["Statements"]}},"/api/v1/statement/{uuid}":{"get":{"summary":"Get a statement","operationId":"getApiV1StatementUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementResource"}}}}},"tags":["Statements"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/statement/{statement_uuid}/lock":{"post":{"summary":"Lock a statement","operationId":"postApiV1StatementStatement_uuidLock","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementResource"}}}}},"tags":["Statements"]},"parameters":[{"in":"path","name":"statement_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/statement/{statement_uuid}/unlock":{"post":{"summary":"Unlock a statement","operationId":"postApiV1StatementStatement_uuidUnlock","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_StatementResource"}}}}},"tags":["Statements"]},"parameters":[{"in":"path","name":"statement_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/static/boolean-choices":{"get":{"summary":"Get a list of boolean choices","operationId":"getApiV1StaticBooleanChoices","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Yes","value":"yes"},{"name":"No","value":"no"},{"name":"Possibly","value":"possibly"},{"name":"Unknown","value":"unknown"}]},"properties":{"data":{"type":"array","example":[{"name":"Yes","value":"yes"},{"name":"No","value":"no"},{"name":"Possibly","value":"possibly"},{"name":"Unknown","value":"unknown"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Yes"},"value":{"type":"string","example":"yes"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/occupations":{"get":{"summary":"Get a list of occupations","operationId":"getApiV1StaticOccupations","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Static_StaticOccupationResource"}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/nationalities":{"get":{"summary":"Get a list of supported nationalities","operationId":"getApiV1StaticNationalities","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Static_StaticNationalityResource"}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/addon-categories":{"get":{"summary":"Get a list of addon categories","operationId":"getApiV1StaticAddonCategories","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Static_StaticAddonCategoryResource"}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/plan-types":{"get":{"summary":"Retrieve a list of all the plan type","operationId":"getApiV1StaticPlanTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Static_StaticPlanTypeResource"}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/plan-sub-types/{type}":{"get":{"summary":"Retrieve the plan sub-types for a given plan type","operationId":"getApiV1StaticPlanSubTypesType","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Static_StaticPlanSubTypeResource"}}}}}}}},"tags":["Static Data"]},"parameters":[{"in":"path","name":"type","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/static/plan-statuses":{"get":{"summary":"Plan statuses","operationId":"getApiV1StaticPlanStatuses","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Active","value":"active"},{"name":"Inactive","value":"inactive"},{"name":"Proposed","value":"proposed"}]},"properties":{"data":{"type":"array","example":[{"name":"Active","value":"active"},{"name":"Inactive","value":"inactive"},{"name":"Proposed","value":"proposed"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Active"},"value":{"type":"string","example":"active"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/plan-inactivity-reasons":{"get":{"summary":"Get a list of plan inactivity reasons","operationId":"getApiV1StaticPlanInactivityReasons","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Accepted","value":"accepted"},{"name":"Agency Transferred","value":"agency_transferred"},{"name":"Cancelled","value":"cancelled"},{"name":"Claimed","value":"claimed"},{"name":"Complete","value":"complete"},{"name":"Death Event","value":"death_event"},{"name":"Deferred","value":"deferred"},{"name":"Drawdown","value":"drawdown"},{"name":"Expired","value":"expired"},{"name":"Full Drawdown","value":"full_drawdown"},{"name":"Issued","value":"issued"},{"name":"Lapsed","value":"lapsed"},{"name":"Matured","value":"matured"},{"name":"Not Proceeded With","value":"not_proceeded_with"},{"name":"Not Taken Up","value":"not_taken_up"},{"name":"Offered","value":"offered"},{"name":"Paid Up","value":"paid_up"},{"name":"Partial Drawdown","value":"partial_drawdown"},{"name":"Partial Surrender","value":"partial_surrender"},{"name":"Proposed","value":"proposed"},{"name":"Prospect","value":"prospect"},{"name":"Refunded","value":"refunded"},{"name":"Refused","value":"refused"},{"name":"Surrendered","value":"surrendered"},{"name":"Transfer","value":"transfer"},{"name":"Transferred","value":"transferred"},{"name":"Underwriting","value":"underwriting"},{"name":"Vested","value":"vested"},{"name":"Declined","value":"declined"},{"name":"Encashment","value":"encashment"},{"name":"Left Service","value":"left_service"},{"name":"Premium Holiday","value":"premium_holiday"},{"name":"Other","value":"other"}]},"properties":{"data":{"type":"array","example":[{"name":"Accepted","value":"accepted"},{"name":"Agency Transferred","value":"agency_transferred"},{"name":"Cancelled","value":"cancelled"},{"name":"Claimed","value":"claimed"},{"name":"Complete","value":"complete"},{"name":"Death Event","value":"death_event"},{"name":"Deferred","value":"deferred"},{"name":"Drawdown","value":"drawdown"},{"name":"Expired","value":"expired"},{"name":"Full Drawdown","value":"full_drawdown"},{"name":"Issued","value":"issued"},{"name":"Lapsed","value":"lapsed"},{"name":"Matured","value":"matured"},{"name":"Not Proceeded With","value":"not_proceeded_with"},{"name":"Not Taken Up","value":"not_taken_up"},{"name":"Offered","value":"offered"},{"name":"Paid Up","value":"paid_up"},{"name":"Partial Drawdown","value":"partial_drawdown"},{"name":"Partial Surrender","value":"partial_surrender"},{"name":"Proposed","value":"proposed"},{"name":"Prospect","value":"prospect"},{"name":"Refunded","value":"refunded"},{"name":"Refused","value":"refused"},{"name":"Surrendered","value":"surrendered"},{"name":"Transfer","value":"transfer"},{"name":"Transferred","value":"transferred"},{"name":"Underwriting","value":"underwriting"},{"name":"Vested","value":"vested"},{"name":"Declined","value":"declined"},{"name":"Encashment","value":"encashment"},{"name":"Left Service","value":"left_service"},{"name":"Premium Holiday","value":"premium_holiday"},{"name":"Other","value":"other"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Accepted"},"value":{"type":"string","example":"accepted"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/transaction-types":{"get":{"summary":"Get a list of transaction types and sub-types","operationId":"getApiV1StaticTransactionTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Adjustment","value":"adjustment"},{"name":"Adviser Fee","value":"adviser_fee"},{"name":"Contribution","value":"contribution"},{"name":"Corporate Action","value":"corporate_action"},{"name":"Distribution","value":"distribution"},{"name":"Fee","value":"fee"},{"name":"Income","value":"income"},{"name":"Payment","value":"payment"},{"name":"Provider Fee","value":"provider_fee"},{"name":"Rebate","value":"rebate"},{"name":"Trade","value":"trade"},{"name":"Transfer","value":"transfer"},{"name":"Withdrawal","value":"withdrawal"},{"name":"Other","value":"other"}]},"properties":{"data":{"type":"array","example":[{"name":"Adjustment","value":"adjustment"},{"name":"Adviser Fee","value":"adviser_fee"},{"name":"Contribution","value":"contribution"},{"name":"Corporate Action","value":"corporate_action"},{"name":"Distribution","value":"distribution"},{"name":"Fee","value":"fee"},{"name":"Income","value":"income"},{"name":"Payment","value":"payment"},{"name":"Provider Fee","value":"provider_fee"},{"name":"Rebate","value":"rebate"},{"name":"Trade","value":"trade"},{"name":"Transfer","value":"transfer"},{"name":"Withdrawal","value":"withdrawal"},{"name":"Other","value":"other"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Adjustment"},"value":{"type":"string","example":"adjustment"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/transaction-sub-types/{transactionType}":{"get":{"summary":"Get the subtypes for a transaction type","operationId":"getApiV1StaticTransactionSubTypesTransactionType","description":"","parameters":[],"responses":{"404":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":""},"properties":{"message":{"type":"string","example":""}}}}}}},"tags":["Static Data"]},"parameters":[{"in":"path","name":"transactionType","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/static/charge-categories":{"get":{"summary":"Get a list of charge categories","operationId":"getApiV1StaticChargeCategories","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Adhoc","value":"adhoc","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Administration","value":"administration","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":false},{"name":"Adjustment","value":"adjustment","fee":true,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":true},{"name":"Bond Renewal","value":"bond_renewal","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Clawback","value":"clawback","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Clawback","value":"clawback"},"can_change_rmar_type":false},{"name":"Dss Rebate","value":"dss_rebate","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Fund","value":"fund","fee":false,"commission":true,"one_off":false,"recurring":true,"service_types":[{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Indemnity","value":"indemnity","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Initial Fee","value":"initial_fee","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Level","value":"level","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Non Indemnity","value":"non_indemnity","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"One Off","value":"one_off","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Ongoing Fee","value":"ongoing_fee","fee":true,"commission":false,"one_off":false,"recurring":true,"service_types":[{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Other Fee","value":"other_fee","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":false},{"name":"Procuration Fee","value":"procuration_fee","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Protected Rights","value":"protected_rights","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Renewal","value":"renewal","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Switch","value":"switch","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Unknown","value":"unknown","fee":true,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":true}]},"properties":{"data":{"type":"array","example":[{"name":"Adhoc","value":"adhoc","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Administration","value":"administration","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":false},{"name":"Adjustment","value":"adjustment","fee":true,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":true},{"name":"Bond Renewal","value":"bond_renewal","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Clawback","value":"clawback","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Clawback","value":"clawback"},"can_change_rmar_type":false},{"name":"Dss Rebate","value":"dss_rebate","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Fund","value":"fund","fee":false,"commission":true,"one_off":false,"recurring":true,"service_types":[{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Indemnity","value":"indemnity","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Initial Fee","value":"initial_fee","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Level","value":"level","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Non Indemnity","value":"non_indemnity","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"One Off","value":"one_off","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Ongoing Fee","value":"ongoing_fee","fee":true,"commission":false,"one_off":false,"recurring":true,"service_types":[{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Adviser Charge","value":"adviser_charge"},"can_change_rmar_type":false},{"name":"Other Fee","value":"other_fee","fee":true,"commission":false,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":false},{"name":"Procuration Fee","value":"procuration_fee","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Protected Rights","value":"protected_rights","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Renewal","value":"renewal","fee":false,"commission":true,"one_off":true,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Switch","value":"switch","fee":false,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Commission","value":"commission"},"can_change_rmar_type":false},{"name":"Unknown","value":"unknown","fee":true,"commission":true,"one_off":false,"recurring":false,"service_types":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"rmar_type":{"name":"Other Fee","value":"other_fee"},"can_change_rmar_type":true}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Adhoc"},"value":{"type":"string","example":"adhoc"},"fee":{"type":"boolean","example":true},"commission":{"type":"boolean","example":false},"one_off":{"type":"boolean","example":true},"recurring":{"type":"boolean","example":false},"service_types":{"type":"array","example":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Initial"},"value":{"type":"string","example":"initial"},"initial":{"type":"boolean","example":true},"ongoing":{"type":"boolean","example":false}}}},"rmar_type":{"type":"object","properties":{"name":{"type":"string","example":"Adviser Charge"},"value":{"type":"string","example":"adviser_charge"}}},"can_change_rmar_type":{"type":"boolean","example":false}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/rmar-types":{"get":{"summary":"Get a list of RMAR types","operationId":"getApiV1StaticRmarTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Adviser Charge","value":"adviser_charge"},{"name":"Clawback","value":"clawback"},{"name":"Commission","value":"commission"},{"name":"Other Fee","value":"other_fee"},{"name":"Unknown","value":"unknown"}]},"properties":{"data":{"type":"array","example":[{"name":"Adviser Charge","value":"adviser_charge"},{"name":"Clawback","value":"clawback"},{"name":"Commission","value":"commission"},{"name":"Other Fee","value":"other_fee"},{"name":"Unknown","value":"unknown"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Adviser Charge"},"value":{"type":"string","example":"adviser_charge"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/service-types":{"get":{"summary":"Get a list of service types","operationId":"getApiV1StaticServiceTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}]},"properties":{"data":{"type":"array","example":[{"name":"Initial","value":"initial","initial":true,"ongoing":false},{"name":"One Off","value":"one_off","initial":true,"ongoing":false},{"name":"Ongoing","value":"ongoing","initial":false,"ongoing":true}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Initial"},"value":{"type":"string","example":"initial"},"initial":{"type":"boolean","example":true},"ongoing":{"type":"boolean","example":false}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/logs-modelable-types":{"get":{"summary":"Get a list of modelable types for logs","operationId":"getApiV1StaticLogsModelableTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":["application","automation_blueprint","board","workflow","case","check","circle","conversation","document","document_template","document_pack","fact_find_schema","fact_find_section","fact_find_template","file","group","illustration","new_business_event","contribution","holding","plan","sub_account","valuation","withdrawal","referral","referral_connection","task","employee","client"]},"properties":{"data":{"type":"array","example":["application","automation_blueprint","board","workflow","case","check","circle","conversation","document","document_template","document_pack","fact_find_schema","fact_find_section","fact_find_template","file","group","illustration","new_business_event","contribution","holding","plan","sub_account","valuation","withdrawal","referral","referral_connection","task","employee","client"],"items":{"type":"string"}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/contribution-types/{type}":{"get":{"summary":"Get a list of contribution types","operationId":"getApiV1StaticContributionTypesType","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Initial","value":"initial"},{"name":"Increment","value":"increment"},{"name":"Decrement","value":"decrement"},{"name":"Advice Point","value":"advice_point"},{"name":"Pension Transfer","value":"pension_transfer"},{"name":"Switch","value":"switch"}]},"properties":{"data":{"type":"array","example":[{"name":"Initial","value":"initial"},{"name":"Increment","value":"increment"},{"name":"Decrement","value":"decrement"},{"name":"Advice Point","value":"advice_point"},{"name":"Pension Transfer","value":"pension_transfer"},{"name":"Switch","value":"switch"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Initial"},"value":{"type":"string","example":"initial"}}}}}}}}}},"tags":["Static Data"]},"parameters":[{"in":"path","name":"type","description":"Optional parameter. Type parameter is optional and defaults to 'plans' if not provided. Valid options are [plans, new-business-events]","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"new-business-events"}}}]},"/api/v1/static/advice-types/{type}":{"get":{"summary":"Get a list of advice types","operationId":"getApiV1StaticAdviceTypesType","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Advised","value":"advised"},{"name":"Execution Only","value":"execution_only"},{"name":"Insistent Investor","value":"insistent_investor"},{"name":"Existing Provision","value":"existing_provision"},{"name":"Direct Offer","value":"direct_offer"},{"name":"Client Instruction","value":"client_instruction"}]},"properties":{"data":{"type":"array","example":[{"name":"Advised","value":"advised"},{"name":"Execution Only","value":"execution_only"},{"name":"Insistent Investor","value":"insistent_investor"},{"name":"Existing Provision","value":"existing_provision"},{"name":"Direct Offer","value":"direct_offer"},{"name":"Client Instruction","value":"client_instruction"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Advised"},"value":{"type":"string","example":"advised"}}}}}}}}}},"tags":["Static Data"]},"parameters":[{"in":"path","name":"type","description":"Optional parameter. Type parameter is optional and defaults to income-reconciliation. Valid options are [income-reconciliation, new-business-events].","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"new-business-events"}}}]},"/api/v1/static/conducted-by":{"get":{"summary":"Get a list of options for new business event conducted by","operationId":"getApiV1StaticConductedBy","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Correspondence Only","value":"correspondence_only"},{"name":"Email","value":"email"},{"name":"Face To Face","value":"face_to_face"},{"name":"Internet","value":"internet"},{"name":"Other","value":"other"},{"name":"Printed Media Campaign","value":"printed_media_campaign"},{"name":"Unknown","value":"unknown"},{"name":"Telephone","value":"telephone"}]},"properties":{"data":{"type":"array","example":[{"name":"Correspondence Only","value":"correspondence_only"},{"name":"Email","value":"email"},{"name":"Face To Face","value":"face_to_face"},{"name":"Internet","value":"internet"},{"name":"Other","value":"other"},{"name":"Printed Media Campaign","value":"printed_media_campaign"},{"name":"Unknown","value":"unknown"},{"name":"Telephone","value":"telephone"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Correspondence Only"},"value":{"type":"string","example":"correspondence_only"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/new-business-events-statuses":{"get":{"summary":"Get a list of options for new business event status","operationId":"getApiV1StaticNewBusinessEventsStatuses","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Accepted","value":"accepted"},{"name":"Proposed","value":"proposed"},{"name":"Rejected","value":"rejected"},{"name":"Deferred","value":"deferred"},{"name":"NPW","value":"NPW"}]},"properties":{"data":{"type":"array","example":[{"name":"Accepted","value":"accepted"},{"name":"Proposed","value":"proposed"},{"name":"Rejected","value":"rejected"},{"name":"Deferred","value":"deferred"},{"name":"NPW","value":"NPW"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Accepted"},"value":{"type":"string","example":"accepted"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/source-of-funds":{"get":{"summary":"Get a list of options for new business event source of funds","operationId":"getApiV1StaticSourceOfFunds","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Gift","value":"gift"},{"name":"Inheritance","value":"inheritance"},{"name":"ISA Transfer","value":"isa_transfer"},{"name":"Pension Transfer","value":"pension_transfer"},{"name":"Salary","value":"salary"},{"name":"Savings","value":"savings"},{"name":"Other","value":"other"}]},"properties":{"data":{"type":"array","example":[{"name":"Gift","value":"gift"},{"name":"Inheritance","value":"inheritance"},{"name":"ISA Transfer","value":"isa_transfer"},{"name":"Pension Transfer","value":"pension_transfer"},{"name":"Salary","value":"salary"},{"name":"Savings","value":"savings"},{"name":"Other","value":"other"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Gift"},"value":{"type":"string","example":"gift"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/frequencies/{type}":{"get":{"summary":"Get a list of Frequency types","operationId":"getApiV1StaticFrequenciesType","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Daily","value":"daily","unitCount":1,"unit":"day","annualised_multiplier":365},{"name":"Weekly","value":"weekly","unitCount":1,"unit":"week","annualised_multiplier":52.143},{"name":"Fortnightly","value":"fortnightly","unitCount":2,"unit":"week","annualised_multiplier":26.0715},{"name":"Four Weekly","value":"four_weekly","unitCount":4,"unit":"week","annualised_multiplier":13.03575},{"name":"Monthly","value":"monthly","unitCount":1,"unit":"month","annualised_multiplier":12},{"name":"Bimonthly","value":"bimonthly","unitCount":2,"unit":"month","annualised_multiplier":6},{"name":"Quarterly","value":"quarterly","unitCount":3,"unit":"month","annualised_multiplier":4},{"name":"Biannually","value":"biannually","unitCount":6,"unit":"month","annualised_multiplier":2},{"name":"Annually","value":"annually","unitCount":1,"unit":"year","annualised_multiplier":1}]},"properties":{"data":{"type":"array","example":[{"name":"Daily","value":"daily","unitCount":1,"unit":"day","annualised_multiplier":365},{"name":"Weekly","value":"weekly","unitCount":1,"unit":"week","annualised_multiplier":52.143},{"name":"Fortnightly","value":"fortnightly","unitCount":2,"unit":"week","annualised_multiplier":26.0715},{"name":"Four Weekly","value":"four_weekly","unitCount":4,"unit":"week","annualised_multiplier":13.03575},{"name":"Monthly","value":"monthly","unitCount":1,"unit":"month","annualised_multiplier":12},{"name":"Bimonthly","value":"bimonthly","unitCount":2,"unit":"month","annualised_multiplier":6},{"name":"Quarterly","value":"quarterly","unitCount":3,"unit":"month","annualised_multiplier":4},{"name":"Biannually","value":"biannually","unitCount":6,"unit":"month","annualised_multiplier":2},{"name":"Annually","value":"annually","unitCount":1,"unit":"year","annualised_multiplier":1}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Daily"},"value":{"type":"string","example":"daily"},"unitCount":{"type":"integer","example":1},"unit":{"type":"string","example":"day"},"annualised_multiplier":{"type":"integer","example":365}}}}}}}}}},"tags":["Static Data"]},"parameters":[{"in":"path","name":"type","description":"Optional parameter. Type parameter is optional and defaults to all options. Valid optional options are [single, recurring].","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"recurring"}}}]},"/api/v1/static/departments":{"get":{"summary":"Get a list of employee departments","operationId":"getApiV1StaticDepartments","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Administrator","value":"administrator"},{"name":"Adviser","value":"adviser"},{"name":"Compliance","value":"compliance"},{"name":"Finance","value":"finance"},{"name":"IT","value":"it"},{"name":"Marketing","value":"marketing"},{"name":"Operations","value":"operations"},{"name":"Paraplanner","value":"paraplanner"}]},"properties":{"data":{"type":"array","example":[{"name":"Administrator","value":"administrator"},{"name":"Adviser","value":"adviser"},{"name":"Compliance","value":"compliance"},{"name":"Finance","value":"finance"},{"name":"IT","value":"it"},{"name":"Marketing","value":"marketing"},{"name":"Operations","value":"operations"},{"name":"Paraplanner","value":"paraplanner"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Administrator"},"value":{"type":"string","example":"administrator"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/crystallisation-reasons":{"get":{"summary":"Get a list of crystallisation reasons","operationId":"getApiV1StaticCrystallisationReasons","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Flex Access","value":"flex_access"},{"name":"Ufpls 100","value":"ufpls_100"}]},"properties":{"data":{"type":"array","example":[{"name":"Flex Access","value":"flex_access"},{"name":"Ufpls 100","value":"ufpls_100"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Flex Access"},"value":{"type":"string","example":"flex_access"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/interest-types":{"get":{"summary":"Get a list of interest types","operationId":"getApiV1StaticInterestTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Fixed","value":"fixed"},{"name":"Variable","value":"variable"},{"name":"Combined","value":"combined"},{"name":"Capped","value":"capped"},{"name":"Discounted","value":"discounted"},{"name":"Interest Only","value":"interest_only"},{"name":"Offset","value":"offset"},{"name":"Tracker","value":"tracker"}]},"properties":{"data":{"type":"array","example":[{"name":"Fixed","value":"fixed"},{"name":"Variable","value":"variable"},{"name":"Combined","value":"combined"},{"name":"Capped","value":"capped"},{"name":"Discounted","value":"discounted"},{"name":"Interest Only","value":"interest_only"},{"name":"Offset","value":"offset"},{"name":"Tracker","value":"tracker"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Fixed"},"value":{"type":"string","example":"fixed"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/property-types":{"get":{"summary":"Get a list of property types","operationId":"getApiV1StaticPropertyTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Agricultural Property","value":"agricultural_property"},{"name":"Buy To Let","value":"buy_to_let"},{"name":"Commercial Property","value":"commercial_property"},{"name":"Holiday Home","value":"holiday_home"},{"name":"Main Residence","value":"main_residence"},{"name":"Other Property","value":"other_property"},{"name":"Property General","value":"property_general"}]},"properties":{"data":{"type":"array","example":[{"name":"Agricultural Property","value":"agricultural_property"},{"name":"Buy To Let","value":"buy_to_let"},{"name":"Commercial Property","value":"commercial_property"},{"name":"Holiday Home","value":"holiday_home"},{"name":"Main Residence","value":"main_residence"},{"name":"Other Property","value":"other_property"},{"name":"Property General","value":"property_general"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Agricultural Property"},"value":{"type":"string","example":"agricultural_property"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/repayment-types":{"get":{"summary":"Get a list of repayment types","operationId":"getApiV1StaticRepaymentTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Deferred","value":"deferred"},{"name":"Interest Only","value":"interest_only"},{"name":"Offset","value":"offset"},{"name":"Repayment","value":"repayment"},{"name":"Other","value":"other"}]},"properties":{"data":{"type":"array","example":[{"name":"Deferred","value":"deferred"},{"name":"Interest Only","value":"interest_only"},{"name":"Offset","value":"offset"},{"name":"Repayment","value":"repayment"},{"name":"Other","value":"other"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Deferred"},"value":{"type":"string","example":"deferred"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/repayment-methods":{"get":{"summary":"Get a list of repayment methods","operationId":"getApiV1StaticRepaymentMethods","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Associated Policy","value":"associated_policy"},{"name":"New Mortgage","value":"new_mortgage"},{"name":"Property Sale","value":"property_sale"},{"name":"Other","value":"other"}]},"properties":{"data":{"type":"array","example":[{"name":"Associated Policy","value":"associated_policy"},{"name":"New Mortgage","value":"new_mortgage"},{"name":"Property Sale","value":"property_sale"},{"name":"Other","value":"other"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Associated Policy"},"value":{"type":"string","example":"associated_policy"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/term-types":{"get":{"summary":"Get a list of term types","operationId":"getApiV1StaticTermTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"To Age","value":"to_age"},{"name":"To Date","value":"to_date"},{"name":"To Death","value":"to_death"}]},"properties":{"data":{"type":"array","example":[{"name":"To Age","value":"to_age"},{"name":"To Date","value":"to_date"},{"name":"To Death","value":"to_death"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"To Age"},"value":{"type":"string","example":"to_age"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/transfer-types":{"get":{"summary":"Get a list of transfer types","operationId":"getApiV1StaticTransferTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Switch","value":"switch"},{"name":"Transfer","value":"transfer"}]},"properties":{"data":{"type":"array","example":[{"name":"Switch","value":"switch"},{"name":"Transfer","value":"transfer"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Switch"},"value":{"type":"string","example":"switch"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/source-of-premiums":{"get":{"summary":"Get a list of source of premiums","operationId":"getApiV1StaticSourceOfPremiums","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Employee","value":"employee"},{"name":"Employer","value":"employer"}]},"properties":{"data":{"type":"array","example":[{"name":"Employee","value":"employee"},{"name":"Employer","value":"employer"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Employee"},"value":{"type":"string","example":"employee"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/premium-payment-methods":{"get":{"summary":"Get a list of premium payment methods","operationId":"getApiV1StaticPremiumPaymentMethods","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Salary Sacrifice","value":"salary_sacrifice"},{"name":"Salary Deduction","value":"salary_deduction"},{"name":"Direct Debit","value":"direct_debit"},{"name":"Standing Order","value":"standing_order"},{"name":"Cheque","value":"cheque"},{"name":"Bank Transfer","value":"bank_transfer"}]},"properties":{"data":{"type":"array","example":[{"name":"Salary Sacrifice","value":"salary_sacrifice"},{"name":"Salary Deduction","value":"salary_deduction"},{"name":"Direct Debit","value":"direct_debit"},{"name":"Standing Order","value":"standing_order"},{"name":"Cheque","value":"cheque"},{"name":"Bank Transfer","value":"bank_transfer"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Salary Sacrifice"},"value":{"type":"string","example":"salary_sacrifice"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/cover-types/{type}":{"get":{"summary":"Get a list of cover types for the specific plan type.","operationId":"getApiV1StaticCoverTypesType","description":"","parameters":[],"responses":{"404":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":""},"properties":{"message":{"type":"string","example":""}}}}}}},"tags":["Static Data"]},"parameters":[{"in":"path","name":"type","description":"","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/static/extensions":{"get":{"summary":"Get a list of file extensions","operationId":"getApiV1StaticExtensions","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":["123","3dml","3g2","3gp","7z","aab","aac","aam","aas","abw","ac","acc","ace","acu","acx","adp","aep","afp","ahead","ai","aif","aifc","aiff","air","ait","ami","apk","application","apr","arc","asf","aso","asr","asx","atc","atomcat","atomsvc","atx","au","avi","avif","aw","axs","azf","azs","azw","bas","bcpio","bdf","bdm","bed","bh2","bin","bmi","bmp","box","btif","bz","bz2","c","c11amc","c11amz","c4g","cab","car","cat","cda","cdbcmsg","cdf","cdkey","cdmia","cdmic","cdmid","cdmio","cdmiq","cdx","cdxml","cdy","cer","cgm","chat","chm","chrt","cif","cii","cil","cla","class","clkk","clkp","clkt","clkw","clkx","clp","cmc","cmdf","cml","cmp","cmx","cod","cpio","cpt","crd","crl","crt","cryptonote","csh","csml","csp","css","csv","cu","curl","cww","dae","daf","davmount","dcr","dcurl","dd2","ddd","deb","der","dfac","dir","dis","djvu","dll","dmg","dms","dna","doc","docm","docx","dot","dotm","dotx","dp","dpg","dra","dsc","dssc","dtb","dtd","dts","dtshd","dvi","dwf","dwg","dxf","dxp","dxr","ecelp4800","ecelp7470","ecelp9600","edm","edx","efif","ei6","eml","emma","eol","eot","eps","epub","es","es3","esf","etx","evy","exi","ext","ez2","ez3","f","f4v","fbs","fcs","fdf","fe_launch","fg5","fh","fif","fig","fli","flo","flv","flw","flx","fly","fm","fnc","fpx","fsc","fst","ftc","fti","fvt","fxp","fzs","g2w","g3","g3w","gac","gdl","geo","gex","ggb","ggt","ghf","gif","gim","gmx","gnumeric","gph","gpx","gqf","gram","grv","grxml","gsf","gtar","gtm","gtw","gv","gxt","gz","h","h261","h263","h264","hal","hbci","hdf","hlp","hpgl","hpid","hps","hqx","hta","htc","htke","htm","html","htt","hvd","hvp","hvs","i2g","icc","ice","ico","ics","ief","ifm","igl","igm","igs","igx","iif","iii","imp","ims","ins","ipfix","ipk","irm","irp","isp","itp","ivp","ivu","jad","jam","jar","java","jfif","jisp","jlt","jnlp","joda","jpe","jpeg","jpg","jpgv","jpm","js","json","jsonld","karbon","kfo","kia","kml","kmz","kne","kon","kpr","ksp","ktx","ktz","kwd","lasxml","latex","lbd","lbe","les","lha","link66","lrm","lsf","lsx","ltf","lvp","lwp","lzh","m13","m14","m21","m3u","m3u8","m4a","m4v","ma","mads","mag","man","mathml","mbk","mbox","mc1","mcd","mcurl","mdb","mdi","me","meta4","mets","mfm","mgp","mgz","mht","mhtml","mid","midi","mif","mj2","mjs","mlp","mmd","mmf","mmr","mny","mods","mov","movie","mp2","mp3","mp4","mp4a","mpa","mpc","mpe","mpeg","mpg","mpga","mpkg","mpm","mpn","mpp","mpv2","mpy","mqy","mrc","mrcx","ms","mscml","msf","msg","msh","msl","msty","mts","mus","musicxml","mvb","mwf","mxf","mxl","mxml","mxs","mxu","n-gage","n3","nbp","nc","ncx","ngdat","nlu","nml","nnd","nns","nnw","npx","nsf","nws","oa2","oa3","oas","obd","oda","odb","odc","odf","odft","odg","odi","odm","odp","ods","odt","oga","ogv","ogx","onetoc","opf","opus","org","osf","osfpvg","otc","otf","otg","oth","oti","otp","ots","ott","oxt","p","p10","p12","p7b","p7c","p7m","p7r","p7s","p8","par","paw","pbd","pbm","pcf","pcl","pclxl","pcurl","pcx","pdb","pdf","pfa","pfr","pfx","pgm","pgn","pgp","php","pic","pjpeg","pki","pkipath","pko","plc","plf","pls","pma","pmc","pml","pmr","pmw","png","pnm","portpkg","pot","potm","potx","ppam","ppd","ppm","pps","ppsm","ppsx","ppt","pptm","pptx","prc","pre","prf","ps","psd","psf","pskcxml","ptid","pub","pya","pyv","qam","qbo","qfx","qps","qt","qxd","ra","ram","rar","ras","rcprofile","rdf","rdz","rep","res","rgb","rif","rip","rl","rlc","rld","rm","rmi","rmp","rms","rnc","roff","rp9","rpss","rpst","rq","rs","rsd","rtf","rtx","s","saf","sbml","sc","scd","scm","scq","scs","sct","scurl","sda","sdc","sdd","sdkm","sdp","sdw","see","seed","sema","semd","semf","ser","setpay","setreg","sfd-hdstx","sfs","sgl","sgml","sh","shar","shf","sis","sit","sitx","skp","sldm","sldx","slt","sm","smf","smi","snd","snf","spc","spf","spl","spot","spp","spq","src","sru","srx","sse","ssf","ssml","sst","st","stc","std","stf","sti","stk","stl","stm","str","stw","sub","sus","sv4cpio","sv4crc","svc","svd","svg","swf","swi","sxc","sxd","sxg","sxi","sxm","sxw","t","tao","tar","tcl","teacher","tei","tex","texi","texinfo","tfi","tfm","tgz","thmx","tif","tiff","tmo","torrent","tpl","tpt","tr","tra","trm","ts","tsd","tsv","ttf","ttl","twd","txd","txf","txt","ufd","uls","umj","unityweb","uoml","uri","ustar","utz","uu","uva","uvh","uvi","uvm","uvp","uvs","uvu","uvv","vcd","vcf","vcg","vcs","vcx","vis","viv","vsd","vsdx","vsf","vtu","vxml","wad","wav","wax","wbmp","wbs","wbxml","wcm","wdb","weba","webm","webp","wg","wgt","wks","wm","wma","wmd","wmf","wml","wmlc","wmls","wmlsc","wmv","wmx","wmz","woff","woff2","wpd","wpl","wps","wqd","wri","wrl","wsdl","wspolicy","wtb","wvx","xap","xar","xbap","xbd","xbm","xdf","xdm","xdp","xdssc","xdw","xenc","xer","xfdf","xfdl","xhtml","xif","xla","xlam","xlc","xlm","xls","xlsb","xlsm","xlsx","xlt","xltm","xltx","xlw","xml","xo","xop","xpi","xpm","xpr","xps","xpw","xslt","xsm","xspf","xul","xwd","xyz","yaml","yang","yin","z","zaz","zip","zir","zmm"]},"properties":{"data":{"type":"array","example":["123","3dml","3g2","3gp","7z","aab","aac","aam","aas","abw","ac","acc","ace","acu","acx","adp","aep","afp","ahead","ai","aif","aifc","aiff","air","ait","ami","apk","application","apr","arc","asf","aso","asr","asx","atc","atomcat","atomsvc","atx","au","avi","avif","aw","axs","azf","azs","azw","bas","bcpio","bdf","bdm","bed","bh2","bin","bmi","bmp","box","btif","bz","bz2","c","c11amc","c11amz","c4g","cab","car","cat","cda","cdbcmsg","cdf","cdkey","cdmia","cdmic","cdmid","cdmio","cdmiq","cdx","cdxml","cdy","cer","cgm","chat","chm","chrt","cif","cii","cil","cla","class","clkk","clkp","clkt","clkw","clkx","clp","cmc","cmdf","cml","cmp","cmx","cod","cpio","cpt","crd","crl","crt","cryptonote","csh","csml","csp","css","csv","cu","curl","cww","dae","daf","davmount","dcr","dcurl","dd2","ddd","deb","der","dfac","dir","dis","djvu","dll","dmg","dms","dna","doc","docm","docx","dot","dotm","dotx","dp","dpg","dra","dsc","dssc","dtb","dtd","dts","dtshd","dvi","dwf","dwg","dxf","dxp","dxr","ecelp4800","ecelp7470","ecelp9600","edm","edx","efif","ei6","eml","emma","eol","eot","eps","epub","es","es3","esf","etx","evy","exi","ext","ez2","ez3","f","f4v","fbs","fcs","fdf","fe_launch","fg5","fh","fif","fig","fli","flo","flv","flw","flx","fly","fm","fnc","fpx","fsc","fst","ftc","fti","fvt","fxp","fzs","g2w","g3","g3w","gac","gdl","geo","gex","ggb","ggt","ghf","gif","gim","gmx","gnumeric","gph","gpx","gqf","gram","grv","grxml","gsf","gtar","gtm","gtw","gv","gxt","gz","h","h261","h263","h264","hal","hbci","hdf","hlp","hpgl","hpid","hps","hqx","hta","htc","htke","htm","html","htt","hvd","hvp","hvs","i2g","icc","ice","ico","ics","ief","ifm","igl","igm","igs","igx","iif","iii","imp","ims","ins","ipfix","ipk","irm","irp","isp","itp","ivp","ivu","jad","jam","jar","java","jfif","jisp","jlt","jnlp","joda","jpe","jpeg","jpg","jpgv","jpm","js","json","jsonld","karbon","kfo","kia","kml","kmz","kne","kon","kpr","ksp","ktx","ktz","kwd","lasxml","latex","lbd","lbe","les","lha","link66","lrm","lsf","lsx","ltf","lvp","lwp","lzh","m13","m14","m21","m3u","m3u8","m4a","m4v","ma","mads","mag","man","mathml","mbk","mbox","mc1","mcd","mcurl","mdb","mdi","me","meta4","mets","mfm","mgp","mgz","mht","mhtml","mid","midi","mif","mj2","mjs","mlp","mmd","mmf","mmr","mny","mods","mov","movie","mp2","mp3","mp4","mp4a","mpa","mpc","mpe","mpeg","mpg","mpga","mpkg","mpm","mpn","mpp","mpv2","mpy","mqy","mrc","mrcx","ms","mscml","msf","msg","msh","msl","msty","mts","mus","musicxml","mvb","mwf","mxf","mxl","mxml","mxs","mxu","n-gage","n3","nbp","nc","ncx","ngdat","nlu","nml","nnd","nns","nnw","npx","nsf","nws","oa2","oa3","oas","obd","oda","odb","odc","odf","odft","odg","odi","odm","odp","ods","odt","oga","ogv","ogx","onetoc","opf","opus","org","osf","osfpvg","otc","otf","otg","oth","oti","otp","ots","ott","oxt","p","p10","p12","p7b","p7c","p7m","p7r","p7s","p8","par","paw","pbd","pbm","pcf","pcl","pclxl","pcurl","pcx","pdb","pdf","pfa","pfr","pfx","pgm","pgn","pgp","php","pic","pjpeg","pki","pkipath","pko","plc","plf","pls","pma","pmc","pml","pmr","pmw","png","pnm","portpkg","pot","potm","potx","ppam","ppd","ppm","pps","ppsm","ppsx","ppt","pptm","pptx","prc","pre","prf","ps","psd","psf","pskcxml","ptid","pub","pya","pyv","qam","qbo","qfx","qps","qt","qxd","ra","ram","rar","ras","rcprofile","rdf","rdz","rep","res","rgb","rif","rip","rl","rlc","rld","rm","rmi","rmp","rms","rnc","roff","rp9","rpss","rpst","rq","rs","rsd","rtf","rtx","s","saf","sbml","sc","scd","scm","scq","scs","sct","scurl","sda","sdc","sdd","sdkm","sdp","sdw","see","seed","sema","semd","semf","ser","setpay","setreg","sfd-hdstx","sfs","sgl","sgml","sh","shar","shf","sis","sit","sitx","skp","sldm","sldx","slt","sm","smf","smi","snd","snf","spc","spf","spl","spot","spp","spq","src","sru","srx","sse","ssf","ssml","sst","st","stc","std","stf","sti","stk","stl","stm","str","stw","sub","sus","sv4cpio","sv4crc","svc","svd","svg","swf","swi","sxc","sxd","sxg","sxi","sxm","sxw","t","tao","tar","tcl","teacher","tei","tex","texi","texinfo","tfi","tfm","tgz","thmx","tif","tiff","tmo","torrent","tpl","tpt","tr","tra","trm","ts","tsd","tsv","ttf","ttl","twd","txd","txf","txt","ufd","uls","umj","unityweb","uoml","uri","ustar","utz","uu","uva","uvh","uvi","uvm","uvp","uvs","uvu","uvv","vcd","vcf","vcg","vcs","vcx","vis","viv","vsd","vsdx","vsf","vtu","vxml","wad","wav","wax","wbmp","wbs","wbxml","wcm","wdb","weba","webm","webp","wg","wgt","wks","wm","wma","wmd","wmf","wml","wmlc","wmls","wmlsc","wmv","wmx","wmz","woff","woff2","wpd","wpl","wps","wqd","wri","wrl","wsdl","wspolicy","wtb","wvx","xap","xar","xbap","xbd","xbm","xdf","xdm","xdp","xdssc","xdw","xenc","xer","xfdf","xfdl","xhtml","xif","xla","xlam","xlc","xlm","xls","xlsb","xlsm","xlsx","xlt","xltm","xltx","xlw","xml","xo","xop","xpi","xpm","xpr","xps","xpw","xslt","xsm","xspf","xul","xwd","xyz","yaml","yang","yin","z","zaz","zip","zir","zmm"],"items":{"type":"string"}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/reports":{"get":{"summary":"Get a list of all reports","operationId":"getApiV1StaticReports","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"id":"actual_vs_estimate_report","name":"Actual vs Estimate Report","description":"List all expectations with their original expected amount and the actual amount received."},{"id":"adviser_income_detailed","name":"Adviser Income Detailed","description":"List all detailed income within a date range."},{"id":"aged_debt_report","name":"Aged Debt Report","description":"List all expectations which still need reconciling to bank transactions."},{"id":"staff_member_export","name":"Business Staff Member Export","description":"Export all of the business clients with their staff members."},{"id":"cases_export","name":"Cases export","description":"Export all cases"},{"id":"charges_export","name":"Charges Export","description":"Export charges."},{"id":"client_expenditure_export","name":"Client Expenditure Export","description":"Export all of the Life Stage Expenditures for clients."},{"id":"client_export","name":"Client Export","description":"Export all clients."},{"id":"conversion_pipeline","name":"Conversion Pipeline","description":"Shows the number of prospects that have converted to clients between two dates."},{"id":"employee_export","name":"Employee Export","description":"Export all employees."},{"id":"form_submission_export","name":"Form Submission Export","description":"Export all submissions for a form"},{"id":"group_scheme_members_export","name":"Group Scheme Members Export","description":"Provides a detailed export of the members on a given group scheme. Can be used with the group scheme member importer to bulk update members."},{"id":"holding_export","name":"Holding Export","description":"An export of a firms or clients holdings"},{"id":"income_reconciliation_export","name":"Income Reconciliation Export","description":"Export all income reconciliation data for a monthly statement or a given date range."},{"id":"new_business_export","name":"New Business Export","description":"Data export of all New Business Events on a firm."},{"id":"new_business_summary_report","name":"New Business Summary Report","description":"Summary Report of New Business Events on a firm."},{"id":"note_export","name":"Notes Export","description":"Export all notes on your firm"},{"id":"plan_export","name":"Plan Export","description":"Data export of all plans on a firm."},{"id":"premium_export","name":"Premium Export","description":"Export premium for plans."},{"id":"rmar","name":"RMAR","description":"RMAR Report."},{"id":"revenue_analysis_based_on_receipts","name":"Revenue Analysis Based On Receipts","description":"Report detailing all revenue reconciled in a payment period or between dates based on bank receipts."},{"id":"task_export","name":"Task Export","description":"Export All Tasks"},{"id":"time_entries","name":"Time Entries Export","description":"Full company time report."},{"id":"valuation_report","name":"Valuation Report","description":"Valuation Report"}]},"properties":{"data":{"type":"array","example":[{"id":"actual_vs_estimate_report","name":"Actual vs Estimate Report","description":"List all expectations with their original expected amount and the actual amount received."},{"id":"adviser_income_detailed","name":"Adviser Income Detailed","description":"List all detailed income within a date range."},{"id":"aged_debt_report","name":"Aged Debt Report","description":"List all expectations which still need reconciling to bank transactions."},{"id":"staff_member_export","name":"Business Staff Member Export","description":"Export all of the business clients with their staff members."},{"id":"cases_export","name":"Cases export","description":"Export all cases"},{"id":"charges_export","name":"Charges Export","description":"Export charges."},{"id":"client_expenditure_export","name":"Client Expenditure Export","description":"Export all of the Life Stage Expenditures for clients."},{"id":"client_export","name":"Client Export","description":"Export all clients."},{"id":"conversion_pipeline","name":"Conversion Pipeline","description":"Shows the number of prospects that have converted to clients between two dates."},{"id":"employee_export","name":"Employee Export","description":"Export all employees."},{"id":"form_submission_export","name":"Form Submission Export","description":"Export all submissions for a form"},{"id":"group_scheme_members_export","name":"Group Scheme Members Export","description":"Provides a detailed export of the members on a given group scheme. Can be used with the group scheme member importer to bulk update members."},{"id":"holding_export","name":"Holding Export","description":"An export of a firms or clients holdings"},{"id":"income_reconciliation_export","name":"Income Reconciliation Export","description":"Export all income reconciliation data for a monthly statement or a given date range."},{"id":"new_business_export","name":"New Business Export","description":"Data export of all New Business Events on a firm."},{"id":"new_business_summary_report","name":"New Business Summary Report","description":"Summary Report of New Business Events on a firm."},{"id":"note_export","name":"Notes Export","description":"Export all notes on your firm"},{"id":"plan_export","name":"Plan Export","description":"Data export of all plans on a firm."},{"id":"premium_export","name":"Premium Export","description":"Export premium for plans."},{"id":"rmar","name":"RMAR","description":"RMAR Report."},{"id":"revenue_analysis_based_on_receipts","name":"Revenue Analysis Based On Receipts","description":"Report detailing all revenue reconciled in a payment period or between dates based on bank receipts."},{"id":"task_export","name":"Task Export","description":"Export All Tasks"},{"id":"time_entries","name":"Time Entries Export","description":"Full company time report."},{"id":"valuation_report","name":"Valuation Report","description":"Valuation Report"}],"items":{"type":"object","properties":{"id":{"type":"string","example":"actual_vs_estimate_report"},"name":{"type":"string","example":"Actual vs Estimate Report"},"description":{"type":"string","example":"List all expectations with their original expected amount and the actual amount received."}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/client-regulatory-classifications":{"get":{"summary":"Get a list of options for client regulatory classifications","operationId":"getApiV1StaticClientRegulatoryClassifications","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Retail Client","value":"retail_client"},{"name":"Professional Client","value":"professional_client"},{"name":"Eligible Counterparty","value":"eligible_counterparty"},{"name":"Not Applicable","value":"not_applicable"},{"name":"Unknown","value":"unknown"}]},"properties":{"data":{"type":"array","example":[{"name":"Retail Client","value":"retail_client"},{"name":"Professional Client","value":"professional_client"},{"name":"Eligible Counterparty","value":"eligible_counterparty"},{"name":"Not Applicable","value":"not_applicable"},{"name":"Unknown","value":"unknown"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Retail Client"},"value":{"type":"string","example":"retail_client"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/lookup-types":{"get":{"summary":"Get a list of all LookupTypes","operationId":"getApiV1StaticLookupTypes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Provider Statement Mapping","value":"provider_statement_mapping"},{"name":"Bank Statement Mapping","value":"bank_statement_mapping"},{"name":"Octopus Money Node Mapping","value":"octopus_money_node_mapping"},{"name":"P1 Node Mapping","value":"p1_node_mapping"},{"name":"Statement Transaction Autoreconciling","value":"statement_transaction_autoreconciling"},{"name":"Seccl Node Mapping","value":"seccl_node_mapping"},{"name":"Soderberg Node Mapping","value":"soderberg_node_mapping"}]},"properties":{"data":{"type":"array","example":[{"name":"Provider Statement Mapping","value":"provider_statement_mapping"},{"name":"Bank Statement Mapping","value":"bank_statement_mapping"},{"name":"Octopus Money Node Mapping","value":"octopus_money_node_mapping"},{"name":"P1 Node Mapping","value":"p1_node_mapping"},{"name":"Statement Transaction Autoreconciling","value":"statement_transaction_autoreconciling"},{"name":"Seccl Node Mapping","value":"seccl_node_mapping"},{"name":"Soderberg Node Mapping","value":"soderberg_node_mapping"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Provider Statement Mapping"},"value":{"type":"string","example":"provider_statement_mapping"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/check-statuses":{"get":{"summary":"Get a list of all CheckStatuses","operationId":"getApiV1StaticCheckStatuses","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Abandoned","value":"abandoned"},{"name":"Active","value":"active"},{"name":"Archive","value":"archive"},{"name":"Complete","value":"complete"},{"name":"Expired","value":"expired"},{"name":"Failed","value":"failed"},{"name":"Lock","value":"lock"},{"name":"Pending","value":"pending"},{"name":"Processing","value":"processing"}]},"properties":{"data":{"type":"array","example":[{"name":"Abandoned","value":"abandoned"},{"name":"Active","value":"active"},{"name":"Archive","value":"archive"},{"name":"Complete","value":"complete"},{"name":"Expired","value":"expired"},{"name":"Failed","value":"failed"},{"name":"Lock","value":"lock"},{"name":"Pending","value":"pending"},{"name":"Processing","value":"processing"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Abandoned"},"value":{"type":"string","example":"abandoned"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/check-outcomes":{"get":{"summary":"Get a list of all CheckOutcomes","operationId":"getApiV1StaticCheckOutcomes","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Pass","value":"pass"},{"name":"Refer","value":"refer"},{"name":"Fail","value":"fail"},{"name":"High Risk","value":"high_risk"},{"name":"Medium Risk","value":"medium_risk"},{"name":"Low Risk","value":"low_risk"}]},"properties":{"data":{"type":"array","example":[{"name":"Pass","value":"pass"},{"name":"Refer","value":"refer"},{"name":"Fail","value":"fail"},{"name":"High Risk","value":"high_risk"},{"name":"Medium Risk","value":"medium_risk"},{"name":"Low Risk","value":"low_risk"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Pass"},"value":{"type":"string","example":"pass"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/state-of-health":{"get":{"summary":"Get a list of all states of health","operationId":"getApiV1StaticStateOfHealth","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Excellent","value":"excellent"},{"name":"Good","value":"good"},{"name":"Fair","value":"fair"},{"name":"Poor","value":"poor"},{"name":"Unknown","value":"unknown"}]},"properties":{"data":{"type":"array","example":[{"name":"Excellent","value":"excellent"},{"name":"Good","value":"good"},{"name":"Fair","value":"fair"},{"name":"Poor","value":"poor"},{"name":"Unknown","value":"unknown"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Excellent"},"value":{"type":"string","example":"excellent"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/webhook-subscription-events":{"get":{"summary":"Get a list of all webhook subscription events.","operationId":"getApiV1StaticWebhookSubscriptionEvents","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"group":"Accounts (Clients, Employees, Introducers)","events":["account.created","account.updated","account.deleted","account.annual-review-date-occurred"]},{"group":"Cases","events":["case.created","case.updated","case.deleted"]},{"group":"Circles","events":["circle.created","circle.updated","circle.deleted"]},{"group":"Client Bank Accounts","events":["bank-account.created","bank-account.updated","bank-account.deleted"]},{"group":"Fact-Find","events":["fact-find.completed-v3"]},{"group":"Fact-Find (Legacy)","events":["fact-find.completed"]},{"group":"Forms","events":["form-submission.completed"]},{"group":"Income Reconciliation","events":["bank-statement.created","bank-statement.updated","bank-statement.deleted","bank-transaction.created","bank-transaction.updated","bank-transaction.deleted","provider-statement.created","provider-statement.updated","provider-statement.deleted","transaction.created","transaction.updated","transaction.deleted","transaction.reconciled","transaction.unreconciled","statement.lock-status"]},{"group":"Plans","events":["plan.created","plan.updated","plan.deleted"]},{"group":"Tasks","events":["task.created","task.updated","task.deleted","task.completed"]}]},"properties":{"data":{"type":"array","example":[{"group":"Accounts (Clients, Employees, Introducers)","events":["account.created","account.updated","account.deleted","account.annual-review-date-occurred"]},{"group":"Cases","events":["case.created","case.updated","case.deleted"]},{"group":"Circles","events":["circle.created","circle.updated","circle.deleted"]},{"group":"Client Bank Accounts","events":["bank-account.created","bank-account.updated","bank-account.deleted"]},{"group":"Fact-Find","events":["fact-find.completed-v3"]},{"group":"Fact-Find (Legacy)","events":["fact-find.completed"]},{"group":"Forms","events":["form-submission.completed"]},{"group":"Income Reconciliation","events":["bank-statement.created","bank-statement.updated","bank-statement.deleted","bank-transaction.created","bank-transaction.updated","bank-transaction.deleted","provider-statement.created","provider-statement.updated","provider-statement.deleted","transaction.created","transaction.updated","transaction.deleted","transaction.reconciled","transaction.unreconciled","statement.lock-status"]},{"group":"Plans","events":["plan.created","plan.updated","plan.deleted"]},{"group":"Tasks","events":["task.created","task.updated","task.deleted","task.completed"]}],"items":{"type":"object","properties":{"group":{"type":"string","example":"Accounts (Clients, Employees, Introducers)"},"events":{"type":"array","example":["account.created","account.updated","account.deleted","account.annual-review-date-occurred"],"items":{"type":"string"}}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/static/titles":{"get":{"summary":"Get a list of all titles","operationId":"getApiV1StaticTitles","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":[{"name":"Mr","value":"mr"},{"name":"Mrs","value":"mrs"},{"name":"Ms","value":"ms"},{"name":"Miss","value":"miss"},{"name":"Admiral","value":"admiral"},{"name":"Air Commodore","value":"air_commodore"},{"name":"Air Vice Marshall","value":"air_vice_marshall"},{"name":"Archdeacon","value":"archdeacon"},{"name":"Baron","value":"baron"},{"name":"Baroness","value":"baroness"},{"name":"Bishop","value":"bishop"},{"name":"Brigadier","value":"brigadier"},{"name":"Canon","value":"canon"},{"name":"Captain","value":"captain"},{"name":"Colonel","value":"colonel"},{"name":"Commander","value":"commander"},{"name":"Commodore","value":"commodore"},{"name":"Corporal","value":"corporal"},{"name":"Count","value":"count"},{"name":"Countess","value":"countess"},{"name":"Dame","value":"dame"},{"name":"Deacon","value":"deacon"},{"name":"Deaconess","value":"deaconess"},{"name":"Dr","value":"dr"},{"name":"Duchess","value":"duchess"},{"name":"Father","value":"father"},{"name":"Flight Lieutenant","value":"flight_lieutenant"},{"name":"Group Captain","value":"group_captain"},{"name":"Judge","value":"judge"},{"name":"Lady","value":"lady"},{"name":"Lance Corporal","value":"lance_corporal"},{"name":"Lieutenant","value":"lieutenant"},{"name":"Lieutenant Colonel","value":"lieutenant_colonel"},{"name":"Lieutenant Commander","value":"lieutenant_commander"},{"name":"Lord","value":"lord"},{"name":"Madam","value":"madam"},{"name":"Major","value":"major"},{"name":"Major General","value":"major_general"},{"name":"Master","value":"master"},{"name":"Monsignor","value":"monsignor"},{"name":"Mx","value":"mx"},{"name":"Other","value":"other"},{"name":"Pastor","value":"pastor"},{"name":"Prince","value":"prince"},{"name":"Princess","value":"princess"},{"name":"Private","value":"private"},{"name":"Professor","value":"professor"},{"name":"Rabbi","value":"rabbi"},{"name":"Rear Admiral","value":"rear_admiral"},{"name":"Reverend","value":"reverend"},{"name":"Reverend Doctor","value":"reverend_doctor"},{"name":"Right Honourable","value":"right_honourable"},{"name":"Right Honourable Lord","value":"right_honourable_lord"},{"name":"Right Reverend","value":"right_reverend"},{"name":"Second Lieutenant","value":"second_lieutenant"},{"name":"Sergeant","value":"sergeant"},{"name":"Sheriff","value":"sheriff"},{"name":"Sir","value":"sir"},{"name":"Sister","value":"sister"},{"name":"Squadron Leader","value":"squadron_leader"},{"name":"Staff Sergeant","value":"staff_sergeant"},{"name":"Surgeon Captain","value":"surgeon_captain"},{"name":"The Earl of","value":"the_earl_of"},{"name":"The Honourable","value":"the_honourable"},{"name":"The Reverend Canon","value":"the_reverend_canon"},{"name":"Trooper","value":"trooper"},{"name":"Unspecified","value":"unspecified"},{"name":"Venerable","value":"venerable"},{"name":"Very Reverend","value":"very_reverend"},{"name":"Viscount","value":"viscount"},{"name":"Viscountess","value":"viscountess"},{"name":"Wing Commander","value":"wing_commander"}]},"properties":{"data":{"type":"array","example":[{"name":"Mr","value":"mr"},{"name":"Mrs","value":"mrs"},{"name":"Ms","value":"ms"},{"name":"Miss","value":"miss"},{"name":"Admiral","value":"admiral"},{"name":"Air Commodore","value":"air_commodore"},{"name":"Air Vice Marshall","value":"air_vice_marshall"},{"name":"Archdeacon","value":"archdeacon"},{"name":"Baron","value":"baron"},{"name":"Baroness","value":"baroness"},{"name":"Bishop","value":"bishop"},{"name":"Brigadier","value":"brigadier"},{"name":"Canon","value":"canon"},{"name":"Captain","value":"captain"},{"name":"Colonel","value":"colonel"},{"name":"Commander","value":"commander"},{"name":"Commodore","value":"commodore"},{"name":"Corporal","value":"corporal"},{"name":"Count","value":"count"},{"name":"Countess","value":"countess"},{"name":"Dame","value":"dame"},{"name":"Deacon","value":"deacon"},{"name":"Deaconess","value":"deaconess"},{"name":"Dr","value":"dr"},{"name":"Duchess","value":"duchess"},{"name":"Father","value":"father"},{"name":"Flight Lieutenant","value":"flight_lieutenant"},{"name":"Group Captain","value":"group_captain"},{"name":"Judge","value":"judge"},{"name":"Lady","value":"lady"},{"name":"Lance Corporal","value":"lance_corporal"},{"name":"Lieutenant","value":"lieutenant"},{"name":"Lieutenant Colonel","value":"lieutenant_colonel"},{"name":"Lieutenant Commander","value":"lieutenant_commander"},{"name":"Lord","value":"lord"},{"name":"Madam","value":"madam"},{"name":"Major","value":"major"},{"name":"Major General","value":"major_general"},{"name":"Master","value":"master"},{"name":"Monsignor","value":"monsignor"},{"name":"Mx","value":"mx"},{"name":"Other","value":"other"},{"name":"Pastor","value":"pastor"},{"name":"Prince","value":"prince"},{"name":"Princess","value":"princess"},{"name":"Private","value":"private"},{"name":"Professor","value":"professor"},{"name":"Rabbi","value":"rabbi"},{"name":"Rear Admiral","value":"rear_admiral"},{"name":"Reverend","value":"reverend"},{"name":"Reverend Doctor","value":"reverend_doctor"},{"name":"Right Honourable","value":"right_honourable"},{"name":"Right Honourable Lord","value":"right_honourable_lord"},{"name":"Right Reverend","value":"right_reverend"},{"name":"Second Lieutenant","value":"second_lieutenant"},{"name":"Sergeant","value":"sergeant"},{"name":"Sheriff","value":"sheriff"},{"name":"Sir","value":"sir"},{"name":"Sister","value":"sister"},{"name":"Squadron Leader","value":"squadron_leader"},{"name":"Staff Sergeant","value":"staff_sergeant"},{"name":"Surgeon Captain","value":"surgeon_captain"},{"name":"The Earl of","value":"the_earl_of"},{"name":"The Honourable","value":"the_honourable"},{"name":"The Reverend Canon","value":"the_reverend_canon"},{"name":"Trooper","value":"trooper"},{"name":"Unspecified","value":"unspecified"},{"name":"Venerable","value":"venerable"},{"name":"Very Reverend","value":"very_reverend"},{"name":"Viscount","value":"viscount"},{"name":"Viscountess","value":"viscountess"},{"name":"Wing Commander","value":"wing_commander"}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Mr"},"value":{"type":"string","example":"mr"}}}}}}}}}},"tags":["Static Data"]}},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios":{"get":{"summary":"Get all portfolios","operationId":"getApiV1PlansPlan_uuidSubAccountsSubAccount_uuidPortfolios","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_at]","description":"Filter portfolios when they were created.","example":"?filter[created_at_after]=2023-09-25","required":false,"schema":{"type":"string","description":"Filter portfolios when they were created.","example":"?filter[created_at_after]=2023-09-25"}},{"in":"query","name":"filter[updated_at]","description":"Filter portfolios when they were updated.","example":"?filter[updated_at_after]=2023-09-25","required":false,"schema":{"type":"string","description":"Filter portfolios when they were updated.","example":"?filter[updated_at_after]=2023-09-25"}},{"in":"query","name":"filter[is_proposed]","description":"Filter portfolios that are proposed.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter portfolios that are proposed.","example":true}},{"in":"query","name":"filter[proposed_at]","description":"Filter portfolios when they were proposed.","example":"?filter[proposed_at_after]=2023-09-25","required":false,"schema":{"type":"string","description":"Filter portfolios when they were proposed.","example":"?filter[proposed_at_after]=2023-09-25"}},{"in":"query","name":"filter[name]","description":"Filter portfolios when they were created.","example":"?filter[created_at_after]=2023-09-25","required":false,"schema":{"type":"string","description":"Filter portfolios when they were created.","example":"?filter[created_at_after]=2023-09-25"}},{"in":"query","name":"filter[exclude_active_portfolio]","description":"Exclude the sub account's active portfolio.","example":true,"required":false,"schema":{"type":"boolean","description":"Exclude the sub account's active portfolio.","example":true}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PortfolioResource"}}}}}}}},"tags":["Sub Account Portfolios"]},"post":{"summary":"Create a portfolio","operationId":"postApiV1PlansPlan_uuidSubAccountsSubAccount_uuidPortfolios","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PortfolioResource"}}}}},"tags":["Sub Account Portfolios"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StorePortfolioRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}":{"get":{"summary":"Get a portfolio","operationId":"getApiV1PlansPlan_uuidSubAccountsSubAccount_uuidPortfoliosUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PortfolioResource"}}}}},"tags":["Sub Account Portfolios"]},"put":{"summary":"Update a portfolio","operationId":"putApiV1PlansPlan_uuidSubAccountsSubAccount_uuidPortfoliosUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_PortfolioResource"}}}}},"tags":["Sub Account Portfolios"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdatePortfolioRequest"}}}}},"delete":{"summary":"Delete a portfolio","operationId":"deleteApiV1PlansPlan_uuidSubAccountsSubAccount_uuidPortfoliosUuid","description":"This will delete the holdings that the portfolio was associated with.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Sub Account Portfolios"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts":{"get":{"summary":"Get all sub accounts","operationId":"getApiV1PlansPlan_uuidSubAccounts","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [latest_valuation].","example":"latest_valuation","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [latest_valuation].","example":"latest_valuation"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}}}}},"tags":["Sub Accounts"]},"post":{"summary":"Create a sub account","operationId":"postApiV1PlansPlan_uuidSubAccounts","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}},"tags":["Sub Accounts"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreSubAccountRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{uuid}":{"get":{"summary":"Get a sub account","operationId":"getApiV1PlansPlan_uuidSubAccountsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}},"tags":["Sub Accounts"]},"put":{"summary":"Update a sub account","operationId":"putApiV1PlansPlan_uuidSubAccountsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}},"tags":["Sub Accounts"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateSubAccountRequest"}}}}},"delete":{"summary":"Delete a sub account","operationId":"deleteApiV1PlansPlan_uuidSubAccountsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_SubAccountResource"}}}}},"tags":["Sub Accounts"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/tag":{"get":{"summary":"Get all tags","operationId":"getApiV1Tag","description":"","parameters":[{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, slug]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-slug","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, slug]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-slug"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[name]","description":"Filter by partial tag name","example":"architecto","required":false,"schema":{"type":"string","description":"Filter by partial tag name","example":"architecto"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TagResource"}}}}}}}},"tags":["Tagging"]},"post":{"summary":"Add tags to company","operationId":"postApiV1Tag","description":"You can provide an array of tags in various formats.\nEach element in the array can be:\n- a string of the tag name (and it will find it if it exists for the firm)\n- a UUID of a tag that already exists\n- an array of a name value and a colour value.  e.g. ['name' =\u003e 'Urgent', 'colour' =\u003e '#FF0000']\n\nThere are four different modes for dealing with tags on a model.\n- create = Create the tags you provide with no model attached to them.\n- attach = Add the tags you provide to the model, keeping any tags already on the model.\n- sync = Only the tags you provide in the request should exist on the model, this will remove any that you have not provided.\n- detach = Remove the tags you provide from the model.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TagResource"}}}}}}}},"tags":["Tagging"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Tag_StoreTagRequest"}}}}}},"/api/v1/tag/{uuid}":{"put":{"summary":"Update a tag","operationId":"putApiV1TagUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TagResource"}}}}},"tags":["Tagging"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Tag_UpdateTagRequest"}}}}},"delete":{"summary":"Delete a tag","operationId":"deleteApiV1TagUuid","description":"","parameters":[],"responses":{},"tags":["Tagging"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/task-status":{"get":{"summary":"Get all task statuses in a firm","operationId":"getApiV1TaskStatus","description":"","parameters":[{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, position]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, position]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskStatusResource"}}}}}}}},"tags":["Task Statuses"]},"post":{"summary":"Create a task status","operationId":"postApiV1TaskStatus","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskStatusResource"}}}}},"tags":["Task Statuses"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Tasks_StoreTaskStatusRequest"}}}}}},"/api/v1/task-status/{taskStatus_uuid}":{"get":{"summary":"Get a task status","operationId":"getApiV1TaskStatusTaskStatus_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskStatusResource"}}}}},"tags":["Task Statuses"]},"put":{"summary":"Update a task status","operationId":"putApiV1TaskStatusTaskStatus_uuid","description":"You cannot update a completed statuses details except it's position","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskStatusResource"}}}}},"tags":["Task Statuses"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Tasks_UpdateTaskStatusRequest"}}}}},"delete":{"summary":"Delete a task status","operationId":"deleteApiV1TaskStatusTaskStatus_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Task Statuses"]},"parameters":[{"in":"path","name":"taskStatus_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/task":{"get":{"summary":"Get all tasks on a firm.","operationId":"getApiV1Task","description":"Constrained by the user role. For example, owners and admins can see all tasks. Members can only see tasks within\ngroups they can access and clients can only see tasks they have access to.","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [author, completed_by, parent_task, related_tasks, custom_fields, workflow_task].","example":"?include=author,completed_by","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [author, completed_by, parent_task, related_tasks, custom_fields, workflow_task].","example":"?include=author,completed_by"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"query","name":"filter[name]","description":"Filter Task name.","example":"Task A","required":false,"schema":{"type":"string","description":"Filter Task name.","example":"Task A"}},{"in":"query","name":"filter[taskable_type]","description":"Taskable type. Can be 'plan' or 'case'.","example":"architecto","required":false,"schema":{"type":"string","description":"Taskable type. Can be 'plan' or 'case'.","example":"architecto"}},{"in":"query","name":"filter[taskable_uuid]","description":"Taskable uuid.","example":"123e4567-e89b-12d3-a456-426614174000","required":false,"schema":{"type":"string","description":"Taskable uuid.","example":"123e4567-e89b-12d3-a456-426614174000"}},{"in":"query","name":"filter[client_uuid]","description":"Client Taskable uuid.","example":"BABCB1F1-50E9-46A9-A5EE-50847EA65043","required":false,"schema":{"type":"string","description":"Client Taskable uuid.","example":"BABCB1F1-50E9-46A9-A5EE-50847EA65043"}},{"in":"query","name":"filter[priority]","description":"Priority. Available options are highest, high, medium, and low.","example":"highest,low","required":false,"schema":{"type":"string","description":"Priority. Available options are highest, high, medium, and low.","example":"highest,low"}},{"in":"query","name":"filter[assigned_to_uuids]","description":"Filter tasks that have been assigned to the account UUIDs.","example":"123e4567-e89b-12d3-a456-426614174000","required":false,"schema":{"type":"string","description":"Filter tasks that have been assigned to the account UUIDs.","example":"123e4567-e89b-12d3-a456-426614174000"}},{"in":"query","name":"filter[circle_uuids]","description":"Filter tasks that have been assigned to the account UUIDs within the specified circles.","example":"123e4567-e89b-12d3-a456-426614174000","required":false,"schema":{"type":"string","description":"Filter tasks that have been assigned to the account UUIDs within the specified circles.","example":"123e4567-e89b-12d3-a456-426614174000"}},{"in":"query","name":"filter[status_uuid]","description":"Status uuid. The task's status uuid.","example":"architecto","required":false,"schema":{"type":"string","description":"Status uuid. The task's status uuid.","example":"architecto"}},{"in":"query","name":"filter[due_before]","description":"date Filter tasks that have a due at date before.","example":"2021-01-04","required":false,"schema":{"type":"string","description":"date Filter tasks that have a due at date before.","example":"2021-01-04"}},{"in":"query","name":"filter[due_after]","description":"date Filter tasks that have a due at date after.","example":"2021-01-02","required":false,"schema":{"type":"string","description":"date Filter tasks that have a due at date after.","example":"2021-01-02"}},{"in":"query","name":"filter[has_due_date]","description":"Filter tasks that have a due at date or not.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter tasks that have a due at date or not.","example":true}},{"in":"query","name":"filter[open_tasks]","description":"Only show open tasks. When true, this will filter tasks in the \"Completed\" or \"Archived\" columns.","example":true,"required":false,"schema":{"type":"boolean","description":"Only show open tasks. When true, this will filter tasks in the \"Completed\" or \"Archived\" columns.","example":true}},{"in":"query","name":"filter[completed_status]","description":"Filter tasks which have a system status of type completed.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter tasks which have a system status of type completed.","example":true}},{"in":"query","name":"filter[archived_status]","description":"Filter tasks which have a system status of type archived.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter tasks which have a system status of type archived.","example":true}},{"in":"query","name":"filter[not_started_status]","description":"Filter tasks which have a system status of type not started.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter tasks which have a system status of type not started.","example":true}},{"in":"query","name":"filter[show_child_tasks]","description":"(deprecated, use subtask_visibility instead) Show child tasks in the top-level list. Defaults to false.","example":true,"required":false,"schema":{"type":"boolean","description":"(deprecated, use subtask_visibility instead) Show child tasks in the top-level list. Defaults to false.","example":true}},{"in":"query","name":"filter[subtask_visibility]","description":"Filter subtasks in the top-level list. options are: include, exclude or only.","example":"include","required":false,"schema":{"type":"string","description":"Filter subtasks in the top-level list. options are: include, exclude or only.","example":"include"}},{"in":"query","name":"filter[unassigned_task_visibility]","description":"Filter unassigned subtasks in the top-level list. options are: include, exclude or only.","example":"include","required":false,"schema":{"type":"string","description":"Filter unassigned subtasks in the top-level list. options are: include, exclude or only.","example":"include"}},{"in":"query","name":"filter[is_recurring]","description":"Filter recurring tasks.","example":true,"required":false,"schema":{"type":"boolean","description":"Filter recurring tasks.","example":true}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name, priority, due_at, completed_last]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name, priority, due_at, completed_last]. Negative sign to denote DESC.  Defaults to 'created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_IndexTaskResource"}}}}}}}},"tags":["Tasks"]},"post":{"summary":"Create a task","operationId":"postApiV1Task","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskResource"}}}}},"tags":["Tasks"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Tasks_StoreTaskRequest"}}}}}},"/api/v1/task/{uuid}":{"get":{"summary":"Get a task","operationId":"getApiV1TaskUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskResource"}}}}},"tags":["Tasks"]},"put":{"summary":"Update a task","operationId":"putApiV1TaskUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskResource"}}}}},"tags":["Tasks"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Tasks_UpdateTaskRequest"}}}}},"delete":{"summary":"Delete a task","operationId":"deleteApiV1TaskUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Tasks"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/task/{task_uuid}/complete":{"patch":{"summary":"Complete a task","operationId":"patchApiV1TaskTask_uuidComplete","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskResource"}}}}},"tags":["Tasks"]},"parameters":[{"in":"path","name":"task_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/task/{task_uuid}/archive":{"patch":{"summary":"Archive","operationId":"patchApiV1TaskTask_uuidArchive","description":"","parameters":[],"responses":{},"tags":["Tasks"]},"parameters":[{"in":"path","name":"task_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/task/{task_uuid}/uncomplete/{taskStatus}":{"patch":{"summary":"Uncomplete a task","operationId":"patchApiV1TaskTask_uuidUncompleteTaskStatus","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TaskResource"}}}}},"tags":["Tasks"]},"parameters":[{"in":"path","name":"task_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskStatus","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/task/{task_uuid}/unarchive/{taskStatus_uuid}":{"patch":{"summary":"Archive","operationId":"patchApiV1TaskTask_uuidUnarchiveTaskStatus_uuid","description":"","parameters":[],"responses":{},"tags":["Tasks"]},"parameters":[{"in":"path","name":"task_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskStatus_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/circles/{circle_uuid}/all-time-entries":{"get":{"summary":"Get all time entries for a circle","operationId":"getApiV1CirclesCircle_uuidAllTimeEntries","description":"Includes time entries within the circle's account's cases and tasks.","parameters":[{"in":"query","name":"filter[trackable_type]","description":"Filter by a comma separated list of trackable types.","example":"client,case,board_task","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of trackable types.","example":"client,case,board_task"}},{"in":"query","name":"filter[account_uuids]","description":"Time entries owned by account UUIDs, comma separated list.  Do not include if getting time entries for current user.","example":"architecto","required":false,"schema":{"type":"string","description":"Time entries owned by account UUIDs, comma separated list.  Do not include if getting time entries for current user.","example":"architecto"}},{"in":"query","name":"filter[start_date_after]","description":"Filter by time entries after a given start date.","example":"2022-08-10","required":false,"schema":{"type":"string","description":"Filter by time entries after a given start date.","example":"2022-08-10"}},{"in":"query","name":"filter[start_date_before]","description":"Filter by time entries before a given start date.","example":"2022-08-18","required":false,"schema":{"type":"string","description":"Filter by time entries before a given start date.","example":"2022-08-18"}},{"in":"query","name":"filter[end_date_after]","description":"Filter by time entries after a given end date.","example":"2022-08-10","required":false,"schema":{"type":"string","description":"Filter by time entries after a given end date.","example":"2022-08-10"}},{"in":"query","name":"filter[end_date_before]","description":"Filter by time entries before a given end date.","example":"2022-08-18","required":false,"schema":{"type":"string","description":"Filter by time entries before a given end date.","example":"2022-08-18"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-end_date'.","example":"start_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-end_date'.","example":"start_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}}}}},"tags":["Time Entries"]},"parameters":[{"in":"path","name":"circle_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"string","description":"Optional parameter. $circle_uuid","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/client/{client_uuid}/all-time-entries":{"get":{"summary":"Get all time entries for a client","operationId":"getApiV1ClientClient_uuidAllTimeEntries","description":"Includes time entries within the client account cases, and tasks.","parameters":[{"in":"query","name":"filter[trackable_type]","description":"Filter by a comma separated list of trackable types.","example":"client,case,board_task","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of trackable types.","example":"client,case,board_task"}},{"in":"query","name":"filter[account_uuids]","description":"Time entries owned by account UUIDs, comma separated list.  Do not include if getting time entries for current user.","example":"architecto","required":false,"schema":{"type":"string","description":"Time entries owned by account UUIDs, comma separated list.  Do not include if getting time entries for current user.","example":"architecto"}},{"in":"query","name":"filter[start_date_after]","description":"Filter by time entries after a given start date.","example":"2022-08-10","required":false,"schema":{"type":"string","description":"Filter by time entries after a given start date.","example":"2022-08-10"}},{"in":"query","name":"filter[start_date_before]","description":"Filter by time entries before a given start date.","example":"2022-08-18","required":false,"schema":{"type":"string","description":"Filter by time entries before a given start date.","example":"2022-08-18"}},{"in":"query","name":"filter[end_date_after]","description":"Filter by time entries after a given end date.","example":"2022-08-10","required":false,"schema":{"type":"string","description":"Filter by time entries after a given end date.","example":"2022-08-10"}},{"in":"query","name":"filter[end_date_before]","description":"Filter by time entries before a given end date.","example":"2022-08-18","required":false,"schema":{"type":"string","description":"Filter by time entries before a given end date.","example":"2022-08-18"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-end_date'.","example":"start_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-end_date'.","example":"start_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}}}}},"tags":["Time Entries"]},"parameters":[{"in":"path","name":"client_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"string","description":"Optional parameter. $client_uuid","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/time-entry":{"post":{"summary":"Create a time entry","operationId":"postApiV1TimeEntry","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}},"tags":["Time Entries"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_TimeEntry_StoreTimeEntryRequest"}}}}}},"/api/v1/time-entry/{uuid}":{"get":{"summary":"Get a time entry","operationId":"getApiV1TimeEntryUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}},"tags":["Time Entries"]},"put":{"summary":"Update a time entry","operationId":"putApiV1TimeEntryUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}},"tags":["Time Entries"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_TimeEntry_UpdateTimeEntryRequest"}}}}},"delete":{"summary":"Delete a time entry","operationId":"deleteApiV1TimeEntryUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}},"tags":["Time Entries"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/time-entry/{trackable_type}/{trackable_uuid}":{"get":{"summary":"Get time entries","operationId":"getApiV1TimeEntryTrackable_typeTrackable_uuid","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[accounts]","description":"Time entries owned by account UUIDs, comma separated list.  Do not include if getting time entries for current user.","example":"architecto","required":false,"schema":{"type":"string","description":"Time entries owned by account UUIDs, comma separated list.  Do not include if getting time entries for current user.","example":"architecto"}},{"in":"query","name":"filter[circle_uuids]","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1","required":false,"schema":{"type":"string","description":"Comma separated string of circle UUIDs to filter by.","example":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0,dfc9c7ba-029d-51c8-a754-e3bb26f9c4b1"}},{"in":"query","name":"filter[between]","description":"array Time entries started between the dates chosen, comma separated in format of Y-m-d.","example":"['2022-08-10', '2022-08-18']","required":false,"schema":{"type":"string","description":"array Time entries started between the dates chosen, comma separated in format of Y-m-d.","example":"['2022-08-10', '2022-08-18']"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-end_date'.","example":"start_date","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC.  Defaults to '-end_date'.","example":"start_date"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}}}}},"tags":["Time Entries"]},"parameters":[{"in":"path","name":"trackable_type","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}},{"in":"path","name":"trackable_uuid","description":"Optional parameter.","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"6ff8f7f6-1eb3-3525-be4a-3932c805afed"}}},{"in":"path","name":"null","description":"Optional parameter. $trackable_uuid","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v1/time-entry/{timeEntry_uuid}/stop":{"post":{"summary":"Stop a time entry","operationId":"postApiV1TimeEntryTimeEntry_uuidStop","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TimeEntryResource"}}}}},"tags":["Time Entries"]},"parameters":[{"in":"path","name":"timeEntry_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/transaction":{"get":{"summary":"Get all transactions","operationId":"getApiV1PlansPlan_uuidTransaction","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[subaccount]","description":"Comma separated list of sub account UUIDs to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of sub account UUIDs to filter by","example":"architecto"}},{"in":"query","name":"filter[holding]","description":"Comma separated list of holding UUIDs to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of holding UUIDs to filter by","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of types to filter by","example":"architecto"}},{"in":"query","name":"filter[sub_type]","description":"Comma separated list of sub-types to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of sub-types to filter by","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Get transactions from a date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get transactions from a date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_to]","description":"Get transactions to a date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get transactions to a date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get transactions greater than or equal to an amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get transactions greater than or equal to an amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get transactions less than or equal to an amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get transactions less than or equal to an amount in pennies.","example":"20000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount, date]. Negative sign to denote DESC.  Defaults to '-date'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount, date]. Negative sign to denote DESC.  Defaults to '-date'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionResource"}}}}}}}},"tags":["Transaction"]},"post":{"summary":"Create a transaction","operationId":"postApiV1PlansPlan_uuidTransaction","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionResource"}}}}},"tags":["Transaction"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Transaction_StoreTransactionRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"The uuid of a Plan.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/transaction/{uuid}":{"get":{"summary":"Get a transaction","operationId":"getApiV1PlansPlan_uuidTransactionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionResource"}}}}},"tags":["Transaction"]},"put":{"summary":"Update a transaction","operationId":"putApiV1PlansPlan_uuidTransactionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionResource"}}}}},"tags":["Transaction"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Transaction_UpdateTransactionRequest"}}}}},"delete":{"summary":"Delete a transaction","operationId":"deleteApiV1PlansPlan_uuidTransactionUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Transaction"]},"parameters":[{"in":"path","name":"plan_uuid","description":"The uuid of a Plan.","example":"dcf0-484e-a0c5-08590fe89a84-f6aa1670","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"The uuid of the transaction.","example":"dbf0-4b4e-a0c5-0b59bf8b84-f6aa1670","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/transaction-schedule/summary":{"get":{"summary":"Get a summary of the transaction schedules","operationId":"getApiV1PlansPlan_uuidTransactionScheduleSummary","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionScheduleSummaryResource"}}}}},"tags":["Transaction"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/transaction-schedule":{"get":{"summary":"Get all transaction schedules","operationId":"getApiV1PlansPlan_uuidTransactionSchedule","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[subaccount]","description":"Comma separated list of sub account UUIDs to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of sub account UUIDs to filter by","example":"architecto"}},{"in":"query","name":"filter[holding]","description":"Comma separated list of holding UUIDs to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of holding UUIDs to filter by","example":"architecto"}},{"in":"query","name":"filter[type]","description":"Comma separated list of types to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of types to filter by","example":"architecto"}},{"in":"query","name":"filter[sub_type]","description":"Comma separated list of sub-types to filter by","example":"architecto","required":false,"schema":{"type":"string","description":"Comma separated list of sub-types to filter by","example":"architecto"}},{"in":"query","name":"filter[date_from]","description":"Get transactions from a date.","example":"2022-03-20","required":false,"schema":{"type":"string","description":"Get transactions from a date.","example":"2022-03-20"}},{"in":"query","name":"filter[date_to]","description":"Get transactions to a date.","example":"2022-03-27","required":false,"schema":{"type":"string","description":"Get transactions to a date.","example":"2022-03-27"}},{"in":"query","name":"filter[amount_from]","description":"Get transactions greater than or equal to an amount in pennies.","example":"15000","required":false,"schema":{"type":"string","description":"Get transactions greater than or equal to an amount in pennies.","example":"15000"}},{"in":"query","name":"filter[amount_to]","description":"Get transactions less than or equal to an amount in pennies.","example":"20000","required":false,"schema":{"type":"string","description":"Get transactions less than or equal to an amount in pennies.","example":"20000"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount, start_date, next_transaction_date]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, type, amount, start_date, next_transaction_date]. Negative sign to denote DESC.  Defaults to '-start_date'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionScheduleResource"}}}}}}}},"tags":["Transaction"]},"post":{"summary":"Create a transaction schedule","operationId":"postApiV1PlansPlan_uuidTransactionSchedule","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionScheduleResource"}}}}},"tags":["Transaction"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Transaction_StoreTransactionScheduleRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}":{"get":{"summary":"Get a transaction schedule","operationId":"getApiV1PlansPlan_uuidTransactionScheduleTransactionSchedule_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionScheduleResource"}}}}},"tags":["Transaction"]},"put":{"summary":"Update a transaction schedule","operationId":"putApiV1PlansPlan_uuidTransactionScheduleTransactionSchedule_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_TransactionScheduleResource"}}}}},"tags":["Transaction"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Transaction_UpdateTransactionScheduleRequest"}}}}},"delete":{"summary":"Delete a transaction schedule","operationId":"deleteApiV1PlansPlan_uuidTransactionScheduleTransactionSchedule_uuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Transaction"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"transactionSchedule_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/transactions":{"get":{"summary":"Get all transactions","operationId":"getApiV2Transactions","description":"This endpoint will return all transactions in the firm relevant to the user accessing them.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[account_uuids]","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of account UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[plan_uuids]","description":"Filter by a comma separated list of plan UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of plan UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[sub_account_uuids]","description":"Filter by a comma separated list of subaccount UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of subaccount UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[created_at]","description":"Filter by created at date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[created_at]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by created at date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[created_at]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[updated_at]","description":"Filter by updated at date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[updated_at]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by updated at date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[updated_at]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[type]","description":"Filter by type.","example":"deposit","required":false,"schema":{"type":"string","description":"Filter by type.","example":"deposit"}},{"in":"query","name":"filter[sub_type]","description":"Filter by subtype.","example":"regular","required":false,"schema":{"type":"string","description":"Filter by subtype.","example":"regular"}},{"in":"query","name":"filter[amount]","description":"Filter by amount. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[amount]=\u003e=1000,\u003c=5000","required":false,"schema":{"type":"string","description":"Filter by amount. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[amount]=\u003e=1000,\u003c=5000"}},{"in":"query","name":"filter[date]","description":"Filter by date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[date]=\u003e=2023-01-01,\u003c=2023-08-01","required":false,"schema":{"type":"string","description":"Filter by date. Can use operands such as \u003e=, \u003c\u003e, \u003e and combine as a range by providing two values separated by comma.","example":"?filter[date]=\u003e=2023-01-01,\u003c=2023-08-01"}},{"in":"query","name":"filter[status]","description":"Filter by status.","example":"completed","required":false,"schema":{"type":"string","description":"Filter by status.","example":"completed"}},{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [plan, subAccount, holding, transactionSchedule].","example":"?include=plan,subAccount","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [plan, subAccount, holding, transactionSchedule].","example":"?include=plan,subAccount"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, date]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, date]. Negative sign to denote DESC. Defaults to '-created_at'.","example":"updated_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_V2_TransactionResource"}}}}}}}},"tags":["Transactions (v2)"]}},"/api/v1/unipass/certificate":{"get":{"summary":"Get the Unipass certificate","operationId":"getApiV1UnipassCertificate","description":"Get the Unipass certificate on the currently authenticated user. Returns 404 if there is no certificate.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_UnipassCertificateResource"}}}}},"tags":["Unipass Certificates"]},"post":{"summary":"Store the Unipass certificate","operationId":"postApiV1UnipassCertificate","description":"Store the Unipass certificate on the currently authenticated user.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_UnipassCertificateResource"}}}}},"tags":["Unipass Certificates"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Unipass_StoreUnipassCertificateRequest"}}}}},"delete":{"summary":"Delete the Unipass certificate","operationId":"deleteApiV1UnipassCertificate","description":"Deletes the Unipass certificate from the account. Returns 404 if there is no certificate.","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Unipass Certificates"]}},"/api/v1/me":{"get":{"summary":"Get the authenticated user","operationId":"getApiV1Me","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_UserResource"}}}}},"tags":["User Management"]},"put":{"summary":"Update the authenticated user","operationId":"putApiV1Me","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_UserResource"}}}}},"tags":["User Management"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_UpdateUserRequest"}}}}}},"/api/v1/logins":{"get":{"summary":"Get all logins for the authenticated user","operationId":"getApiV1Logins","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_LoginResource"}}}}}}}},"tags":["User Management"]}},"/api/v1/fact-find-passes/{factFindRequest_uuid}":{"get":{"summary":"List all fact-find passes for the user","operationId":"getApiV1FactFindPassesFactFindRequest_uuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_FactFindPassResource"}}}}},"tags":["User Management"]},"parameters":[{"in":"path","name":"factFindRequest_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/me/switch-account":{"post":{"summary":"Switch user accounts","operationId":"postApiV1MeSwitchAccount","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_UserResource"}}}}},"tags":["User Management"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_SwitchAccountRequest"}}}}}},"/api/v1/mobile/notification-token":{"post":{"summary":"Store Firebase notification tokens","operationId":"postApiV1MobileNotificationToken","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["User Management"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_StoreMobileNotificationTokenRequest"}}}}},"delete":{"summary":"Revoke Firebase notification tokens","operationId":"deleteApiV1MobileNotificationToken","description":"","parameters":[],"responses":{},"tags":["User Management"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_DestroyMobileNotificationTokenRequest"}}}}}},"/api/v1/integrations/{passportClient_id}/revoke":{"post":{"summary":"Remotely revoke an integration","operationId":"postApiV1IntegrationsPassportClient_idRevoke","description":"This route is purposely left undocumented as we don't currently have a UI\nfor the customer to revoke access to their Plannr account.","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["User Management"]},"parameters":[{"in":"path","name":"passportClient_id","description":"The ID of the passportClient.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/my/welcome-widget-tasks":{"get":{"summary":"Get the welcome widget tasks for the authenticated user","operationId":"getApiV1MyWelcomeWidgetTasks","description":"Only available to Plannr's front-end.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_WelcomeWidgetTasksResource"}}}}},"tags":["User Management"]}},"/api/v1/my/welcome-widget-tasks/{id}":{"post":{"summary":"Update a welcome widget task for the given user","operationId":"postApiV1MyWelcomeWidgetTasksId","description":"Only available to Plannr's front-end.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_WelcomeWidgetTasksResource"}}}}},"tags":["User Management"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_User_UpdateWelcomeWidgetTaskRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The ID of the welcome widget task.","example":"architecto","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations":{"post":{"summary":"Create a valuation","operationId":"postApiV1PlansPlan_uuidSubAccountsSubAccount_uuidValuations","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Valuations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_StoreValuationRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}":{"get":{"summary":"Get a valuation","operationId":"getApiV1PlansPlan_uuidSubAccountsSubAccount_uuidValuationsUuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Valuations"]},"put":{"summary":"Update a valuation","operationId":"putApiV1PlansPlan_uuidSubAccountsSubAccount_uuidValuationsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ValuationResource"}}}}},"tags":["Valuations"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Plans_UpdateValuationRequest"}}}}},"delete":{"summary":"Delete a valuation","operationId":"deleteApiV1PlansPlan_uuidSubAccountsSubAccount_uuidValuationsUuid","description":"","parameters":[],"responses":{},"tags":["Valuations"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/valuations/{subAccount}":{"get":{"summary":"Get all valuations","operationId":"getApiV1PlansPlan_uuidValuationsSubAccount","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[valued_at_after]","description":"Filter by valuations valued after a date.","example":"2021-01-01","required":false,"schema":{"type":"string","description":"Filter by valuations valued after a date.","example":"2021-01-01"}},{"in":"query","name":"filter[valued_at_before]","description":"Filter by valuations valued before a date.","example":"2021-01-01","required":false,"schema":{"type":"string","description":"Filter by valuations valued before a date.","example":"2021-01-01"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [valued_at]. Negative sign to denote DESC.  Defaults to 'valued_at'.","example":"-valued_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [valued_at]. Negative sign to denote DESC.  Defaults to 'valued_at'.","example":"-valued_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_ValuationResource"}}}}}}}},"tags":["Valuations"]},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount","description":"Optional parameter. An optional sub-account to constrain the results by.","required":true,"schema":{"type":"integer"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":16}}}]},"/api/v2/valuations/bulk":{"post":{"summary":"Bulk insert valuations","operationId":"postApiV2ValuationsBulk","description":"Creates multiple valuations for a plan and sub-account","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Valuations (V2)"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_V2_Valuations_StoreBulkValuationsRequest"}}}}}},"/api/v2/webhook-subscriptions":{"get":{"summary":"Get all webhook subscriptions","operationId":"getApiV2WebhookSubscriptions","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[url]","description":"Filter by a comma separated list of URLs.","example":"https://api.example.com/webooks","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of URLs.","example":"https://api.example.com/webooks"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_WebhookSubscriptionResource"}}}}}}}},"tags":["Webhook Subscriptions"]},"post":{"summary":"Create a webhook subscription","operationId":"postApiV2WebhookSubscriptions","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_WebhookSubscriptionResource"}}}}},"tags":["Webhook Subscriptions"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_StoreWebhookSubscriptionRequest"}}}}}},"/api/v2/webhook-subscriptions/{uuid}":{"get":{"summary":"Get a webhook subscription","operationId":"getApiV2WebhookSubscriptionsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_WebhookSubscriptionResource"}}}}},"tags":["Webhook Subscriptions"]},"put":{"summary":"Update a webhook subscription","operationId":"putApiV2WebhookSubscriptionsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_WebhookSubscriptionResource"}}}}},"tags":["Webhook Subscriptions"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_UpdateWebhookSubscriptionRequest"}}}}},"delete":{"summary":"Delete a webhook subscription","operationId":"deleteApiV2WebhookSubscriptionsUuid","description":"","parameters":[{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{}}}}}},"tags":["Webhook Subscriptions"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Optional parameter. The UUID of the Webhook Subscription","required":true,"schema":{"type":"string"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"architecto"}}}]},"/api/v2/webhook-subscriptions/{webhookSubscription_uuid}/calls":{"get":{"summary":"Get all calls made to a given webhook subscription","operationId":"getApiV2WebhookSubscriptionsWebhookSubscription_uuidCalls","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"filter[event]","description":"Filter by a comma separated list of events.","example":"account.created","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of events.","example":"account.created"}},{"in":"query","name":"filter[response_status]","description":"Filter by a comma separated list of response status codes.","example":"500,422","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of response status codes.","example":"500,422"}},{"in":"query","name":"filter[successful]","description":"Filter successful webhook calls.","example":"true","required":false,"schema":{"type":"string","description":"Filter successful webhook calls.","example":"true"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, response_status]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, response_status]. Negative sign to denote DESC.  Defaults to '-created_at'.","example":"updated_at"}},{"in":"header","name":"X-PLANNR-ACCOUNT-UUID","description":"","example":"{YOUR_PLANNR_ACCOUNT_UUID}","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_OutgoingWebhookCallResource"}}}}}}}},"tags":["Webhook Subscriptions"]},"parameters":[{"in":"path","name":"webhookSubscription_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v2/webhook-subscriptions/calls/{outgoingWebhookCall_uuid}/retry":{"post":{"summary":"Retry the existing Webhook Call","operationId":"postApiV2WebhookSubscriptionsCallsOutgoingWebhookCall_uuidRetry","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Webhook Subscriptions"]},"parameters":[{"in":"path","name":"outgoingWebhookCall_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals":{"post":{"summary":"Create a withdrawal [DEPRECATED: Use transaction routes]","operationId":"postApiV1PlansPlan_uuidSubAccountsSubAccount_uuidWithdrawals","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_WithdrawalResource"}}}}},"tags":["Withdrawals"],"deprecated":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Withdrawal_StoreWithdrawalRequest"}}}}},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}":{"get":{"summary":"Get a withdrawal [DEPRECATED: Use transaction routes]","operationId":"getApiV1PlansPlan_uuidSubAccountsSubAccount_uuidWithdrawalsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_WithdrawalResource"}}}}},"tags":["Withdrawals"],"deprecated":true},"put":{"summary":"Update a withdrawal [DEPRECATED: Use transaction routes]","operationId":"putApiV1PlansPlan_uuidSubAccountsSubAccount_uuidWithdrawalsUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_WithdrawalResource"}}}}},"tags":["Withdrawals"],"deprecated":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Withdrawal_UpdateWithdrawalRequest"}}}}},"delete":{"summary":"Delete a withdrawal [DEPRECATED: Use transaction routes]","operationId":"deleteApiV1PlansPlan_uuidSubAccountsSubAccount_uuidWithdrawalsUuid","description":"","parameters":[],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_WithdrawalResource"}}}}},"tags":["Withdrawals"],"deprecated":true},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/plans/{plan_uuid}/withdrawals/{subAccount}":{"get":{"summary":"Get all withdrawals [DEPRECATED: Use transaction routes]","operationId":"getApiV1PlansPlan_uuidWithdrawalsSubAccount","description":"","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, withdrawn_at]. Negative sign to denote DESC.  Defaults to '-withdrawn_at'.","example":"-withdrawn_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, withdrawn_at]. Negative sign to denote DESC.  Defaults to '-withdrawn_at'.","example":"-withdrawn_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Plans_WithdrawalResource"}}}}}}}},"tags":["Withdrawals"],"deprecated":true},"parameters":[{"in":"path","name":"plan_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"subAccount","description":"Optional parameter. An optional sub-account to constrain the results by.","required":true,"schema":{"type":"integer"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":16}}}]},"/api/v1/workflow":{"get":{"summary":"Get all workflows","operationId":"getApiV1Workflow","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [author, tasks_count].","example":"?include=author,tasks_count","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [author, tasks_count].","example":"?include=author,tasks_count"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Board_WorkflowResource"}}}}},"tags":["Workflows"]},"post":{"summary":"Create a workflow","operationId":"postApiV1Workflow","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Board_WorkflowResource"}}}}},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_StoreWorkflowRequest"}}}}}},"/api/v1/workflow/{uuid}":{"get":{"summary":"Get a workflow","operationId":"getApiV1WorkflowUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Board_WorkflowResource"}}}}},"tags":["Workflows"]},"put":{"summary":"Update a workflow","operationId":"putApiV1WorkflowUuid","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Board_WorkflowResource"}}}}},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_UpdateWorkflowRequest"}}}}},"delete":{"summary":"Delete a workflow","operationId":"deleteApiV1WorkflowUuid","description":"","parameters":[],"responses":{},"tags":["Workflows"]},"parameters":[{"in":"path","name":"uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/workflow/{workflow_uuid}/tree":{"get":{"summary":"Render a tree of the structure of the workflow.","operationId":"getApiV1WorkflowWorkflow_uuidTree","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Board_WorkflowTreeResource"}}}}},"tags":["Workflows"]},"parameters":[{"in":"path","name":"workflow_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/workflow/{workflow_uuid}/breadcrumbs":{"get":{"summary":"Render breadcrumbs of the structure of the workflow.","operationId":"getApiV1WorkflowWorkflow_uuidBreadcrumbs","description":"","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/App_Http_Resources_Board_WorkflowBreadcrumbsResource"}}}}},"tags":["Workflows"]},"parameters":[{"in":"path","name":"workflow_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/workflow/{workflow_uuid}/task":{"get":{"summary":"Get all workflow tasks","operationId":"getApiV1WorkflowWorkflow_uuidTask","description":"","parameters":[{"in":"query","name":"include","description":"Comma separated list of relationships to include in the response. Valid relationships are [author, participants, tags, groups].","example":"?include=author,tags","required":false,"schema":{"type":"string","description":"Comma separated list of relationships to include in the response. Valid relationships are [author, participants, tags, groups].","example":"?include=author,tags"}},{"in":"query","name":"filter[uuid]","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf","required":false,"schema":{"type":"string","description":"Filter by a comma separated list of UUIDs.","example":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52,6a6a176d-52bc-47f2-88c3-141d44059bcf"}},{"in":"query","name":"sort","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at","required":false,"schema":{"type":"string","description":"Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC.  Defaults to 'name'.","example":"-created_at"}},{"in":"query","name":"per_page","description":"Number of results to return with pagination (Default 15. Max 500).","example":50,"required":false,"schema":{"type":"integer","description":"Number of results to return with pagination (Default 15. Max 500).","example":50}}],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Workflows"]},"post":{"summary":"Create a workflow task","operationId":"postApiV1WorkflowWorkflow_uuidTask","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_StoreWorkflowTaskRequest"}}}}},"parameters":[{"in":"path","name":"workflow_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}":{"get":{"summary":"Get a workflow task","operationId":"getApiV1WorkflowWorkflow_uuidTaskWorkflowTask_uuid","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Workflows"]},"put":{"summary":"Update a workflow task","operationId":"putApiV1WorkflowWorkflow_uuidTaskWorkflowTask_uuid","description":"","parameters":[],"responses":{},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_UpdateWorkflowTaskRequest"}}}}},"delete":{"summary":"Delete a workflow task","operationId":"deleteApiV1WorkflowWorkflow_uuidTaskWorkflowTask_uuid","description":"","parameters":[],"responses":{},"tags":["Workflows"]},"parameters":[{"in":"path","name":"workflow_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"workflowTask_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants":{"post":{"summary":"Add a participant to the workflow task","operationId":"postApiV1WorkflowWorkflow_uuidTaskWorkflowTask_uuidParticipants","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_AddParticipantsToWorkflowTaskRequest"}}}}},"delete":{"summary":"Remove a participant from a workflow task","operationId":"deleteApiV1WorkflowWorkflow_uuidTaskWorkflowTask_uuidParticipants","description":"","parameters":[],"responses":{},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_RemoveParticipantsFromWorkflowTaskRequest"}}}}},"parameters":[{"in":"path","name":"workflow_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}},{"in":"path","name":"workflowTask_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]},"/api/v1/workflow/{workflow_uuid}/run":{"post":{"summary":"Run a workflow","operationId":"postApiV1WorkflowWorkflow_uuidRun","description":"","parameters":[],"responses":{"401":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"message":"Unauthenticated."},"properties":{"message":{"type":"string","example":"Unauthenticated."}}}}}}},"tags":["Workflows"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_Http_Requests_Board_RunWorkflowRequest"}}}}},"parameters":[{"in":"path","name":"workflow_uuid","description":"","example":"6ff8f7f6-1eb3-3525-be4a-3932c805afed","required":true,"schema":{"type":"string"}}]}}}