Create an statement transaction Run in API Explorer
Ask AI
Add transactions to an already existing provider statement or add extra client paid transactions to a payment period.
Body
-
Required if adding client paid transactions that do not belong in a provider statement. You should be using provider_statement_uuid in most cases. Statement must also be unlocked.
-
Provider statement UUID to store these transactions in.
-
An array of statement_transactions. If expected payments date is not provided it will use the provider statement date. All amounts must be in pennies. Can also provide extra metadata which can be the rest of the columns of the provider statement.
POST
/api/v1/statement-transaction
curl \
--request POST 'https://api.plannrcrm.com/api/v1/statement-transaction' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"statement_uuid":"8d2086eb-e7e0-44a6-8400-8b620e01fc56","provider_statement_uuid":"55b1037e-f705-4f7b-bc49-7d5d64d65975","statement_transactions":[{"date":"2025-12-22","reason":"Provider Reason","category":"ongoing_fee","net_amount":15000,"client_name":"Gareth Thompson","scheme_name":"Scheme name","adviser_name":"Bill Gates","gross_amount":15000,"agency_number":"Bwb4afVB","policy_number":"AVIVA_0001","scheme_number":"Scheme number","customer_number":"Customer number","product_reference":"lmg9yXwU","policy_market_value":"Policy market value","sender_id_sib_number":"Sender ID/SIB number","transaction_reference":"ao5NmAMG"},{"date":"2025-12-22","category":"renewal","gross_amount":8999,"policy_number":"AVIVA_0002","client_last_name":"Allen","adviser_last_name":"Wayne","client_first_name":"Barry","adviser_first_name":"Bruce"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"statement_uuid": "8d2086eb-e7e0-44a6-8400-8b620e01fc56",
"provider_statement_uuid": "55b1037e-f705-4f7b-bc49-7d5d64d65975",
"statement_transactions": [
{
"date": "2025-12-22",
"reason": "Provider Reason",
"category": "ongoing_fee",
"net_amount": 15000,
"client_name": "Gareth Thompson",
"scheme_name": "Scheme name",
"adviser_name": "Bill Gates",
"gross_amount": 15000,
"agency_number": "Bwb4afVB",
"policy_number": "AVIVA_0001",
"scheme_number": "Scheme number",
"customer_number": "Customer number",
"product_reference": "lmg9yXwU",
"policy_market_value": "Policy market value",
"sender_id_sib_number": "Sender ID/SIB number",
"transaction_reference": "ao5NmAMG"
},
{
"date": "2025-12-22",
"category": "renewal",
"gross_amount": 8999,
"policy_number": "AVIVA_0002",
"client_last_name": "Allen",
"adviser_last_name": "Wayne",
"client_first_name": "Barry",
"adviser_first_name": "Bruce"
}
]
}
Response examples (200)
{
"date": "2025-12-24",
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "231cd649-e215-4d41-a8df-29753406fa14",
"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-12-24T11:03:00+00:00",
"updated_at": "2025-12-24T11:03:00+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": "f4b03a8b-4cb0-44cd-b324-7d0414351e5b",
"reason": "Reason",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "4f81685b-7031-4766-8da9-e678a0781355",
"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-12-24T11:03:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:03:00+00:00",
"with_login": true,
"inactive_at": "2025-12-24",
"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-12-24T11:03:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-24T11:03:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2025-12-24 11:03:00",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-24T11:03:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-24T11:03:00+00:00"
},
"category": "initial_fee",
"metadata": {
"client_name": "Gareth Thompson"
},
"provider": "Aviva",
"statement": {
"name": "01/06/2022 - 30/06/2022",
"uuid": "97dc0c9f-a9a4-44f4-949e-da3a7fd76dac",
"locked": false,
"end_date": "2022-06-01",
"locked_at": "2025-12-24T11:03:00+00:00",
"locked_by": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-12-24T11:03:00+00:00",
"start_date": "2022-06-30",
"updated_at": "2025-12-24T11:03:00+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-12-24T11:03:00+00: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-12-24T11:03:00+00:00",
"client_name": "Gareth Thompson",
"expectation": {
"tax": 20,
"firm": "App\\Http\\Resources\\FirmResource",
"type": "fee",
"uuid": "0a59c7bf-15b5-4e28-a9d2-4d96f6d4f670",
"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-12-24T11:03:00+00: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-12-24T11:03:00+00: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-12-24T11:03:00+00: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",
"reconciliation": {
"is_reconciled_with_expectation": false,
"expectation_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"
}
},
"expectation_reconciliation_percentage": 50,
"is_fully_reconciled_with_expectations": false,
"bank_transaction_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"
}
},
"bank_transaction_reconciliation_percentage": 100,
"is_fully_reconciled_with_bank_transactions": true
},
"customer_number": "Customer number",
"bank_transactions": [
{
"date": "2022-07-15",
"firm": "App\\Http\\Resources\\FirmResource",
"uuid": "0602299b-e06e-4df1-81e1-1b801f377134",
"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-12-24T11:03:00+00:00",
"updated_at": "2025-12-24T11:03:00+00:00",
"bank_statement": "App\\Http\\Resources\\BankStatementResource"
}
],
"product_reference": "Product reference",
"provider_statement": {
"date": "2025-12-24",
"name": "Aviva",
"uuid": "21d70610-fe36-4aa8-9e42-4034f3e15802",
"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-12-24T11:03:00+00:00",
"updated_at": "2025-12-24T11:03:00+00: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": "zSzW3RIB19",
"bank_transaction_reconciliations": {
"uuid": "97097709-c136-4894-aed3-216a3a23eade",
"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-12-24T11:03:00+00:00",
"updated_at": "2025-12-24T11:03:00+00:00",
"bank_transaction": "App\\Http\\Resources\\BankTransactionResource",
"statement_transaction": "App\\Http\\Resources\\StatementTransactionResource"
}
}