SuiteQL
AI-generatedOverview
This node executes SuiteQL queries against the NetSuite platform using Token-Based Authentication (OAuth 1.0a HMAC-SHA256). It allows users to run custom SQL-like queries to retrieve data from NetSuite records efficiently. This is useful for scenarios where complex data retrieval is needed beyond standard CRUD operations, such as generating custom reports or extracting specific datasets from NetSuite.
Use Case Examples
- Retrieve a list of customer IDs using a SuiteQL query.
- Fetch a limited number of sales orders with pagination using offset and limit parameters.
- Execute a SuiteQL query and return the full API response for detailed inspection.
Properties
| Name | Meaning |
|---|---|
| Query | The SuiteQL query to execute, written in JSON format with a 'q' key containing the SQL-like query string. |
| Return All | Boolean flag to determine whether to return all results or limit the output. |
| Limit | Maximum number of records to return when 'Return All' is false. Range is 1 to 1000. |
| Offset | Number of records to skip before starting to return results, useful for pagination. |
| Return Full Response | Boolean flag to return the full API response instead of just the data records. |
| Add Prefer: transient Header | Boolean flag to add the 'Prefer: transient' header to the request, which may affect how the API processes the query. |
Output
JSON
id- The unique identifier of the record returned by the SuiteQL query.any other fields- Additional fields returned by the SuiteQL query as specified in the SELECT statement.
Dependencies
- NetSuite API with Token-Based Authentication (OAuth 1.0a HMAC-SHA256)
Troubleshooting
- Ensure the SuiteQL query syntax is correct and valid for NetSuite's SuiteQL engine.
- Verify that the API credentials (Token-Based Authentication) are correctly configured and have sufficient permissions.
- If the node returns an error, check if the 'Continue On Fail' option is enabled to handle errors gracefully.
- Pagination parameters (limit and offset) should be within allowed ranges to avoid errors.
Links
- NetSuite SuiteQL Documentation - Official documentation for SuiteQL queries in NetSuite.
- NetSuite REST API Documentation - General information about NetSuite REST APIs including authentication and usage.