What are Custom Records in NetSuite?

All information in your NetSuite account is tracked using records.

Administrators and users with permission for Custom Record Entries can also create custom records that collect information specific to the needs of your business.

Custom Record Type

Custom Record Instance

Including Custom Records in your fetch

By default, you will fetch only Custom Record Types. You may choose to exclude some or all custom record types, using the exclude section (same as you would do for any other type).

Fetching Custom Record Instance(s)

Add the customRecords segment into your adapter configuration (e.g. netsuite.nacl) inside the include section.

Adapter configuration is auto-saved, so you only need to run Fetch again after changing the configuration.

Fetching Specific Custom Record Instances

Here's an example of including all instances of the specific custom record type customrecord108:

include = {
      types = [
        ...
      ]
      fileCabinet = [
        ...
      ]
      customRecords = [
        {
          name = "customrecord108"
        }
      ]
    }

Fetching All Custom Records Instances

Here's an example of including all instances of all custom record types:

Please note, this may increase your fetch time

include = {
      types = [
        ...
      ]
      fileCabinet = [
        ...
      ]
      customRecords = [
        {
          name = ".*"
        }
      ]
    }

Excluding Custom Records from your fetch

As the default behavior is to fetch all your custom record types, you may wish to specifically exclude some/all types/instances.

Excluding custom record types from your fetch can reduce fetch time.

Custom record types that are referenced will be replaced with “SDF reference” format, e.g. "[scriptid=customrecord_108]".

Excluding Specific Custom Record Type

Here's an example of excluding a specific custom record type customrecord108:

exclude = {
      name = "customrecord108"
      ids = [
        "customrecord_108",
      ]
    }

Excluding All Instances of a Specific Custom Record

Here's an example of excluding all instances of a specific custom record type customrecord108:

exclude = {
      customRecords = [
        {
          name = "customrecord_108"
        }
      ]
    }

Excluding All Custom Record Types

Here's an example of excluding all custom record types

Please note, you need to add a line per custom record prefix.

exclude = {
        name = "customrecordtype"
    }