Get a transaction

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

Path parameters

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction/uuid \
 -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}"
Response examples (200)
{
  "date": "2024-10-16",
  "plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "c85ee892-7c27-450c-b9f3-740a717619ab",
    "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": "2af20c51-12a9-44e5-a4f6-1a87128fdd43",
  "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": "c931d897-fa2d-4e08-b841-c526cf1a23bd",
    "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": "cb21f27c-a800-415e-9ea9-3d551baae000",
    "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": "ce795ce4-e720-465d-9075-6b4e109fe874",
    "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": "0d2c3c30-7125-4c3d-b25d-08e7b5f88a20",
    "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": "6f213228-cb05-4bc7-92f1-b3a750b0f733",
    "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"
  }
}