Create a bank transaction | PlannrCRM API documentation

Create a bank transaction Run in API Explorer

POST /api/v1/bank-transaction

Personal access token & O auth2

Incoming transactions from a bank statement.

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

bank_statement_uuid string Required

Bank statement UUID to store these transactions in.
statement_transactions array[string] Required

An array of payments. Required data are policy_number, date, gross_amount, and category. All amounts must be in pennies.

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.
- date string
  
  Transaction date on bank statement
- amount object
  
  Transaction amount
  
  Hide amount attributes Show amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- reference string
  
  Transaction reference on bank statement
- metadata object
  
  Any metadata that was saved during a CSV import for transactions
  
  Hide metadata attribute Show metadata attribute object
  
  client_name string
- filename string
  
  Filename of the CSV import transactions
- bank_statement object
  
  Bank statement this bank transaction belongs to
  
  Hide bank_statement attributes Show bank_statement attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  number integer
  
  reference string
  
  date string
  
  name string
  
  statement string
  
  bank_transactions_count integer
  
  bank_transactions string
  
  total_amount object
  
  Hide total_amount attributes Show total_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  reconciled_amount object
  
  Hide reconciled_amount attributes Show reconciled_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  reconciled_percentage number
- statement object
  
  The statement period this bank transaction belongs to
  
  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
- account object
  
  Account that created this bank transaction
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- firm object
  
  Firm this bank transaction belongs to
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  address_1 string
  
  address_2 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  regulatory_text string
  
  logo string
  
  logo_icon string
  
  brand_colours object
  
  Hide brand_colours attributes Show brand_colours attributes object
  
  sidebar_background string
  
  sidebar_accent string
  
  sidebar_text string
  
  sidebar_hover string
  
  sidebar_active string
  
  sidebar_title_background string
  
  sidebar_title_primary string
  
  sidebar_title_secondary string
  
  sidebar_title_secondary_hover string
  
  email_background string
  
  email_logo_background_panel string
  
  email_sub_text string
  
  email_button_background string
  
  email_button_text string
  
  portal_sidebar_button_background string
  
  portal_sidebar_button_hover string
  
  portal_sidebar_button_active string
  
  portal_brand_title string
  
  portal_brand_sub_title string
  
  portal_sidebar_title string
  
  portal_sidebar_text string
  
  portal_sidebar_text_hover string
  
  portal_sidebar_text_active string
  
  portal_sidebar_icon string
  
  portal_sidebar_icon_hover string
  
  portal_sidebar_icon_active string
  
  portal_background string
  
  portal_sidebar_account_title string
  
  portal_sidebar_account_email string
  
  portal_sidebar_divider string
  
  portal_dashboard_bg_one string
  
  portal_dashboard_bg_two string
  
  portal_sidebar_collapse_button string
  
  portal_sidebar_collapse_button_hover string
  
  portal_sidebar_user_select_background string
  
  portal_sidebar_user_select_hover string
  
  portal_sidebar_user_select_text string
  
  portal_sidebar_user_select_text_hover string
  
  portal_sidebar_user_select_border string
  
  portal_sidebar_user_select_border_hover string
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  keep_deleted_files_for integer
  
  tax number
  
  month_end integer
  
  statement_frequency string
  
  billing object
  
  Hide billing attributes Show billing attributes object
  
  invoice_address_1 string
  
  invoice_address_2 string
  
  invoice_town_city string
  
  invoice_county string
  
  invoice_postcode string
  
  invoice_country string
  
  invoice_email string
  
  task_board_template string
  
  ip_whitelist array[string]
  
  welcome_paragraph_html string
  
  email_welcome_paragraph_html string
  
  show_fact_find_illustrations boolean
  
  cc_email_addresses array[string]
  
  bcc_email_addresses array[string]
  
  reply_to_email_address string
- reconciliation object
  
  The amount that the payment has been reconciled to statement transactions.
  
  Hide reconciliation attributes Show reconciliation attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  percentage integer
  
  is_reconciled boolean
- reconciliations object
  
  The individual reconciliations against the expected bank payment
  
  Hide reconciliations attributes Show reconciliations attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  statement_transaction string
  
  bank_transaction string
  
  account string

