Create a bank transaction

POST /api/v1/bank-transaction

Incoming transactions from a bank statement.

Headers

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

    • reference string

      Transaction reference on bank statement

    • metadata object

      Any metadata that was saved during a CSV import for transactions

    • filename string

      Filename of the CSV import transactions

    • bank_statement object

      Bank statement this bank transaction belongs to

    • statement object

      The statement period this bank transaction belongs to

    • account object

      Account that created this bank transaction

    • firm object

      Firm this bank transaction belongs to

    • reconciliation object

      The amount that the payment has been reconciled to statement transactions.

    • reconciliations object

      The individual reconciliations against the expected bank payment
POST /api/v1/bank-transaction 
curl \
 -X POST 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}" \
 -d '{"bank_statement_uuid":"ebe7ab69-e41a-4d74-89fd-b7d857e45e47","statement_transactions":[{"date":"2024-10-14","amount":15000,"reference":"AVIVA_0001"},{"date":"2024-10-14","amount":8999,"reference":"AVIVA_0002"}]}'
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
{
  "bank_statement_uuid": "ebe7ab69-e41a-4d74-89fd-b7d857e45e47",
  "statement_transactions": [
    {
      "date": "2024-10-14",
      "amount": 15000,
      "reference": "AVIVA_0001"
    },
    {
      "date": "2024-10-14",
      "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": "dce034a4-fe21-4c49-ac1c-8c26b0176d9c",
    "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": "2024-10-16T11:10:17+01:00",
    "updated_at": "2024-10-16T11:10:17+01: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": "c94643fa-d1ff-49e3-ab3b-9c9c78254e3f",
  "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": "705fb5b7-eb5d-488c-8026-48a226e4eb68",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:17+01: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": "2024-10-16T11:10:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:17+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:17+01:00"
  },
  "filename": "Natwest June 2022 Statement.xlsx",
  "metadata": {
    "client_name": "Gareth Thompson"
  },
  "reference": "VitalityLtd",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "e861f2c6-a86c-4d99-9c99-257b80507b6b",
    "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",
  "bank_statement": {
    "date": "2024-10-16",
    "name": "Aviva",
    "uuid": "354d7a43-11db-41c0-8207-d7fef601ab32",
    "number": 23,
    "reference": "SW#8434",
    "statement": "App\\Http\\Resources\\StatementResource",
    "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": "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": "46e11b7c-4bcc-41d3-9fb3-40e721676ad6",
    "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": "2024-10-16T11:10:17+01:00",
    "updated_at": "2024-10-16T11:10:17+01:00",
    "bank_transaction": "App\\Http\\Resources\\BankTransactionResource",
    "statement_transaction": "App\\Http\\Resources\\StatementTransactionResource"
  }
}