NetSuite Report Properties with...

Starting in your NetSuite account, running reports involves checking available reports, determining necessary parameters like subsidiary filters and date ranges, and executing the report tool effectively.

Key Features of the Run Report Tool

Checking Available Reports: Use the ns_listAllReports function to identify standard and custom reports and obtain their IDs.
Subsidiary Support: If the report mandates a subsidiary filter, leverage ns_getSubsidiaries to retrieve the internal ID of the subsidiaries.

Essential Properties for Report Execution

Running a report demands specific properties, outlined in the table below:

Property	Type	Requirement	Description
`reportId`	number	Required	The internal ID of the report.
`dateFrom`	string	Required for from-to date type, optional for as-of date type	Start date for the report.
`dateTo`	string	Required	End date for the report.
`subsidiaryId`	number	Required if subsidiary filter is used and account has subsidiaries, optional otherwise	Internal ID of the desired subsidiary.

Note: Ensure that all date parameters are accurate to avoid unpredictable AI client responses.

Permissions

Access to running reports depends on the permissions set within your NetSuite role; however, no additional permissions are necessary to see this tool in the AI client.

Who This Affects

This tool primarily impacts developers and administrators who are involved in generating reports that require subsidiary-specific data filtering.

Key Takeaways

Use ns_listAllReports to verify and select available reports.
Ensure required parameters like dates and subsidiary filters are provided.
Permissions are role-dependent but no special permissions are needed in the AI client.
Be prepared for AI client behavior if date information is incomplete.

Frequently Asked Questions (4)

Is the `reportId` a unique identifier across all reports in NetSuite?

Yes, the `reportId` is the internal ID of the specific report you’re working with in NetSuite and serves as the primary reference point, ensuring you are modifying or running the correct report.

When is the `subsidiaryId` property required in a report?

The `subsidiaryId` property is required when your NetSuite account includes subsidiaries and you are using the subsidiary filter; it allows for filtering report data accordingly.

What happens if I forget to specify the `dateFrom` and `dateTo` properties in my report?

If you don't specify the `dateFrom` and `dateTo` properties for date range reports, you may retrieve incorrect data periods or no data at all, impacting the accuracy of your analysis.

Do I need to enable any specific features in NetSuite to utilize multi-subsidiary reporting with the `subsidiaryId`?

No additional feature flags need to be enabled; however, it is important to be familiar with the internal IDs and how to use tools like `ns_getSubsidiaries` to retrieve valid subsidiary IDs effectively.

NetSuite Report Properties with Subsidiary Filters