Headers
-
Content-Type string
-
Accept string
Body Required
-
keep_deleted_files_for integer
Number of days to keep files in the recycle bin. Set as null for indefinitely
-
tax number
Tax rate
-
rmar_start_date date
Date you will not be able to add charges before
-
advice_type string
Default RMAR advice type for new employees
-
month_end integer
Date of the month for the monthly income reconciliation statements to end. Leave at 31 for the end of the month
-
lock_statements_after integer
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 string
Default adviser split to be applied to new advisers
-
Whether to allow clients to view the pseudo folders in the client portal
-
Notify the assigned adviser when a client completes a fact find
-
Notify the assigned administrator when a client completes a fact find
-
Notify the assigned paraplanner when a client completes a fact find
-
charge_identifier boolean
Charge identifier to apply to charges. Visit support documentation for requirements and list of variables.
-
Notify the assigned adviser when a clients core details are updated.
-
Notify the assigned adviser when a clients core details are updated.
-
Notify the assigned adviser when a clients core details are updated.
POST
/api/v1/firm/{firm_uuid}/settings
curl \
--request POST https://api.plannrcrm.com/api/v1/firm/firm_uuid/settings \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"keep_deleted_files_for":60,"tax":17.5,"rmar_start_date":"2022-08-01","advice_type":"independent","month_end":25,"lock_statements_after":0,"adviser_split_uuid":"a7cbb0a9-8ec5-40f5-9937-8d1abad43d9b","show_pseudo_folders_in_client_portal":true,"fact_find_completed_notification_to_assigned_adviser":true,"fact_find_completed_notification_to_assigned_administrator":true,"fact_find_completed_notification_to_assigned_paraplanner":true,"charge_identifier":true,"core_details_changed_notification_for_assigned_adviser":true,"core_details_changed_notification_for_assigned_administrator":true,"core_details_changed_notification_for_assigned_paraplanner":true}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
# Payload
{
"keep_deleted_files_for": 60,
"tax": 17.5,
"rmar_start_date": "2022-08-01",
"advice_type": "independent",
"month_end": 25,
"lock_statements_after": 0,
"adviser_split_uuid": "a7cbb0a9-8ec5-40f5-9937-8d1abad43d9b",
"show_pseudo_folders_in_client_portal": true,
"fact_find_completed_notification_to_assigned_adviser": true,
"fact_find_completed_notification_to_assigned_administrator": true,
"fact_find_completed_notification_to_assigned_paraplanner": true,
"charge_identifier": true,
"core_details_changed_notification_for_assigned_adviser": true,
"core_details_changed_notification_for_assigned_administrator": true,
"core_details_changed_notification_for_assigned_paraplanner": true
}
Response examples (200)
{
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "e1a05516-3c90-49c4-ae76-e62c7e69563c",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00:00",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"brand_colours": {
"sidebar_text": "#ffffff",
"sidebar_hover": "#0A0A42",
"email_sub_text": "#ffffff",
"sidebar_accent": "#36367E",
"sidebar_active": "#53DBB8",
"email_background": "#0E0E56",
"email_button_text": "#ffffff",
"sidebar_background": "#0E0E56",
"sidebar_title_primary": "#FFC634",
"email_button_background": "#36367E",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"email_logo_background_panel": "#36367E",
"sidebar_title_secondary_hover": "#ffffff"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": [
{
"uuid": "391bb0d9-29e4-4650-976d-5922b2b1b23c",
"addon": "App\\Http\\Resources\\Addons\\AddonResource",
"enabled": "true",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00:00"
}
],
"statement_frequency": "monthly",
"task_board_template": {
"name": "Task Board",
"uuid": "4305b6b9-f263-4724-aaac-6d9b9a5f42dc",
"lists": "App\\Http\\Resources\\Board\\BoardListResource",
"modelable": "App\\Http\\Resources\\CasesResource",
"created_at": "2025-02-20T10:13:00+00:00",
"priorities": [
{
"name": "High",
"value": "high"
},
{
"name": "Low",
"value": "low"
}
],
"updated_at": "2025-02-20T10:13:00+00:00",
"is_editable": true,
"is_template": false,
"default_list_uuid": "fda5050a-7aa4-49c9-922e-b2dc2330a33e"
},
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!"
}