POST /api/v1/bank-transaction

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/bank-transaction' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"bank_statement_uuid":"834b0548-1475-47f8-a241-38ec03900ea8","statement_transactions":[{"date":"2025-11-15","amount":15000,"reference":"AVIVA_0001"},{"date":"2025-11-15","amount":8999,"reference":"AVIVA_0002"}]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "bank_statement_uuid": "834b0548-1475-47f8-a241-38ec03900ea8",
  "statement_transactions": [
    {
      "date": "2025-11-15",
      "amount": 15000,
      "reference": "AVIVA_0001"
    },
    {
      "date": "2025-11-15",
      "amount": 8999,
      "reference": "AVIVA_0002"
    }
  ]
}

Response examples (201)

{
  "date": "2022-07-15",
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "2b00bdba-858a-4a24-a0cb-e6f13e02d3f7",
    "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-11-17T21:14:40+00:00",
    "updated_at": "2025-11-17T21:14:40+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",
      "portal_background": "#F6F6F6",
      "portal_brand_title": "#323B4B",
      "sidebar_background": "#0E0E56",
      "portal_sidebar_icon": "#828994",
      "portal_sidebar_text": "#323B4B",
      "portal_sidebar_title": "#11151D",
      "sidebar_title_primary": "#FFC634",
      "portal_brand_sub_title": "#828994",
      "portal_sidebar_divider": "#E3E5E9",
      "email_button_background": "#36367E",
      "portal_dashboard_bg_one": "#EF4583",
      "portal_dashboard_bg_two": "#FFC634",
      "sidebar_title_secondary": "#FFFFFF",
      "sidebar_title_background": "#36367E",
      "portal_sidebar_icon_hover": "#828994",
      "portal_sidebar_text_hover": "#323B4B",
      "portal_sidebar_icon_active": "#828994",
      "portal_sidebar_text_active": "#323B4B",
      "email_logo_background_panel": "#36367E",
      "portal_sidebar_button_hover": "#FFFFFF",
      "portal_sidebar_account_email": "#828994",
      "portal_sidebar_account_title": "#11151D",
      "portal_sidebar_button_active": "#FFFFFF",
      "sidebar_title_secondary_hover": "#FFFFFF",
      "portal_sidebar_collapse_button": "#828994",
      "portal_sidebar_user_select_text": "#323B4B",
      "portal_sidebar_button_background": "#F6F6F6",
      "portal_sidebar_user_select_hover": "#F6F6F6",
      "portal_sidebar_user_select_border": "#EEEEEE",
      "portal_sidebar_collapse_button_hover": "#B3B9C4",
      "portal_sidebar_user_select_background": "#F6F6F6",
      "portal_sidebar_user_select_text_hover": "#323B4B",
      "portal_sidebar_user_select_border_hover": "#828994"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "cc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "bcc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "reply_to_email_address": "jack@example.com",
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true
  },
  "uuid": "991b59ad-8cd3-401d-a87c-53d9807cbfa3",
  "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": "f5e53cb9-c083-4729-8d95-0a6273550279",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-11-17T21:14:40+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-17T21:14:40+00:00",
    "with_login": true,
    "inactive_at": "2025-11-17",
    "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-11-17T21:14:40+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-11-17T21:14:40+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-11-17T21:14:40+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-11-17T21:14:40+00:00"
  },
  "filename": "Natwest June 2022 Statement.xlsx",
  "metadata": {
    "client_name": "Gareth Thompson"
  },
  "reference": "VitalityLtd",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "ac97483b-630c-4164-b17d-ca7e726d22dd",
    "locked": false,
    "end_date": "2022-06-01",
    "locked_at": "2025-11-17T21:14:40+00:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-11-17T21:14:40+00:00",
    "start_date": "2022-06-30",
    "updated_at": "2025-11-17T21:14:40+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-11-17T21:14:40+00:00",
  "updated_at": "2025-11-17T21:14:40+00:00",
  "bank_statement": {
    "date": "2025-11-17",
    "name": "Aviva",
    "uuid": "859c20d4-4db8-49d6-9a40-d2b8d1e6a67b",
    "number": 23,
    "reference": "SW#8434",
    "statement": "App\\Http\\Resources\\StatementResource",
    "created_at": "2025-11-17T21:14:40+00:00",
    "updated_at": "2025-11-17T21:14:40+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": "0000ddb5-215c-4763-a012-f9729b9ca5a9",
    "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-11-17T21:14:40+00:00",
    "updated_at": "2025-11-17T21:14:40+00:00",
    "bank_transaction": "App\\Http\\Resources\\BankTransactionResource",
    "statement_transaction": "App\\Http\\Resources\\StatementTransactionResource"
  }
}