# Generate a new Report

**POST /api/v1/report**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters



### Body: application/json (object)

- **name** (string)
  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, valuation_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.


## Responses
### 201


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **last_interaction_at** (string)
  Last interaction date of an account associated with this report
- **last_login_at** (string)
  Last login date of an account associated with this report
- **name** (string)
  Name of the report
- **created_by** (object)
  the account that created this report
- **report_type_id** (string)
  report type id
- **status** (string)
  Current status of report generation
- **progress** (integer)
  Current progress of the report when generating
- **files** (array[object])
  Files generated for this report instance
- **folder** (object)
  Folder generated with the report. this is the default folder that all generated documents will be stored


[Powered by Bump.sh](https://bump.sh)