Netsuite

Learn how to use Netsuite with Composio

Overview

SLUG: NETSUITE

Description

NetSuite by Oracle is a cloud-based ERP suite that combines accounting, CRM, e-commerce, and inventory management for comprehensive business oversight

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to profile
bearer_token
string
subdomain
stringRequired

Connecting to Netsuite

Create an auth config

Use the dashboard to create an auth config for the Netsuite toolkit. This allows you to connect multiple Netsuite accounts to Composio for agents to use.

1

Select App

Navigate to Netsuite.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Netsuite Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4netsuite_auth_config_id = "ac_YOUR_NETSUITE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Netsuite: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, netsuite_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Netsuite toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["NETSUITE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get Async Job Status

Description

Tool to poll the status of an asynchronous REST job. Use after submitting an async request with 'Prefer: respond-async' and receiving a Job ID.

Action Parameters

jobId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Async Job Task

Description

Tool to get the task reference for an async job. Use when polling for job completion to retrieve the task ID.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Async Get Job Task Result

Description

Tool to retrieve the payload result of a completed async task. Use after confirming the async job and task have completed to fetch the operation's output.

Action Parameters

jobId
stringRequired
taskId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Customer

Description

Tool to create a new customer record. Use when you have all required customer details and want to add them to NetSuite.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Customer Payment

Description

Tool to create a new customer payment record. Use when you have payment details to record a payment against a customer in NetSuite.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Employee

Description

Tool to create a new employee record. Use when you have all required employee details ready.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Invoice

Description

Tool to create a new invoice record. Use when you have all required invoice details and want to add them to NetSuite.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Item

Description

Tool to create a new item record. Use when you have all required item details and want to add them to NetSuite.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
record_type
stringRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Item Receipt

Description

Tool to create an Item Receipt from a Purchase Order. Use when you need to record received items for a Purchase Order.

Action Parameters

purchase_order_id
integerRequired
record_body
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Journal Entry

Description

Tool to create a new journal entry record. Use when posting balanced debits and credits to the general ledger.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create JWT Client Assertion

Description

Tool to build a JWT client assertion for NetSuite OAuth2 client credentials. Use before exchanging for an access token.

Action Parameters

alg
string
aud
string
certificate_id
string
client_id
string
exp
integer
iat
integer
private_key_pem
string
scope
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Purchase Order

Description

Tool to create a new purchase order record. Use when you need to submit a purchase order to a vendor.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
customForm
string
entity
objectRequired
item
objectRequired
location
objectRequired
memo
string
replace
string
tranDate
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Record

Description

Tool to create a new record instance for any record type. Use when you need to insert a record by specifying recordType and data. Use after confirming record metadata schema. Limited to synchronous or async single-record creation; subrecords and bulk creates are not supported.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
record_type
stringRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Sales Order

Description

Tool to create a new sales order record. Use when you need to submit a customer order with one or more items.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
customForm
string
entity
objectRequired
item
objectRequired
memo
string
orderStatus
string
otherrefnum
string
promocode
object
replace
string
tranDate
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Vendor

Description

Tool to create a new vendor record. Use when you have all required vendor details to add a new vendor in NetSuite.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Vendor Bill

Description

Tool to create a new vendor bill record. Use when you have all required bill and line-item details to add a vendor bill in NetSuite.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
body
objectRequired
replace
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Customer

Description

Tool to delete a customer record by ID. Use when you need to remove an existing customer record from NetSuite.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Customer Payment

Description

Tool to delete a customer payment record by ID. Use when you need to remove an existing customer payment from NetSuite.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Employee

Description

Tool to delete an employee record by ID. Use when you need to remove an existing employee record from NetSuite.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Invoice

Description

Tool to delete an invoice record by ID. Use when you need to remove an existing invoice record from NetSuite.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Item

Description

Tool to delete an item record by its type and ID. Use when you need to remove an existing item record from NetSuite. Use after verifying the record exists to avoid unintended deletions.

Action Parameters

