Headers
-
Content-Type
string -
Accept
string
Body
Required
-
name
string Required Name of the report
-
report_type_id
string 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, demo_report
-
report_template_uuid
string Report template uuid to generate a report from, required if no report id is passed
-
report_query
array[string] 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
-
save_as_template
boolean 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
-
template_name
string The name of the template to generate. Required if save_as_template is true.
POST
/api/v1/report
curl \
--request POST 'https://api.plannrcrm.com/api/v1/report' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"name":"Client Export 22nd July","report_type_id":"rmar","report_template_uuid":"c36b348e-4c94-48ea-8197-3a1d1f5fea4f","report_query":[{"start_date":"2025-04-02T13:27:58+01:00"}],"save_as_template":true,"template_name":"1"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
# Payload
{
"name": "Client Export 22nd July",
"report_type_id": "rmar",
"report_template_uuid": "c36b348e-4c94-48ea-8197-3a1d1f5fea4f",
"report_query": [
{
"start_date": "2025-04-02T13:27:58+01:00"
}
],
"save_as_template": true,
"template_name": "1"
}
Response examples (201)
{
"name": "rmar-report-2025-04-02T13:27:58+01:00",
"uuid": "334869aa-571d-47aa-92cb-198bfda73967",
"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": "3e88f0a3-c325-4b55-890e-e518554780bf",
"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": "e3591480-297a-4ca4-9f60-563b84eaa054"
},
"created_at": "2025-04-02T13:27:58+01:00",
"updated_at": "2025-04-02T13:27:58+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-02T13:27:58+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/9efcbff5-c82b-4da3-821d-a1227b1968d1/download",
"last_modified": "2025-04-02T13:27:58+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-02T13:27:58+01:00"
}
],
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "59e6ebc4-5078-4844-ab6f-9788fbb8a5d6",
"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-04-02T13:27:58+01:00",
"updated_at": "2025-04-02T13:27:58+01: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-04-02T13:27:58+01:00",
"created_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "69ba75aa-0302-4958-b561-32f042ec5b7a",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:58+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:58+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"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-04-02T13:27:58+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:58+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-04-02T13:27:58+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:58+01:00"
},
"updated_at": "2025-04-02T13:27:58+01:00",
"report_type_id": "rmar"
}