Covered in this article
Netsuite component pages
Created on Updated on
NetSuite component

NetSuite actions

NetSuite component actions.

Delete Object By Id

Deletes an object by the ID provided.

Delete Object By Id. Config fields

  • Object Category - a category of an object in NetSuite
    • Standard
    • Custom
  • Object Type - an object in NetSuite (Contact, Customer etc.). Fetches dynamically.

Delete Object By Id. Input Metadata

Is being fetched dynamically. The sample:

Input metadata for Transaction objects:

{
  "internalId": "string",
  "externalId": "string",
  "deletionReasonCode": "deleteionReasonCodeString",
  "deletionReasonMemo": "deletionReasonMemoString"
}

Deletion Reason Usage Notes

Click to expand > Note the following about the deletionReason parameter: > The deletionReason complex type includes two fields: deletionReasonCode and deletionReasonMemo. The deletionReasonCode must identify a deletion reason that is listed at Setup > Accounting > Accounting Lists. If the Use Deletion Reasons feature is enabled and you use the deletionReasonCode to identify a code that does not exist, the request fails with an INVALID_REF_KEY error. > Deletion reasons can be saved only for transactions. However, in SOAP web services, you must use the deletionReason parameter even when referencing other record types, and even when the Use Deletion Reasons feature is not enabled. For situations where it is not appropriate to identify a deletion reason, pass in a value of null. > Even when when a deletion reason is required, you can use a value of null. In these cases, the system automatically populates the deletion reason fields with default values. These defaults are: Other for deletionReasonCode and This transaction was deleted by script or web service for deletionReasonMemo. > The deletionReason complex type is defined in the core XSD. > For more details about the Use Deletion Reasons feature, see Recording a Reason for Deleting a Transaction.

Input metadata for other objects:

{
  "internalId": "string",
  "externalId": "string"
}

Delete Object By Id. Output Metadata

{
  "internalId": "string"
}

Lookup Object By Id

Lookup an object by the ID provided.

Lookup Object By Id. Config fields

  • Object Category - a category of an object in NetSuite
    • Standard
    • Custom
  • Object Type - an object in NetSuite (Contact, Customer etc.). Fetches dynamically.
  • Allow ID to be omitted
  • Allow Zero Results

Lookup Objects

Looks for objects available in NetSuite which meet given criteria. Use this action to execute the following types of searches:

  • Basic search — Execute a search on a record type based on search filter fields that are specific to that type. See Basic Searches in SOAP Web Services.

  • Joined search — Execute a search on a record type based on search filter fields on an associated record type. See Joined Searches in SOAP Web Services

  • Advanced search — Execute a search on a record type in which you specify search filter fields and/or search return columns or joined search columns. Using advanced search, you can also return an existing saved search. See Advanced Searches in SOAP Web Services.

Lookup Objects. Config fields

  • Object Type - an object in NetSuite (Contact, Customer etc.). Fetches dynamically.

  • Search Type - a type of search. See below.
    • Basic
    • Joined
    • Advanced
  • Behavior - a behavior for the component on how to handle the response which has more than 1 object to response with:
    • Emit individually
    • Fetch all
    • Fetch Page

A basic search lets you search records of a specific type using the fields on that record as search filters. In a basic search, field criteria are the only values you set. You cannot specify search return columns. The full list of available objects to search can be found in the Help Center (may vary for each installation). You can find the entire metadata of each object there as well.

Log in to your NetSuite account > Suite Cloud (Customization, Scripting, and Web Services) > SuiteCloud Platform Introduction > SuiteCloud Records Reference Tools > The SuiteScript Records Browser > Click ‘Go to the SuiteScript Records Browser.’

SuiteScript Records Browser

Then choose Schema Browser > ‘common’ from the dropdown list and open the Search tab at the left.

Common

What you should do next is to build a correct search request using object fields and operators.

Search operators

It is just the recommended list. You should always use an actual one based on the Help center of your account.

  • GetSelectValueFilterOperator:
