Body
Required
-
Payment period statement UUID, must be unlocked.
-
Bank statement date
-
Statement reference given by bank
-
An array of payments. Required data are amount, If transaction date is not provided it will use the bank statement date. All amounts must be in pennies. Can also provide extra metadata which can be the rest of the columns of the bank statement.
-
Filename of the CSV import payments.
POST
/api/v1/bank-statement/upload
curl \
--request POST 'https://api.plannrcrm.com/api/v1/bank-statement/upload' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"statement_uuid":"b5ccef41-3eaa-410b-8640-75bdc78984cd","date":"2025-06-26","reference":"Natwest Statement #8434","bank_transactions":[{"date":"2022-07-15","amount":12345,"reference":"AvivaRef#34"},{"date":"2022-07-14","amount":19855,"reference":"VIT_LTD"}],"filename":"natwest-statement-2022-04-05.csv"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"statement_uuid": "b5ccef41-3eaa-410b-8640-75bdc78984cd",
"date": "2025-06-26",
"reference": "Natwest Statement #8434",
"bank_transactions": [
{
"date": "2022-07-15",
"amount": 12345,
"reference": "AvivaRef#34"
},
{
"date": "2022-07-14",
"amount": 19855,
"reference": "VIT_LTD"
}
],
"filename": "natwest-statement-2022-04-05.csv"
}
Response examples (200)
{
"date": "2025-06-26",
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "e7e82966-4da6-4976-84fa-a1508d890dc9",
"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-06-26T11:37:09+01:00",
"updated_at": "2025-06-26T11:37:09+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",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_account_email": "#828994",
"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_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"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!",
"show_fact_find_illustrations": true
},
"uuid": "eeb74265-ae5e-4fa4-b7ce-54fb8876fff0",
"reason": "Reason",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "59d3e057-0fb5-4ffc-8c91-a1280992d751",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:09+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:09+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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-06-26T11:37:09+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:09+01: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-06-26T11:37:09+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:09+01:00"
},
"category": "initial_fee",
"metadata": {
"client_name": "Gareth Thompson"
},
"provider": "Aviva",
"statement": {
"name": "01/06/2022 - 30/06/2022",
"uuid": "9fc75d47-5379-4312-a945-fd043be63a46",
"locked": false,
"end_date": "2022-06-01",
"locked_at": "2025-06-26T11:37:09+01:00",
"locked_by": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-26T11:37:09+01:00",
"start_date": "2022-06-30",
"updated_at": "2025-06-26T11:37:09+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": "2025-06-26T11:37:09+01:00",
"net_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"
}
},
"updated_at": "2025-06-26T11:37:09+01:00",
"client_name": "Gareth Thompson",
"expectation": {
"tax": 20,
"firm": "App\\Http\\Resources\\FirmResource",
"type": "fee",
"uuid": "bb91080d-4c8f-4b8a-bb65-330ee7aa4fd0",
"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"
}
},
"author": "App\\Http\\Resources\\AccountResource",
"seller": "App\\Http\\Resources\\AccountResource",
"account": "App\\Http\\Resources\\AccountResource",
"category": "ongoing_fee",
"recurring": true,
"rmar_type": "adviser_charge",
"statement": "App\\Http\\Resources\\StatementResource",
"chargeable": "App\\Http\\Resources\\Plans\\PlanResource",
"created_at": "2025-06-26T11:37:09+01:00",
"net_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": 0.75,
"tax_exempt": true,
"updated_at": "2025-06-26T11:37:09+01:00",
"advice_type": "independent",
"is_balanced": false,
"notes_count": 5,
"gross_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"
}
},
"service_type": "initial",
"income_splits": "App\\Http\\Resources\\IncomeSplitResource",
"payment_origin": "provider",
"advice_area_net": {
"deposit": 7500,
"unknown": 0,
"non_rmar": 0,
"non_regulated": 0,
"retail_investment": 0,
"regulated_mortgage": 2500,
"other_fca_regulated": 0,
"non_investment_insurance": 0
},
"charge_schedule": "App\\Http\\Resources\\ChargeResource",
"chargeable_type": "plan",
"expected_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"
}
},
"advice_area_gross": {
"deposit": 7500,
"unknown": 0,
"non_rmar": 0,
"non_regulated": 0,
"retail_investment": 0,
"regulated_mortgage": 2500,
"other_fca_regulated": 0,
"non_investment_insurance": 0
},
"exclude_from_rmar": true,
"expected_payment_date": "2025-06-26T11:37:09+01:00",
"statement_transactions": "App\\Http\\Resources\\StatementTransactionResource",
"unbalanced_expected_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"
}
}
},
"scheme_name": "Scheme name",
"adviser_name": "Adviser name",
"gross_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"
}
},
"agency_number": "Agency number",
"policy_number": "AVIVA_00001",
"scheme_number": "Scheme number",
"payment_origin": "provider",
"customer_number": "Customer number",
"bank_transactions": [
{
"date": "2022-07-15",
"firm": "App\\Http\\Resources\\FirmResource",
"uuid": "56399693-364b-4740-a3cf-aa13632c88d2",
"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-06-26T11:37:09+01:00",
"updated_at": "2025-06-26T11:37:09+01:00",
"bank_statement": "App\\Http\\Resources\\BankStatementResource"
}
],
"product_reference": "Product reference",
"provider_statement": {
"date": "2025-06-26",
"name": "Aviva",
"uuid": "0b2c8501-2868-42b1-bdf3-953231a20b0f",
"number": 23,
"origin": "upload",
"filename": "aviva-statement-may.csv",
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"reference": "SW#8434",
"statement": "App\\Http\\Resources\\StatementResource",
"created_at": "2025-06-26T11:37:09+01:00",
"updated_at": "2025-06-26T11:37:09+01:00",
"total_amount": {
"amount": "345895",
"currency": "GBP",
"formatted": "£3,458.95"
},
"statement_transactions": "App\\Http\\Resources\\StatementTransactionResource",
"statement_transactions_count": 6,
"reconciled_expectations_amount": {
"amount": "12849",
"currency": "GBP",
"formatted": "£128.49"
},
"reconciled_expectations_percentage": 95.68,
"is_fully_reconciled_to_expectations": true,
"reconciled_bank_transactions_amount": {
"amount": "22985",
"currency": "GBP",
"formatted": "£229.85"
},
"reconciled_bank_transactions_percentage": 95.68
},
"policy_market_value": "Policy market value",
"sender_id_sib_number": "Sender id sib number",
"transaction_reference": "QQdDrugSCg"
}