Records (List)
AI-generatedOverview
This node integrates with the NetSuite API using Token-Based Authentication (OAuth 1.0a HMAC-SHA256) to perform various operations including generic HTTP requests, CRUD operations on records, listing records, and executing SuiteQL queries. Specifically, the 'Records (List)' operation allows users to retrieve lists of records of a specified type from NetSuite, with options to control pagination and response detail. This is useful for scenarios where users need to fetch multiple records for processing, reporting, or synchronization with other systems, such as listing customers, sales orders, or custom record types.
Use Case Examples
- Fetching a list of customer records with a limit of 100 entries.
- Retrieving all sales orders without pagination limits.
- Using offset and limit to paginate through large sets of custom records.
Properties
| Name | Meaning |
|---|---|
| Record Type | Specifies the type of NetSuite record to list, e.g., customer, salesOrder, or a custom record type. |
| Return All | Determines whether to return all records or limit the number of records returned. |
| Limit | Specifies the maximum number of records to return when 'Return All' is false. The value ranges from 1 to 1000. |
| Offset | Specifies the number of records to skip before starting to return records, useful for pagination. |
| Return Full Response | If true, returns the full API response including metadata, not just the records. |
| Add Prefer: transient Header | If true, adds a 'Prefer: transient' header to the API request, which may affect how the server processes the request. |
Output
JSON
records- Array of records retrieved from NetSuite based on the specified record type and query parameters.fullResponse- Optional full API response including metadata if 'Return Full Response' is enabled.
Dependencies
- NetSuite API with Token-Based Authentication (OAuth 1.0a HMAC-SHA256)
Troubleshooting
- Ensure that the NetSuite credentials (Token-Based Authentication) are correctly configured and valid to avoid authentication errors.
- If the node returns an error about record types, verify that the specified record type exists and is accessible with the provided credentials.
- When using pagination (Limit and Offset), ensure the values are within allowed ranges to prevent API errors.
- If 'Return Full Response' is enabled, be prepared to handle additional metadata fields in the output.
- Network or API rate limit errors may occur; consider implementing retry logic or adjusting request frequency.
Links
- NetSuite API Documentation - Official documentation for NetSuite APIs including REST and SuiteQL.
- SuiteQL Documentation - Details on using SuiteQL queries within NetSuite.