Click to expand * contains * is * startsWith
  • SearchDateFieldOperator:
Click to expand * after * before * empty * notAfter * notBefore * notEmpty * notOn * notOnOrAfter * notOnOrBefore * notWithin * on * onOrAfter * onOrBefore * within
  • SearchDoubleFieldOperator:
Click to expand * between * empty * equalTo * greaterThan * greaterThanOrEqualTo * lessThan * lessThanOrEqualTo * notBetween * notEmpty * notEqualTo * notGreaterThan * notGreaterThanOrEqualTo * notLessThan * notLessThanOrEqualTo
  • SearchEnumMultiSelectFieldOperator:
Click to expand * anyOf * noneOf
  • SearchLongFieldOperator:
Click to expand * between * empty * equalTo * greaterThan * greaterThanOrEqualTo * lessThan * lessThanOrEqualTo * notBetween * notEmpty * notEqualTo * notGreaterThan * notGreaterThanOrEqualTo * notLessThan * notLessThanOrEqualTo
  • SearchMultiSelectFieldOperator:
Click to expand * anyOf * noneOf
  • SearchStringFieldOperator:
Click to expand * contains * doesNotContain * doesNotStartWith * empty * hasKeywords * is * isNot * notEmpty * startsWith
  • SearchTextNumberFieldOperator:
Click to expand * between * empty * equalTo * greaterThan * greaterThanOrEqualTo * lessThan * lessThanOrEqualTo * notBetween * notEmpty * notEqualTo * notGreaterThan * notGreaterThanOrEqualTo * notLessThan * notLessThanOrEqualTo

Basic Search Samples

Search contacts by a provided email

Object Type: Contact

Search Type: ContactSearchBasic

XML request:

Click to expand ```xml YOURAPPLICATIONID YOUREMAIL YOURPASSWORD YOURACCOUNT tomsmith@tomsmith.com ```

The same request for the component (JSON):

{
  "email": {
    "searchValue": "tomsmith@tomsmith.com",
    "operator": {
      "value": "is"
    }
  }
}

Response:

Click to see the response ```json { "results": [ { "internalId": "4248", "lastModifiedDate": "2018-08-17T08:51:19.000+0000", "dateCreated": "2018-08-17T08:16:53.000+0000", "globalSubscriptionStatus": { "value": "_softOptIn" }, "subsidiary": { "internalId": "3", "name": "Honeycomb Holdings Inc." }, "isInactive": false, "isPrivate": false, "email": "tomsmith@tomsmith.com", "lastName": "Smith", "firstName": "Tom", "salutation": "Smith", "entityId": "Tom Smith" } ] } ```

Execute a search on a record type based on search filter fields on an associated record type. A joined search allows you search against a specific record type using the fields on an associated record as search filters. In the NetSuite UI, you can identify which associated records provide joined filter criteria by first navigating to a record’s search interface.

Once again, you can find the list of available objects in the Help Center. The component will dynamically fetch all the list with an available metadata. But you should always look at the documentation to build a correct search request.

Joined Search Samples

Search contacts associated with customers

Object Type: Contact

Search Type: Contact Search Join

The following sample shows how to return an associated joined list of records. In this case, all contacts associated with customers of internalId 1, 2 and 3 are returned.

XML request:

Click to expand ```xml YOURAPPLICATIONID YOUREMAIL YOURPASSWORD YOURACCOUNT ```

The same request for the component (JSON):

{
  "customerJoin": {
    "internalId": {
      "searchValue": [
        {
          "internalId": "449",
          "name": "customer"
        },
        {
          "internalId": "500",
          "name": "customer"
        },
        {
          "name": "customer",
          "internalId": "594"
        }
      ],
      "operator": {
        "value": "anyOf"
      }
    }
  }
}

Response

