The Hurdlr Embedded experience provides you with the capability to embed an interactive (drill-down) Balance Sheet report in your product, with options for customizing the time period grouping of the report.
1. Initializing the Embedded Experience
To initialize the Hurdlr Embedded experience in your project, follow the instructions on Embedding Hurdlr's white-labelled UI.
2. Rendering an interactive Balance Sheet report
To render a Balance Sheet report for a specific user, you will need to provide the elementId parameter, which is the HTML id of the main <div> where you would like the report to render. When your user clicks on the report element, you simply need to invoke the following line of javascript:
Hurdlr.renderReport(elementId, 'balanceSheet');
3. Populate the desired parameters
You can also pass in some optional parameters to specify the grouping and date range of the report.
| Parameter | Description | Format |
|---|---|---|
| grouping | The time period grouping of the report (e.g. for creating a month-over-month report). | Must be one of the following enumerations:NONE,MONTHLY, QUARTERLY, YEARLY |
| dateRange | The date range type of the report. | Must be one of the following enumerations:THIS_YEAR,LAST_YEAR, CUSTOM |
| beginMonth | The beginning month of the report. Should be used withcurrentDate set to CUSTOM and an active grouping. | Numeric |
| beginYear | The beginning year of the report. Should be used withcurrentDate set to CUSTOM and an active grouping. | Numeric |
| endMonth | The ending month of the report. Should be used withcurrentDate set to CUSTOM. | Numeric |
| endYear | The ending year of the report. Should be used withcurrentDate set to CUSTOM. | Numeric |
Pass these parameters in as an object to the renderReport call as follows:
Hurdlr.renderReport(elementId, 'balanceSheet', {
grouping: "MONTHLY",
dateRange: "CUSTOM",
beginMonth: 3,
endMonth: 12,
beginYear: 2024,
endYear: 2024
});