Update an statement transaction
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body
-
client_name string
The client name this payment would be for.
-
date date
Provider statement transaction date
-
policy_number string
Provider reference of the plan the statement transactions is for.
-
category string
Provider statement transaction category. Possible 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 and unknown
-
gross_amount integer
Transaction gross amount in lowest denomination.
-
net_amount integer
Transaction net amount in lowest denomination.
-
adviser_name string
The adviser name if given on the provider statement
-
transaction_reference string
Unique statement transactions reference provided by the provider.
-
agency_number string
Agency number of the transaction if given on the provider statement.
-
product_reference string
Product reference of the transaction if given on the provider statement.
-
sender_id_sib_number string
Sender ID/SIB number
-
reason string
Reason
-
scheme_name string
Scheme name
-
scheme_number string
Scheme number
-
customer_number string
Customer number
-
policy_market_value string
Policy market value
-
payment_origin string
Where this statement transactions came from. Possible values are: client, provider and unknown
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
curl \
-X PUT https://api.plannrcrm.com/api/v1/statement-transaction/statementTransaction_uuid \
-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 '{"client_name":"Gareth Thompson","date":"2024-11-20","policy_number":"AVIVA00001","category":"ongoing_fee","gross_amount":15099,"net_amount":15099,"adviser_name":"Bill Gates","transaction_reference":"dtW2qI67LA","agency_number":"DlI01LOoj1","product_reference":"HSqZSm8HxP","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":"provider"}'
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
{
"client_name": "Gareth Thompson",
"date": "2024-11-20",
"policy_number": "AVIVA00001",
"category": "ongoing_fee",
"gross_amount": 15099,
"net_amount": 15099,
"adviser_name": "Bill Gates",
"transaction_reference": "dtW2qI67LA",
"agency_number": "DlI01LOoj1",
"product_reference": "HSqZSm8HxP",
"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": "provider"
}
Response examples (200)
{
"date": "2024-11-20",
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "80d1ee77-a48a-415c-a3c3-9c91220bd340",
"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-11-20T13:24:04+00:00",
"updated_at": "2024-11-20T13:24:04+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",
"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": "3db9e0e6-b88b-473c-aa4c-a26a2a74e3bd",
"reason": "Reason",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "b79a6d62-e863-4b88-8579-777ba4002a3e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:04+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:04+00: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-11-20T13:24:04+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:04+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:04+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:04+00:00"
},
"category": "initial_fee",
"metadata": {
"client_name": "Gareth Thompson"
},
"provider": "Aviva",
"statement": {
"name": "01/06/2022 - 30/06/2022",
"uuid": "2b8183d8-64dc-463f-8865-c6a26deab631",
"locked": false,
"end_date": "2022-06-01",
"locked_at": "2024-11-20T13:24:04+00:00",
"locked_by": "App\\Http\\Resources\\AccountResource",
"created_at": "2024-11-20T13:24:04+00:00",
"start_date": "2022-06-30",
"updated_at": "2024-11-20T13:24:04+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": "2024-11-20T13:24:04+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": "2024-11-20T13:24:04+00:00",
"client_name": "Gareth Thompson",
"expectation": {
"tax": 20,
"firm": "App\\Http\\Resources\\FirmResource",
"type": "fee",
"uuid": "ffb4a2c9-528b-468d-a03f-209d056e819f",
"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": "2024-11-20T13:24:04+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": "2024-11-20T13:24:04+00:00",
"advice_type": "independent",
"is_balanced": false,
"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": "2024-11-20T13:24:04+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": "3418e7b9-b090-42af-a2b1-457169729a54",
"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": "2024-11-20T13:24:04+00:00",
"updated_at": "2024-11-20T13:24:04+00:00",
"bank_statement": "App\\Http\\Resources\\BankStatementResource"
}
],
"product_reference": "Product reference",
"provider_statement": {
"date": "2024-11-20",
"name": "Aviva",
"uuid": "c7abb0bc-4e7c-4f8e-a8d9-19c6616abed2",
"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": "2024-11-20T13:24:04+00:00",
"updated_at": "2024-11-20T13:24:04+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": "bBNzXwuMWJ",
"bank_transaction_reconciliations": {
"uuid": "f6f25fd5-721e-4c01-b662-8623668bdf16",
"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-11-20T13:24:04+00:00",
"updated_at": "2024-11-20T13:24:04+00:00",
"bank_transaction": "App\\Http\\Resources\\BankTransactionResource",
"statement_transaction": "App\\Http\\Resources\\StatementTransactionResource"
}
}