Create a transaction

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

Headers

Path parameters

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
POST /api/v1/plans/{plan_uuid}/transaction 
curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction \
 -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":"a528cc06-8d26-4c15-850b-4ba8f07e1d97","holding_uuid":"6d4565c4-efd2-45e2-a22f-c68f04dd866d","type":"transfer","sub_type":"product_fees","amount":1099,"date":"2024-10-16"}'
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": "a528cc06-8d26-4c15-850b-4ba8f07e1d97",
  "holding_uuid": "6d4565c4-efd2-45e2-a22f-c68f04dd866d",
  "type": "transfer",
  "sub_type": "product_fees",
  "amount": 1099,
  "date": "2024-10-16"
}
Response examples (201) 
{
  "date": "2024-10-16",
  "plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "e3cea42f-e03f-4b95-95fa-2f1bd03c5bd8",
    "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-10-16T11:10:16+01:00",
    "valued_at": "2024-10-16T11:10:16+01:00",
    "created_at": "2024-10-16T11:10:16+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-10-16T11:10:16+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-10-16T11:10:16+01:00",
    "review_date": "2023-10-16",
    "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-10-16",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "type": "contribution",
  "uuid": "63697f5a-1e35-4ba7-ab4b-bca412b5fbd7",
  "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": "ebac093a-8b42-4dec-9f2f-4d1caa10ba77",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:16+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:16+01: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-10-16T11:10:16+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:16+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:16+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:16+01:00"
  },
  "holding": {
    "citi": "ACB123",
    "isin": "ACB123",
    "uuid": "72f2720f-f57f-4edc-995b-9392e0d75ebe",
    "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-10-16T11:10:16+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": "2024-10-16T11:10:16+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
  },
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "9bae2222-b4f7-408c-ab17-47a1c386da52",
    "created_at": "2024-10-16T11:10:16+01:00",
    "updated_at": "2024-10-16T11:10:16+01:00"
  },
  "sub_type": "product_fees",
  "created_at": "2024-10-16T11:10:16+01:00",
  "updated_at": "2024-10-16T11:10:16+01:00",
  "sub_account": {
    "name": "John's ISA",
    "uuid": "09fb8eaa-9a7a-4199-ba59-be7f4480a6bc",
    "created_at": "2024-10-16T11:10:16+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-10-16T11:10:16+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": "e0d7bff3-098c-4c19-aca9-500635876a03",
    "amount": {
      "amount": "1099",
      "currency": "GBP",
      "formatted": "£10.99"
    },
    "account": "App\\Http\\Resources\\AccountResource",
    "holding": "App\\Http\\Resources\\Plans\\HoldingResource",
    "end_date": "2025-10-16",
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "product_fees",
    "frequency": "monthly",
    "created_at": "2024-10-16T11:10:16+01:00",
    "start_date": "2024-10-16",
    "updated_at": "2024-10-16T11:10:16+01:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "paused_until": "2024-10-16T11:10:16+01:00",
    "provider_controlled": true,
    "next_transaction_date": "2024-11-16"
  }
}