Get all provider statements

GET /api/v1/provider-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.

  • filter[statement_uuids] string

    Comma separated list of payment period statement UUIDs. e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea

  • filter[name] string

    Comma separated list of partial provider statement names. e.g. Scottish Widows

  • filter[reference] string

    Comma separated list of partial provider statement references. e.g. SW#324

  • filter[provider_uuids] string

    Comma separated list of exact provider UUIDs. e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea

  • filter[date_from] string

    Statement date from in format YYYY-MM-DD e.g. 2022-10-15

  • filter[date_to] string

    Statement date from in format YYYY-MM-DD e.g. 2022-12-30

  • filter[amount_from] integer

    Total amount of transactions within provider statement to, in pennies e.g. 5000

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. 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
      • number integer
      • name string
      • date string
      • reference string
      • filename string
      • origin string
      • provider object
        Hide provider attributes Show provider attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • slug string
      • statement object
        Hide statement attributes Show statement 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 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 string
      • 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
      • total_amount object
        Hide total_amount attributes Show total_amount attributes object
        • amount string
        • currency string
        • formatted string
      • reconciled_expectations_amount object
        Hide reconciled_expectations_amount attributes Show reconciled_expectations_amount attributes object
        • amount string
        • currency string
        • formatted string
      • reconciled_expectations_percentage number
      • reconciled_bank_transactions_amount object
        Hide reconciled_bank_transactions_amount attributes Show reconciled_bank_transactions_amount attributes object
        • amount string
        • currency string
        • formatted string
      • reconciled_bank_transactions_percentage number
      • is_fully_reconciled_to_expectations boolean
GET /api/v1/provider-statement 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/provider-statement' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "date": "2025-06-25",
      "name": "Aviva",
      "uuid": "126ef10d-f340-43c2-ab89-301cbf9789d7",
      "number": 23,
      "origin": "upload",
      "filename": "aviva-statement-may.csv",
      "provider": {
        "name": "AJ Bell",
        "slug": "aj-bell",
        "uuid": "836d1f7a-8d23-4d3e-80f9-82269a134817",
        "created_at": "2025-06-25T15:10:47+01:00",
        "updated_at": "2025-06-25T15:10:47+01:00"
      },
      "reference": "SW#8434",
      "statement": {
        "name": "01/06/2022 - 30/06/2022",
        "uuid": "334107a3-99b8-4837-8166-836fd4545523",
        "locked": false,
        "end_date": "2022-06-01",
        "locked_at": "2025-06-25T15:10:47+01:00",
        "locked_by": "App\\Http\\Resources\\AccountResource",
        "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": "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"
        }
      },
      "created_at": "2025-06-25T15:10:47+01:00",
      "updated_at": "2025-06-25T15:10:47+01:00",
      "total_amount": {
        "amount": "345895",
        "currency": "GBP",
        "formatted": "£3,458.95"
      },
      "statement_transactions": [
        {
          "date": "2025-06-25",
          "firm": "App\\Http\\Resources\\FirmResource",
          "uuid": "b6411e6c-4a61-42f2-b776-cb95db7543f7",
          "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": "YIruxpR0m9"
        }
      ],
      "statement_transactions_count": 6,
      "reconciled_expectations_amount": {
        "amount": "12849",
        "currency": "GBP",
        "formatted": "£128.49"
      },
      "reconciled_expectations_percentage": 95.68,
      "is_fully_reconciled_to_expectations": true,
      "reconciled_bank_transactions_amount": {
        "amount": "22985",
        "currency": "GBP",
        "formatted": "£229.85"
      },
      "reconciled_bank_transactions_percentage": 95.68
    }
  ]
}