Create report

Create a Report

Create a report based on both a specific report ID and specific objects.

See Parameters below.

Sample Request

{"report_id": "",
 "report_type": "EntityReport",
 "report":
  {"fields": "203844",
   "sort_fields": "203844",
   "name": "v3 test sonali 3",
   "output": "pdf",
   "size": "Letter",
   "orientation": "1",
   "has_gridlines": "1",
   "font_size": "12",
   "entity_id": "12993",
   "sum_currency": "true",
   "sum_number": "false",
   "company_logo": "true",
   "reportable_id": "",
   "depreciable_object": "0",
   "begin_date": "",
   "end_date": "",
   "appreciable_object": "false",
   "appreciation_start_date": "",
   "appreciation_end_date": "",
   "default_image": "true",
   "group_page_break": "false"},
 "entity_embed_yn": "false",
 "object_selector": "0",
 "reportable_value": ""
}

Parameters

See both the Body Parameters table and Reports Object List below.

Body Parameters	Required/Optional	Description	Type
`report_id`	required	Value of the report(s) you want to create.	string
`report_type`	required	The type of report you want to create.	string
`report`	required	List of required, specific objects you want to be included within your report. See Report Objects List below.	object
`object_selector`	required	The categories to group reports by.	string
`reportable_value`	required	The value in which to report.	string

Reports Object List

fields: The list of available fields that can be selected to include within the report.
sort_fields: The fields that have been selected to be included within the report.
name: The name of the report.
output: The output of the report (pdf, csv, Excel, screen).
size: The size (letter or A4) of the page.
orientation: The orientation (landscape or portrait) of the page.
has_gridlines: Allows gridlines (or not) to display on the report.
font_size: The size of the font on the report.
entity_id: The ID of the group you want to pull information from.
sum_currency: Included in reports that use currency fields. This selection provides total sums in the report when selected and is set to true by default (when pdf output is selected).
sum_number: Included in reports that use numeric fields. This selection provides numeric totals in the report when selected and is set to false by default (when pdf output is selected).
company_logo: Select to display a company logo on the report (or not).
reportable_id: Dependent on the report type (group, action, etc.).
depreciable_object: Allows the object to depreciate in value (or not).
begin_date: The date on which to begin gathering data for the report.
end_date: The date on which to conclude gathering data for the report.
appreciable_object: Allows the object to appreciate in value (or not).
appreciation_start_date: Selects the start date for the object to begin its appreciation of value.
appreciation_end_date: Selects the end date for the object to end its appreciation of value.
default_image: Allows a default image to display on the report (or not).
group_page_break: Allows for page breaks (between groups) within the report.