Create a transaction

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

Personal access token & O auth2

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
date date Required

Transaction 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
- sub_account object
  
  Sub account of the transaction
- holding object
  
  Holding of the subaccount
- account object
  
  Account that added the transaction
- transaction_schedule object
  
  Schedule that created this transaction
- provider object
  
  Provider that created this transaction
- type string
  
  Transaction type
- sub_type string
  
  Transaction sub type
- amount object
  
  Transaction amount
- date string
  
  Transaction date
- notes string
  
  Transaction note

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

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction' \
 --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":"8336b7e0-7424-4e3a-b65e-e007e80fa542","holding_uuid":"97fb3a14-1ac9-4dc6-8577-0de25ac3d843","type":"transfer","sub_type":"product_fees","amount":1099,"date":"2025-04-02"}'

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": "8336b7e0-7424-4e3a-b65e-e007e80fa542",
  "holding_uuid": "97fb3a14-1ac9-4dc6-8577-0de25ac3d843",
  "type": "transfer",
  "sub_type": "product_fees",
  "amount": 1099,
  "date": "2025-04-02"
}

Response examples (201)

{
  "date": "2025-04-02",
  "plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "bb9022cb-f7bd-456c-996f-8011defaf8c5",
    "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-02T13:27:57+01:00",
    "valued_at": "2025-04-02T13:27:57+01:00",
    "created_at": "2025-04-02T13:27:57+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-04-02T13:27:57+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-04-02T13:27:57+01:00",
    "review_date": "2024-04-02",
    "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": "2024-04-02",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "type": "contribution",
  "uuid": "aff0b9d2-7e42-4044-b778-6df36aa0a9a7",
  "notes": "Withdrawal from ISA",
  "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": "d10c3671-8c45-42a7-847c-b5663dcbc480",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-02T13:27:57+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:57+01:00",
    "with_login": true,
    "inactive_at": "2025-04-02",
    "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-02T13:27:57+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-02T13:27:57+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-02T13:27:57+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-02T13:27:57+01:00"
  },
  "holding": {
    "citi": "ACB123",
    "isin": "ACB123",
    "uuid": "539e8e47-e92d-4953-a794-da794cbb432e",
    "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-02T13:27:57+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-02T13:27:57+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"
  },
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "915935c2-9f07-46bc-8058-805aaacb8b2b",
    "created_at": "2025-04-02T13:27:57+01:00",
    "updated_at": "2025-04-02T13:27:57+01:00"
  },
  "sub_type": "product_fees",
  "created_at": "2025-04-02T13:27:57+01:00",
  "updated_at": "2025-04-02T13:27:57+01:00",
  "sub_account": {
    "name": "John's ISA",
    "uuid": "7d6883e8-4741-479b-ad4b-cfc9710dda69",
    "created_at": "2025-04-02T13:27:57+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-04-02T13:27:57+01:00",
    "policy_number": "AVI-4837",
    "is_main_account": false,
    "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
    "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource"
  },
  "transaction_schedule": {
    "plan": "App\\Http\\Resources\\Plans\\PlanResource",
    "type": "contribution",
    "uuid": "ab045627-75e6-4978-b0ac-b8058e740b3d",
    "amount": {
      "amount": "1099",
      "currency": "GBP",
      "formatted": "£10.99"
    },
    "account": "App\\Http\\Resources\\AccountResource",
    "holding": "App\\Http\\Resources\\Plans\\HoldingResource",
    "end_date": "2026-04-02",
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "product_fees",
    "frequency": "monthly",
    "created_at": "2025-04-02T13:27:57+01:00",
    "start_date": "2025-04-02",
    "updated_at": "2025-04-02T13:27:57+01:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "paused_until": "2025-04-02T13:27:57+01:00",
    "provider_controlled": true,
    "next_transaction_date": "2025-05-02"
  }
}