Get all transactions

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

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required

    The uuid of a Plan.

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[subaccount] string

    Comma separated list of sub account UUIDs to filter by

  • filter[holding] string

    Comma separated list of holding UUIDs to filter by

  • filter[type] string

    Comma separated list of types to filter by

  • filter[sub_type] string

    Comma separated list of sub-types to filter by

  • filter[date_from] string

    Get transactions from a date.

  • filter[date_to] string

    Get transactions to a date.

  • filter[amount_from] string

    Get transactions greater than or equal to an amount in pennies.

  • filter[amount_to] string

    Get transactions less than or equal to an amount in pennies.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, type, amount, date]. Negative sign to denote DESC. Defaults to '-date'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • plan object
        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
        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
        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
        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
      • transaction_schedule object
        Hide transaction_schedule attributes Show transaction_schedule attributes object
        • uuid string
        • created_at string
        • updated_at string
        • plan string
        • sub_account string
        • holding string
        • account string
        • provider string
        • provider_controlled boolean
        • type string
        • sub_type string
        • amount object
          Hide amount attributes Show amount attributes object
          • amount string
          • currency string
          • formatted string
        • frequency string
        • start_date string
        • end_date string
        • next_transaction_date string
        • paused_until string
      • provider object
        Hide provider attributes Show provider attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • slug string
      • type string
      • sub_type string
      • amount object
        Hide amount attributes Show amount attributes object
        • amount string
        • currency string
        • formatted string
      • date string
      • notes string
      • status string
      • editable boolean
GET /api/v1/plans/{plan_uuid}/transaction
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/dcf0-484e-a0c5-08590fe89a84-f6aa1670/transaction' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": [
    {
      "date": "2025-07-17",
      "plan": {
        "name": "Johns ISA",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "cash_account",
        "uuid": "40ca997b-4bb5-48aa-b932-8d768e432efe",
        "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-07-17T16:23:23+01:00",
        "valued_at": "2025-07-17T16:23:23+01:00",
        "created_at": "2025-07-17T16:23:23+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-07-17T16:23:23+01:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2025-07-17T16:23:23+01:00",
        "review_date": "2024-07-17",
        "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-07-16T16:23:23+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-07-17",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "type": "contribution",
      "uuid": "1e8870e4-299c-4e71-9cc1-6a28a38c8c4d",
      "notes": "Withdrawal from ISA",
      "amount": {
        "amount": "1099",
        "currency": "GBP",
        "formatted": "£10.99"
      },
      "status": "Completed",
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "492bf514-41f8-4d7e-884d-9213def59f0e",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-07-17T16:23:23+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-07-17T16:23:23+01:00",
        "with_login": true,
        "inactive_at": "2025-07-17",
        "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-07-17T16:23:23+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-07-17T16:23:23+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-07-17T16:23:23+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-07-17T16:23:23+01:00"
      },
      "holding": {
        "citi": "ACB123",
        "isin": "ACB123",
        "uuid": "6cf99569-3670-4fd8-a6e8-f7247a3c6285",
        "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-07-17T16:23:23+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-07-17T16:23:23+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"
      },
      "editable": true,
      "provider": {
        "name": "AJ Bell",
        "slug": "aj-bell",
        "uuid": "479e941a-3e87-485f-82b5-e2c4e226ac43",
        "created_at": "2025-07-17T16:23:23+01:00",
        "updated_at": "2025-07-17T16:23:23+01:00"
      },
      "sub_type": "product_fees",
      "created_at": "2025-07-17T16:23:23+01:00",
      "updated_at": "2025-07-17T16:23:23+01:00",
      "sub_account": {
        "name": "John's ISA",
        "uuid": "e6cd87e8-2521-4abe-bd38-8207492f582f",
        "created_at": "2025-07-17T16:23:23+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-07-17T16:23:23+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": "eb9a638d-9d5b-4a96-a04e-008b2e9315ed",
        "amount": {
          "amount": "1099",
          "currency": "GBP",
          "formatted": "£10.99"
        },
        "account": "App\\Http\\Resources\\AccountResource",
        "holding": "App\\Http\\Resources\\Plans\\HoldingResource",
        "end_date": "2026-07-17",
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "sub_type": "product_fees",
        "frequency": "monthly",
        "created_at": "2025-07-17T16:23:23+01:00",
        "start_date": "2025-07-17",
        "updated_at": "2025-07-17T16:23:23+01:00",
        "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "paused_until": "2025-07-17T16:23:23+01:00",
        "provider_controlled": true,
        "next_transaction_date": "2025-08-17"
      }
    }
  ]
}