Report Filters MCP App

Tool Name

ns_report_filters_app

Tool Description

Helps you choose the filters needed to run a report in your NetSuite account.

The AI client can use this interactive MCP app when a report needs more information before it can be run. The app presents the available report filters in a guided interface so you can review, confirm, and adjust the values before running the report.

Before opening this app, the AI client may call ns_listAllReports to check whether the report exists and determine which parameters are allowed or required. It may also call any of the following helper tools to check for valid IDs or available values:

After you confirm the selections in the app, the AI uses the returned values to call ns_runReport and display the report results.

Annotation

NetSuite Report Filters

Properties

Note:

All properties are optional when opening this app. The AI client can prefill any known values, and the app determines which filters or options are required before the selected report can be run.

Property	Type	Required or Optional	Description
`reportId`	number	Optional	The internal ID of the NetSuite report to run.
`dateFrom`	string	Optional	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	Optional	End date for the report.
`subsidiaryId`	number	Optional	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. The list shows: Positive internal IDs for individual subsidiaries. Use this ID to view the report data for the selected subsidiary. Negative internal IDs for consolidated or context subsidiaries. Reports for a consolidated subsidiary display data for the selected subsidiary and its child subsidiaries. Reports for a context subsidiary display data for any child subsidiary you have access to, in the currency of the selected context subsidiary. For reports that support consolidation, you can specify a negative internal ID in this parameter.
`accountingContext`	number	Optional	The internal ID of the accounting context you want to filter the report results by. This parameter is valid only when the accounting context filter is available for the report and the NetSuite account has accounting contexts. You can run the ns_getAccountingContexts tool to get a list of accounting contexts in your account.
`book`	number	Optional	The internal ID of the primary accounting book you want to filter the report results by. This parameter is valid only when the accounting book filter is available for the report and the NetSuite account has accounting books. You can run the ns_getAccountingBooks tool to get a list of accounting books in your account.
`book2`	number	Optional	The internal ID of the second accounting book you want to filter the report results by. This parameter is required when the report has two accounting book filters (Multi-Book comparison reports) and the NetSuite account has accounting books. You can run the ns_getAccountingBooks tool to get a list of accounting books in your account.
`nexusId`	number	Optional	The internal ID of the nexus (tax jurisdiction) you want to filter report results by. This parameter is required when all the following conditions are true: The nexus filter is available for the report. The cash basis setting (`taxCashBasisMode`) for the report is set to Nexus. The NetSuite account has nexuses. You can run the ns_getNexusIds tool to get a list of nexuses in your account.
`periodEndTransactionReportMode`	boolean	Optional	Enables or disables the period end transaction report mode. This parameter is valid only if the period end mode switch is available for the report.
`range`	string	Optional	The column grouping for the report. This parameter is valid only when column grouping is available for the report.
`taxCashBasisMode`	string	Optional	Specifies whether the report uses cash basis, accrual basis, or nexus-based tax handling. This parameter is valid only when the report supports cash basis reporting. Valid values are: T (true) - Select this option if you want to use cash-basis tax data for the report. F (false) - Select this option if you want to use accrual-basis tax data for the report. NEXUS - Select this option if you want to use nexus settings for tax data. This option is valid only if the nexus filter is available for the report. When you select this option, you also need to specify a value for the `nexusId` parameter. You can run the ns_getNexusIds tool to get a list of nexuses in your account.

Property

Type

Required or Optional

Description

reportId

number

Optional

The internal ID of the NetSuite report to run.

dateFrom

string

Optional

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

Optional

End date for the report.

subsidiaryId

number

Optional

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. The list shows:

Positive internal IDs for individual subsidiaries. Use this ID to view the report data for the selected subsidiary.
Negative internal IDs for consolidated or context subsidiaries. Reports for a consolidated subsidiary display data for the selected subsidiary and its child subsidiaries. Reports for a context subsidiary display data for any child subsidiary you have access to, in the currency of the selected context subsidiary.

For reports that support consolidation, you can specify a negative internal ID in this parameter.

accountingContext

number

Optional

The internal ID of the accounting context you want to filter the report results by.

This parameter is valid only when the accounting context filter is available for the report and the NetSuite account has accounting contexts.

You can run the ns_getAccountingContexts tool to get a list of accounting contexts in your account.

book

number

Optional

The internal ID of the primary accounting book you want to filter the report results by.

This parameter is valid only when the accounting book filter is available for the report and the NetSuite account has accounting books.

You can run the ns_getAccountingBooks tool to get a list of accounting books in your account.

book2

number

Optional

The internal ID of the second accounting book you want to filter the report results by.

This parameter is required when the report has two accounting book filters (Multi-Book comparison reports) and the NetSuite account has accounting books.

You can run the ns_getAccountingBooks tool to get a list of accounting books in your account.

nexusId

number

Optional

The internal ID of the nexus (tax jurisdiction) you want to filter report results by.

This parameter is required when all the following conditions are true:

The nexus filter is available for the report.
The cash basis setting (taxCashBasisMode) for the report is set to Nexus.
The NetSuite account has nexuses.

You can run the ns_getNexusIds tool to get a list of nexuses in your account.

periodEndTransactionReportMode

boolean

Optional

Enables or disables the period end transaction report mode.

This parameter is valid only if the period end mode switch is available for the report.

range

string

Optional

The column grouping for the report.

This parameter is valid only when column grouping is available for the report.

taxCashBasisMode

string

Optional

Specifies whether the report uses cash basis, accrual basis, or nexus-based tax handling.

This parameter is valid only when the report supports cash basis reporting.

Valid values are:

T (true) - Select this option if you want to use cash-basis tax data for the report.
F (false) - Select this option if you want to use accrual-basis tax data for the report.
NEXUS - Select this option if you want to use nexus settings for tax data. This option is valid only if the nexus filter is available for the report. When you select this option, you also need to specify a value for the nexusId parameter.

You can run the ns_getNexusIds tool to get a list of nexuses 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