id
stringRequired
item_record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Item Fulfillment

Description

Tool to delete an Item Fulfillment record. Use when you need to remove an existing Item Fulfillment record from NetSuite. Use after confirming the record exists.

Action Parameters

id
stringRequired
idempotency_key
string
prefer
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Item Receipt

Description

Tool to delete an item receipt record by ID. Use when you need to remove an existing item receipt from NetSuite.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Journal Entry

Description

Tool to delete a journal entry record by ID. Use when you need to remove an existing journal entry from NetSuite.

Action Parameters

id
integerRequired
idempotency_key
string
prefer
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Purchase Order

Description

Tool to delete a purchase order record by ID. Use when you need to remove an existing purchase order from NetSuite.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Record

Description

Tool to delete a NetSuite record by type and internal ID. Use when you need to remove a specific record instance.

Action Parameters

id
integerRequired
record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Sales Order

Description

Tool to delete a sales order by internal ID. Use when you need to remove an existing sales order record from NetSuite. Use after confirming the record exists to avoid unintended deletions.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Vendor Payment

Description

Tool to delete a vendor payment record by ID. Use when you need to remove an existing vendor payment from NetSuite.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Execute Dataset

Description

Tool to execute a SuiteAnalytics dataset and return paged results. Use when you need to retrieve dataset rows with paging support.

Action Parameters

dataset_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Filter Record Collection

Description

Tool to filter a record collection by query expression. Use when you need to retrieve specific records of a given type using filter expressions and pagination.

Action Parameters

limit
integer
offset
integer
q
string
recordType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Customer

Description

Tool to retrieve a customer record by internal ID. Use when you have a customer ID and need detailed customer data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Customer Payment

Description

Tool to retrieve a customer payment record by ID. Use when you need to fetch payment details using the internal or external ID.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
simpleEnumFormat
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Data Center URLs

Description

Tool to discover account-specific service domains. Use when you need to determine the correct REST, SOAP, and UI endpoints before making other API calls.

Action Parameters

account
stringRequired
c
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Employee

Description

Tool to retrieve an employee record by ID. Use when you have an employee ID and need detailed employee data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Governance Limits

Description

Tool to retrieve account and integration concurrency limits. Use when you need to verify your account concurrency limits (admin only).

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Invoice

Description

Tool to retrieve an invoice record by internal ID. Use when you have an invoice ID and need detailed invoice data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
simpleEnumFormat
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Item

Description

Tool to retrieve an item record by internal ID. Use when you have an item ID and need detailed item data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
itemRecordType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Item Fulfillment

Description

Tool to retrieve an item fulfillment record by internal ID. Use when you have an item fulfillment ID and need detailed fulfillment data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
simpleEnumFormat
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Item Receipt

Description

Tool to retrieve an item receipt record by internal ID. Use when you have an item receipt ID and need detailed item receipt data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Journal Entry

Description

Tool to retrieve a journal entry by internal ID. Use when you have a journal entry ID and need detailed journal entry data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
simpleEnumFormat
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Purchase Order

Description

Tool to retrieve a purchase order record by internal ID. Use when you have a purchase order ID and need detailed purchase order data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
simpleEnumFormat
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Record By ID

Description

Tool to retrieve a specific record by internal ID. Use when you need full details of any NetSuite record by specifying its type and ID.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Record Metadata

Description

Tool to retrieve metadata definition for a specific record type. Use when you need to inspect the schema of a NetSuite record before creating or updating records.

Action Parameters

accept
stringDefaults to application/schema+json
record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Record Selected Fields

Description

Tool to retrieve selected body fields of a record instance. Use when you need only specific fields to minimize payload.

Action Parameters

fields
stringRequired
id
stringRequired
record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Reference Select Field

Description

Tool to retrieve a record referenced by a select field. Use after you have a parent record and need the full linked record instance.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
record_type
stringRequired
select_field
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sales Order

Description

Tool to retrieve a sales order record by internal ID. Use when you have a sales order ID and need detailed sales order data.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Server Time

