Get all expectations of circle

GET /api/v1/circles/{circle_uuid}/expectations

Headers

Path parameters

circle_uuid integer Required

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[status] string

Filter expectations based on their status. Available options: expecting,ready_for_reconciliation
filter[statement_uuids] string

Filter expectations by a statement UUID.
filter[date_after] string

Get charges from an expectation date.
filter[date_before] string

Get charges to an expectation date.
filter[amount_from] string

Get charges greater than or equal to an expected amount in pennies.
filter[amount_to] string

Get charges less than or equal to an expected amount in pennies.
filter[client_uuids] string

Comma separated string of partial names or exact account UUIDs to filter by.
filter[circle_uuids] string

Filter by a comma separated list of circle UUIDs.
filter[group_uuids] string

Comma separated string group UUIDs to filter by.
filter[category] string

Comma separated string of categories to filter by.
filter[type] string

Comma separated string of categories to filter by.
filter[policy_number] string

Comma separated string of partial policy numbers to filter by.
filter[provider_uuids] string

Comma separated string of partial provider names or exact provider UUIDs to filter by.
filter[plan_uuids] string

Comma separated string of partial plan names or exact plan UUIDs to filter by.
filter[payment_origin] string

Filter expectations to client or provider paid. Valid options are [client, provider]
filter[seller_uuids] string

Comma separated string of partial names or exact account UUIDs to filter by.
filter[reconciliation] string

Filter expectations based on their reconciliation amount. Available options: reconciled,unreconciled,partially_reconciled
filter[reconciliation_percentage_between] string

Filter expectations based on their reconciliation amount between two values as a percentage.
filter[reconciliation_amount_between] string

Filter expectations based on their reconciliation amount between two values in pennies.
sort string

Field to sort by. Valid fields are [created_at, updated_at, expected_payment_date, expected_amount]. Negative sign to denote DESC. Defaults to 'expected_payment_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]
  
  Additional properties are allowed.

GET /api/v1/circles/{circle_uuid}/expectations

curl \
 -X GET https://api.plannrcrm.com/api/v1/circles/circle_uuid/expectations \
 -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}"

Response examples (200)

{
  "data": [
    {
      "tax": 20,
      "firm": {
        "tax": 17.5,
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "name": "Codepotato",
        "slug": "codepotato",
        "uuid": "81b68550-1b63-470f-a1c0-115e081391d8",
        "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-01-17T11:18:28+00:00",
        "updated_at": "2025-01-17T11:18:28+00: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!"
      },
      "type": "fee",
      "uuid": "7bceed5e-0e30-4378-8056-796479700af5",
      "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": "f8442689-bc39-47fa-8f4c-be9c0b6f0d22",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:28+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:28+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": "2025-01-17T11:18:28+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:28+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:28+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:28+00:00"
      },
      "seller": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "2e826a4c-78a6-4ee6-9333-8d9e705555c8",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:28+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:28+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": "2025-01-17T11:18:28+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:28+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:28+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:28+00:00"
      },
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "b379edf9-cfb5-4d7a-ac12-7aef1ff94ebd",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:28+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:28+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": "2025-01-17T11:18:28+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:28+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:28+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:28+00:00"
      },
      "category": "ongoing_fee",
      "recurring": true,
      "rmar_type": "adviser_charge",
      "statement": {
        "name": "01/06/2022 - 30/06/2022",
        "uuid": "c734ec96-de1e-47e8-9712-14045fd53194",
        "locked": false,
        "end_date": "2022-06-01",
        "locked_at": "2025-01-17T11:18:28+00:00",
        "locked_by": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-01-17T11:18:28+00:00",
        "start_date": "2022-06-30",
        "updated_at": "2025-01-17T11:18:28+00: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": "e66fb8bc-5bda-4a15-b652-e1e5b40f5e98",
        "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": "2025-01-17T11:18:28+00:00",
        "valued_at": "2025-01-17T11:18:28+00:00",
        "created_at": "2025-01-17T11:18:28+00:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-01-17T11:18:28+00:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2025-01-17T11:18:28+00:00",
        "review_date": "2024-01-17",
        "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-01-17",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "created_at": "2025-01-17T11:18:28+00: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-01-17T11:18:28+00: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": "975b0b39-6f3d-4866-8f21-d19020d18426",
          "expected_amount": {
            "amount": "12500",
            "currency": "GBP",
            "formatted": "£125.00"
          },
          "bank_receipt_date": "2025-01-17",
          "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": "7f57d3bf-04a2-4796-a048-cbadfd34425e",
        "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-02-17",
        "frequency": "monthly",
        "recurring": true,
        "rmar_type": "adviser_charge",
        "chargeable": "App\\Http\\Resources\\Plans\\PlanResource",
        "created_at": "2025-01-17T11:18:28+00:00",
        "percentage": 0.75,
        "plan_value": "plan",
        "start_date": "2024-05-17",
        "tax_exempt": false,
        "updated_at": "2025-01-17T11:18:28+00: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-01-27"
      },
      "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-01-17T11:18:28+00:00",
      "statement_transactions": [
        {
          "date": "2025-01-17",
          "firm": "App\\Http\\Resources\\FirmResource",
          "uuid": "ec8141db-59ee-4bea-b76b-8841e534599f",
          "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-01-17T11:18:28+00: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-01-17T11:18:28+00: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": "AHDdpHwlTB"
        }
      ],
      "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"
        }
      }
    }
  ]
}