Create a transaction schedule Run in API Explorer
Body
-
Sub account to add the transaction to, if not provided if will go to the plan's main account
-
Holding to add the transaction to. Holding must exist for the main account, or to the sub account if sub_account_uuid is provided
-
Transaction type. Valid types are: adjustment, adviser_fee, contribution, corporate_action, distribution, fee, income, payment, provider_fee, rebate, trade, transfer, withdrawal and other
Value Description adjustment Adjustment adviser_fee Adviser Fee contribution Contribution corporate_action Corporate Action distribution Distribution fee Fee income Income payment Payment provider_fee Provider Fee rebate Rebate trade Trade transfer Transfer withdrawal Withdrawal other Other Values are
adjustment,adviser_fee,contribution,corporate_action,distribution,fee,income,payment,provider_fee,rebate,trade,transfer,withdrawal, orother. -
Transaction sub type. Valid types are: advice_fee_adjustments, advice_fee_refunds, advice_fees_ad_hoc, advice_fees_annual, advice_fees_initial, discretionary_fund_manager_fees, nucleus_fee_rebates, nucleus_fees, product_fees, provider_fee_rebates, provider_fees, bed_and_isa_transfers, cash_transfers_in, cash_transfers_out, inter_account_transfers_in, inter_account_transfers_out, reregistrations_in, reregistrations_out, acquisitions, asset_closures, bonus_issues, capital_reorganisations, capital_returns, closed_offers, compulsory_call_payments, consolidations, de_mergers, early_withdrawals, fund_mergers, liquidations, mergers, open_offers, optional_call_conversions, optional_call_payments, optional_conversions, optional_redemptions, rights_issues, scheme_of_arrangements, scrip_dividends, share_offers, stock_splits, subdivisions, subscription_offers, subscriptions, take_overs, tender_offers, credit_adjustments, debit_adjustments, early_redemption, external_value, insurance_premium_adjustments, interest_adjustments, share_capital_reductions, surcharge_adjustments, trade_correction, lump_sum, regular, reinvestment_of_income, transfer_in, amc_cash_rebates, amc_unit_rebates, tax_rebates, asset_conversions, auto_disinvestments, buys, rebalances, sells, switches, dividend, dividend_tax, interest, bed_and_isa_payments, corrections, lump_sum_payments, pension_tax_relief, regular_employer_payments, regular_payments, bond_assignments, lump_sum_withdrawals, natural_income, regular_withdrawals, income_distributions, interest_distributions and other
Value Description advice_fee_adjustments Advice Fee Adjustments advice_fee_refunds Advice Fee Refunds advice_fees_ad_hoc Advice Fees Ad Hoc advice_fees_annual Advice Fees Annual advice_fees_initial Advice Fees Initial discretionary_fund_manager_fees Discretionary Fund Manager Fees nucleus_fee_rebates Nucleus Fee Rebates nucleus_fees Nucleus Fees product_fees Product Fees provider_fee_rebates Provider Fee Rebates provider_fees Provider Fees bed_and_isa_transfers Bed And Isa Transfers cash_transfers_in Cash Transfers In cash_transfers_out Cash Transfers Out inter_account_transfers_in Inter Account Transfers In inter_account_transfers_out Inter Account Transfers Out reregistrations_in Reregistrations In reregistrations_out Reregistrations Out acquisitions Acquisitions asset_closures Asset Closures bonus_issues Bonus Issues capital_reorganisations Capital Reorganisations capital_returns Capital Returns closed_offers Closed Offers compulsory_call_payments Compulsory Call Payments consolidations Consolidations de_mergers De Mergers early_withdrawals Early Withdrawals fund_mergers Fund Mergers liquidations Liquidations mergers Mergers open_offers Open Offers optional_call_conversions Optional Call Conversions optional_call_payments Optional Call Payments optional_conversions Optional Conversions optional_redemptions Optional Redemptions rights_issues Rights Issues scheme_of_arrangements Scheme Of Arrangements scrip_dividends Scrip Dividends share_offers Share Offers stock_splits Stock Splits subdivisions Subdivisions subscription_offers Subscription Offers subscriptions Subscriptions take_overs Take Overs tender_offers Tender Offers credit_adjustments Credit Adjustments debit_adjustments Debit Adjustments early_redemption Early Redemption external_value External Value insurance_premium_adjustments Insurance Premium Adjustments interest_adjustments Interest Adjustments share_capital_reductions Share Capital Reductions surcharge_adjustments Surcharge Adjustments trade_correction Trade Correction lump_sum Lump Sum regular Regular reinvestment_of_income Reinvestment Of Income transfer_in Transfer In amc_cash_rebates Amc Cash Rebates amc_unit_rebates Amc Unit Rebates tax_rebates Tax Rebates asset_conversions Asset Conversions auto_disinvestments Auto Disinvestments buys Buys rebalances Rebalances sells Sells switches Switches dividend Dividend dividend_tax Dividend Tax interest Interest bed_and_isa_payments Bed And Isa Payments corrections Corrections lump_sum_payments Lump Sum Payments pension_tax_relief Pension Tax Relief regular_employer_payments Regular Employer Payments regular_payments Regular Payments bond_assignments Bond Assignments lump_sum_withdrawals Lump Sum Withdrawals natural_income Natural Income regular_withdrawals Regular Withdrawals income_distributions Income Distributions interest_distributions Interest Distributions other Other Values are
advice_fee_adjustments,advice_fee_refunds,advice_fees_ad_hoc,advice_fees_annual,advice_fees_initial,discretionary_fund_manager_fees,nucleus_fee_rebates,nucleus_fees,product_fees,provider_fee_rebates,provider_fees,bed_and_isa_transfers,cash_transfers_in,cash_transfers_out,inter_account_transfers_in,inter_account_transfers_out,reregistrations_in,reregistrations_out,acquisitions,asset_closures,bonus_issues,capital_reorganisations,capital_returns,closed_offers,compulsory_call_payments,consolidations,de_mergers,early_withdrawals,fund_mergers,liquidations,mergers,open_offers,optional_call_conversions,optional_call_payments,optional_conversions,optional_redemptions,rights_issues,scheme_of_arrangements,scrip_dividends,share_offers,stock_splits,subdivisions,subscription_offers,subscriptions,take_overs,tender_offers,credit_adjustments,debit_adjustments,early_redemption,external_value,insurance_premium_adjustments,interest_adjustments,share_capital_reductions,surcharge_adjustments,trade_correction,lump_sum,regular,reinvestment_of_income,transfer_in,amc_cash_rebates,amc_unit_rebates,tax_rebates,asset_conversions,auto_disinvestments,buys,rebalances,sells,switches,dividend,dividend_tax,interest,bed_and_isa_payments,corrections,lump_sum_payments,pension_tax_relief,regular_employer_payments,regular_payments,bond_assignments,lump_sum_withdrawals,natural_income,regular_withdrawals,income_distributions,interest_distributions, orother. -
Transaction amount in pennies
-
How often to automatically create transactions
Value Description daily Daily weekly Weekly fortnightly Fortnightly four_weekly Four Weekly monthly Monthly bimonthly Bimonthly quarterly Quarterly biannually Biannually annually Annually Values are
daily,weekly,fortnightly,four_weekly,monthly,bimonthly,quarterly,biannually, orannually. -
Automatically create transactions from this date
-
Stop automatically creating transactions after this date. Leave as null for indefinitely.
-
Boolean to denote whether the provider feeds (if available) are responsible for creating the recurring transactions. If false then Plannr will create these recurring transactions using this transaction schedule
-
When true this will create the transactions from the given start date
curl \
--request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/transaction-schedule' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"sub_account_uuid":"2bc8bedb-3f81-41c2-849e-b8635fb721b1","holding_uuid":"7c93b761-aa67-43db-ac1e-593c6e931bff","type":"adjustment","sub_type":"advice_fee_adjustments","amount":1099,"frequency":"daily","start_date":"2025-12-24","end_date":"2028-09-19","provider_controlled":false,"backdate_transactions":true}'# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"sub_account_uuid": "2bc8bedb-3f81-41c2-849e-b8635fb721b1",
"holding_uuid": "7c93b761-aa67-43db-ac1e-593c6e931bff",
"type": "adjustment",
"sub_type": "advice_fee_adjustments",
"amount": 1099,
"frequency": "daily",
"start_date": "2025-12-24",
"end_date": "2028-09-19",
"provider_controlled": false,
"backdate_transactions": true
}{
"plan": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "8f6a9e9e-80da-44c6-9665-8fffb2167905",
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"cases": "App\\Http\\Resources\\CasesResource",
"value": {
"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"
}
},
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"client": "App\\Http\\Resources\\AccountResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"seller": "App\\Http\\Resources\\AccountResource",
"status": "inactive",
"accounts": "App\\Http\\Resources\\AccountResource",
"on_panel": true,
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"sub_type": "lifetime isa",
"opened_at": "2025-12-24T11:02:59+00:00",
"valued_at": "2025-12-24T11:02:59+00:00",
"created_at": "2025-12-24T11:02:59+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-12-24T11:02:59+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-12-24T11:02:59+00:00",
"review_date": "2024-12-24",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"under_advice": true,
"abstract_type": "asset",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"is_wrap_child": false,
"linked_owners": "App\\Http\\Resources\\AccountResource",
"policy_number": "AVIVA-123",
"show_on_joint": true,
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"can_be_deleted": "false",
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
}
}
},
"inactive_reason": "claimed",
"is_group_scheme": false,
"is_wrap_product": false,
"shown_on_circles": true,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"original_valued_at": "2025-12-23T11:02:59+00:00",
"proposal_reference": "AB123456",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"agency_in_your_name": true,
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"is_sub_group_scheme": false,
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
}
},
"is_group_scheme_member": false,
"originally_sold_by_firm": true,
"agency_in_your_name_from": "2024-12-24",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"type": "contribution",
"uuid": "b8c34dc3-cf1d-4fbb-86ca-7f9c3cef6069",
"amount": {
"amount": "1099",
"currency": "GBP",
"formatted": "£10.99"
},
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "7a8f5e56-ef9d-4e65-9150-c7115f160e5c",
"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:02:59+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:02:59+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:02:59+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-24T11:02:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2025-12-24 11:02:59",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-24T11:02:59+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-24T11:02:59+00:00"
},
"holding": {
"citi": "ACB123",
"isin": "ACB123",
"uuid": "dad2c3ab-9c47-425f-9a56-be4059560a6d",
"sedol": "ACB123",
"units": 5,
"value": {
"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"
}
},
"sector": "Europe",
"fund_name": "Fund",
"is_active": true,
"reference": "REF123",
"created_at": "2025-12-24T11:02:59+00:00",
"unit_price": {
"amount": {
"example": "1000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£10.00",
"description": "Money amount formatted with currency"
}
},
"updated_at": "2025-12-24T11:02:59+00:00",
"sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"purchase_price": {
"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"
}
},
"unit_price_raw": 10,
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2026-12-24",
"provider": {
"name": "AJ Bell",
"slug": "aj-bell",
"uuid": "3ac18223-437a-4141-a896-0d3a107980c3",
"created_at": "2025-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00"
},
"sub_type": "product_fees",
"frequency": "monthly",
"created_at": "2025-12-24T11:02:59+00:00",
"start_date": "2025-12-24",
"updated_at": "2025-12-24T11:02:59+00:00",
"sub_account": {
"name": "John's ISA",
"uuid": "4fa8cbce-7ad3-489f-a3c0-f5c81a9a7b92",
"created_at": "2025-12-24T11:02:59+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-12-24T11:02:59+00:00",
"policy_number": "AVI-4837",
"is_main_account": false,
"active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
"latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource"
},
"paused_until": "2025-12-24T11:02:59+00:00",
"provider_controlled": true,
"next_transaction_date": "2026-01-24"
}