NetSuite icon

NetSuite

NetSuite REST API

Actions7

Execute SuiteQL

AI-generated

Overview

This node operation executes SuiteQL queries against the NetSuite platform. It allows users to run custom SQL-like queries to retrieve data from NetSuite records efficiently. This is useful for advanced data retrieval scenarios where standard record listing or filtering is insufficient, such as complex joins or aggregations.

Use Case Examples

  1. A user wants to extract detailed sales data combining multiple record types using a SuiteQL query.
  2. A user needs to run a custom report query on NetSuite data and retrieve all matching records with pagination support.

Properties

Name Meaning
Query The SuiteQL query string to execute against NetSuite.
Return All Whether to return all results or limit the number of records returned.
Limit The maximum number of records to return when 'Return All' is false.
Offset The number of records to skip before starting to return records, used for pagination.
API Version The version of the NetSuite API to use for the request.
Options Additional options such as concurrency for controlling parallel requests and whether to return the full response.

Output

JSON

  • json
    • hasMore - Indicates if there are more records available beyond the current response.
    • items - Array of records returned by the SuiteQL query.
    • links - Links for pagination such as the next page URL.
    • count - Number of records returned in the current response.
    • totalResults - Total number of records matching the query.
    • offset - The offset used in the query for pagination.

Dependencies

  • NetSuite API credentials (account ID, consumer key, consumer secret, token key, token secret)

Troubleshooting

  • Ensure the SuiteQL query syntax is correct and valid for NetSuite's SuiteQL engine.
  • If the node throws an error about unsupported operations, verify the operation parameter is set to 'runSuiteQL'.
  • Check API credentials and permissions to ensure the user has access to run SuiteQL queries.
  • If pagination is not working as expected, verify the 'Return All', 'Limit', and 'Offset' parameters are set correctly.

Links

Discussion