# Create a transaction schedule

**POST /api/v1/plans/{plan_uuid}/transaction-schedule**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)


### Path parameters
- **plan_uuid** (string)



### Body: application/json (object)

- **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)
  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. 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


## Responses
### 201


#### Body: application/json (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
- **sub_account** (object)
  Sub account of the transaction
- **holding** (object)
  Holding of the subaccount
- **account** (object)
  Account that added the transaction
- **provider** (object)
  Provider that created this transaction
- **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
- **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


[Powered by Bump.sh](https://bump.sh)