Overview
This node integrates with the NetSuite REST API to perform various operations on NetSuite records. Specifically, the "List Records" operation retrieves multiple records of a specified type from NetSuite, supporting pagination and filtering via queries.
Common scenarios where this node is beneficial include:
- Extracting lists of customers, sales orders, or invoices for reporting or synchronization.
- Retrieving custom record types for specialized business data.
- Running SuiteQL queries to fetch complex datasets.
Practical example: A user wants to retrieve all open sales orders up to a limit of 500 records to process them in another system. They select "Sales Order" as the record type, set "Return All" to false, and specify a limit of 500. The node then fetches these records efficiently using the NetSuite REST API.
Properties
| Name | Meaning |
|---|---|
| Record Type | The type of NetSuite record to list. Options include standard records like "Assembly Item", "Customer", "Invoice", "Sales Order", and many others. Selecting "Custom Record (*)" requires specifying the script ID below. |
| Custom Record Script ID | Required if "Custom Record (*)" is selected as the record type. This is the internal identifier (script ID) of the custom record type, usually starting with "customrecord". |
| Query | Optional SuiteQL or filter query string to refine which records are returned. |
| Return All | Boolean flag indicating whether to return all matching records or only up to a specified limit. |
| Limit | When "Return All" is false, limits the number of records returned. Minimum 1, maximum 1000. Defaults to 100. |
| Offset | When "Return All" is false, specifies how many records to skip before starting to return results. Useful for pagination. |
| API Version | The version of the NetSuite REST API to use. Currently only "v1" is supported. |
| Options | Additional options including: - Concurrency: Maximum number of simultaneous REST requests sent to NetSuite (default 1). - Full Response: Whether to return the full HTTP response instead of just the body. |
Output
The output consists of an array of JSON objects representing the retrieved NetSuite records. Each item corresponds to one record and contains its fields as key-value pairs.
If the "Full Response" option is enabled, the output includes the entire HTTP response details such as status code and headers.
No binary data output is produced by this operation.
Dependencies
- Requires valid NetSuite API credentials with appropriate permissions to access the requested record types.
- Uses the NetSuite REST API endpoint corresponding to the configured account.
- Supports concurrency control to manage rate limits and optimize performance.
- No additional external services beyond NetSuite are required.
Troubleshooting
Common Issues:
- Incorrect or missing credentials will cause authentication failures.
- Specifying an invalid record type or custom record script ID will result in errors.
- Exceeding API limits may cause throttling or partial results.
- Improperly formatted queries can lead to request failures.
Error Messages:
"The operation \"listRecords\" is not supported!"— indicates an unsupported operation was requested; verify the operation name.- Authentication errors typically mention invalid tokens or permission denied; ensure credentials are correct and have sufficient rights.
- Validation errors may include property validation details in the response headers; review these to fix input parameters.
Resolutions:
- Double-check API credentials and permissions.
- Confirm the record type and custom record script ID are accurate.
- Use the "Limit" and "Offset" properties to paginate large datasets.
- Validate query syntax according to NetSuite SuiteQL or REST API documentation.
Links and References
- NetSuite REST API Documentation
- SuiteQL Query Language Guide
- NetSuite Records Browser (for record type references)