Create a transaction schedule

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

Headers

Path parameters

plan_uuid string Required

application/json

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

Responses

201 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
  
  Additional properties are allowed.
- sub_account object
  
  Sub account of the transaction
  
  Additional properties are allowed.
- holding object
  
  Holding of the subaccount
  
  Additional properties are allowed.
- account object
  
  Account that added the transaction
  
  Additional properties are allowed.
- provider object
  
  Provider that created this transaction
  
  Additional properties are allowed.
- 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
  
  Additional properties are allowed.
- 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

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

curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction-schedule \
 -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 '{"sub_account_uuid":"fe9f2084-aee1-40eb-ab49-4675e8176060","holding_uuid":"d305dac7-5564-4031-87ee-9c6ba663bf99","type":"transfer","sub_type":"product_fees","amount":1099,"frequency":"weekly","start_date":"2024-11-20","end_date":"2027-08-17","provider_controlled":false,"backdate_transactions":true}'

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
{
  "sub_account_uuid": "fe9f2084-aee1-40eb-ab49-4675e8176060",
  "holding_uuid": "d305dac7-5564-4031-87ee-9c6ba663bf99",
  "type": "transfer",
  "sub_type": "product_fees",
  "amount": 1099,
  "frequency": "weekly",
  "start_date": "2024-11-20",
  "end_date": "2027-08-17",
  "provider_controlled": false,
  "backdate_transactions": true
}

Response examples (201)

{
  "plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "610b85ac-79ef-42a1-a5cf-e0bd2b368ec6",
    "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",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2024-11-20T13:24:02+00:00",
    "valued_at": "2024-11-20T13:24:02+00:00",
    "created_at": "2024-11-20T13:24:02+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:02+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:02+00:00",
    "review_date": "2023-11-20",
    "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",
    "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": "2023-11-20",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "type": "contribution",
  "uuid": "2b8e4e7c-606a-4523-8851-a623c7b5a690",
  "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": "cb28e1e2-db8e-4b47-9307-7dd187eab24c",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:02+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:02+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:02+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:02+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:02+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:02+00:00"
  },
  "holding": {
    "citi": "ACB123",
    "isin": "ACB123",
    "uuid": "ded54d7c-ef1d-4518-b279-51590a944e6f",
    "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": "2024-11-20T13:24:02+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": "2024-11-20T13:24:02+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
  },
  "end_date": "2025-11-20",
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "40ec2abb-8f59-40a8-9ba0-552e1d5ecaaf",
    "created_at": "2024-11-20T13:24:02+00:00",
    "updated_at": "2024-11-20T13:24:02+00:00"
  },
  "sub_type": "product_fees",
  "frequency": "monthly",
  "created_at": "2024-11-20T13:24:02+00:00",
  "start_date": "2024-11-20",
  "updated_at": "2024-11-20T13:24:02+00:00",
  "sub_account": {
    "name": "John's ISA",
    "uuid": "f8673eed-8f05-4ffd-acbf-26eee8a6781c",
    "created_at": "2024-11-20T13:24:02+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:02+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": "2024-11-20T13:24:02+00:00",
  "provider_controlled": true,
  "next_transaction_date": "2024-12-20"
}