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 standard reports and their corresponding IDs. Customized reports are not included in the list returned by the ns_listAllReports tool, but you can run them using ns_runReport by providing the custom report internal ID.

Take note of the following:

  • Accounting periods are not supported. Currently, the report tools ignore the Report by Period user preference. The AI client won't be able to see the accounting periods that you have set up in your NetSuite account, and may use the calendar year as the fiscal year or ask you to provide more details about your fiscal year.

  • Only date filters are supported when running the reports. Other filters or report footer options available in the UI are currently not supported by the report tools.

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.

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.

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.

Related Topics

General Notices