Get a bank statement

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

Personal access token & O auth2

Headers

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
- bank_transactions_count integer
  
  Total number of bank transactions within bank statement
- bank_transactions array[object]
  
  Bank transactions within bank statement
- total_amount object
  
  Total amount of all bank transactions within this bank statement
- reconciled_amount object
  
  Total amount reconciled
- reconciled_percentage number
  
  Total percentage reconciled

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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/bank-statement/bankStatement_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)

{
  "date": "2025-04-02",
  "name": "Aviva",
  "uuid": "3bcb23f2-1cb0-4779-b30a-e5d11ce16746",
  "number": 23,
  "reference": "SW#8434",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "babd0fb6-6ca9-4598-a0be-78c249c9e8ec",
    "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"
    }
  },
  "created_at": "2025-04-02T13:27:58+01:00",
  "updated_at": "2025-04-02T13:27:58+01:00",
  "total_amount": {
    "amount": "345895",
    "currency": "GBP",
    "formatted": "£3,458.95"
  },
  "bank_transactions": [
    {
      "date": "2022-07-15",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "f3f83d76-ae30-4e38-9291-2a21b1f915c0",
      "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-04-02T13:27:58+01:00",
      "updated_at": "2025-04-02T13:27:58+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
}