Get all sub schemes for a group scheme Run in API Explorer
Query parameters
-
Filter by a comma separated list of UUIDs.
-
Filter members by name. This is a partial match against first_name, last_name, and entity_name together.
-
Filter members by their status. Options: active, inactive, proposed
-
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
-
Field to sort by. Valid fields are [created_at, updated_at, premium, status]. Negative sign to denote DESC. Defaults to '-created_at'.
-
Number of results to return with pagination (Default 15. Max 500).
Responses
-
Hide response attribute Show response attribute object
-
Hide data attributes Show data attributes object
-
Hide main_account attributes Show main_account attributes object
-
Hide active_portfolio attributes Show active_portfolio attributes object
-
Hide sub_accounts attributes Show sub_accounts attributes object
-
Hide active_portfolio attributes Show active_portfolio attributes object
-
Hide covers attributes Show covers attributes object
-
Hide benefit_amount attributes Show benefit_amount attributes object
-
Hide excess attributes Show excess attributes object
-
Hide client attributes Show client attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide claims attributes Show claims attributes object
-
Hide claim_amount attributes Show claim_amount attributes object
-
Hide client attributes Show client attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide total_benefit_amount attributes Show total_benefit_amount attributes object
-
Hide total_benefits attributes Show total_benefits attributes object
-
Hide critical_illness attributes Show critical_illness attributes object
-
Hide family_income_benefit attributes Show family_income_benefit attributes object
-
-
Hide latest_valuations attributes Show latest_valuations attributes object
-
Hide value attributes Show value attributes object
-
Hide sub_account attributes Show sub_account attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide value attributes Show value attributes object
-
Hide client attributes Show client attributes object
-
Hide firm attributes Show firm attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the firm
-
Slug of the firm
-
First line of the address
-
Second line of the address
-
Town/City
-
County
-
Postcode
-
Country
-
Regulatory text of the firm.
-
URL of your firm logo.
-
URL of your firm logo icon.
-
Firm branding colours.
-
Subscription status.
-
Number of days to keep deleted files for
-
Tax percent
-
Date of the month for the monthly income reconciliation statements to end
-
The frequency of the income reconciliation statements
-
Firm invoice details for billing
-
A list of IP Addresses a firm is allowed to log in from.
-
Custom welcome paragraph html for the branded auth welcome page
-
Custom welcome paragraph for the welcome/new user email
-
Determines if the illustrations/graphics are displayed on the fact find.
-
Array of email cc addresses.
-
Array of email bcc addresses.
-
Firm reply to email address.
-
Firm mobile app support number.
-
Firm mobile app support email address.
-
-
Hide primary_phone_number attributes Show primary_phone_number attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide primary_email attributes Show primary_email attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide current_time_entry attributes Show current_time_entry attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The name of the time entry.
-
The description of the time entry.
-
The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.
-
The start time of the time entry.
-
The end time of the time entry.
-
Determines if the time entry is currently ongoing.
-
Total time in minutes.
-
Computed time elapsed in seconds.
-
-
Hide assigned_adviser attributes Show assigned_adviser attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_administrator attributes Show assigned_administrator attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide introduced_by attributes Show introduced_by attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide business_unit attributes Show business_unit attributes object
-
The UUID of the resource.
-
Name of the business unit.
-
Whether alternative branding is enabled for this business unit.
-
Brand colours for this business unit, merged with firm defaults.
-
Number of accounts assigned to this business unit
-
Number of groups assigned to this business unit
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
-
Hide groups attributes Show groups attributes object
-
Hide owners attributes Show owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide joint_account_circle attributes Show joint_account_circle attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide circles attributes Show circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide accounts attributes Show accounts attributes object
-
Hide firm attributes Show firm attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the firm
-
Slug of the firm
-
First line of the address
-
Second line of the address
-
Town/City
-
County
-
Postcode
-
Country
-
Regulatory text of the firm.
-
URL of your firm logo.
-
URL of your firm logo icon.
-
Firm branding colours.
-
Subscription status.
-
Number of days to keep deleted files for
-
Tax percent
-
Date of the month for the monthly income reconciliation statements to end
-
The frequency of the income reconciliation statements
-
Firm invoice details for billing
-
A list of IP Addresses a firm is allowed to log in from.
-
Custom welcome paragraph html for the branded auth welcome page
-
Custom welcome paragraph for the welcome/new user email
-
Determines if the illustrations/graphics are displayed on the fact find.
-
Array of email cc addresses.
-
Array of email bcc addresses.
-
Firm reply to email address.
-
Firm mobile app support number.
-
Firm mobile app support email address.
-
-
Hide primary_phone_number attributes Show primary_phone_number attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide primary_email attributes Show primary_email attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide current_time_entry attributes Show current_time_entry attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The name of the time entry.
-
The description of the time entry.
-
The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.
-
The start time of the time entry.
-
The end time of the time entry.
-
Determines if the time entry is currently ongoing.
-
Total time in minutes.
-
Computed time elapsed in seconds.
-
-
Hide assigned_adviser attributes Show assigned_adviser attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_administrator attributes Show assigned_administrator attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide introduced_by attributes Show introduced_by attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide business_unit attributes Show business_unit attributes object
-
The UUID of the resource.
-
Name of the business unit.
-
Whether alternative branding is enabled for this business unit.
-
Brand colours for this business unit, merged with firm defaults.
-
Number of accounts assigned to this business unit
-
Number of groups assigned to this business unit
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
-
Hide groups attributes Show groups attributes object
-
Hide owners attributes Show owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide joint_account_circle attributes Show joint_account_circle attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide circles attributes Show circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide seller attributes Show seller attributes object
-
Hide firm attributes Show firm attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the firm
-
Slug of the firm
-
First line of the address
-
Second line of the address
-
Town/City
-
County
-
Postcode
-
Country
-
Regulatory text of the firm.
-
URL of your firm logo.
-
URL of your firm logo icon.
-
Firm branding colours.
-
Subscription status.
-
Number of days to keep deleted files for
-
Tax percent
-
Date of the month for the monthly income reconciliation statements to end
-
The frequency of the income reconciliation statements
-
Firm invoice details for billing
-
A list of IP Addresses a firm is allowed to log in from.
-
Custom welcome paragraph html for the branded auth welcome page
-
Custom welcome paragraph for the welcome/new user email
-
Determines if the illustrations/graphics are displayed on the fact find.
-
Array of email cc addresses.
-
Array of email bcc addresses.
-
Firm reply to email address.
-
Firm mobile app support number.
-
Firm mobile app support email address.
-
-
Hide primary_phone_number attributes Show primary_phone_number attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide primary_email attributes Show primary_email attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide current_time_entry attributes Show current_time_entry attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The name of the time entry.
-
The description of the time entry.
-
The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.
-
The start time of the time entry.
-
The end time of the time entry.
-
Determines if the time entry is currently ongoing.
-
Total time in minutes.
-
Computed time elapsed in seconds.
-
-
Hide assigned_adviser attributes Show assigned_adviser attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_administrator attributes Show assigned_administrator attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide introduced_by attributes Show introduced_by attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide business_unit attributes Show business_unit attributes object
-
The UUID of the resource.
-
Name of the business unit.
-
Whether alternative branding is enabled for this business unit.
-
Brand colours for this business unit, merged with firm defaults.
-
Number of accounts assigned to this business unit
-
Number of groups assigned to this business unit
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
-
Hide groups attributes Show groups attributes object
-
Hide owners attributes Show owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide joint_account_circle attributes Show joint_account_circle attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide circles attributes Show circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide linked_owners attributes Show linked_owners attributes object
-
Hide firm attributes Show firm attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the firm
-
Slug of the firm
-
First line of the address
-
Second line of the address
-
Town/City
-
County
-
Postcode
-
Country
-
Regulatory text of the firm.
-
URL of your firm logo.
-
URL of your firm logo icon.
-
Firm branding colours.
-
Subscription status.
-
Number of days to keep deleted files for
-
Tax percent
-
Date of the month for the monthly income reconciliation statements to end
-
The frequency of the income reconciliation statements
-
Firm invoice details for billing
-
A list of IP Addresses a firm is allowed to log in from.
-
Custom welcome paragraph html for the branded auth welcome page
-
Custom welcome paragraph for the welcome/new user email
-
Determines if the illustrations/graphics are displayed on the fact find.
-
Array of email cc addresses.
-
Array of email bcc addresses.
-
Firm reply to email address.
-
Firm mobile app support number.
-
Firm mobile app support email address.
-
-
Hide primary_phone_number attributes Show primary_phone_number attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide primary_email attributes Show primary_email attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide current_time_entry attributes Show current_time_entry attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The name of the time entry.
-
The description of the time entry.
-
The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.
-
The start time of the time entry.
-
The end time of the time entry.
-
Determines if the time entry is currently ongoing.
-
Total time in minutes.
-
Computed time elapsed in seconds.
-
-
Hide assigned_adviser attributes Show assigned_adviser attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_administrator attributes Show assigned_administrator attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide introduced_by attributes Show introduced_by attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide business_unit attributes Show business_unit attributes object
-
The UUID of the resource.
-
Name of the business unit.
-
Whether alternative branding is enabled for this business unit.
-
Brand colours for this business unit, merged with firm defaults.
-
Number of accounts assigned to this business unit
-
Number of groups assigned to this business unit
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
-
Hide groups attributes Show groups attributes object
-
Hide owners attributes Show owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide joint_account_circle attributes Show joint_account_circle attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide circles attributes Show circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide linked_plans attributes Show linked_plans attributes object
-
Hide main_account attributes Show main_account attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide sub_accounts attributes Show sub_accounts attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide covers attributes Show covers attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Cover type
-
Benefit amount
-
Benefit frequency
-
Benefit status
-
Excess
-
Indexation percentage
-
-
Hide claims attributes Show claims attributes object
-
Hide total_benefit_amount attributes Show total_benefit_amount attributes object
-
Hide total_benefits attributes Show total_benefits attributes object
-
Hide critical_illness attributes Show critical_illness attributes object
-
Hide family_income_benefit attributes Show family_income_benefit attributes object
-
-
Hide value attributes Show value attributes object
-
Hide client attributes Show client attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide accounts attributes Show accounts attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide seller attributes Show seller attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_owners attributes Show linked_owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_plans attributes Show linked_plans attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
Any additional group scheme member details.
-
-
Hide visible_to_circles attributes Show visible_to_circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide cases attributes Show cases attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the case
-
Slug of the case
-
Timestamp of when the case should be reviewed
-
UUIDs of accounts that will be assigned to the case when it is created.
-
UUIDs of groups that will be assigned when the case is created.
-
Timestamp of when the case was completed
-
Expected value of this case
-
The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
-
The number of participants on the case
-
UUID of the task board
-
-
Hide wrap attributes Show wrap attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide wrap_children attributes Show wrap_children attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide group_scheme attributes Show group_scheme attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
Any additional group scheme member details.
-
-
Hide visible_to_circles attributes Show visible_to_circles attributes object
-
Hide accounts attributes Show accounts attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide groups attributes Show groups attributes object
-
Hide external_references attributes Show external_references attributes object
-
Hide cases attributes Show cases attributes object
-
Hide status attributes Show status attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The name of the status.
-
The colour of the status.
-
The position of the status.
-
Indicates if the status is for a completed case type.
-
-
Hide value attributes Show value attributes object
-
Hide participants attributes Show participants attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide plans attributes Show plans attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide wrap attributes Show wrap attributes object
-
Hide main_account attributes Show main_account attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide sub_accounts attributes Show sub_accounts attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide covers attributes Show covers attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Cover type
-
Benefit amount
-
Benefit frequency
-
Benefit status
-
Excess
-
Indexation percentage
-
-
Hide claims attributes Show claims attributes object
-
Hide total_benefit_amount attributes Show total_benefit_amount attributes object
-
Hide total_benefits attributes Show total_benefits attributes object
-
Hide critical_illness attributes Show critical_illness attributes object
-
Hide family_income_benefit attributes Show family_income_benefit attributes object
-
-
Hide value attributes Show value attributes object
-
Hide client attributes Show client attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide accounts attributes Show accounts attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide seller attributes Show seller attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_owners attributes Show linked_owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_plans attributes Show linked_plans attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide visible_to_circles attributes Show visible_to_circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide cases attributes Show cases attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the case
-
Slug of the case
-
Timestamp of when the case should be reviewed
-
UUIDs of accounts that will be assigned to the case when it is created.
-
UUIDs of groups that will be assigned when the case is created.
-
Timestamp of when the case was completed
-
Expected value of this case
-
The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
-
The number of participants on the case
-
UUID of the task board
-
-
Hide wrap attributes Show wrap attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide wrap_children attributes Show wrap_children attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide wrap_children attributes Show wrap_children attributes object
-
Hide main_account attributes Show main_account attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide sub_accounts attributes Show sub_accounts attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide covers attributes Show covers attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Cover type
-
Benefit amount
-
Benefit frequency
-
Benefit status
-
Excess
-
Indexation percentage
-
-
Hide claims attributes Show claims attributes object
-
Hide total_benefit_amount attributes Show total_benefit_amount attributes object
-
Hide total_benefits attributes Show total_benefits attributes object
-
Hide critical_illness attributes Show critical_illness attributes object
-
Hide family_income_benefit attributes Show family_income_benefit attributes object
-
-
Hide value attributes Show value attributes object
-
Hide client attributes Show client attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide accounts attributes Show accounts attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide seller attributes Show seller attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_owners attributes Show linked_owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_plans attributes Show linked_plans attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide visible_to_circles attributes Show visible_to_circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide cases attributes Show cases attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the case
-
Slug of the case
-
Timestamp of when the case should be reviewed
-
UUIDs of accounts that will be assigned to the case when it is created.
-
UUIDs of groups that will be assigned when the case is created.
-
Timestamp of when the case was completed
-
Expected value of this case
-
The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
-
The number of participants on the case
-
UUID of the task board
-
-
Hide wrap attributes Show wrap attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide wrap_children attributes Show wrap_children attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide linked_policy_numbers attributes Show linked_policy_numbers attributes object
-
Hide plan attributes Show plan attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
-
Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
-
Hide firm attributes Show firm attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the firm
-
Slug of the firm
-
First line of the address
-
Second line of the address
-
Town/City
-
County
-
Postcode
-
Country
-
Regulatory text of the firm.
-
URL of your firm logo.
-
URL of your firm logo icon.
-
Firm branding colours.
-
Subscription status.
-
Number of days to keep deleted files for
-
Tax percent
-
Date of the month for the monthly income reconciliation statements to end
-
The frequency of the income reconciliation statements
-
Firm invoice details for billing
-
A list of IP Addresses a firm is allowed to log in from.
-
Custom welcome paragraph html for the branded auth welcome page
-
Custom welcome paragraph for the welcome/new user email
-
Determines if the illustrations/graphics are displayed on the fact find.
-
Array of email cc addresses.
-
Array of email bcc addresses.
-
Firm reply to email address.
-
Firm mobile app support number.
-
Firm mobile app support email address.
-
-
Hide primary_phone_number attributes Show primary_phone_number attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide primary_email attributes Show primary_email attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Contact detail type
-
Contact detail description
-
Contact detail value
-
If the type is a phone number, this additional field will be displayed giving you information about the phone number.
-
-
Hide current_time_entry attributes Show current_time_entry attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The name of the time entry.
-
The description of the time entry.
-
The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.
-
The start time of the time entry.
-
The end time of the time entry.
-
Determines if the time entry is currently ongoing.
-
Total time in minutes.
-
Computed time elapsed in seconds.
-
-
Hide assigned_adviser attributes Show assigned_adviser attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_administrator attributes Show assigned_administrator attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide introduced_by attributes Show introduced_by attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide business_unit attributes Show business_unit attributes object
-
The UUID of the resource.
-
Name of the business unit.
-
Whether alternative branding is enabled for this business unit.
-
Brand colours for this business unit, merged with firm defaults.
-
Number of accounts assigned to this business unit
-
Number of groups assigned to this business unit
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
-
Hide groups attributes Show groups attributes object
-
Hide owners attributes Show owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide joint_account_circle attributes Show joint_account_circle attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide circles attributes Show circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide custom_fields attributes Show custom_fields attributes object
-
The UUID of the custom field
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The type of custom field
-
The name of the custom field
-
The reference of the custom field, used when updating the custom field on the model.
-
Denotes if the custom field is required
-
The value of the custom field
-
This is the array of available options for the selection box. If the type is "selection" this array will be provided.
-
Optional help text to aide the custom field. Will be displayed on Plannr.
-
-
Hide external_references attributes Show external_references attributes object
-
Hide group_scheme attributes Show group_scheme attributes object
-
Hide main_account attributes Show main_account attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide sub_accounts attributes Show sub_accounts attributes object
-
UUID of the sub account
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was created.
-
Descriptive name of the sub account
-
Provider reference of the sub account
-
Denotes if the sub account a main account of the plan
-
The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
-
-
Hide covers attributes Show covers attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Cover type
-
Benefit amount
-
Benefit frequency
-
Benefit status
-
Excess
-
Indexation percentage
-
-
Hide claims attributes Show claims attributes object
-
Hide total_benefit_amount attributes Show total_benefit_amount attributes object
-
Hide total_benefits attributes Show total_benefits attributes object
-
Hide critical_illness attributes Show critical_illness attributes object
-
Hide family_income_benefit attributes Show family_income_benefit attributes object
-
-
Hide value attributes Show value attributes object
-
Hide client attributes Show client attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide accounts attributes Show accounts attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide seller attributes Show seller attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_owners attributes Show linked_owners attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Account type
-
Account role
-
First name
-
Last name
-
Name
-
(Deprecated - Please use primary_email instead). The email of the account.
-
URL for initial avatar image
-
First contact date
-
Next review date
-
Previous review date
-
Anniversary review date
-
Date the Terms of Business were agreed and signed
-
Date the client agreement was agreed and signed
-
Denotes whether the account has a login to Plannr
-
Denotes whether this account belongs to a joint account too
-
Denotes if the account can be deleted
-
Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
-
Inactive from date
-
Last interaction date
-
Unique referral code for the employee account (employees only)
-
Denotes whether the account is currently within an active Out of Office window (employees only)
-
Start of the Out of Office period (employees only). Null when not out of office
-
End of the Out of Office period (employees only). Null when not out of office
-
Message shown to portal users while the account is Out of Office (employees only). Null when not out of office
-
Permission map where keys are permission names and values are target arrays
-
-
Hide linked_plans attributes Show linked_plans attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
Total value of the plan
-
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
-
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.
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Denotes if the plan can be deleted
-
Any additional group scheme member details.
-
-
Hide visible_to_circles attributes Show visible_to_circles attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
The Circle name
-
URL for initial avatar image
-
Hex colour background for avatar
-
Whether any member of the circle has portal access
-
Aggregated portal access status: active, never_logged_in, or no_portal_access
-
Aggregated engagement rating: green, amber, red, or none
-
Most recent portal login across all circle members, including who logged in
-
Total portal login count across all members in last 30 days
-
Total portal login count across all members in last 90 days
-
Total portal login count across all members in last 365 days
-
uuid of joint account where circle created from joint account
-
The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
-
UUID of the circle's current life stage for expenditure
-
-
Hide cases attributes Show cases attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Name of the case
-
Slug of the case
-
Timestamp of when the case should be reviewed
-
UUIDs of accounts that will be assigned to the case when it is created.
-
UUIDs of groups that will be assigned when the case is created.
-
Timestamp of when the case was completed
-
Expected value of this case
-
The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
-
The number of participants on the case
-
UUID of the task board
-
-
Hide wrap attributes Show wrap attributes object
-
The UUID of the resource.
-
The timestamp of when the resource was created.
-
The timestamp of when the resource was updated.
-
Timestamp of when the plan was originally opened
-
Name of the plan
-
Type of plan, this will indicate what to expect from the fields attribute
-
Plan sub type
-
describes if the plan is an asset, protection or liability
-
The policy number on the main sub account of the plan
-
The proposal reference on the main sub account of the plan
-
Plan status
-
Timestamp of when the plan became inactive
-
Reason for inactivity
-
Denotes if plan has agency in your name
-
Date the agency was in your name from
-
Denotes if the plan was originally sold by your firm
-
Denotes if plan is under advice
-
Denotes if this plan is visible to clients on the client portal
-
Denotes if this plan should be included in the client valuation
-
Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
-
Determines if plan should be shown on a circle
-
Review date
-
On panel
-
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.
-
Denotes if the plan is a sub-scheme of a group scheme.
-
Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
-
The advice area of the plan based on the plan's sub type.
-
Total amount benefit of all covers
-
Total benefits broken down in to cover types
-
-