Create a transaction schedule
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
plan_uuid
string Required
Body
Required
-
sub_account_uuid
string Sub account to add the transaction to, if not provided if will go to the plan's main account
-
holding_uuid
string Holding to add the transaction to. Holding must exist for the main account, or to the sub account if sub_account_uuid is provided
-
type
string Required Transaction type. Valid types are: adjustment, adviser_fee, contribution, corporate_action, distribution, fee, income, payment, provider_fee, rebate, trade, transfer, withdrawal and other
-
sub_type
string 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
-
amount
integer Required Transaction amount in pennies
-
frequency
date Required How often to automatically create transactions
-
start_date
date Required Automatically create transactions from this date
-
end_date
date Stop automatically creating transactions after this date. Leave as null for indefinitely.
-
provider_controlled
boolean 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
-
backdate_transactions
boolean When true this will create the transactions from the given start date
curl \
--request POST 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction-schedule' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"sub_account_uuid":"d8f7ae67-efd5-4388-8be1-1e7ef6e5e6c6","holding_uuid":"77fa9907-5f4e-4a58-9a11-8a04eec933eb","type":"transfer","sub_type":"product_fees","amount":1099,"frequency":"weekly","start_date":"2025-04-22","end_date":"2028-01-17","provider_controlled":false,"backdate_transactions":true}'# 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
{
"sub_account_uuid": "d8f7ae67-efd5-4388-8be1-1e7ef6e5e6c6",
"holding_uuid": "77fa9907-5f4e-4a58-9a11-8a04eec933eb",
"type": "transfer",
"sub_type": "product_fees",
"amount": 1099,
"frequency": "weekly",
"start_date": "2025-04-22",
"end_date": "2028-01-17",
"provider_controlled": false,
"backdate_transactions": true
}{
"plan": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "68cae612-8f7c-4c7f-904e-73efa6d3bb02",
"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-04-22T13:44:19+01:00",
"valued_at": "2025-04-22T13:44:19+01:00",
"created_at": "2025-04-22T13:44:19+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-04-22T13:44:19+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-04-22T13:44:19+01:00",
"review_date": "2024-04-22",
"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,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"original_valued_at": "2025-04-21T13:44:19+01:00",
"proposal_reference": "AB123456",
"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-04-22",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"type": "contribution",
"uuid": "6478b1ca-d256-4288-8d4d-ed913e761c07",
"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": "73cdfff6-4853-4fae-8291-7e5fa5e5a2cd",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:19+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:19+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:19+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-04-22T13:44:19+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:19+01:00"
},
"holding": {
"citi": "ACB123",
"isin": "ACB123",
"uuid": "067d9603-1232-44fb-9a0a-4c878f323c37",
"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-04-22T13:44:19+01: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-04-22T13:44:19+01: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-04-22",
"provider": {
"name": "AJ Bell",
"slug": "aj-bell",
"uuid": "1b800260-93d1-4aad-9cee-17eb5c5cb5d7",
"created_at": "2025-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+01:00"
},
"sub_type": "product_fees",
"frequency": "monthly",
"created_at": "2025-04-22T13:44:19+01:00",
"start_date": "2025-04-22",
"updated_at": "2025-04-22T13:44:19+01:00",
"sub_account": {
"name": "John's ISA",
"uuid": "6c549e5d-0c7b-41db-8486-3fa1b7670304",
"created_at": "2025-04-22T13:44:19+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-04-22T13:44:19+01: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-04-22T13:44:19+01:00",
"provider_controlled": true,
"next_transaction_date": "2025-05-22"
}