Get a bank statement

GET /api/v1/bank-statement/{bankStatement_uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

bankStatement_uuid string 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.
- number integer
  
  Bank statement number
- reference string
  
  Bank statement reference given by bank statement
- date string
  
  Bank statement date
- name string
  
  Bank statement name
- statement object
  
  Statement
  
  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
- bank_transactions_count integer
  
  Total number of bank transactions within bank statement
- bank_transactions array[object]
  
  Bank transactions within bank statement
  
  Hide bank_transactions attributes Show bank_transactions attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  date string
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  reference string
  
  metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  client_name string
  
  filename string
  
  bank_statement string
  
  statement string
  
  account string
  
  firm string
- total_amount object
  
  Total amount of all bank transactions within this bank statement
  
  Hide total_amount attributes Show total_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- reconciled_amount object
  
  Total amount reconciled
  
  Hide reconciled_amount attributes Show reconciled_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- reconciled_percentage number
  
  Total percentage reconciled

GET /api/v1/bank-statement/{bankStatement_uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/bank-statement/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "date": "2025-07-17",
  "name": "Aviva",
  "uuid": "ec8f39a8-93a3-46d7-a3bc-4623cd0348a4",
  "number": 23,
  "reference": "SW#8434",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "9d0d0e52-d65d-4faf-ab3e-176a0ed8ad76",
    "locked": false,
    "end_date": "2022-06-01",
    "locked_at": "2025-07-17T16:23:25+01:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-07-17T16:23:25+01:00",
    "start_date": "2022-06-30",
    "updated_at": "2025-07-17T16:23:25+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-07-17T16:23:25+01:00",
  "updated_at": "2025-07-17T16:23:25+01:00",
  "total_amount": {
    "amount": "345895",
    "currency": "GBP",
    "formatted": "£3,458.95"
  },
  "bank_transactions": [
    {
      "date": "2022-07-15",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "3f131531-3218-4b45-a074-6ba3d4c61f6c",
      "amount": {
        "amount": "12399",
        "currency": "GBP",
        "formatted": "£123.99"
      },
      "account": "App\\Http\\Resources\\AccountResource",
      "filename": "Natwest June 2022 Statement.xlsx",
      "metadata": {
        "client_name": "Gareth Thompson"
      },
      "reference": "VitalityLtd",
      "statement": "App\\Http\\Resources\\StatementResource",
      "created_at": "2025-07-17T16:23:25+01:00",
      "updated_at": "2025-07-17T16:23:25+01:00",
      "bank_statement": "App\\Http\\Resources\\BankStatementResource"
    }
  ],
  "reconciled_amount": {
    "amount": "12849",
    "currency": "GBP",
    "formatted": "£128.49"
  },
  "reconciled_percentage": 95.68,
  "bank_transactions_count": 6
}