Update a transaction schedule

PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

plan_uuid string Required
transactionSchedule_uuid string Required

application/json

Body

type string

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

Transaction amount in pennies
frequency date

How often to automatically create transactions
start_date date

Automatically create transactions from this date
end_date date

Stop automatically creating transactions after this date
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
paused_until date

Pause creating transactions up until this date. To unpause set to null

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- plan object
  
  Plan of the transaction
  
  Hide plan attributes Show plan attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  opened_at string
  
  name string
  
  type string
  
  sub_type string
  
  abstract_type string
  
  policy_number string
  
  proposal_reference string
  
  status string
  
  inactive_at string
  
  inactive_reason string
  
  agency_in_your_name boolean
  
  agency_in_your_name_from string
  
  originally_sold_by_firm boolean
  
  under_advice boolean
  
  visible_on_client_portal boolean
  
  include_in_client_valuation boolean
  
  show_on_joint boolean
  
  review_date string
  
  on_panel boolean
  
  is_group_scheme boolean
  
  is_sub_group_scheme boolean
  
  is_group_scheme_member boolean
  
  advice_area string
  
  main_account string
  
  sub_accounts string
  
  provider string
  
  covers string
  
  claims string
  
  total_benefit_amount object
  
  Hide total_benefit_amount attributes Show total_benefit_amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  total_benefits object
  
  Hide total_benefits attributes Show total_benefits attributes object
  
  critical_illness object
  
  Hide critical_illness attributes Show critical_illness attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  family_income_benefit object
  
  Hide family_income_benefit attributes Show family_income_benefit attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  latest_valuations string
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  valued_at string
  
  original_valued_at string
  
  client string
  
  accounts string
  
  seller string
  
  linked_owners string
  
  linked_plans string
  
  statistics object
  
  Hide statistics attribute Show statistics attribute object
  
  recent_growth integer
  
  cases string
  
  tags string
  
  is_wrap_product boolean
  
  is_wrap_child boolean
  
  wrap string
  
  wrap_children string
  
  can_be_deleted string
  
  contract_enquiry_account string
  
  custom_fields string
  
  external_references string
- sub_account object
  
  Sub account of the transaction
  
  Hide sub_account attributes Show sub_account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  policy_number string
  
  latest_valuation string
  
  is_main_account boolean
  
  active_portfolio string
  
  statistics object
  
  Hide statistics attribute Show statistics attribute object
  
  recent_growth integer
- holding object
  
  Holding of the subaccount
  
  Hide holding attributes Show holding attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  fund_name string
  
  reference string
  
  sector string
  
  sedol string
  
  isin string
  
  citi string
  
  units integer
  
  unit_price object
  
  Hide unit_price attributes Show unit_price attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  unit_price_raw integer
  
  purchase_price object
  
  Hide purchase_price attributes Show purchase_price attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  is_active boolean
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  sub_account string
  
  external_references string
- account object
  
  Account that added the transaction
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- provider object
  
  Provider that created this transaction
  
  Hide provider attributes Show provider attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
- 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
- type string
  
  Transaction type
- sub_type string
  
  Transaction sub type
- amount object
  
  Transaction amount
  
  Hide amount attributes Show amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- frequency string
  
  How often this schedule will create transactions
- start_date string
  
  Automatically create transactions from this date
- end_date string
  
  Stop automatically creating transactions after this date
- next_transaction_date string
  
  Date the next transaction will be created from this schedule
- paused_until string
  
  Pause creating transactions up until this date

PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/transaction-schedule/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 '{"type":"transfer","sub_type":"product_fees","amount":1099,"frequency":"weekly","start_date":"2025-06-26","end_date":"2028-03-22","provider_controlled":false,"paused_until":"2026-02-26 11:37:07"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "type": "transfer",
  "sub_type": "product_fees",
  "amount": 1099,
  "frequency": "weekly",
  "start_date": "2025-06-26",
  "end_date": "2028-03-22",
  "provider_controlled": false,
  "paused_until": "2026-02-26 11:37:07"
}

Response examples (200)

{
  "plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "daf6bb93-1043-4aca-964f-b65e1d4a2dd4",
    "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-06-26T11:37:07+01:00",
    "valued_at": "2025-06-26T11:37:07+01:00",
    "created_at": "2025-06-26T11:37:07+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-06-26T11:37:07+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-06-26T11:37:07+01:00",
    "review_date": "2024-06-26",
    "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-06-25T11:37:07+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-06-26",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "type": "contribution",
  "uuid": "03de47ad-28a3-430c-a75f-bb3842214534",
  "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": "167d4ba9-e954-4948-80bd-d5a9f3edbebe",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-26T11:37:07+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:07+01:00",
    "with_login": true,
    "inactive_at": "2025-06-26",
    "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-06-26T11:37:07+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-26T11:37:07+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-06-26T11:37:07+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-26T11:37:07+01:00"
  },
  "holding": {
    "citi": "ACB123",
    "isin": "ACB123",
    "uuid": "2751a218-c0c8-472a-a537-c1a2a8d14e5f",
    "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-06-26T11:37:07+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-06-26T11:37:07+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-06-26",
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "9f5eb859-4174-4b09-a363-50f48cae414f",
    "created_at": "2025-06-26T11:37:07+01:00",
    "updated_at": "2025-06-26T11:37:07+01:00"
  },
  "sub_type": "product_fees",
  "frequency": "monthly",
  "created_at": "2025-06-26T11:37:07+01:00",
  "start_date": "2025-06-26",
  "updated_at": "2025-06-26T11:37:07+01:00",
  "sub_account": {
    "name": "John's ISA",
    "uuid": "c0dd808e-ecb8-44a2-a594-0c9e0eb23810",
    "created_at": "2025-06-26T11:37:07+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-06-26T11:37:07+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-06-26T11:37:07+01:00",
  "provider_controlled": true,
  "next_transaction_date": "2025-07-26"
}