Get all transaction schedules
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
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, start_date, next_transaction_date]. Negative sign to denote DESC. Defaults to '-start_date'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET /api/v1/plans/{plan_uuid}/transaction-schedule
curl \
-X GET 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}"
Response examples (200)
{
"data": [
{
"plan": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "c02fd2b9-edc0-4875-8128-3fd32b6a91ec",
"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": "a6a20248-575f-44d6-a581-9321eef5f5d6",
"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": "4447e8bb-b32f-4c23-970a-d1baf117c31b",
"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": "eab8fa71-6dec-48c3-861f-b9dae7181178",
"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
},
"end_date": "2025-10-16",
"provider": {
"name": "AJ Bell",
"slug": "aj-bell",
"uuid": "cce81836-aec6-4730-9311-649fabf883ab",
"created_at": "2024-10-16T11:10:16+01:00",
"updated_at": "2024-10-16T11:10:16+01:00"
},
"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": {
"name": "John's ISA",
"uuid": "f2dcb6d5-fcb7-4909-bceb-6ef75f026d7a",
"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"
},
"paused_until": "2024-10-16T11:10:16+01:00",
"provider_controlled": true,
"next_transaction_date": "2024-11-16"
}
]
}