Create a premium

POST /api/v1/plans/{plan_uuid}/premiums

Headers

Path parameters

application/json

Body Required

  • transfer_type string Required

    Transfer type. Possible values are: switch and transfer

  • date_advice_given date Required

    Date advice given

  • amount integer Required

    Premium amount in pennies. Either amount or percentage can be given in request

  • percentage number Required

    Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request

  • frequency string Required

    Premium frequency

  • source string

    Premium source, only for pension plans. Possible values are: employee and employer

  • payment_method string Required

    Payment method. Possible values are: salary_sacrifice, salary_deduction, direct_debit, standing_order, cheque and bank_transfer

  • start_date date Required

    Start date

  • end_date date

    End date. Leave blank for ongoing

  • details string

    Details

  • transferred_from_plan_uuid string

    The plan UUID this premium was transferred from

  • transferred_from_plan_type string Required

    The plan type this premium was transferred from if the actual plan UUID is unknown

  • transferred_from_plan_sub_type string Required

    The plan sub type this premium was transferred from if the actual plan UUID is unknown

  • external_reference array[string]

    A third-party external reference to attach when creating the model. The third party must be one of the following: adviser_office, aj_bell, conquest, filehaven, finio, fundment, intelliflo_office, nucleus, parmenion, seccl, smartsearch, soderberg and transact_remuneration

Responses

POST /api/v1/plans/{plan_uuid}/premiums 
curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/premiums \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"transfer_type":"transfer","date_advice_given":"2024-05-30","amount":250000,"percentage":5.5,"frequency":"monthly","source":"employee","payment_method":"direct_debit","start_date":"2024-10-06","end_date":"2026-11-20","details":"Any extra details about the premium","transferred_from_plan_uuid":"36fa13b0-e964-4c59-993e-33921a61b326","transferred_from_plan_type":"string","transferred_from_plan_sub_type":"string","external_reference":[{"reference":"AB123456","third_party":"nucleus"}]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "transfer_type": "transfer",
  "date_advice_given": "2024-05-30",
  "amount": 250000,
  "percentage": 5.5,
  "frequency": "monthly",
  "source": "employee",
  "payment_method": "direct_debit",
  "start_date": "2024-10-06",
  "end_date": "2026-11-20",
  "details": "Any extra details about the premium",
  "transferred_from_plan_uuid": "36fa13b0-e964-4c59-993e-33921a61b326",
  "transferred_from_plan_type": "string",
  "transferred_from_plan_sub_type": "string",
  "external_reference": [
    {
      "reference": "AB123456",
      "third_party": "nucleus"
    }
  ]
}
Response examples (201) 
{
  "plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "437bee8b-7066-4e0e-b2b3-7544305e44c4",
    "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
    "cases": "App\\Http\\Resources\\CasesResource",
    "value": {
      "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"
      }
    },
    "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
    "client": "App\\Http\\Resources\\AccountResource",
    "covers": "App\\Http\\Resources\\Plans\\CoverResource",
    "seller": "App\\Http\\Resources\\AccountResource",
    "status": "inactive",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2024-11-20T13:24:03+00:00",
    "valued_at": "2024-11-20T13:24:03+00:00",
    "created_at": "2024-11-20T13:24:03+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:03+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:03+00:00",
    "review_date": "2023-11-20",
    "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "under_advice": true,
    "abstract_type": "asset",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "is_wrap_child": false,
    "linked_owners": "App\\Http\\Resources\\AccountResource",
    "policy_number": "AVIVA-123",
    "show_on_joint": true,
    "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
    "can_be_deleted": "false",
    "total_benefits": {
      "critical_illness": {
        "amount": {
          "example": "15000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£150,000.00",
          "description": "Money amount formatted with currency"
        }
      },
      "family_income_benefit": {
        "amount": {
          "example": "10000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£100,000.00",
          "description": "Money amount formatted with currency"
        }
      }
    },
    "inactive_reason": "claimed",
    "is_group_scheme": false,
    "is_wrap_product": false,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "proposal_reference": "AB123456",
    "agency_in_your_name": true,
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "is_sub_group_scheme": false,
    "total_benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      }
    },
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2023-11-20",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "uuid": "3cc3b006-5b7c-47a3-9151-6400be3af471",
  "amount": 74584,
  "source": "employee",
  "details": "Extra premium details",
  "premium": 74584,
  "end_date": "2026-11-20",
  "frequency": "weekly",
  "created_at": "2024-11-20T13:24:03+00:00",
  "created_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5bf6cfdf-a04c-49a6-8f42-156cabdb8a17",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00:00"
  },
  "percentage": 5.5,
  "start_date": "2024-10-06",
  "updated_at": "2024-11-20T13:24:03+00:00",
  "transfer_type": "transfer",
  "payment_method": "direct_debit",
  "premium_monthly": 298336,
  "premium_annually": 3580032,
  "date_advice_given": "2024-05-30",
  "pensionable_salary": 10000000,
  "total_premium_to_date": 74584,
  "transferred_from_plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "4aa10773-d121-4a54-955d-94bae21a07e3",
    "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
    "cases": "App\\Http\\Resources\\CasesResource",
    "value": {
      "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"
      }
    },
    "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
    "client": "App\\Http\\Resources\\AccountResource",
    "covers": "App\\Http\\Resources\\Plans\\CoverResource",
    "seller": "App\\Http\\Resources\\AccountResource",
    "status": "inactive",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2024-11-20T13:24:03+00:00",
    "valued_at": "2024-11-20T13:24:03+00:00",
    "created_at": "2024-11-20T13:24:03+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:03+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:03+00:00",
    "review_date": "2023-11-20",
    "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "under_advice": true,
    "abstract_type": "asset",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "is_wrap_child": false,
    "linked_owners": "App\\Http\\Resources\\AccountResource",
    "policy_number": "AVIVA-123",
    "show_on_joint": true,
    "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
    "can_be_deleted": "false",
    "total_benefits": {
      "critical_illness": {
        "amount": {
          "example": "15000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£150,000.00",
          "description": "Money amount formatted with currency"
        }
      },
      "family_income_benefit": {
        "amount": {
          "example": "10000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£100,000.00",
          "description": "Money amount formatted with currency"
        }
      }
    },
    "inactive_reason": "claimed",
    "is_group_scheme": false,
    "is_wrap_product": false,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "proposal_reference": "AB123456",
    "agency_in_your_name": true,
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "is_sub_group_scheme": false,
    "total_benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      }
    },
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2023-11-20",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "date_of_transfer_valuation": "2024-07-04",
  "transferred_from_plan_type": "cash_account",
  "transferred_from_plan_sub_type": "cash_deposit"
}