Description

Tool to retrieve NetSuite server time in UTC. Use when you need the current server timestamp for synchronization.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sublist Collection

Description

Tool to retrieve a sublist collection from a parent record. Use when you need all lines of a given sublist (e.g., items on a sales order).

Action Parameters

id
stringRequired
record_type
stringRequired
sublist_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sublist Line

Description

Tool to retrieve a specific line from a sublist of a record. Use when you need details of a particular sublist line by its ID.

Action Parameters

expandSubResources
boolean
id
stringRequired
line_id
stringRequired
record_type
stringRequired
sublist_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subrecord

Description

Tool to retrieve a subrecord from a parent record. Use when you need detailed subrecord data by specifying the record type, record ID, and subrecord name.

Action Parameters

id
stringRequired
record_type
stringRequired
subrecord_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Vendor

Description

Tool to get a single vendor record by internal ID. Use when needing specific vendor information.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired
simpleEnumFormat
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Vendor Bill

Description

Tool to retrieve a vendor bill record by internal ID. Use when you have a vendor bill ID and need detailed vendor bill data including sublists.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Vendor Payment

Description

Tool to retrieve a vendor payment record by internal ID. Use when you have the vendor payment's internal ID and need its details.

Action Parameters

expandSubResources
boolean
fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Customer Payments

Description

Tool to list customer payment records. Use when you need to retrieve payments with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Datasets

Description

Tool to list SuiteAnalytics Workbook datasets. Use when you need to retrieve datasets with optional pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Employees

Description

Tool to list employee records. Use when you need to retrieve multiple employees with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Integrations

Description

Tool to list integration applications. Use when you need to retrieve client IDs and redirect URIs necessary for OAuth2 authorization flows.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Invoices

Description

Tool to list invoice records. Use when you need to retrieve multiple invoices with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Item Fulfillments

Description

Tool to list item fulfillment records. Use when you need to retrieve multiple item fulfillments with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Item Receipts

Description

Tool to list item receipt records. Use when you need to retrieve multiple item receipt records with optional filtering and pagination after confirming a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Journal Entries

Description

Tool to list journal entry records. Use when you need to retrieve multiple journal entries with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Metadata Catalog

Description

Tool to list all record types and their metadata. Use after authenticating when you need to discover available record definitions before further API calls.

Action Parameters

accept
string
select
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Purchase Orders

Description

Tool to list purchase order records. Use when you need to retrieve multiple purchase orders with optional filtering and pagination.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Records

Description

Tool to list record instances. Use when you need to retrieve multiple records with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string
recordType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Sales Orders

Description

Tool to list sales order records. Use when you need to retrieve multiple sales orders with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Vendor Payments

Description

Tool to list vendor payment records. Use when you need to retrieve vendor payments with optional filtering and pagination after establishing a valid NetSuite connection.

Action Parameters

limit
integer
offset
integer
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: OAuth2 Authorize Account Domain

Description

Tool to construct an OAuth2 authorization URL for a NetSuite account-specific domain. Use when initiating the OAuth2 authorization code flow.

Action Parameters

client_id
stringRequired
code_challenge
string
code_challenge_method
string
prompt
string
redirect_uri
stringRequired
response_type
stringDefaults to code
scope
stringRequired
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: OAuth2 Authorize System Domain

Description

Tool to start OAuth2 authorization code flow on system domain. Use when initiating an OAuth2 authorization code grant from the NetSuite system domain.

Action Parameters

client_id
stringRequired
code_challenge
string
code_challenge_method
string
nonce
stringRequired
prompt
string
redirect_uri
stringRequired
response_type
stringDefaults to code
scope
stringRequired
state
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get OAuth2 JWKS Keys

Description

Tool to retrieve OAuth2 JWKS public keys. Use when validating token signatures.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: OAuth2 Logout

Description

Tool to revoke an ID token and its associated access and refresh tokens. Use when ending an OAuth2 session to ensure credentials are invalidated.

