Update an statement transaction Run in API Explorer
Ask AI
Body
-
The client name this payment would be for.
-
Provider statement transaction date
-
Provider reference of the plan the statement transactions is for.
-
Provider statement transaction category.
Value Description adhoc Adhoc administration Administration adjustment Adjustment bond_renewal Bond Renewal clawback Clawback dss_rebate Dss Rebate fund Fund indemnity Indemnity initial_fee Initial Fee level Level non_indemnity Non Indemnity one_off One Off ongoing_fee Ongoing Fee other_fee Other Fee procuration_fee Procuration Fee protected_rights Protected Rights renewal Renewal switch Switch unknown Unknown Values are
adhoc,administration,adjustment,bond_renewal,clawback,dss_rebate,fund,indemnity,initial_fee,level,non_indemnity,one_off,ongoing_fee,other_fee,procuration_fee,protected_rights,renewal,switch, orunknown. -
Transaction gross amount in lowest denomination.
-
Transaction net amount in lowest denomination.
-
The adviser name if given on the provider statement
-
Unique statement transactions reference provided by the provider.
-
Agency number of the transaction if given on the provider statement.
-
Product reference of the transaction if given on the provider statement.
-
Sender ID/SIB number
-
Reason
-
Scheme name
-
Scheme number
-
Customer number
-
Policy market value
-
Where this statement transactions came from.
Value Description client Client provider Provider unknown Unknown Values are
client,provider, orunknown.
PUT
/api/v1/statement-transaction/{statementTransaction_uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/statement-transaction/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"client_name":"Gareth Thompson","date":"2026-06-08","policy_number":"AVIVA00001","category":"adhoc","gross_amount":15099,"net_amount":15099,"adviser_name":"Bill Gates","transaction_reference":"bsLMILN9Lv","agency_number":"5k2mOJlpDP","product_reference":"MJsi6dpCnQ","sender_id_sib_number":"Sender ID/SIB number","reason":"Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value","payment_origin":"client"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"client_name": "Gareth Thompson",
"date": "2026-06-08",
"policy_number": "AVIVA00001",
"category": "adhoc",
"gross_amount": 15099,
"net_amount": 15099,
"adviser_name": "Bill Gates",
"transaction_reference": "bsLMILN9Lv",
"agency_number": "5k2mOJlpDP",
"product_reference": "MJsi6dpCnQ",
"sender_id_sib_number": "Sender ID/SIB number",
"reason": "Reason",
"scheme_name": "Scheme name",
"scheme_number": "Scheme number",
"customer_number": "Customer number",
"policy_market_value": "Policy market value",
"payment_origin": "client"
}
Response examples (200)
{
"uuid": "e644982d-2418-4d2b-8288-407f7a87bf6a",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"client_name": "Gareth Thompson",
"transaction_reference": "dWrQiEYgtG",
"policy_number": "AVIVA_00001",
"date": "2026-06-08",
"gross_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"net_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"category": "initial_fee",
"payment_origin": "provider",
"agency_number": "Agency number",
"product_reference": "Product reference",
"adviser_name": "Adviser name",
"sender_id_sib_number": "Sender id sib number",
"reason": "Reason",
"scheme_name": "Scheme name",
"scheme_number": "Scheme number",
"customer_number": "Customer number",
"policy_market_value": "Policy market value",
"provider": "Aviva",
"provider_statement": {
"uuid": "d36b9941-861e-4830-a668-836705989c86",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"number": 23,
"name": "Aviva",
"date": "2026-06-08",
"reference": "SW#8434",
"filename": "aviva-statement-may.csv",
"origin": "upload",
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"statement": "App\\Http\\Resources\\StatementResource",
"statement_transactions_count": 6,
"statement_transactions": "App\\Http\\Resources\\StatementTransactionResource",
"total_amount": {
"amount": "345895",
"currency": "GBP",
"formatted": "£3,458.95"
},
"reconciled_expectations_amount": {
"amount": "12849",
"currency": "GBP",
"formatted": "£128.49"
},
"reconciled_expectations_percentage": 95.68,
"reconciled_bank_transactions_amount": {
"amount": "22985",
"currency": "GBP",
"formatted": "£229.85"
},
"reconciled_bank_transactions_percentage": 95.68,
"is_fully_reconciled_to_expectations": true
},
"metadata": {
"client_name": "Gareth Thompson"
},
"expectation": {
"uuid": "159db17a-e8cf-445f-97e6-5ce0c7fe3cac",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"payment_origin": "provider",
"type": "fee",
"category": "ongoing_fee",
"expected_payment_date": "2026-06-08T16:08:03+01:00",
"tax_exempt": true,
"tax": 20,
"recurring": true,
"is_balanced": false,
"unbalanced_expected_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"expected_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"gross_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"net_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"percentage": 0.75,
"exclude_from_rmar": true,
"rmar_type": "adviser_charge",
"advice_type": "independent",
"service_type": "initial",
"advice_area_gross": {
"deposit": 7500,
"non_regulated": 0,
"non_rmar": 0,
"non_investment_insurance": 0,
"regulated_mortgage": 2500,
"retail_investment": 0,
"other_fca_regulated": 0,
"unknown": 0
},
"advice_area_net": {
"deposit": 7500,
"non_regulated": 0,
"non_rmar": 0,
"non_investment_insurance": 0,
"regulated_mortgage": 2500,
"retail_investment": 0,
"other_fca_regulated": 0,
"unknown": 0
},
"account": "App\\Http\\Resources\\AccountResource",
"seller": "App\\Http\\Resources\\AccountResource",
"author": "App\\Http\\Resources\\AccountResource",
"charge_schedule": "App\\Http\\Resources\\ChargeResource",
"chargeable_type": "plan",
"chargeable": "App\\Http\\Resources\\Plans\\PlanResource",
"statement_transactions": "App\\Http\\Resources\\StatementTransactionResource",
"statement": "App\\Http\\Resources\\StatementResource",
"income_splits": "App\\Http\\Resources\\IncomeSplitResource",
"firm": "App\\Http\\Resources\\FirmResource",
"notes_count": 5
},
"bank_transactions": [
{
"uuid": "5898223c-a5b6-46a8-a6d3-c74ae3d31e5e",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"date": "2022-07-15",
"amount": {
"amount": "12399",
"currency": "GBP",
"formatted": "£123.99"
},
"reference": "VitalityLtd",
"metadata": {
"client_name": "Gareth Thompson"
},
"filename": "Natwest June 2022 Statement.xlsx",
"bank_statement": "App\\Http\\Resources\\BankStatementResource",
"statement": "App\\Http\\Resources\\StatementResource",
"account": "App\\Http\\Resources\\AccountResource",
"firm": "App\\Http\\Resources\\FirmResource"
}
],
"statement": {
"uuid": "9162d745-5723-447f-93b9-0b31fb97b9e9",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"name": "01/06/2022 - 30/06/2022",
"start_date": "2022-06-30",
"end_date": "2022-06-01",
"locked": false,
"locked_at": "2026-06-08T16:08:03+01:00",
"locked_by": "App\\Http\\Resources\\AccountResource",
"total_expectations": {
"amount": "124585",
"currency": "GBP",
"formatted": "£1,245.85"
},
"total_statement_transactions": {
"amount": "125599",
"currency": "GBP",
"formatted": "£1,255.99"
},
"total_bank_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"
},
"expectations_count": 6,
"statement_transactions_count": 6,
"statement_transactions": "App\\Http\\Resources\\StatementTransactionResource"
},
"account": {
"uuid": "d35d84f4-f032-41c7-922f-73ceb5fe21c9",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-08T16:08:03+01:00",
"next_review_date": "2026-06-08T16:08:03+01:00",
"previous_review_date": "2026-06-08T16:08:03+01:00",
"anniversary_review_date": "2026-06-08T16:08:03+01:00",
"terms_of_business_at": "2026-06-08T16:08:03+01:00",
"client_agreement_at": "2026-06-08T16:08:03+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:03",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"firm": {
"uuid": "72bf48f6-0b4b-4b48-a621-df19166a66f5",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"name": "Codepotato",
"slug": "codepotato",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"regulatory_text": "Regulatory text",
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"brand_colours": {
"sidebar_background": "#0E0E56",
"sidebar_accent": "#36367E",
"sidebar_text": "#FFFFFF",
"sidebar_hover": "#0A0A42",
"sidebar_active": "#53DBB8",
"sidebar_title_background": "#36367E",
"sidebar_title_primary": "#FFC634",
"sidebar_title_secondary": "#FFFFFF",
"sidebar_title_secondary_hover": "#FFFFFF",
"email_background": "#0E0E56",
"email_logo_background_panel": "#36367E",
"email_sub_text": "#FFFFFF",
"email_button_background": "#36367E",
"email_button_text": "#FFFFFF",
"portal_sidebar_button_background": "#F6F6F6",
"portal_sidebar_button_hover": "#FFFFFF",
"portal_sidebar_button_active": "#FFFFFF",
"portal_brand_title": "#323B4B",
"portal_brand_sub_title": "#828994",
"portal_sidebar_title": "#11151D",
"portal_sidebar_text": "#323B4B",
"portal_sidebar_text_hover": "#323B4B",
"portal_sidebar_text_active": "#323B4B",
"portal_sidebar_icon": "#828994",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_icon_active": "#828994",
"portal_background": "#F6F6F6",
"portal_sidebar_account_title": "#11151D",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_divider": "#E3E5E9",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_hover": "#F6F6F6",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"keep_deleted_files_for": 30,
"tax": 17.5,
"month_end": 25,
"statement_frequency": "monthly",
"billing": {
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville",
"invoice_county": "Hampshire",
"invoice_postcode": "PO7 7YH",
"invoice_country": "United Kingdom",
"invoice_email": "gareth@codepotato.co.uk"
},
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true,
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"reply_to_email_address": "jack@example.com",
"mobile_app_support_number": "01234 567890",
"mobile_app_support_email": "support@example.com"
},
"reconciliation": {
"bank_transaction_reconciliation_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"bank_transaction_reconciliation_percentage": 100,
"is_fully_reconciled_with_bank_transactions": true,
"expectation_reconciliation_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"expectation_reconciliation_percentage": 50,
"is_reconciled_with_expectation": false,
"is_fully_reconciled_with_expectations": false
},
"bank_transaction_reconciliations": {
"uuid": "ec61ec99-b1d3-4d44-b6d3-dd918bb89773",
"created_at": "2026-06-08T16:08:03+01:00",
"updated_at": "2026-06-08T16:08:03+01:00",
"amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"statement_transaction": "App\\Http\\Resources\\StatementTransactionResource",
"bank_transaction": "App\\Http\\Resources\\BankTransactionResource",
"account": "App\\Http\\Resources\\AccountResource"
}
}