Create a bank statement

POST /api/v1/bank-statement
Personal access token & OAuth2

Headers

application/json

Body Required

  • statement_uuid string Required

    Payment period statement UUID

  • date 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
POST /api/v1/bank-statement 
curl \
 --request POST https://api.plannrcrm.com/api/v1/bank-statement \
 --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}" \
 --data '{"statement_uuid":"5c4a2317-6233-4d84-bb39-ca4e8e06568b","date":"2025-02-20","name":"Natwest Statement #8434","reference":"BAT#8434"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "statement_uuid": "5c4a2317-6233-4d84-bb39-ca4e8e06568b",
  "date": "2025-02-20",
  "name": "Natwest Statement #8434",
  "reference": "BAT#8434"
}
Response examples (201) 
{
  "date": "2025-02-20",
  "name": "Aviva",
  "uuid": "903ed5aa-a4b7-4e3c-bb71-7657d3e79462",
  "number": 23,
  "reference": "SW#8434",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "826f0e00-81ca-47bf-9f3b-3395952b1add",
    "locked": false,
    "end_date": "2022-06-01",
    "locked_at": "2025-02-20T10:13:05+00:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-02-20T10:13:05+00:00",
    "start_date": "2022-06-30",
    "updated_at": "2025-02-20T10:13:05+00: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-02-20T10:13:05+00:00",
  "updated_at": "2025-02-20T10:13:05+00:00",
  "total_amount": {
    "amount": "345895",
    "currency": "GBP",
    "formatted": "£3,458.95"
  },
  "bank_transactions": [
    {
      "date": "2022-07-15",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "9ca46085-e4a4-4155-9ce8-5f279351f182",
      "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-02-20T10:13:05+00:00",
      "updated_at": "2025-02-20T10:13:05+00:00",
      "bank_statement": "App\\Http\\Resources\\BankStatementResource"
    }
  ],
  "reconciled_amount": {
    "amount": "12849",
    "currency": "GBP",
    "formatted": "£128.49"
  },
  "reconciled_percentage": 95.68,
  "bank_transactions_count": 6
}