ns_runReport

Tool Description

Runs a report in your NetSuite account and displays the results.

You can run ns_listAllReports to obtain the list of available standard and custom reports, and their corresponding IDs.

Before running any report, this tool first calls ns_listAllReports to check if the report exists and find out which parameters are needed. If the report uses the subsidiary filter, this tool calls ns_getSubsidiaries to get the subsidiaries in your account.

Note:

Required date inputs vary by report. If a date is missing, the AI client may return an error, make assumptions, or ask you for more information, and its response may not always be predictable. Including all relevant date information in your request can help the AI process your report more effectively.

For known limitations when running reports from the AI client, see Known Limitations of the Report Tools.

Annotation

Run Report

Properties

Property	Type	Required or Optional	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. This date is required for reports that use from-to dates, and optional for reports that use as-of dates.
`dateTo`	string	Required	End date for the report.
`subsidiaryId`	number	Required if the report has a subsidiary filter and your account has subsidiaries, optional otherwise.	The internal ID of the subsidiary you want to filter the results by. This parameter is required if both of these conditions are true: The report uses the subsidiary filter. The NetSuite account has subsidiaries. You can run the ns_getSubsidiaries tool to get a list of subsidiaries in your account.

Property

Type

Required or Optional

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.

This date is required for reports that use from-to dates, and optional for reports that use as-of dates.

dateTo

string

Required

End date for the report.

subsidiaryId

number

Required if the report has a subsidiary filter and your account has subsidiaries, optional otherwise.

The internal ID of the subsidiary you want to filter the results by.

This parameter is required if both of these conditions are true:

The report uses the subsidiary filter.
The NetSuite account has subsidiaries.

You can run the ns_getSubsidiaries tool to get a list of subsidiaries in your account.

Permissions

There are no specific permission requirements to see this tool in the AI client. However, your ability to run reports depends on the permissions assigned to your NetSuite role.

Properties

Permissions

Related Topics