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":"18c98f98-1b60-4a35-a280-174f71d34531","provider_statement_uuid":"06f1c363-99ef-4ca3-ba4a-7f5bf1671f0b","statement_transactions":[{"client_name":"Gareth Thompson","policy_number":"AVIVA_0001","date":"2026-04-27","gross_amount":15000,"net_amount":15000,"transaction_reference":"6Yy2gPfz","agency_number":"Y6nXiGfy","product_reference":"zWgD0fr2","category":"ongoing_fee","adviser_name":"Bill Gates","sender_id_sib_number":"Sender ID/SIB number","reason":"Provider Reason","scheme_name":"Scheme name","scheme_number":"Scheme number","customer_number":"Customer number","policy_market_value":"Policy market value"},{"client_first_name":"Barry","client_last_name":"Allen","policy_number":"AVIVA_0002","date":"2026-04-27","gross_amount":8999,"category":"renewal","adviser_first_name":"Bruce","adviser_last_name":"Wayne"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"statement_uuid": "18c98f98-1b60-4a35-a280-174f71d34531",
"provider_statement_uuid": "06f1c363-99ef-4ca3-ba4a-7f5bf1671f0b",
"statement_transactions": [
{
"client_name": "Gareth Thompson",
"policy_number": "AVIVA_0001",
"date": "2026-04-27",
"gross_amount": 15000,
"net_amount": 15000,
"transaction_reference": "6Yy2gPfz",
"agency_number": "Y6nXiGfy",
"product_reference": "zWgD0fr2",
"category": "ongoing_fee",
"adviser_name": "Bill Gates",
"sender_id_sib_number": "Sender ID/SIB number",
"reason": "Provider Reason",
"scheme_name": "Scheme name",
"scheme_number": "Scheme number",
"customer_number": "Customer number",
"policy_market_value": "Policy market value"
},
{
"client_first_name": "Barry",
"client_last_name": "Allen",
"policy_number": "AVIVA_0002",
"date": "2026-04-27",
"gross_amount": 8999,
"category": "renewal",
"adviser_first_name": "Bruce",
"adviser_last_name": "Wayne"
}
]
}
Response examples (200)
{
"uuid": "df25d48a-037b-4d73-a45d-45fbbc9f7ffa",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"client_name": "Gareth Thompson",
"transaction_reference": "m15DNwxzJx",
"policy_number": "AVIVA_00001",
"date": "2026-04-29",
"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": "de6281b8-ebfa-4764-b20d-1b08d7c7fbe4",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"number": 23,
"name": "Aviva",
"date": "2026-04-29",
"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": "def195a6-1a98-4aea-9c9d-c362c74f9783",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"payment_origin": "provider",
"type": "fee",
"category": "ongoing_fee",
"expected_payment_date": "2026-04-29T16:54:32+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": "f326e490-84a3-4479-9c12-70e0e238b730",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "9a9d2c3b-c02c-4753-aa8c-6a2c5ad66ab9",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"name": "01/06/2022 - 30/06/2022",
"start_date": "2022-06-30",
"end_date": "2022-06-01",
"locked": false,
"locked_at": "2026-04-29T16:54:32+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": "76afd049-7e4b-49de-9e23-8f9af9384f2c",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-04-29T16:54:32+01:00",
"next_review_date": "2026-04-29T16:54:32+01:00",
"previous_review_date": "2026-04-29T16:54:32+01:00",
"anniversary_review_date": "2026-04-29T16:54:32+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-04-29",
"last_interaction_at": "2026-04-29 16:54:32",
"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": "3f4b87be-b1b0-4d5e-b550-4255f493772c",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "f24cfb63-7df4-46c5-be1d-6d9a60b1ba80",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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"
}
}