Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [statement].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[client_uuids] string

  Filter by a comma separated list of client UUIDs.

• filter[group_uuids] string

  Filter by a comma separated list of group UUIDs.

• filter[circle_uuids] string

  Filter by a comma separated list of circle UUIDs.

• filter[plan_uuids] string

  Filter by a comma separated list of plan UUIDs.

• filter[provider_uuids] string

  Filter by a comma separated list of provider UUIDs.

• filter[policy_number] string

  Filter by policy numbers.

• filter[seller_uuids] string

  Filter by a comma separated list of seller account UUIDs.

• filter[payment_origin] string

  Filter by comma separated list of payment origins.

• filter[type] string

  Filter by comma separated list of charge types.

• filter[category] string

  Filter by comma separated list of charge categories.

• filter[recurring] boolean

  Filter by recurring charges or not.

• filter[frequency] string

  Filter by comma separated list of frequencies.

• filter[start_date_after] string

  Filter by charge start dates after.

• filter[start_date_before] string

  Filter by charge start dates before.

• filter[end_date_after] string

  Filter by charge end dates after.

• filter[end_date_before] string

  Filter by charge end dates before.

• filter[next_expectation_date_after] string

  Filter by charge next expectation dates after.

• filter[next_expectation_date_before] string

  Filter by charge next expectation dates before.

• filter[amount_from] integer

  Filter by charge fixed amounts from in pennies.

• filter[amount_to] integer

  Filter by charge fixed amounts to in pennies.

• filter[percentage_from] number

  Filter by charge percentages from.

• filter[percentage_to] number

  Filter by charge percentages to.

• filter[tax_exempt] boolean

  Filter by tax exempt charges or not.

• filter[exclude_from_rmar] boolean

  Filter by charges excluded from RMAR or not.

• filter[rmar_type] string

  Filter by comma separated list of RMAR types.

• filter[advice_type] string

  Filter by comma separated list of advice types.

• filter[service_type] string

  Filter by comma separated list of service types.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC. Defaults to '-start_date'.

• per_page integer

  Number of results to return with pagination (Default 15. Max 500).

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • data array[object]
    Hide data attributes Show data attributes object

    • uuid string
    • created_at string
    • updated_at string
    • payment_origin string
    • type string
    • category string
    • recurring boolean
    • frequency string
    • start_date string
    • end_date string
    • next_expectation_date string
    • tax_exempt boolean
    • tax number
    • amount object
      Hide amount attributes Show amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • percentage number
    • percentage_frequency string
    • charge_identifier string
    • exclude_from_rmar boolean
    • rmar_type string
    • advice_type string
    • service_type string
    • advice_area object
      Hide advice_area attributes Show advice_area attributes object

      • deposit integer
      • non_regulated integer
      • non_rmar integer
      • non_investment_insurance integer
      • regulated_mortgage integer
      • retail_investment integer
      • other_fca_regulated integer
      • unknown integer
    • plan_value string
    • chargeable_type object
      Hide chargeable_type attributes Show chargeable_type attributes object

      • amount string
      • currency string
      • formatted string
    • chargeable object
      Hide chargeable attributes Show chargeable attributes object

      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • shown_on_circles boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account string
      • sub_accounts string
      • provider string
      • covers string
      • claims string
      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_amount attributes object

        • amount object
          Hide amount attributes Show amount attributes object

          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object

          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object

          • example string
          • description string
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object

        • critical_illness object
          Hide critical_illness attributes Show critical_illness attributes object

          • amount object
            Hide amount attributes Show amount attributes object

            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object

            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object

            • example string
            • description string
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit attributes object

          • amount object
            Hide amount attributes Show amount attributes object

            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object

            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object

            • example string
            • description string
      • latest_valuations string
      • value object
        Hide value attributes Show value attributes object

        • amount object
          Hide amount attributes Show amount attributes object

          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object

          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object

          • example string
          • description string
      • valued_at string
      • original_valued_at string
      • client string
      • accounts string
      • seller string
      • linked_owners string
      • linked_plans string
      • visible_to_circles string
      • statistics object
        Hide statistics attribute Show statistics attribute object

        • recent_growth integer
      • cases string
      • tags string
      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap string
      • wrap_children string
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • account object
      Hide account attributes Show account attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • business_unit string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • terms_of_business_at string
      • client_agreement_at string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object

        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • author object
      Hide author attributes Show author attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • business_unit string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • terms_of_business_at string
      • client_agreement_at string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object

        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • seller object
      Hide seller attributes Show seller attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • business_unit string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • terms_of_business_at string
      • client_agreement_at string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object

        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • premium object
      Hide premium attributes Show premium attributes object

      • uuid string
      • created_at string
      • updated_at string
      • transfer_type string
      • date_of_transfer_valuation string
      • date_advice_given string
      • premium integer
      • premium_monthly integer
      • premium_annually integer
      • total_premium_to_date integer
      • amount integer
      • percentage number
      • frequency string
      • source string
      • payment_method string
      • start_date string
      • end_date string
      • pensionable_salary integer
      • details string
      • created_by string
      • plan string
      • transferred_from_plan string
      • transferred_from_plan_type string
      • transferred_from_plan_sub_type string
    • firm object
      Hide firm attributes Show firm attributes object

      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • address_1 string
      • address_2 string
      • town_city string
      • county string
      • postcode string
      • country string
      • regulatory_text string
      • logo string
      • logo_icon string
      • brand_colours object
        Hide brand_colours attributes Show brand_colours attributes object

        • sidebar_background string
        • sidebar_accent string
        • sidebar_text string
        • sidebar_hover string
        • sidebar_active string
        • sidebar_title_background string
        • sidebar_title_primary string
        • sidebar_title_secondary string
        • sidebar_title_secondary_hover string
        • email_background string
        • email_logo_background_panel string
        • email_sub_text string
        • email_button_background string
        • email_button_text string
        • portal_sidebar_button_background string
        • portal_sidebar_button_hover string
        • portal_sidebar_button_active string
        • portal_brand_title string
        • portal_brand_sub_title string
        • portal_sidebar_title string
        • portal_sidebar_text string
        • portal_sidebar_text_hover string
        • portal_sidebar_text_active string
        • portal_sidebar_icon string
        • portal_sidebar_icon_hover string
        • portal_sidebar_icon_active string
        • portal_background string
        • portal_sidebar_account_title string
        • portal_sidebar_account_email string
        • portal_sidebar_divider string
        • portal_dashboard_bg_one string
        • portal_dashboard_bg_two string
        • portal_sidebar_collapse_button string
        • portal_sidebar_collapse_button_hover string
        • portal_sidebar_user_select_background string
        • portal_sidebar_user_select_hover string
        • portal_sidebar_user_select_text string
        • portal_sidebar_user_select_text_hover string
        • portal_sidebar_user_select_border string
        • portal_sidebar_user_select_border_hover string
      • is_subscribed boolean
      • addon_subscriptions string
      • keep_deleted_files_for integer
      • tax number
      • month_end integer
      • statement_frequency string
      • billing object
        Hide billing attributes Show billing attributes object

        • invoice_address_1 string
        • invoice_address_2 string
        • invoice_town_city string
        • invoice_county string
        • invoice_postcode string
        • invoice_country string
        • invoice_email string
      • task_board_template string
      • ip_whitelist array[string]
      • welcome_paragraph_html string
      • email_welcome_paragraph_html string
      • show_fact_find_illustrations boolean
      • cc_email_addresses array[string]
      • bcc_email_addresses array[string]
      • reply_to_email_address string
      • mobile_app_support_number string
      • mobile_app_support_email string
    • notes_count integer