Click to see the response ```json { "results": [ { "externalId": "Karen Austin / John Spear", "internalId": "912", "lastModifiedDate": "2019-07-24T09:54:53.000+0000", "dateCreated": "2015-06-07T20:47:55.000+0000", "globalSubscriptionStatus": { "value": "_softOptIn" }, "supervisor": { "internalId": "27", "name": "Brad M Sparling" }, "mobilePhone": "(123) 545-6666", "homePhone": "(222) 123-4321", "officePhone": "(123) 456-7890", "subsidiary": { "internalId": "1", "name": "Honeycomb Mfg." }, "isInactive": false, "isPrivate": false, "defaultAddress": "Brandy Dough
7829 N. Commerce Avenue
San Francisco CA
United States", "email": "bdickens@ramsey.com", "phone": "(123) 456-7890", "title": "Purchasing", "lastName": "Dickens", "firstName": "Brandy", "entityId": "Brandy Dickens" }, { "internalId": "1545", "lastModifiedDate": "2019-07-24T09:56:22.000+0000", "dateCreated": "2015-03-18T14:35:42.000+0000", "globalSubscriptionStatus": { "value": "_softOptIn" }, "supervisor": { "internalId": "1516", "name": "Brenda Jones" }, "homePhone": "(713) 456-7878", "subsidiary": { "internalId": "1", "name": "Honeycomb Mfg." }, "isInactive": false, "isPrivate": false, "defaultAddress": "123
Ave B
Houston TX 78665
United States", "email": "adminaccess2@ramsey.com", "phone": "(713) 456-7878", "lastName": "Samms", "firstName": "Brandy", "entityId": "Brandy Samms" } ] } ```
Search items with a price equal to 10

Object Type: Item

Search Type: Item Search Join

The following sample shows how to search for all items that have a price level of 10.00.

XML request:

Click to expand ```xml YOURAPPLICATIONID YOUREMAIL YOURPASSWORD YOURACCOUNT _inventoryItem 10 ```

The same request for the component (JSON):

{
  "pricingJoin": {
    "rate": {
      "operator": {
        "value": "equalTo"
      },
      "searchValue": 10
    }
  },
  "basic": {
    "type": {
      "operator": {
        "value": "anyOf"
      },
      "searchValue": [
        "_inventoryItem"
      ]
    }
  }
}

Response