Action Parameters

id_token_hint
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Revoke OAuth2 Refresh Token

Description

Tool to revoke a refresh token and its access tokens. Use when you need to invalidate existing OAuth2 refresh tokens after decommissioning credentials.

Action Parameters

client_id
string
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Exchange OAuth2 Authorization Code

Description

Tool to exchange OAuth2 authorization code for tokens. Use after obtaining an authorization code with PKCE.

Action Parameters

client_id
string
code
stringRequired
code_verifier
stringRequired
grant_type
stringDefaults to authorization_code
redirect_uri
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: OAuth2 Token Client Credentials

Description

Tool to obtain an OAuth2 access token via client credentials grant. Use when authenticating to NetSuite APIs with a JWT-based client credentials flow.

Action Parameters

client_assertion
stringRequired
client_assertion_type
stringDefaults to urn:ietf:params:oauth:client-assertion-type:jwt-bearer
grant_type
stringDefaults to client_credentials

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: OAuth2 Token Refresh

Description

Tool to refresh an OAuth2 access token. Use when the current access token has expired and you need a new one.

Action Parameters

client_id
string
client_secret
string
refresh_token
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Run SuiteQL Query

Description

Tool to execute a SuiteQL query. Use when you need ad-hoc SQL queries against NetSuite data with server-side paging.

Action Parameters

limit
integer
offset
integer
q
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Transform Record

Description

Tool to transform an existing NetSuite record into another record type. Use when you need to generate a new target record based on a source record with optional field overrides.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
record_body
object
record_id
integerRequired
replace
string
source_record_type
stringRequired
target_record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Customer

Description

Tool to update a customer record by ID. Use when modifying fields of an existing customer.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Customer Payment

Description

Tool to update an existing customer payment by ID. Use when you need to modify fields of a customer payment record.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Employee

Description

Tool to update an employee record by ID. Use when modifying fields of an existing employee.

Action Parameters

Prefer
string
X-NetSuite-Idempotency-Key
string
X-NetSuite-PropertyNameValidation
string
X-NetSuite-PropertyValueValidation
string
data
objectRequired
id
stringRequired
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Invoice

Description

Tool to update an invoice record by ID. Use when modifying fields of an existing invoice.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Item

Description

Tool to update an item record by ID. Use when modifying selected fields of an existing item; omitted fields remain unchanged.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
item_type
stringRequired
prefer
string
property_name_validation
string
property_value_validation
string
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Item Fulfillment

Description

Tool to update an Item Fulfillment record by ID. Use when modifying fields or sublists of an existing fulfillment.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Item Receipt

Description

Tool to update an item receipt record by ID. Use when modifying fields of an existing item receipt.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Journal Entry

Description

Tool to update a journal entry record by ID. Use when modifying fields of an existing journal entry after retrieving its details.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string
replace
string
replace_selected_fields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Purchase Order

Description

Tool to update a purchase order record by ID. Use when modifying fields of an existing purchase order. Call after retrieving the record to confirm current values.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Record

Description

Tool to update an existing record instance. Use after fetching record metadata.

Action Parameters

data
objectRequired
id
stringRequired
recordType
stringRequired
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Sales Order

Description

Tool to update a sales order record by ID. Use when modifying fields of an existing sales order.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Vendor

Description

Tool to update a vendor record by ID. Use when modifying fields of an existing vendor.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Vendor Bill

Description

Tool to update a vendor bill record by ID. Use when modifying fields of an existing vendor bill.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Vendor Payment

Description

Tool to update a vendor payment record by ID. Use when modifying one or more fields on an existing vendor payment.

Action Parameters

data
objectRequired
id
integerRequired
idempotency_key
string
prefer
string
property_name_validation
string
property_value_validation
string
replace
string
replaceSelectedFields
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upsert Record by External ID

Description

Tool to create or update a record by external ID. Use when you need to ensure a record exists or update its fields in one call.

Action Parameters

body
objectRequired
external_id
stringRequired
record_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired