Get all bank transactions

GET /api/v1/bank-transaction

Headers

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [statement].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[statement_uuids] string

Filter bank transaction by a statement UUID.
filter[bank_statement_uuids] string

Filter bank statement transactions by an exact bank statement UUID.
filter[date_from] string

Get bank transactions from a certain date.
filter[date_to] string

Get bank transactions to a certain date.
filter[amount_from] string

Get bank transactions greater than or equal to a certain amount in pennies.
filter[amount_to] string

Get bank transactions less than or equal to a certain amount in pennies.
filter[reference] string

Filter bank transactions by a partial transaction reference
filter[reconciliation] string

Filter bank transactions based on their reconciliation status. Available options: reconciled,unreconciled,partially_reconciled
filter[reconciliation_percentage_between] string

Filter bank transactions based on their reconciliation amount between two values as a percentage.
filter[reconciliation_amount_between] string

Filter bank transactions based on their reconciliation amount between two values in pennies.
sort string

Field to sort by. Valid fields are [created_at, updated_at, payment_date, reference, amount]. Negative sign to denote DESC. Defaults to 'date'.
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
- data array[object]
  
  Additional properties are allowed.

GET /api/v1/bank-transaction

curl \
 -X GET https://api.plannrcrm.com/api/v1/bank-transaction \
 -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": "2022-07-15",
      "firm": {
        "tax": 17.5,
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "name": "Codepotato",
        "slug": "codepotato",
        "uuid": "4f90c9bd-237f-42ed-b86e-5c60a96d6ee2",
        "county": "Hampshire",
        "billing": {
          "invoice_email": "gareth@codepotato.co.uk",
          "invoice_county": "Hampshire",
          "invoice_country": "United Kingdom",
          "invoice_postcode": "PO7 7YH",
          "invoice_address_1": "Suite E, 5 The Briars",
          "invoice_address_2": "Waterberry Drive",
          "invoice_town_city": "Waterlooville"
        },
        "country": "United Kingdom",
        "postcode": "PO7 7YH",
        "address_1": "Suite E, 5 The Briars",
        "address_2": "Waterberry Drive",
        "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
        "month_end": 25,
        "town_city": "Waterlooville",
        "created_at": "2025-01-17T11:18:32+00:00",
        "updated_at": "2025-01-17T11:18:32+00:00",
        "ip_whitelist": [
          "192.168.0.1",
          "127.0.0.1"
        ],
        "brand_colours": {
          "sidebar_text": "#ffffff",
          "sidebar_hover": "#0A0A42",
          "email_sub_text": "#ffffff",
          "sidebar_accent": "#36367E",
          "sidebar_active": "#53DBB8",
          "email_background": "#0E0E56",
          "email_button_text": "#ffffff",
          "sidebar_background": "#0E0E56",
          "sidebar_title_primary": "#FFC634",
          "email_button_background": "#36367E",
          "sidebar_title_secondary": "#ffffff",
          "sidebar_title_background": "#36367E",
          "email_logo_background_panel": "#36367E",
          "sidebar_title_secondary_hover": "#ffffff"
        },
        "is_subscribed": true,
        "regulatory_text": "Regulatory text",
        "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
        "statement_frequency": "monthly",
        "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
        "keep_deleted_files_for": 30,
        "welcome_paragraph_html": "<h1>Welcome.</h1>",
        "email_welcome_paragraph_html": "Welcome to Plannr!"
      },
      "uuid": "738857cb-cc6c-46c7-81e3-54491e3cb669",
      "amount": {
        "amount": "12399",
        "currency": "GBP",
        "formatted": "£123.99"
      },
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "ed09e8fd-9a53-482f-9407-6fde8a8667a1",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:32+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:32+00:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-01-17T11:18:32+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:32+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:32+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:32+00:00"
      },
      "filename": "Natwest June 2022 Statement.xlsx",
      "metadata": {
        "client_name": "Gareth Thompson"
      },
      "reference": "VitalityLtd",
      "statement": {
        "name": "01/06/2022 - 30/06/2022",
        "uuid": "319792e0-53fb-41c8-8bea-05c25741e739",
        "locked": false,
        "end_date": "2022-06-01",
        "locked_at": "2025-01-17T11:18:32+00:00",
        "locked_by": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-01-17T11:18:32+00:00",
        "start_date": "2022-06-30",
        "updated_at": "2025-01-17T11:18:32+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-01-17T11:18:32+00:00",
      "updated_at": "2025-01-17T11:18:32+00:00",
      "bank_statement": {
        "date": "2025-01-17",
        "name": "Aviva",
        "uuid": "6552a27f-d51f-4c70-b20b-aadb3a53a501",
        "number": 23,
        "reference": "SW#8434",
        "statement": "App\\Http\\Resources\\StatementResource",
        "created_at": "2025-01-17T11:18:32+00:00",
        "updated_at": "2025-01-17T11:18:32+00:00",
        "total_amount": {
          "amount": "345895",
          "currency": "GBP",
          "formatted": "£3,458.95"
        },
        "bank_transactions": "App\\Http\\Resources\\BankTransactionResource",
        "reconciled_amount": {
          "amount": "12849",
          "currency": "GBP",
          "formatted": "£128.49"
        },
        "reconciled_percentage": 95.68,
        "bank_transactions_count": 6
      },
      "reconciliation": {
        "amount": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "percentage": 100,
        "is_reconciled": true
      },
      "reconciliations": {
        "uuid": "2537f2bc-bccc-49a6-a4fe-1baa3efb4958",
        "amount": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "account": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-01-17T11:18:32+00:00",
        "updated_at": "2025-01-17T11:18:32+00:00",
        "bank_transaction": "App\\Http\\Resources\\BankTransactionResource",
        "statement_transaction": "App\\Http\\Resources\\StatementTransactionResource"
      }
    }
  ]
}