Click to see the response ```json { "results": [ { "externalId": "ITEM163", "internalId": "163", "customFieldList": { "customField": [ { "value": false, "scriptId": "custitem16", "internalId": "194" } ] }, "supplyReplenishmentMethod": { "internalId": "REORDER_POINT", "name": "Reorder Point" }, "currency": "USA", "availableToPartners": false, "isInactive": true, "offerSupport": false, "isOnline": true, "displayName": "Reserve Pinot Noir 2000", "itemId": "Reserve Pinot Noir 2000", "outOfStockBehavior": { "value": "_default" }, "onSpecial": false, "dontShowPrice": false, "showDefaultDonationAmount": false, "isDonationItem": false, "sitemapPriority": { "value": "_auto" }, "excludeFromSitemap": false, "autoReorderPoint": true, "seasonalDemand": false, "autoPreferredStockLevel": true, "autoLeadTime": true, "leadTime": 0, "useBins": false, "cost": 6, "overallQuantityPricingType": { "value": "_byLineQuantity" }, "costEstimateType": { "value": "_averageCost" }, "useMarginalRates": false, "costCategory": { "internalId": "3", "name": "Default" }, "shipIndividually": false, "enforceMinQtyInternally": true, "roundUpAsComponent": false, "isSpecialOrderItem": false, "isDropShipItem": false, "trackLandedCost": false, "costingMethodDisplay": "Average", "weightUnit": { "value": "_lb" }, "weight": 5, "billExchRateVarianceAcct": { "internalId": "152", "name": "5097 Bill Exchange Rate Variance" }, "billPriceVarianceAcct": { "internalId": "151", "name": "5096 Bill Price Variance" }, "billQtyVarianceAcct": { "internalId": "150", "name": "5095 Bill Quantity Variance" }, "matchBillToReceipt": false, "assetAccount": { "internalId": "120", "name": "Inventory Asset" }, "taxSchedule": { "internalId": "1", "name": "S1" }, "incomeAccount": { "internalId": "56", "name": "4002 Sales : Sales - Merchandise" }, "includeChildren": true, "salesDescription": "Reserve Pinot Noir 2000", "cogsAccount": { "internalId": "121", "name": "Cost of Goods Sold" }, "copyDescription": false, "purchaseDescription": "Reserve Pinot Noir 2000", "lastModifiedDate": "2016-01-18T08:05:19.000+0000", "createdDate": "2015-06-12T21:29:35.000+0000" }, { "externalId": "ITEM164", "internalId": "164", "customFieldList": { "customField": [ { "value": false, "scriptId": "custitem16", "internalId": "194" } ] }, "supplyReplenishmentMethod": { "internalId": "REORDER_POINT", "name": "Reorder Point" }, "currency": "USA", "availableToPartners": false, "isInactive": true, "offerSupport": false, "isOnline": true, "displayName": "Crystallus 2002", "itemId": "Crystallus 2002", "outOfStockBehavior": { "value": "_default" }, "onSpecial": false, "dontShowPrice": false, "showDefaultDonationAmount": false, "isDonationItem": false, "sitemapPriority": { "value": "_auto" }, "excludeFromSitemap": false, "autoReorderPoint": true, "seasonalDemand": false, "autoPreferredStockLevel": true, "autoLeadTime": true, "leadTime": 0, "useBins": false, "cost": 5, "overallQuantityPricingType": { "value": "_byLineQuantity" }, "costEstimateType": { "value": "_averageCost" }, "useMarginalRates": false, "costCategory": { "internalId": "3", "name": "Default" }, "shipIndividually": false, "enforceMinQtyInternally": true, "roundUpAsComponent": false, "isSpecialOrderItem": false, "isDropShipItem": false, "trackLandedCost": false, "costingMethodDisplay": "Average", "weightUnit": { "value": "_lb" }, "weight": 5, "billExchRateVarianceAcct": { "internalId": "152", "name": "5097 Bill Exchange Rate Variance" }, "billPriceVarianceAcct": { "internalId": "151", "name": "5096 Bill Price Variance" }, "billQtyVarianceAcct": { "internalId": "150", "name": "5095 Bill Quantity Variance" }, "matchBillToReceipt": false, "assetAccount": { "internalId": "120", "name": "Inventory Asset" }, "taxSchedule": { "internalId": "1", "name": "S1" }, "incomeAccount": { "internalId": "56", "name": "4002 Sales : Sales - Merchandise" }, "includeChildren": true, "salesDescription": "Crystallus 2002", "cogsAccount": { "internalId": "121", "name": "Cost of Goods Sold" }, "copyDescription": false, "purchaseDescription": "Crystallus 2002", "lastModifiedDate": "2016-01-18T08:05:19.000+0000", "createdDate": "2015-06-12T21:29:35.000+0000" } ] } ```

Execute a search on a record type in which you specify search filter fields and/or search return columns or joined search columns. Using advanced search, you can also return an existing saved search.

Advanced searching provides users with the ability to:

  • Perform a search that references an existing saved search
  • Perform a search that references an existing saved search, and then overrides existing search return columns with new search return columns
  • Perform a search that references an existing saved search, and then provides additional search filter criteria (on top of the criteria already specified in the saved search)
  • Perform a search that specifies search criteria and search result columns

The SOAP web services API includes advanced search objects for all records that have an existing search interface.

Please check your ‘Advanced Search’ Help center section in order to build a correct request. You can find it in the following way:

Log in to your NetSuite account > Suite Cloud (Customization, Scripting, and Web Services) > SuiteTalk Web Services > SuiteTalk SOAP Web Services Platform Guide > SOAP Web Services operations > search > Advanced Searches in SOAP Web Services.

