NetSuite Archives | ZappySys Blog

How to call NetSuite RESTlet API in SSIS / ODBC

ZappySys — Mon, 23 May 2022 21:18:19 +0000

Introduction

In our previous post we saw how to read API data in SSIS. This post we will cover how to call NetSuite RESTlet to read / write data in SSIS or ODBC Apps. For demo purpose we will use SSIS PowerPack REST API Task but concepts and many UI elements remain same for ODBC JSON Driver too. This article assumes you know how to write Netsuite RESTlet and you have obtained Credentials to call RESTlet from extranal app.

What is NetSuite RESTlets

NetSuite added a really nice feature to expose business data and workflows as API by writing Javascript functions which they call it RESTlets. You can secure and customize these restlets as per your need.

You can automate CRUD (Create /Read / Write / Delete) operations in NetSuite by writing special functions in JavaScript and expose those functions as API URL which can be called by any external Systems (i.e. SSIS Packages , ODBC Apps like Power BI, Informatica, SSRS).

RESTlet can be secured few ways such as OAuth 1.0 and OAuth 2.0 authentication. We will cover both approach briefly in this article. You can choose any one as per your need

Prerequisites

Before we perform the steps listed in this article, you will need to make sure the following prerequisites are met:

SSIS designer installed. Sometimes it is referred to as BIDS or SSDT (download it from the Microsoft site).
Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
Make sure ZappySys SSIS PowerPack is installed (download it, if you haven't already).
(Optional step). Read this article, if you are planning to deploy packages to a server and schedule their execution later.

Creating NetSuite RESTlet / Obtain OAuth Credentials (Client ID and Secret)

Below video shows how to obtain necessary credentials to call Netsuites API (RESTlet).

At mark 4:30 seconds it will show you How to use OAuth 2.0 for calling RESTlet

Create NetSuite RESTlet Connection

There are few ways to authenticate NetSuite RESTlet. If you are using ZappySys Products then it makes it super easy to use either approach. Lets look at both approaches.

Using OAuth 2.0 (Recommended)

As per above video if you obtained Client ID and Secret for OAuth 2.0 you can follow below steps to configure OAuth connection to call RESTlet.

What you need to use OAuth 2.0.

Your Account ID (it goes in URL)
Your Client ID and Secret (Obtained from Netsuite Portal) – See above video Mark 04:30
Register Redirect URL in NetSuite portal (we recommend you use https://zappysys.com/oauth as call back Url for Automatic Code extraction)

Steps to configure OAuth Connection

Right click on Connection Panel and choose Choose “New Connection..”. Select ZS-OAUTH type

Create new SSIS OAuth API Connection Manager
Enter following things
————————-
On General Tab
————————-
ClientID and Secret:
Authorization URL: https://.app.netsuite.com/app/login/oauth2/authorize.nl
Token URL: https://.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token
Scope: restlet

Configure NetSuite OAuth 2.0 Connection for API call

————————-
On Advanced Tab
————————-
Callback / Redirect URL: https://zappysys.com/oauth (this must be entered same way in NetSuite Portal)

OAuth2 Connection – Callback / Redirect URL
Now go back to General Tab and click Generate Token button
Follow login screen and try to finish the flow. At the end it will generate Tokens and populate on UI
Click OK to save

Using OAuth 1.0

Another approach is use OAuth 1.0 (Older version). If you have enabled OAuth 1.0 in NetSuite then follow below steps (Create connection is same as before).

Setup General Tab and Advanced Tab as below.
On ==== General Tab====:
Enter ClientID, ClientSecret, AccessToken, AccessToken Secret
On ==== Advanced Tab ====:
Check Do Not Include Empty Key/Value Pairs
Select Signature Method as HMAC-SHA256
For Extra Token Attribute enter realm=_SB1
Click OK to Save

Call NetSuite RESTlet in SSIS

Create a new SSIS Package
Drag REST API Task from SSIS Toolbox
Double click the Task to configure
Select URL from Connection
From Connection dropdown select OAuth connection we created in the earlier section (either OAuth 1 or OAuth 2)
Enter the URL as below. Assuming you copied URL from NetSuite Replace script ID and account number
```
https://-sb1.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=&deploy=1
```
Enter
Enter
Change Method to POST if your script supports Parameters (Else you can supply id=xxxx and recordtype=xxxxx in the URL for GET request)
If its POST request then chnage ContentType to ApplicationJSON (application/json)
Enter your Input in the body. In below example our RESTlet takes sql query as input so we enter just one parameter named query but you can have different parameter(s)
```
Syntax:  { param1_name :  , param2_name :  ....  }
```
Now click Test see everything works
Calling NetSuite RESTlet in SSIS (Using REST API Task)

Conclusion

We saw how easy it is to call NetSuite RESTlets or other NetSuite API in SSIS / other BI Apps using ODBC Drivers provided by ZappySys. Download SSIS PowerPack and try your self see how easy it is to consume virtually any API in SSIS.

The post How to call NetSuite RESTlet API in SSIS / ODBC appeared first on ZappySys Blog.

How to read data from NetSuite in SSIS (SimpleTalk SOAP API)

ZappySys — Thu, 06 Sep 2018 15:59:12 +0000

Introduction

In this post we will learn how to read data from NetSuite in SSIS. We will use ZappySys XML Source for SOAP API access.

Prerequisites

Before we perform the steps listed in this article, you will need to make sure the following prerequisites are met:

SSIS designer installed. Sometimes it is referred to as BIDS or SSDT (download it from the Microsoft site).
Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
Make sure ZappySys SSIS PowerPack is installed (download it, if you haven't already).
(Optional step). Read this article, if you are planning to deploy packages to a server and schedule their execution later.

What is NetSuite CRM?

NetSuite is a CRM / ERP product. It gives you scalable cloud CRM / ERP solution targeted at high-growing, mid-sized businesses and large enterprises. It automates front- and back-office processes including: financial management, revenue management, fixed assets, order management, billing, and inventory management.

Preparing for NetSuite WebService Call in SSIS

For NetSuite API call we have to make sure certain settings and obtain Application ID and AccountID. So let’s get started.

How to enable NetSuite Web Service Feature

Before you call any NetSuite SOAP API (i.e. SuiteTask Web Service), First thing to get started with NetSuite SOAP API (i.e. ) is to enable Web Service Feature. Once you enable Web Service, you can programmatically access NetSuite data in your App (e.g. Power BI, Tableau, Informatica). Click this link to see steps to enable Web Service Feature

Enable NetSuite Web Service Feature

" data-medium-file="https://zappysys.com/blog/wp-content/uploads/2018/08/netsuite-enable-web-service-features-setup-option.png?fit=253%2C300&ssl=1" data-large-file="https://zappysys.com/blog/wp-content/uploads/2018/08/netsuite-enable-web-service-features-setup-option.png?fit=479%2C568&ssl=1" />

Enable NetSuite Web Service Feature (SuiteTalk API)

Obtain NetSuite Account ID

NetSuite Account ID is needed by Login API call. So perform following steps if you dont know account id.

Login to your NetSuite Portal
Click the Setup Tab
In the drop-down click Integration > Web services preferences
On that page you will find your Account ID (example account ID = TSTDRV1234567 )

Obtain NetSuite Account ID (Needed for Web Service Login)

" data-medium-file="https://zappysys.com/blog/wp-content/uploads/2018/08/obtain-netsuite-accountid.png?fit=218%2C300&ssl=1" data-large-file="https://zappysys.com/blog/wp-content/uploads/2018/08/obtain-netsuite-accountid.png?fit=262%2C360&ssl=1" />

Obtain NetSuite Account ID (Needed for Web Service Login)

Obtain NetSuite Application ID

Once you have account ID now we need to get Application ID. For that follow these steps.

Login to your NetSuite Portal
Click the Setup Tab
In the drop-down click Integration > Manage Integrations
On that page you will find your existing Applications along with Account ID / Status (example Application ID = AE2EACFD-1234-1222-1111-12345544555 )
If you don’t have any application created yet then just click on New.

Create new App / Get NetSuite Application ID

" data-medium-file="https://zappysys.com/blog/wp-content/uploads/2018/08/netsuite-obtain-application-for-soap-api-call.png?fit=300%2C133&ssl=1" data-large-file="https://zappysys.com/blog/wp-content/uploads/2018/08/netsuite-obtain-application-for-soap-api-call.png?fit=660%2C293&ssl=1" />

Create new App / Get NetSuite Application ID

Understanding how NetSuite SOAP API Call works

In this section we will briefly understand how NetSuite SOAP API call works. When you use ZappySys Driver / Component it will take care many details for you but still you have to configure correct XML Body. There are two steps involved before you can call any SOAP API in NetSuite.

Call Login method and extract JSESSIONID from response Cookie (This token expires after some time)
Call any other API (Pass obtained JSESSIONID token in Cookie header)

NetSuite Login Call

Request

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "login"
Accept-Encoding: gzip, deflate



  
    
      xxxxxxxxxxxxxx
    
  
  
    
      
        xxxxxxxxxxxxx
        xxxxxxxxxxxx
        TSTxxxxxxxxxxxxxxx

Response Notice JSESSIONID=6xI6xxxxxxxxx in the login call response below. This Session ID can be used to call next call. ZappySys HTTP Connection Manager configured with Dynamic Token option can extract Cookie and reuse it until its expired (1 hour by default).

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 16:50:41 GMT
Content-Length: 1676
Content-Type: text/xml; charset=utf-8
X-N-OperationId: 777274f6-49c6-4883-bcd1-1d70df90d78e
Strict-Transport-Security: max-age=31536000
NS_RTIMER_COMPOSITE: 13633xxxxxxxxx:70617xxxxxxxxxxxxx36F6D:80
Set-Cookie: JSESSIONID=6xI61rdFt26pxxxxxxxxxxxxxxxqvJIMlu!-17981123445; path=/; secure; HttpOnly
Set-Cookie: NS_VER=2018.1.0; domain=webservices.netsuite.com; path=/
Set-Cookie: NS_ROUTING_VERSION=LAGGING; path=/
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent
Keep-Alive: timeout=10, max=990
Connection: Keep-Alive



  
    
      WEBSERVICES_xxxxxxxxxxxxxxxxx_9fc719
    
  
  
    
      
        
        
          
            
              Administrator
            
            false
            false
          
          
            
              Employee Center
            
            false
            false

NetSuite API Call ( getAll method )

Now once you have JSESSIONID extracted you can pass it to call next API call as below. For example here is how to call getAll method to obtain currency list and exchange rates. If you are not sure how to craft correct Request XML then use tool like SoapUI. You can use NetSuite WSDL file from here and import it in SoapUI. Request See how Cookie is passed for authentication purpose. Again you can pass this manually or use HTTP connection with Dynamic Token to pass it automatically along with each API call.

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getAll"
Cookie: JSESSIONID=6xI61rxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxMlu!-1798141234
Accept-Encoding: gzip, deflate

Response

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 16:50:42 GMT
Content-Length: 9648
Content-Type: text/xml; charset=utf-8
X-N-OperationId: 1b2989e4-b930-4a72-b471-00a8e131dfd4
NS_RTIMER_COMPOSITE: 21403xxxxxx:706172746E65xxxxxxxxxxxx6F6D:80
Strict-Transport-Security: max-age=31536000
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent



  
    
      WEBSERVICES_TSTDRV1439151_100320189871507121000128715_6ae8e8
    
  
  
    
      
        
        11
        
          
            USD
            USD
            true
            false
            false
            $
            _beforeNumber
            _unitedStatesEnglish
            $1,234.56
            1.0
            _americaNewYork
            _two
          
          
            GBP
            GBP
            true
            false
            false
            £
            _beforeNumber
            _unitedKingdomEnglish
            £1,234.56
            1.33165497
            _americaNewYork
            _two
          
          
            CAD
            CAD
            true
            false
            false
            $
            _beforeNumber
            _canadaEnglish
            $1,234.56
            0.76457273
            _americaNewYork
            _two

NetSuite Search API (Pagination Example)

Now let's look at more complex API calls where Pagination is needed. For example when you call search API to pull data from specific table (e.g. Account) you need to loop through multiple responses until all records are consumed. Request (Page-1)

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml; charset=utf-8
SOAPAction: "search"
Cookie: JSESSIONID=BKQ7xxxxxxxxxxxx4Ug!-995xxxxxx
Accept-Encoding: gzip, deflate



  
    
      xxxxxxxxxxxxxxx
    
    
      50
    
  
  
    
      
        
          
            x
          
          
            a

Response (Page-1) In below response notice 2 things. SearchId is like a cursor id which you have to pass for each page you request after first page. And you can stop looping after 4th page based on totalPages count. platformCore:searchId = WEBSERVICES_ABCD_12345-xxxxxxxxx platformCore:totalPages = 4

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 18:40:33 GMT
Content-Length: 49266
Content-Type: text/xml; charset=utf-8
X-N-OperationId: c1e79336-63b7-4eb7-989e-5c3d24c56891
NS_RTIMER_COMPOSITE: 118xxxxxxxx:70617xxxxxxxxxxxxxxxxxxxxxD:80
Strict-Transport-Security: max-age=31536000
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent



  
    
      WEBSERVICES_ABCD_12345-xxxxxxxxx
    
  
  
    
      
        
        193
        50
        4
        1
        WEBSERVICES_ABCD_12345-xxxxxxxxx
        
          
            _bank
            1111
            Checking
            false
            
              USD
            
            _current
            
              xxxxxxxxxxxxxxxxxxx
            
            _average
            Checking
            false
            false
            false
            true
          
          
            _bank
            22222
            Savings
            false
            
              USD
            
            _current
            
              yyyyyyyyy
            
            _average
            Savings
            false
            false
            false
            true
          
          .........
          .........
          .........
          .........

Request (Page-2 and onwards) Here is the second page request. Notice few things here. In heraders we are now sending SOAPAction: "searchMoreWithId" rather than "search". Also our SOAP Body is also different compared to first page request. Now we only sending pageIndex we want to fetch and searchId. We have also change tag with under Body.

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml; charset=utf-8
SOAPAction: "searchMoreWithId"
Cookie: JSESSIONID=BKQ7xxxxxxxxxxxx4Ug!-995xxxxxx
Accept-Encoding: gzip, deflate



  
    
      xxxxxxxxxxxxxxxxxx
    
    
      50
    
  
  
    
      WEBSERVICES_ABCD_12345-xxxxxxxxx
      2

Response (Page-2 and onwards)

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 18:40:33 GMT
Content-Length: 49266
Content-Type: text/xml; charset=utf-8
X-N-OperationId: c1e79336-63b7-4eb7-989e-5c3d24c56891
NS_RTIMER_COMPOSITE: 118xxxxxxxx:70617xxxxxxxxxxxxxxxxxxxxxD:80
Strict-Transport-Security: max-age=31536000
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent



  
    
      WEBSERVICES_ABCD_12345-xxxxxxxxx
    
  
  
    
      
        
        193
        50
        4
        2
        WEBSERVICES_ABCD_12345-xxxxxxxxx
        
          
            _bank
            8000
            Checking
            false
            
              USD
            
            _current
            
              xxxxxxxxxxxxxxxxxxx
            
            _average
            Checking
            false
            false
            false
            true
          
          
            _bank
            8001
            Savings
            false
            
              USD
            
            _current
            
              yyyyyyyyy
            
            _average
            Savings
            false
            false
            false
            true
          
          .........
          .........
          .........
          .........

Getting Started

Now let’s check step by step instructions on how to load NetSuite data in SSIS. In this exercise we will focus on calling search API but you can call virtually any API using the same technique.

For detailed help on NetSuite SOAP API and other useful information check this documentation. To browse schema you can use this link. From schema browser we will use Search Type name later on in this article. For example later on in this article to search accounts we will use AccountSearch as below example. This name can be found from here(click search tab) You can change it to something else. For now dont worry too much until we get to that point.

<searchRecord xmlns:q1="urn:accounting_2017_1.lists.webservices.netsuite.com" xsi:type="q1:AccountSearch">

Configure SSIS HTTP Connection for NetSuite

Now let’s look at how to configure SSIS HTTP Connection for NetSuite API login. We will use Dynamic Token Approach.

1. Open SSIS Package
2. Drag Data flow from SSIS Toolbox and double click it
3. Inside data flow SSIS toolbox, find ZS XML Source and drag it on the surface.
4. Double click it to configure. First enter NetSuite API URL. If you need to use latest WebService version e.g. NetSuitePort_2019_1 then you must use company specific endpoint.
```
https://webservices.netsuite.com/services/NetSuitePort_2017_1
```
  –OR–
  
  To use
```
NetSuitePort_2019_1
```
  or higher use company specific endpoint like below otherwise you will get error. NOTE: You must change Body in coming section to match Version if you use below way.
```
https://111222333444.suitetalk.api.netsuite.com/services/NetSuitePort_2019_1
```
5. Check Use Credentials option and Click New HTTP connection.
6. Configure general properties of connections as below.
  1. Select Credentials Type as Dynamic Token
  2. Use any URL (It will be ignored)
  3. Enter your NetSuite UserID, Password
  4. Enter Header as Cookie
  5. Enter AUth Scheme as JSESSIONID=
7. First Screen will look like as below. Click Configure.
  Configure SSIS NetSuite Connection
8. On Dynamic Token > Request Tab we have to set Token URL, Method, Body, Header.
  1. In the URL enter same URL again
```
https://webservices.netsuite.com/services/NetSuitePort_2017_1
```
  2. In the Body enter as below. Change APPLICATION-ID and ACCOUNT-ID with correct ID we obtained earlier. [$userid$] and [$password$] is special placeholders will be replaced automatically at runtime.
    NOTE: Try to match your URL version in the Body Request. If you used For example if you used 2019_1 in URL then change below body to match that version
```
  
    
      xxxxxxYOUR-APPLICATION-IDxxxxxx
    
  
  
    
      
        [$userid$]
        [$password$]
        xxxxxxYOUR-ACCOUNT-IDxxxxxx
        
      
    
  
```
    NOTE: Remove below line from above Body if you get INVALID_ROLE error later in this tutorial. If if you get INVALID_LOGIN_CREDENTIALS error then refer here.
  3. Select Content Type as text/xml
  4. In the Headers click on Raw Edit Button and enter like below.
```
SOAPAction: "login"
```
9. Once all settings done your Request Tab will look like below
  SSIS NetSuite Connection – Configure Token Request
10. On Response Tab configure like below. You have to enter Cookie name as JSESSIONID
  SSIS NetSuite Connection – Configure Token Response
11. Click OK to Save Connection.
12. We will configure XML Source in next section.

Configure SSIS XML Source to read NetSuite data

Now let’s continue configuration of XML Source. In this section we will show you how to get data without pagination. In next section we will see how to modify XML Source Settings to pagination request to read many records (e.g. 1000+ rows).

On your XML Source enter NetSuite Webservice URL like below.

https://webservices.netsuite.com/services/NetSuitePort_2017_1

Now check Use Credentials and select previously created HTTP connection.
Select Method as POST and content type as text/xml
Edit Request Body and enter like below (or any other XML body for API you like to call. Make sure SOAPAction in next step updated correctly too for other action)
NOTE: Try to match your URL version in the Body Request. If you used For example if you used 2019_1 in URL then change below body to match that version
```
   
      
          
      
   
```
NOTE: If you used NetSuitePort_2019_1 or higher version in URL then make sure you changed version 2017_1 to 2019_1 in below body
Now you click Raw Edit above headers grid and enter method name in SOAPAction (e.g. getAll in our case)
```
SOAPAction: "getAll"
```
NOTE: SOAPAction Header is very important so make sure you change it to match Action you like to call. You can Use Correct WebService WSDL File (Metadata) in Tool like SOAPUI as explained here

Version 2017_1 WSDL Link
Version 2018_1 WSDL Link
Version 2019_1 WSDL Link
For Other Versions Just Change URL Version Part to different Number e.g. 2019_2_0
Now enter Filter like below or navigate by clicking Select Filter button.
```
$.soapenv:Envelope.soapenv:Body.getAllResponse.platformCore:getAllResult.platformCore:recordList.platformCore:record[*]
```
Configure XML Source – NetSuite SOAP API getAll (Body, Header, ContentType, Method, Filter)
Now click preview data.
Preview NetSuite data in XML Source
Click OK to save XML Source UI
Now you can connect XML Source to target like OLEDB Destination and load NetSuite data into SQL Server.

Configure SSIS XML Source with Pagination

So in previous section we saw how to configure XML Source for basic API calls (without pagination). In this section we will see how to call more complex API (e.g. search ) which requires pagination. Some ideas about NetSuite Pagination discussed here too.

Foe pagination setup using XML Source we have to configure following properties via Properties Grid or Advanced Edit rather than Normal UI. May of these properties not available via UI as of now.

Create new data flow and drag new ZS XML Source.
Right click on XML Source and click Properties in Data flow designer. Find property by name in the Grid and set correct value.
NOTE: In newer version v3.1.2 or higher you can use XML Source UI to enter some multi line properties for ease of use (e.g. FirstPageBodyPart and NextPageBodyPart can be entered on Advanced Pagination Tab, all other properties are easier to enter from Grid Mode if you sort alphabetically)

ElementsToTreatAsArray	platformCore:record
EnablePageTokenForBody	True
Filter	$.soapenv:Envelope.soapenv:Body.search[$tag$]Response.platformCore:searchResult.platformCore:recordList.platformCore:record[*]
FirstPageBodyPart	x a Change as per your need but we used above example search
HasDifferentNextPageInfo	True
NextPageBodyPart	[$pagetoken$] [$pagenumber$]
NextUrlAttribute	$.soapenv:Envelope.soapenv:Body.search[$tag$]Response.platformCore:searchResult.platformCore:searchId
PagePlaceholders	header=\|MoreWithId;filter=\|MoreWithId
PagesMaxPagesExpr	$.soapenv:Envelope.soapenv:Body.searchResponse.platformCore:searchResult.platformCore:totalPages

Once above items are set in property grid. Double click XML source to edit few more items from UI.

Enter URL as below

https://webservices.netsuite.com/services/NetSuitePort_2017_1

Check Use Credentials and select HTTP connection we created in previous section.
Click Raw Edit button (above headers grid) and enter below
```
SOAPAction: "search[$tag$]"
```

Click on Edit button next to Body. Enter following XML fragment for search request. Change ApplicationId and adjust PageSize if needed.



  
    
      ABCD-1234-XXXXXXXXXXXXXXX
    
    
      100
    
  
  
[$tag$]

Select POST method, change content type to XML (text / xml, charset=UTF-8)
That’s it. Click ‘Preview to confirm.
Click ok to save XML Source.
Read NetSuite data in SSIS with Pagination ( search, searchMoreWithId API call)

Configure SQL Server Destination to load NetSuite data

Once you have XML Source configured you can connect XML Source to Target (OLEDB Destination) and load data into SQL Server.

Conclusion

In this post we explored many advanced options of HTTP Connection and XML Source to enable NetSuite API integration in SSIS. Download SSIS PowerPack today for FREE to uncover many other data integration scenarios not discussed in this article.

The post How to read data from NetSuite in SSIS (SimpleTalk SOAP API) appeared first on ZappySys Blog.

How to read NetSuite data in Power BI

ZappySys — Sat, 11 Aug 2018 17:29:14 +0000

Introduction

In our previous blog we discussed how to import REST / SOAP API data in Power BI. Now we will use that knowledge to read NetSuite data in Power BI (NetSuite CRM – SuiteTalk). We will use ZappySys XML Driver to call Search function in NetSuite SOAP API. If you are not familiar with SOAP API concept then we highly recommend you read previous blog post. In this post we will use Power BI as an example App to consume NetSuite data but you can use steps listed in this article to load data in any other ODBC compliant ETL / reporting app (e.g. Excel, Qlik, Informatica, SSRS) or programming language (e.g. C#, JAVA, Python) or SQL Server (Linked Server).

We will look at each step in depth, how to enable SOAP Api access in NetSuite, How to register Application, how to configure NetSuite ODBC DSN, and finally how to load NetSuite data into Power BI dashboard.

So let’s get started. The approach listed in this article can be used to call other SOAP based API such as Salesforce, Workday, SAP, Sage etc.

Prerequisite

Before you get started make sure following requirements are met.

NetSuite CRM Login (UserID and Password)
Enable Web Service Feature in NetSuite
Obtain NetSuite Account ID
Obtain Application ID if you have created an App. Else Register new Netsuite Application and get Application ID
Download ZappySys ODBC PowerPack (for SOAP / XML Driver)
Download Power BI Desktop (FREE) if you have not already done it.

What is NetSuite CRM?

Preparing for NetSuite WebService Call in Power BI

For NetSuite API call we have to make sure certain settings and obtain Application ID and AccountID. So let’s get started.

How to enable NetSuite Web Service Feature

Enable NetSuite Web Service Feature

Enable NetSuite Web Service Feature (SuiteTalk API)

Obtain NetSuite Account ID

NetSuite Account ID is needed by Login API call. So perform following steps if you dont know account id.

Login to your NetSuite Portal
Click the Setup Tab
In the drop-down click Integration > Web services preferences
On that page you will find your Account ID (example account ID = TSTDRV1234567 )

Obtain NetSuite Account ID (Needed for Web Service Login)

Obtain NetSuite Application ID

Once you have account ID now we need to get Application ID. For that follow these steps.

Login to your NetSuite Portal
Click the Setup Tab
In the drop-down click Integration > Manage Integrations
On that page you will find your existing Applications along with Account ID / Status (example Application ID = AE2EACFD-1234-1222-1111-12345544555 )
If you don’t have any application created yet then just click on New.

Create new App / Get NetSuite Application ID

Understanding how NetSuite SOAP API Call works

Call Login method and extract JSESSIONID from response Cookie (This token expires after some time)
Call any other API (Pass obtained JSESSIONID token in Cookie header)

NetSuite Login Call

Request

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "login"
Accept-Encoding: gzip, deflate



  
    
      xxxxxxxxxxxxxx
    
  
  
    
      
        xxxxxxxxxxxxx
        xxxxxxxxxxxx
        TSTxxxxxxxxxxxxxxx

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 16:50:41 GMT
Content-Length: 1676
Content-Type: text/xml; charset=utf-8
X-N-OperationId: 777274f6-49c6-4883-bcd1-1d70df90d78e
Strict-Transport-Security: max-age=31536000
NS_RTIMER_COMPOSITE: 13633xxxxxxxxx:70617xxxxxxxxxxxxx36F6D:80
Set-Cookie: JSESSIONID=6xI61rdFt26pxxxxxxxxxxxxxxxqvJIMlu!-17981123445; path=/; secure; HttpOnly
Set-Cookie: NS_VER=2018.1.0; domain=webservices.netsuite.com; path=/
Set-Cookie: NS_ROUTING_VERSION=LAGGING; path=/
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent
Keep-Alive: timeout=10, max=990
Connection: Keep-Alive



  
    
      WEBSERVICES_xxxxxxxxxxxxxxxxx_9fc719
    
  
  
    
      
        
        
          
            
              Administrator
            
            false
            false
          
          
            
              Employee Center
            
            false
            false

NetSuite API Call ( getAll method )

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getAll"
Cookie: JSESSIONID=6xI61rxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxMlu!-1798141234
Accept-Encoding: gzip, deflate

Response

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 16:50:42 GMT
Content-Length: 9648
Content-Type: text/xml; charset=utf-8
X-N-OperationId: 1b2989e4-b930-4a72-b471-00a8e131dfd4
NS_RTIMER_COMPOSITE: 21403xxxxxx:706172746E65xxxxxxxxxxxx6F6D:80
Strict-Transport-Security: max-age=31536000
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent



  
    
      WEBSERVICES_TSTDRV1439151_100320189871507121000128715_6ae8e8
    
  
  
    
      
        
        11
        
          
            USD
            USD
            true
            false
            false
            $
            _beforeNumber
            _unitedStatesEnglish
            $1,234.56
            1.0
            _americaNewYork
            _two
          
          
            GBP
            GBP
            true
            false
            false
            £
            _beforeNumber
            _unitedKingdomEnglish
            £1,234.56
            1.33165497
            _americaNewYork
            _two
          
          
            CAD
            CAD
            true
            false
            false
            $
            _beforeNumber
            _canadaEnglish
            $1,234.56
            0.76457273
            _americaNewYork
            _two

NetSuite Search API (Pagination Example)

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml; charset=utf-8
SOAPAction: "search"
Cookie: JSESSIONID=BKQ7xxxxxxxxxxxx4Ug!-995xxxxxx
Accept-Encoding: gzip, deflate



  
    
      xxxxxxxxxxxxxxx
    
    
      50
    
  
  
    
      
        
          
            x
          
          
            a

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 18:40:33 GMT
Content-Length: 49266
Content-Type: text/xml; charset=utf-8
X-N-OperationId: c1e79336-63b7-4eb7-989e-5c3d24c56891
NS_RTIMER_COMPOSITE: 118xxxxxxxx:70617xxxxxxxxxxxxxxxxxxxxxD:80
Strict-Transport-Security: max-age=31536000
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent



  
    
      WEBSERVICES_ABCD_12345-xxxxxxxxx
    
  
  
    
      
        
        193
        50
        4
        1
        WEBSERVICES_ABCD_12345-xxxxxxxxx
        
          
            _bank
            1111
            Checking
            false
            
              USD
            
            _current
            
              xxxxxxxxxxxxxxxxxxx
            
            _average
            Checking
            false
            false
            false
            true
          
          
            _bank
            22222
            Savings
            false
            
              USD
            
            _current
            
              yyyyyyyyy
            
            _average
            Savings
            false
            false
            false
            true
          
          .........
          .........
          .........
          .........

POST https://webservices.netsuite.com/services/NetSuitePort_2017_1
Content-Type: text/xml; charset=utf-8
SOAPAction: "searchMoreWithId"
Cookie: JSESSIONID=BKQ7xxxxxxxxxxxx4Ug!-995xxxxxx
Accept-Encoding: gzip, deflate



  
    
      xxxxxxxxxxxxxxxxxx
    
    
      50
    
  
  
    
      WEBSERVICES_ABCD_12345-xxxxxxxxx
      2

Response (Page-2 and onwards)

HTTP/1.1 200 OK
Date: Wed, 03 Oct 2018 18:40:33 GMT
Content-Length: 49266
Content-Type: text/xml; charset=utf-8
X-N-OperationId: c1e79336-63b7-4eb7-989e-5c3d24c56891
NS_RTIMER_COMPOSITE: 118xxxxxxxx:70617xxxxxxxxxxxxxxxxxxxxxD:80
Strict-Transport-Security: max-age=31536000
P3P: CP="CAO PSAa OUR BUS PUR"
Vary: User-Agent



  
    
      WEBSERVICES_ABCD_12345-xxxxxxxxx
    
  
  
    
      
        
        193
        50
        4
        2
        WEBSERVICES_ABCD_12345-xxxxxxxxx
        
          
            _bank
            8000
            Checking
            false
            
              USD
            
            _current
            
              xxxxxxxxxxxxxxxxxxx
            
            _average
            Checking
            false
            false
            false
            true
          
          
            _bank
            8001
            Savings
            false
            
              USD
            
            _current
            
              yyyyyyyyy
            
            _average
            Savings
            false
            false
            false
            true
          
          .........
          .........
          .........
          .........

Getting Started

Now let’s check step by step instructions on how to load NetSuite data in Power BI. In this exercise we will focus on calling search API but you can call virtually any API using the same technique.

<searchRecord xmlns:q1="urn:accounting_2017_1.lists.webservices.netsuite.com" xsi:type="q1:AccountSearch">

Creating NetSuite ODBC Connection (Using ZappySys XML / SOAP Driver)

Once you have all necessary information handy we can create ODBC DSN for NetSuite which can be used by any ODBC compliant app such as Power BI. Perform the following steps to set NetSuite Connection which we will use to query data (e.g. Accounts, Budget, Campaign etc).

Open start menu and search for “ODBC 64”. Launch ODBC Data sources for 64 bit
Click Add and select ZappySys XML Driver
ZappySys ODBC Driver for XML / SOAP API
Once driver UI is visible change default DSN name (e.g. change to ZS – NetSuite)

Click on the Load Connection String button and enter the following string after replacing below placeholders to configure the NetSuite connection. If you are unsure how to get Account ID and Application ID then check previous sections. For now dont worry about various options in the connection string. We will cover them later.
Replace $$$YOUR-APPLICATION-ID$$$ (2 times) with your own Application ID
Replace $$$YOUR-ACCOUNT-ID$$$ with your own Account ID
Replace $$$YOUR-USER-ID$$$ with your own Login ID (e.g myuser@mycompany.com)
Replace $$$YOUR-PASSWORD$$$ with your own Password
Replace 50 with your own value. We suggest not to go more than 200 rows per page for better performance.
Replace c:\temp\netsuite.cache.db with your own path for Cache File. Caching must be ON in order to Import data in Power BI correct way. We also use CacheTtl=120 seconds (Cache Expires in 120 seconds) but adjust it longer if your data import takes long time.

DRIVER={ZappySys XML Driver};ElementsToTreatAsArray='platformCore:record';DataPath='https://webservices.netsuite.com/services/NetSuitePort_2017_1';DataConnectionType=HTTP;AuthScheme='JSESSIONID=';TokenUrl='https://webservices.netsuite.com/services/NetSuitePort_2017_1';TokenRequestData='

  
    
      $$$YOUR-APPLICATION-ID$$$
    
  
  
    
      
        [$userid$]
        [$password$]
        $$$YOUR-ACCOUNT-ID$$$
        
      
    
  
';TokenRequestMethod='POST';TokenRequestContentType=TextXmlUtf8;TokenResponseValueExtractMode=Cookie;TokenRequestHeaders='SOAPAction:"login"';TokenResponseCookie='JSESSIONID';TokenAuthHeader='Cookie';UserName='$$$YOUR-USER-ID$$$';CredentialType=TokenDynamic;Password='$$$YOUR-PASSWORD$$$';Filter='$.soapenv:Envelope.soapenv:Body.search[$tag$]Response.platformCore:searchResult.platformCore:recordList.platformCore:record[*]';RequestData='

  
    
      $$$YOUR-APPLICATION-ID$$$
    
    
      50
    
  
  
[$tag$]
  
';RequestMethod='POST';NextUrlAttributeOrExpr='$.soapenv:Envelope.soapenv:Body.search[$tag$]Response.platformCore:searchResult.platformCore:searchId';FirstPageBodyPart='    
      
        
		 
        
      
    ';NextPageBodyPart='    
      [$pagetoken$]
      [$pagenumber$]
    ';PagingMaxPagesExpr='$.soapenv:Envelope.soapenv:Body.searchResponse.platformCore:searchResult.platformCore:totalPages';HasDifferentNextPageInfo=True;EnablePageTokenForBody=True;PagePlaceholders='header=|MoreWithId;filter=|MoreWithId';RequestHeaders='Content-Type: text/xml; charset=utf-8 || SOAPAction: "search[$tag$]"';CachingMode=All;CacheStorage=File;CacheEntryTtl=120;CacheFileLocation='c:\temp\netsuite.cache.db'

ZappySys ODBC Driver Load Connection String – NetSuite Connection Example

After configuration your screen may look like below. You can also click on Advanced View (Radio button) to see some Advanced properties (e.g. Caching Properties such as CachingMode, CacheFileLocation and Advanced Pagination Properties such as PagingMaxPagesExpr, HasDifferentNextPageInfo, NextPageBodyPart, FirstPageBodyPart, EnablePageTokenForBody, PagePlaceholders )

Notice [$tag$] in Body, Header and Filter. This gets replaced at runtime based on some settings we did for pagination (see next 2 screenshots). NetSuite API has different Header, Body and Filter need for First page vs Next Pages so it needs special configuration. [$tag$] in Body gets replacement based on FirstPageBodyPart and NextPageBodyPart properties found on Advanced View under Pagination. [$tag$] used in Filter, Header or any other place gets its replacements from PagePlaceHolders Property found on Advanced View (see filter=firstPartString|nextPartString;header=firstPartString|nextPartString). Use pipe (vertical bar to separate first part placeholder and next part placeholder) In our case we use blank for first part.

NetSuite ODBC Connection Settings (ZappySys XML Driver)
Here is what it looks like on Advanced Tab.
ODBC XML Driver – Ádvanced View (Pagination, Caching, Logging and other properties not found in Simple Mode)
Now go to preview tab and click Preview Data button. You will see upto 100 sample records. Using below query it will use all options from UI (No override in query).SELECT * from $
Preview NetSuite data (Query Accounts) using ODBC Driver
Now let’s change our default query a bit to get list of Expense Category (i.e. ExpenseCategorySearch). As you see we change FirstRequestBody a little bit (change q1:ExpenseCategorySearch). We also removed some unwanted columns from preview by setting IncludeParentColumns=’false’
```
SELECT * FROM $
WITH(
	FirstPageBodyPart='    
      
        
          
            Some-String-Goes-Here
          
          
            Some-String-Goes-Here
          
        
      
    ',
    IncludeParentColumns='False'
)
```
We have commented SearchQuery portion to make it simple but you can learn more about how to write search query from here

Here is one more example of query which combines Basic Search and Advanced Search

Pay close attention to namespace prefix in SOAP code you copy from Help center. It may be using different prefix than our original connection string (e.g. we use q1:xxxxx at some places but online sample may use ns1, ns2, ns3 ….)
```
SELECT * FROM $
WITH(
	FirstPageBodyPart='
    
      
        
          
            .com
          
        
        
          
            C
          
        
      
    ',
    IncludeParentColumns='False'
)
```
NetSuite Search API Example (Mixing BasicSearch / AdvancedSearch with JOIN)
Copy your Final Query you like to use to import NetSuite data in Power BI
Click OK to save DSN

Import NetSuite data in Power BI

Now lets perform the final step to import our NetSuite Query to Power BI. Assume that we want to import Contacts in Power BI to report them by demographics or some other criteria.

Open Power BI Desktop
Click on Get Data > More Data… > Other > ODBC
Import SOAP API in Power BI (Using ZappySys XML ODBC Driver)
Select your ODBC DSN Source from the dropdown (Assuming you have created a ODBC Data Source using ZappySys XML Driver – See the previous Section)
Expand Advanced Options to enter custom Query.
Enter your SOAP API call SQL query here. For example purpose, we will use below query to get all account using NetSuite Search Web service.
```
SELECT * FROM $
WITH(
	FirstPageBodyPart='    
      
        
        
        
      
    ',
    IncludeParentColumns='False'
)
```
Import NetSuite SOAP Web Service Data in Power BI (ZappySys XML Driver)
Once you see data preview click OK to import.
After data import is done you can edit your dataset (e.g. remove unwanted columns)
You can also edit Source query after data is imported (See below)
Edit Power BI Data Source SQL after REST / SOAP Web Service Import
That’s it. You can now create your dashboards using NetSuite data. See below example.
Import NetSuite data in Power BI dashboard

How to debug Web Requests using Fiddler

There will be a time you like to see RAW HTTP Requests generated by driver for NetSuite SOAP API. If you like to do that check this article.

How to call other NetSuite SOAP API

So far we have seen only search API to query data. But there are many other SOAP APIs which can be consumed using approach listed in this article. Check this article to learn more how to call any SOAP API using ZappySys XML Driver. It shows techniques to use tool called SoapUI. You can use NetSuite WSDL file from here copy link listed on that page and use it to import in SoapUI.

Conclusion

Consuming data from NetSuite API or any XML / SOAP based API in your Reporting / ETL apps can be tricky. But we have seen how to solve this challenging task using ZappySys XML Driver in few clicks. Download ODBC PowerPack and explore many other API integration scenarios not discussed in this article.

The post How to read NetSuite data in Power BI appeared first on ZappySys Blog.