Get all statements

GET /api/v1/statement

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
sort string

Field to sort by. Valid fields are [start_date, end_date, created_at, updated_at, name]. Negative sign to denote DESC. Defaults to '-created_at'.
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
  
  name string
  
  start_date string
  
  end_date string
  
  locked boolean
  
  locked_at string
  
  locked_by object
  
  Hide locked_by attributes Show locked_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email 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
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
  
  total_expectations object
  
  Hide total_expectations attributes Show total_expectations attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_statement_transactions object
  
  Hide total_statement_transactions attributes Show total_statement_transactions attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_bank_transactions object
  
  Hide total_bank_transactions attributes Show total_bank_transactions attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_expectation_amount_reconciled_to_bank object
  
  Hide total_expectation_amount_reconciled_to_bank attributes Show total_expectation_amount_reconciled_to_bank attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_expectation_percentage_reconciled_to_bank object
  
  Hide total_expectation_percentage_reconciled_to_bank attributes Show total_expectation_percentage_reconciled_to_bank attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  expectations_count integer
  
  statement_transactions_count integer
  
  statement_transactions array[object]
  
  Hide statement_transactions attributes Show statement_transactions attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  client_name string
  
  transaction_reference string
  
  policy_number string
  
  date string
  
  gross_amount object
  
  Hide gross_amount attributes Show gross_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
  
  net_amount object
  
  Hide net_amount attributes Show net_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
  
  category string
  
  payment_origin string
  
  agency_number string
  
  product_reference string
  
  adviser_name string
  
  sender_id_sib_number string
  
  reason string
  
  scheme_name string
  
  scheme_number string
  
  customer_number string
  
  policy_market_value string
  
  provider string
  
  provider_statement string
  
  metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  client_name string
  
  expectation string
  
  bank_transactions string
  
  statement string
  
  account string
  
  firm string

GET /api/v1/statement

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/statement' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "01/06/2022 - 30/06/2022",
      "uuid": "31ed099c-0c30-454b-aa16-753beb4efcf9",
      "locked": false,
      "end_date": "2022-06-01",
      "locked_at": "2025-06-25T15:10:47+01:00",
      "locked_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "16565760-ac15-400d-a929-afa37009cddc",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-25T15:10:47+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:47+01:00",
        "with_login": true,
        "inactive_at": "2025-06-25",
        "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-06-25T15:10:47+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-25T15:10:47+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-06-25T15:10:47+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-25T15:10:47+01:00"
      },
      "created_at": "2025-06-25T15:10:47+01:00",
      "start_date": "2022-06-30",
      "updated_at": "2025-06-25T15:10:47+01:00",
      "expectations_count": 6,
      "total_expectations": {
        "amount": "124585",
        "currency": "GBP",
        "formatted": "£1,245.85"
      },
      "statement_transactions": [
        {
          "date": "2025-06-25",
          "firm": "App\\Http\\Resources\\FirmResource",
          "uuid": "20f4bf6a-626d-4b3f-a71b-90653b717468",
          "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-06-25T15:10:47+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-06-25T15:10:47+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": "iTH3oTrUOS"
        }
      ],
      "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"
      }
    }
  ]
}