Create a sub-scheme for a group scheme plan Run in API Explorer
Body
-
The name for the sub-scheme
Maximum length is
255. -
Plan status for the member.
Value Description active Active inactive Inactive proposed Proposed Values are
active,inactive, orproposed. -
Optional inactive status when the status is inactive.
Value Description accepted Accepted agency_transferred Agency Transferred cancelled Cancelled claimed Claimed complete Complete death_event Death Event deferred Deferred drawdown Drawdown expired Expired full_drawdown Full Drawdown issued Issued lapsed Lapsed matured Matured not_proceeded_with Not Proceeded With not_taken_up Not Taken Up offered Offered paid_up Paid Up partial_drawdown Partial Drawdown partial_surrender Partial Surrender proposed Proposed prospect Prospect refunded Refunded refused Refused surrendered Surrendered transfer Transfer transferred Transferred underwriting Underwriting vested Vested declined Declined encashment Encashment left_service Left Service premium_holiday Premium Holiday other Other Values are
accepted,agency_transferred,cancelled,claimed,complete,death_event,deferred,drawdown,expired,full_drawdown,issued,lapsed,matured,not_proceeded_with,not_taken_up,offered,paid_up,partial_drawdown,partial_surrender,proposed,prospect,refunded,refused,surrendered,transfer,transferred,underwriting,vested,declined,encashment,left_service,premium_holiday, orother. -
Optional policy number if the sub scheme has separate policy numbers per member.
Maximum length is
255. -
Date when the policy was made inactive.
-
Date when the policy went "on risk".
-
Employer percentage being paid in to pension plan.
Minimum value is
0.0, maximum value is100.0. -
Frequency of the employer percentage being paid in to pension plan.
-
Employee percentage being paid in to pension plan.
Minimum value is
0.0, maximum value is100.0. -
Frequency of the employee percentage being paid in to pension plan.
Value Description daily Daily weekly Weekly fortnightly Fortnightly four_weekly Four Weekly monthly Monthly bimonthly Bimonthly quarterly Quarterly biannually Biannually annually Annually adhoc Adhoc one_off One Off Values are
daily,weekly,fortnightly,four_weekly,monthly,bimonthly,quarterly,biannually,annually,adhoc, orone_off.
Responses
-
Hide response attributes Show response 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 sub scheme of the group scheme plan.
-
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.
-
Plans main account
Hide main_account attributes Show main_account attributes object
-
Plans sub accounts
Hide sub_accounts attributes Show sub_accounts attributes object
-
The plan's provider
-
Covers of the plan
Hide covers attributes Show covers attributes object
-
Hide benefit_amount attributes Show benefit_amount attributes object
-
Hide excess attributes Show excess attributes object
-
Claims of the plan
Hide claims attributes Show claims attributes object
-
Hide claim_amount attributes Show claim_amount attributes object
-
Total amount benefit of all covers
Hide total_benefit_amount attributes Show total_benefit_amount attributes object
-
Total benefits broken down in to cover types
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
-
-
The plan's latest valuations (Included when the "latest_valuations" relationship is included)
Hide latest_valuations attributes Show latest_valuations attributes object
-
Hide value attributes Show value attributes object
-
Total value of the plan
Hide value attributes Show value attributes object
-
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.
-
[DEPRACATED] Please use accounts instead. The plan's client
Hide client attributes Show client attributes object
-
The plan's accounts
Hide accounts attributes Show accounts attributes object
-
Adviser who sold the plan
Hide seller attributes Show seller attributes object
-
Other clients who have been linked to this plan
Hide linked_owners attributes Show linked_owners attributes object
-
Other plans that have been linked to this plan
Hide linked_plans attributes Show linked_plans 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
-
Circles which members of circles can see the plan as long as they have the right access level for the circle
-
The statistics on a plan. Only displayed when you retrieve an individual plan
-
Cases this plan belongs to
Hide cases attributes Show cases attributes object
-
Hide value attributes Show value attributes object
-
Tags this plan have been tagged with
-
Determines if the plan is a wrap plan
-
Determines if the plan is a wrap child
-
Parent wrap plan. if this plan is linked to a wrap product
Hide wrap attributes Show wrap 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
-
List of child plans on a wrap product
Hide wrap_children attributes Show wrap_children 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
-
Linked policy numbers
-
Denotes if the plan can be deleted
-
The specific account used to make contract enquiry requests.
Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
-
Any custom fields on the model.
-
The external references that have been added to the client.
-
The group scheme that the sub scheme is part of.
Hide group_scheme attributes Show group_scheme 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
-
curl \
--request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-group-schemes' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Families","status":"active","inactive_status":"accepted","policy_number":"AVIVA-123","inactive_at":"2024-03-26","on_risk_at":"2023-03-26","employer_percentage":1.24,"employer_frequency":"monthly","employee_percentage":9.65,"employee_frequency":"daily"}'# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Families",
"status": "active",
"inactive_status": "accepted",
"policy_number": "AVIVA-123",
"inactive_at": "2024-03-26",
"on_risk_at": "2023-03-26",
"employer_percentage": 1.24,
"employer_frequency": "monthly",
"employee_percentage": 9.65,
"employee_frequency": "daily"
}{
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
}