Generate a new Report Run in API Explorer
Body
-
Name of the report
-
Type of report to generate, available types are actual_vs_estimate_report, adviser_income_detailed, aged_debt_report, cases_export, charges_export, client_expenditure_export, client_export, conversion_pipeline, employee_export, form_submission_export, group_scheme_members_export, holding_export, income_reconciliation_export, new_business_export, new_business_summary_report, note_export, plan_export, premium_export, revenue_analysis_based_on_receipts, rmar, staff_member_export, task_export, time_entries, valuation_report
Values are
actual_vs_estimate_report,adviser_income_detailed,aged_debt_report,cases_export,charges_export,client_expenditure_export,client_export,conversion_pipeline,employee_export,form_submission_export,group_scheme_members_export,holding_export,income_reconciliation_export,new_business_export,new_business_summary_report,note_export,plan_export,premium_export,revenue_analysis_based_on_receipts,rmar,staff_member_export,task_export,time_entries, orvaluation_report. -
Report template uuid to generate a report from, required if no report id is passed
-
Extra query parameters that can be used to manipulate the report output, only works for new reports, for templates the data stored on the template will be used
Additional properties are allowed.
-
setting this to true will save this request as a template that can be reused, if no value is given this defaults to false, does not store a new template if a template if a template is passed
-
The name of the template to generate. Required if save_as_template is true.
curl \
--request POST 'https://api.plannrcrm.com/api/v1/report' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"name":"Client Export 22nd July","report_type_id":"actual_vs_estimate_report","report_template_uuid":"60301e34-d33d-4b67-a933-f0292d8a32e6","report_query":{"start_date":"2025-12-24T11:03:00+00:00"},"save_as_template":true,"template_name":"my-template"}'{
"name": "Client Export 22nd July",
"report_type_id": "actual_vs_estimate_report",
"report_template_uuid": "60301e34-d33d-4b67-a933-f0292d8a32e6",
"report_query": {
"start_date": "2025-12-24T11:03:00+00:00"
},
"save_as_template": true,
"template_name": "my-template"
}{
"name": "rmar-report-2025-12-24T11:03:00+00:00",
"uuid": "0b06e75e-bd93-491e-9dc4-3aa186427910",
"files": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "e395eed2-9a59-4320-9e52-345215e39d64",
"folder": "App\\Http\\Resources\\FolderResource",
"status": "uploaded",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "66ad0c2c-b578-4e85-aa4a-7a37df614299"
},
"created_at": "2025-12-24T11:03:00+00:00",
"updated_at": "2025-12-24T11:03:00+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-12-24T11:03:00+00:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/5f381da3-faed-4fca-99c2-d9969d36920d/download",
"last_modified": "2025-12-24T11:03:00+00:00",
"documentable_type": "account",
"original_created_at": "2025-12-24T11:03:00+00:00"
}
],
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "411ccc4e-deec-4a64-9524-3a8a96fae1d9",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-12-24T11:03:00+00:00",
"updated_at": "2025-12-24T11:03:00+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
},
"status": "complete",
"progress": 100,
"created_at": "2025-12-24T11:03:00+00:00",
"created_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "5f6dd9e5-776c-4d9d-9ee2-763a7f56e249",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-12-24T11:03:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:03:00+00:00",
"with_login": true,
"inactive_at": "2025-12-24",
"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-12-24T11:03:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-24T11:03:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2025-12-24 11:03:00",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-24T11:03:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-24T11:03:00+00:00"
},
"updated_at": "2025-12-24T11:03:00+00:00",
"last_login_at": "2024-01-24T09:15:00Z",
"report_type_id": "rmar",
"last_interaction_at": "2024-01-24T10:30:00Z"
}