The component will always fetch all the existing metadata for the advanced search for you. All you should do is to delete what you don’t need and to build a correct request based on the documentation.

Known Limitations

  • Enum values for condition operators accessible only in the Basic search type.
  • Input metadata for property columns absent for object type: Transaction and Advance Search search type.
  • The following transaction searches are not supported:
Click to expand - Blanket Purchase Order - CCard Refund - Commission - Credit Card - Currency Revaluation - Customer Payment Authorization - Deprecated Custom Transaction - Finance Charge - Fulfillment Request - GL Impact Adjustment - Inventory Count - Inventory Distribution - Inventory Status Change - Inventory Worksheet - Liability Adjustment - Ownership Transfer - Payroll Adjustment - Payroll Liability Check - Period End Journal - Purchase Contract - Request For Quote - Revenue Arrangement - Revenue Commitment - Revenue Commitment Reversal - Revenue Contract - Sales Tax Payment - Statement Charge - Store Pickup Fulfillment - System Journal - Tax Liability Cheque - Tegata Payable - Tegata Receivable - Transfer - Vendor Request For Quote

Advanced Search Samples

Object Type: Customer

Search Type: Customer Search Advanced

The following sample shows how to find customers, using saved search (by a keyword in an email).

XML request:

Click to expand ```xml YOURAPPLICATIONID YOUREMAIL YOURPASSWORD YOURACCOUNT ```

The same request for the component (JSON):

{
  "savedSearchId": "740"
}

Response

Click to see the response ```json { "results": [ { "basic": { "salesRep": [ { "searchValue": { "internalId": "1008" } } ], "phone": [ { "searchValue": "937-287-2222" } ], "internalId": [ { "searchValue": { "internalId": "980" } } ], "entityId": [ { "searchValue": "D&H Manufacturing" } ], "billState": [ { "searchValue": "OH" } ], "billCity": [ { "searchValue": "Dayton" } ], "billAddress1": [ { "searchValue": "410 E. Fifth St." } ] } } ] } ```

Upsert Object By Id

Either update an object in NetSuite by an ID provided or inserts as a new object if it does not exist.

Upsert Object By Id. Config Fields

  • Object Category - a category of an object in NetSuite
    • Standard
    • Custom
  • Object Type - an object in NetSuite (Contact, Customer etc.). Fetches dynamically.

Lookup Customer(deprecated)

Deprecated. Use Lookup Object By Id action instead.

This action enables to find the customer by provided ID. It is possible to provide internal, external id or all of them in input message.

If entity doesn’t have externalId You must specify only internalId in input message. If You specify incorrect internal or external id, You will get error That record does not exist.

For example when the externalId exists the answer would be:

{
  "internalId":"1234",
  "externalId":"4567"
}

When the externalId does not exist:

{
  "internalId":"1234"
}

Lookup Invoice(deprecated)

Deprecated. Use Lookup Object By Id action instead.

This action can be used to find invoices by provided ID.

You can provide internal, external id or all of them in input message. If entity doesn’t have externalId You must specify only internalId in input message.

If You specify incorrect internal or external id, You will get error “That record does not exist.

For example if the externalId exists:

{
  "internalId":"1234",
  "externalId":"4567"
}

If the externalId does not exist:

{
  "internalId":"1234"
}

Upsert Customer(deprecated)

Deprecated. Use Lookup Object By Id action instead

Create new or update existing customer by provided external ID. The request sample could look like:

