Get an expectation

GET /api/v1/expectation/{uuid}

Personal access token & O auth2

Headers

Path parameters

uuid integer Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- payment_origin string
  
  Who you expect to be paying this expectation
- type string
  
  Expectation type, fee or comission
- category string
  
  Expectation category, used for accurate reporting
- expected_payment_date string
  
  Expected payment date of expectation
- tax_exempt boolean
  
  Denotes if this expectation is tax exempt
- tax integer
  
  Tax percentage that was applied to this expectation
- recurring boolean
  
  Denotes if this expectation is from a recurring charge
- is_balanced boolean
  
  Denotes if the expected amount has been balanced to the reconciled amount
- unbalanced_expected_amount object
  
  The unbalanced amount the expectation is expected to received
- expected_amount object
  
  Amount the expectation is expected to be received
- gross_amount object
  
  Gross amount the expectation is expected to be received
- net_amount object
  
  Net amount the expectation is expected to be received
- amount object
  
  Amount that was entered for the charge
- percentage number
  
  Percentage of plans value that was entered for the charge
- exclude_from_rmar boolean
  
  Denotes if this expectation will be excluded from RMAR
- rmar_type string
  
  RMAR type
- advice_type string
  
  Advice type
- service_type string
  
  Service type
- advice_area_gross object
  
  RMAR advice area gross values.
- advice_area_net object
  
  RMAR advice area net values.
- account object
  
  Client this expectation belongs to
- seller object
  
  Adviser who sold this expectation
- author object
  
  Adviser who created the charge of this expectation
- charge_schedule object
  
  The expectation schedule for a reoccuring expectation
- chargeable_type string
  
  Model type this expectation belongs to
- chargeable object
  
  Model this expectation belongs to e.g. plan
- statement_transactions array[object]
  
  Payments used to reconcile the expectation
- statement object
  
  The statement period this expectation belongs to
- income_splits array[object]
  
  Details of who will be receiving what of this expectation
- firm object
  
  Firm this expectation schedule belongs to
- notes_count integer
  
  Notes count
- reconciliation object
  
  The amount that the expectation has been reconciled to statement transactions.

