Get all bank statements

GET /api/v1/bank-statement

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[statement] string

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

  • filter[name] string

    Comma separated list of partial bank statement names. e.g. Natwest

  • filter[reference] string

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

  • 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 bank 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
GET /api/v1/bank-statement 
curl \
 -X GET https://api.plannrcrm.com/api/v1/bank-statement \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "date": "2024-10-16",
      "name": "Aviva",
      "uuid": "bff182ca-09b8-4483-a72d-657908ffbcf1",
      "number": 23,
      "reference": "SW#8434",
      "statement": {
        "name": "01/06/2022 - 30/06/2022",
        "uuid": "269961f6-72cd-4628-af14-c1231abd7be9",
        "locked": false,
        "end_date": "2022-06-01",
        "locked_at": "2024-10-16T11:10:17+01:00",
        "locked_by": "App\\Http\\Resources\\AccountResource",
        "created_at": "2024-10-16T11:10:17+01:00",
        "start_date": "2022-06-30",
        "updated_at": "2024-10-16T11:10:17+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": "2024-10-16T11:10:17+01:00",
      "updated_at": "2024-10-16T11:10:17+01:00",
      "total_amount": {
        "amount": "345895",
        "currency": "GBP",
        "formatted": "£3,458.95"
      },
      "bank_transactions": [
        {
          "date": "2022-07-15",
          "firm": "App\\Http\\Resources\\FirmResource",
          "uuid": "adbd5d86-796e-4350-ab7a-d98615a8a4b9",
          "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": "2024-10-16T11:10:17+01:00",
          "updated_at": "2024-10-16T11:10:17+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
    }
  ]
}