{
  "externalId": "external order ID",
  "customerId": "internal customer ID",
  "currency": "USA",
  "exchangeRate": 1.0,
  "orderItems": [
		{
			"itemInternalId": "387",
			"quantity": 10![Step 1](https://some-url-address)

		}
	]
}

Upsert Contact(deprecated)

Deprecated. Use Upsert Object By Id action instead.

Create new or update existing contact by provided external ID.

Request sample:

{
  "externalId": "entity164",
  "customForm": {
    "internalId": "-40",
    "name": "Standard Contact Form"
  },
  "entityId": "Olha Grogan",
  "salutation": "Mrs.",
  "firstName": "Olha",
  "lastName": "Grogan",
  "subsidiary": {
    "internalId": "1",
    "name": "Honeycomb Mfg."
  }
}

Upsert Invoice(deprecated)

Deprecated. Use Upsert Object By Id action instead.

Create new or update existing invoice by provided external ID.

Request sample:

{
  "externalId": "23213000001",
  "customForm": {
    "name": "HM Product Invoice",
    "internalId": "102"
  },
  "entity": {
    "name": "Jennings Financial",
    "internalId": "81"
  },
  "terms": {
    "name": "Net 30",
    "internalId": "2"
  },
  "subsidiary": {
    "name": "Honeycomb Mfg.",
    "internalId": "1"
  },
  "currency": {
    "name": "USA",
    "internalId": "1"
  },
  "location": {
    "name": "02: Boston",
    "internalId": "1"
  },
  "isTaxable": true,
  "taxItem": {
    "name": "CA-SAN MATEO",
    "internalId": "-112"
  },
  "taxRate": 8.25,
  "fax": "916-555-0806",
  "message": "We appreciate your prompt payment",
  "shipMethod": {
    "name": "Truck",
    "internalId": "3"
  },
  "itemList": {
    "item": [
      {
        "job": null,
        "item": {
          "name": "CHA00002®",
          "internalId": "707",
          "externalId": null,
          "type": null
        },
        "line": 1,
        "description": "Assembly Item - Historical",
        "amount": 7020,
        "isTaxable": null,
        "quantity": 36,
        "price": {
          "name": "List Price",
          "internalId": "1"
        },
        "rate": "195.00",
        "taxCode": {
          "name": "-Not Taxable-",
          "internalId": "-7"
        }
      }
    ],
    "replaceAll": false
  },
  "shippingCost": 704.25,
  "customFieldList": {
    "customField": [
      {
        "type": "BooleanCustomFieldRef",
        "internalId": "167",
        "scriptId": "custbody_fmt_senior_exec_declined",
        "value": false
      }
    ]
  }
}

Upsert Sales Order(deprecated)

Deprecated. Use Upsert Object By Id action instead.

Create new or update existing sales order by provided external ID.

Request sample:

{
  "externalId": "80144000000B5wqAAC",
  "orderStatus": "_pendingFulfillment",
  "currency": {
    "name": "USA",
    "internalId": "1"
  },
  "customForm": {
    "internalId": "174",
    "name": "Z - HM Sales Order Form"
  },
  "entity": {
    "internalId": "2053"
  },
  "exchangeRate": "1.0",
  "toBePrinted":"false"
}

Upsert Vendor(deprecated)

Deprecated. Use Upsert Object By Id action instead.

Create new or update existing vendor by provided external ID.

Request sample:

{
  "externalId": "9999",
  "entityId": "Nick",
  "isPerson": "false",
  "companyName": "Nick2",
  "phone": "937 99 92",
  "fax": "937 99 92",
  "email": "nick2@nickthebest.com",
  "url": "http://www.nickthebest2.com",
  "customFieldList": {
    "customField": [
      {
        "internalId": "3992",
        "scriptId": "custentity_2663_payment_method",
        "type": "BooleanCustomFieldRef",
        "value": "false"
      },
      {
        "internalId": "3993",
        "scriptId": "custentity_2663_payment_method",
        "type": "BooleanCustomFieldRef",
        "value": "false"
      }
    ]
  }
}

Upsert Custom Fields

Currently, You can upsert custom fields only from developer mode. You should to use property type, which can accept next values:

  • BooleanCustomFieldRef
  • DateCustomFieldRef
  • DoubleCustomFieldRef
  • LongCustomFieldRef
  • MultiSelectCustomFieldRef
  • SelectCustomFieldRef
  • StringCustomFieldRef

You can find example of custom field structures here.