Create a bank statement Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
POST /api/v1/bank-statement

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • statement_uuid string(uuid) Required

    Payment period statement UUID

  • date string(date) Required

    Statement date

  • name string

    Optional title to name the bank statement. If null an auto generated name will be created.

  • reference string

    Statement reference given by bank

Responses

  • 201 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

POST /api/v1/bank-statement
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/bank-statement' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"statement_uuid":"6015f34c-be06-4517-ae70-95610270dd91","date":"2026-06-08","name":"Natwest Statement #8434","reference":"BAT#8434"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "statement_uuid": "6015f34c-be06-4517-ae70-95610270dd91",
  "date": "2026-06-08",
  "name": "Natwest Statement #8434",
  "reference": "BAT#8434"
}
Response examples (201)
{
  "uuid": "051338e6-f450-4eec-9ea9-4de545aae761",
  "created_at": "2026-06-08T16:08:03+01:00",
  "updated_at": "2026-06-08T16:08:03+01:00",
  "number": 23,
  "reference": "SW#8434",
  "date": "2026-06-08",
  "name": "Aviva",
  "statement": {
    "uuid": "f95916ea-d410-44dc-853b-f18ffe793ebd",
    "created_at": "2026-06-08T16:08:03+01:00",
    "updated_at": "2026-06-08T16:08:03+01:00",
    "name": "01/06/2022 - 30/06/2022",
    "start_date": "2022-06-30",
    "end_date": "2022-06-01",
    "locked": false,
    "locked_at": "2026-06-08T16:08:03+01:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "total_expectations": {
      "amount": "124585",
      "currency": "GBP",
      "formatted": "£1,245.85"
    },
    "total_statement_transactions": {
      "amount": "125599",
      "currency": "GBP",
      "formatted": "£1,255.99"
    },
    "total_bank_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"
    },
    "expectations_count": 6,
    "statement_transactions_count": 6,
    "statement_transactions": "App\\Http\\Resources\\StatementTransactionResource"
  },
  "bank_transactions_count": 6,
  "bank_transactions": [
    {
      "uuid": "4ec26c7b-0f63-43ca-8df3-586708a7fe6d",
      "created_at": "2026-06-08T16:08:03+01:00",
      "updated_at": "2026-06-08T16:08:03+01:00",
      "date": "2022-07-15",
      "amount": {
        "amount": "12399",
        "currency": "GBP",
        "formatted": "£123.99"
      },
      "reference": "VitalityLtd",
      "metadata": {
        "client_name": "Gareth Thompson"
      },
      "filename": "Natwest June 2022 Statement.xlsx",
      "bank_statement": "App\\Http\\Resources\\BankStatementResource",
      "statement": "App\\Http\\Resources\\StatementResource",
      "account": "App\\Http\\Resources\\AccountResource",
      "firm": "App\\Http\\Resources\\FirmResource"
    }
  ],
  "total_amount": {
    "amount": "345895",
    "currency": "GBP",
    "formatted": "£3,458.95"
  },
  "reconciled_amount": {
    "amount": "12849",
    "currency": "GBP",
    "formatted": "£128.49"
  },
  "reconciled_percentage": 95.68
}