GET /api/v1/expectation/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/expectation/uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "tax": 20,
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "9f3bc3a7-f526-4a85-b90f-16ceaab6806c",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true
  },
  "type": "fee",
  "uuid": "9d2c04ee-60aa-4f7d-b556-33adfc0daff7",
  "amount": {
    "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"
    }
  },
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "9cf1f1b1-eda0-4dfe-98cf-e5d038f7dc9d",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-02T13:27:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "with_login": true,
    "inactive_at": "2025-04-02",
    "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": "2025-04-02T13:27:58+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-02T13:27:58+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-04-02T13:27:58+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-02T13:27:58+01:00"
  },
  "seller": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "00e0badd-db86-4dbb-94f2-ba49cc9453e9",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-02T13:27:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "with_login": true,
    "inactive_at": "2025-04-02",
    "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": "2025-04-02T13:27:58+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-02T13:27:58+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-04-02T13:27:58+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-02T13:27:58+01:00"
  },
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "52100b77-ed70-419f-bd42-6cd613647a7a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-02T13:27:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "with_login": true,
    "inactive_at": "2025-04-02",
    "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": "2025-04-02T13:27:58+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-02T13:27:58+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-04-02T13:27:58+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-02T13:27:58+01:00"
  },
  "category": "ongoing_fee",
  "recurring": true,
  "rmar_type": "adviser_charge",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "3ee3ffa9-f3b5-4624-bdca-68e1717bffc1",
    "locked": false,
    "end_date": "2022-06-01",
    "locked_at": "2025-04-02T13:27:58+01:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-04-02T13:27:58+01:00",
    "start_date": "2022-06-30",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "expectations_count": 6,
    "total_expectations": {
      "amount": "124585",
      "currency": "GBP",
      "formatted": "£1,245.85"
    },
    "statement_transactions": "App\\Http\\Resources\\StatementTransactionResource",
    "total_bank_transactions": {
      "amount": "125599",
      "currency": "GBP",
      "formatted": "£1,255.99"
    },
    "statement_transactions_count": 6,
    "total_statement_transactions": {
      "amount": "125599",
      "currency": "GBP",
      "formatted": "£1,255.99"
    },
    "total_expectation_amount_reconciled_to_bank": {
      "amount": "125599",
      "currency": "GBP",
      "formatted": "£1,255.99"
    },
    "total_expectation_percentage_reconciled_to_bank": {
      "amount": "8570",
      "currency": "GBP",
      "formatted": "£85.70"
    }
  },
  "chargeable": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "48030fdd-3cfa-4a1a-b1ae-ec91c0ef97fb",
    "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",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2025-04-02T13:27:58+01:00",
    "valued_at": "2025-04-02T13:27:58+01:00",
    "created_at": "2025-04-02T13:27:58+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-04-02T13:27:58+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-04-02T13:27:58+01:00",
    "review_date": "2024-04-02",
    "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": "2024-04-02",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "created_at": "2025-04-02T13:27:58+01:00",
  "net_amount": {
    "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"
    }
  },
  "percentage": 0.75,
  "tax_exempt": true,
  "updated_at": "2025-04-02T13:27:58+01:00",
  "advice_type": "independent",
  "is_balanced": false,
  "notes_count": 5,
  "gross_amount": {
    "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"
    }
  },
  "service_type": "initial",
  "income_splits": [
    {
      "name": "Gareth Thompson",
      "type": "selling_adviser",
      "percentage": 70,
      "splitable_type": "account",
      "splitable_uuid": "2a7512b1-c386-4e7f-a52d-0a27a27cf8a3",
      "expected_amount": {
        "amount": "12500",
        "currency": "GBP",
        "formatted": "£125.00"
      },
      "bank_receipt_date": "2025-04-02",
      "expected_net_amount": {
        "amount": "10400",
        "currency": "GBP",
        "formatted": "£104.00"
      },
      "requested_percentage": 70,
      "expected_gross_amount": {
        "amount": "12500",
        "currency": "GBP",
        "formatted": "£125.00"
      },
      "reconciled_net_amount": {
        "amount": "9569",
        "currency": "GBP",
        "formatted": "£95.69"
      },
      "reconciled_gross_amount": {
        "amount": "11483",
        "currency": "GBP",
        "formatted": "£114.83"
      },
      "expected_fci_recognition": {
        "amount": "12500",
        "currency": "GBP",
        "formatted": "£125.00"
      },
      "reconciled_fci_recognition": {
        "amount": "9569",
        "currency": "GBP",
        "formatted": "£95.69"
      }
    }
  ],
  "payment_origin": "provider",
  "reconciliation": {
    "amount": {
      "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"
      }
    },
    "percentage": 100,
    "is_reconciled": true
  },
  "advice_area_net": {
    "deposit": 7500,
    "unknown": 0,
    "non_rmar": 0,
    "non_regulated": 0,
    "retail_investment": 0,
    "regulated_mortgage": 2500,
    "other_fca_regulated": 0,
    "non_investment_insurance": 0
  },
  "charge_schedule": {
    "tax": 17.5,
    "firm": "App\\Http\\Resources\\FirmResource",
    "type": "fee",
    "uuid": "73b58817-db76-4e98-9cac-7a26f34cc709",
    "amount": {
      "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"
      }
    },
    "author": "App\\Http\\Resources\\AccountResource",
    "seller": "App\\Http\\Resources\\AccountResource",
    "account": "App\\Http\\Resources\\AccountResource",
    "premium": "App\\Http\\Resources\\Plans\\PremiumResource",
    "category": "ongoing_fee",
    "end_date": "2025-05-02",
    "frequency": "monthly",
    "recurring": true,
    "rmar_type": "adviser_charge",
    "chargeable": "App\\Http\\Resources\\Plans\\PlanResource",
    "created_at": "2025-04-02T13:27:58+01:00",
    "percentage": 0.75,
    "plan_value": "plan",
    "start_date": "2024-08-02",
    "tax_exempt": false,
    "updated_at": "2025-04-02T13:27:58+01:00",
    "advice_area": {
      "deposit": 7500,
      "unknown": 0,
      "non_rmar": 0,
      "non_regulated": 0,
      "retail_investment": 0,
      "regulated_mortgage": 2500,
      "other_fca_regulated": 0,
      "non_investment_insurance": 0
    },
    "advice_type": "independent",
    "notes_count": 5,
    "service_type": "initial",
    "payment_origin": "provider",
    "chargeable_type": {
      "amount": "12000000",
      "currency": "GBP",
      "formatted": "£120,000.00"
    },
    "charge_identifier": "PLANNR-72484",
    "exclude_from_rmar": true,
    "percentage_frequency": "annually",
    "next_expectation_date": "2025-04-12"
  },
  "chargeable_type": "plan",
  "expected_amount": {
    "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"
    }
  },
  "advice_area_gross": {
    "deposit": 7500,
    "unknown": 0,
    "non_rmar": 0,
    "non_regulated": 0,
    "retail_investment": 0,
    "regulated_mortgage": 2500,
    "other_fca_regulated": 0,
    "non_investment_insurance": 0
  },
  "exclude_from_rmar": true,
  "expected_payment_date": "2025-04-02T13:27:58+01:00",
  "statement_transactions": [
    {
      "date": "2025-04-02",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "fb9a5bc8-455b-4f48-b39b-42d2595cfea7",
      "reason": "Reason",
      "account": "App\\Http\\Resources\\AccountResource",
      "category": "initial_fee",
      "metadata": {
        "client_name": "Gareth Thompson"
      },
      "provider": "Aviva",
      "statement": "App\\Http\\Resources\\StatementResource",
      "created_at": "2025-04-02T13:27:58+01:00",
      "net_amount": {
        "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"
        }
      },
      "updated_at": "2025-04-02T13:27:58+01:00",
      "client_name": "Gareth Thompson",
      "expectation": "App\\Http\\Resources\\ExpectationResource",
      "scheme_name": "Scheme name",
      "adviser_name": "Adviser name",
      "gross_amount": {
        "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"
        }
      },
      "agency_number": "Agency number",
      "policy_number": "AVIVA_00001",
      "scheme_number": "Scheme number",
      "payment_origin": "provider",
      "customer_number": "Customer number",
      "bank_transactions": "App\\Http\\Resources\\BankTransactionResource",
      "product_reference": "Product reference",
      "provider_statement": "App\\Http\\Resources\\ProviderStatementResource",
      "policy_market_value": "Policy market value",
      "sender_id_sib_number": "Sender id sib number",
      "transaction_reference": "6aq66FVLIK"
    }
  ],
  "unbalanced_expected_amount": {
    "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"
    }
  }
}