NetSuite icon

NetSuite

NetSuite REST API

Actions7

List Records

AI-generated

Overview

This node operation lists records from NetSuite based on the specified record type and query parameters. It supports fetching all records or a limited subset with pagination options like limit and offset. The operation is useful for retrieving data such as sales orders, customers, invoices, or custom records from NetSuite for further processing or integration in workflows.

Use Case Examples

  1. Retrieve all sales orders from NetSuite to process in an automation workflow.
  2. Fetch a limited number of customer records with a specific query filter for reporting purposes.
  3. List custom records by specifying the custom record script ID to integrate with other systems.

Properties

Name Meaning
Record Type Specifies the type of NetSuite record to list, e.g., salesOrder, customer, invoice, or custom record types.
Custom Record Script ID Internal identifier of the Custom Record type, required if Record Type is custom.
Query Optional SuiteQL or filter query string to refine the records returned.
Return All Boolean flag to return all matching records or limit the number returned.
Limit Maximum number of records to return if Return All is false.
Offset Number of records to skip before starting to return records, used for pagination.
API Version Version of the NetSuite API to use for the request.
Options Additional options such as concurrency for parallel requests and fullResponse to return the complete API response.

Output

JSON

  • json - Array of records returned from NetSuite, each item contains the JSON representation of a record.

Dependencies

  • NetSuite REST API client library
  • An API key credential for NetSuite authentication

Troubleshooting

  • Ensure correct API credentials are provided to avoid authentication errors.
  • If the operation returns an error about unsupported operations, verify the operation name is correctly set to 'listRecords'.
  • Pagination parameters like limit and offset must be within allowed ranges; otherwise, the API may return errors or incomplete data.
  • Network or API rate limiting issues may occur if concurrency is set too high; adjust concurrency accordingly.

Links

Discussion